docs/man/qpid-config.1

.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.6.
.TH QPID-CONFIG "1" "October 2018" "qpid-config  (qpid-cpp) version 1.40.0" "User Commands"
.SH NAME

qpid-config \-  QPID Broker Configuration Tool
.SH SYNOPSIS

qpid-config [OPTIONS] commands
.SH DESCRIPTION

Usage:  qpid-config [OPTIONS]
        qpid-config [OPTIONS] exchanges [filter-string]
        qpid-config [OPTIONS] queues    [filter-string]
        qpid-config [OPTIONS] add exchange <type> <name> [AddExchangeOptions]
        qpid-config [OPTIONS] del exchange <name>
        qpid-config [OPTIONS] add queue <name> [AddQueueOptions]
        qpid-config [OPTIONS] del queue <name> [DelQueueOptions]
        qpid-config [OPTIONS] bind   <exchange-name> <queue-name> [binding-key]
                  <for type xml>     [-f -|filename]
                  <for type header>  [all|any] k1=v1 [, k2=v2...]
        qpid-config [OPTIONS] unbind <exchange-name> <queue-name> [binding-key]
        qpid-config [OPTIONS] reload-acl
        qpid-config [OPTIONS] add <type> <name> [--argument <property-name>=<property-value>]
        qpid-config [OPTIONS] del <type> <name>
        qpid-config [OPTIONS] list <type> [--show-property <property-name>]
        qpid-config [OPTIONS] log [<logstring>]
        qpid-config [OPTIONS] shutdown"""
.SH OPTIONS
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.IP
General Options:
.TP
\fB\-t\fR <secs>, \fB\-\-timeout=\fR<secs>
Maximum time to wait for broker connection (in
seconds)
.TP
\fB\-r\fR, \fB\-\-recursive\fR
Show bindings in queue or exchange list
.TP
\fB\-b\fR <address>, \fB\-\-broker=\fR<address>
Address of qpidd broker with syntax:
[username/password@] hostname | ip\-address [:<port>]
.HP
\fB\-a\fR <address>, \fB\-\-broker\-addr=\fR<address>
.TP
\fB\-\-sasl\-mechanism=\fR<mech>
SASL mechanism for authentication (e.g. EXTERNAL,
ANONYMOUS, PLAIN, CRAM\-MD5, DIGEST\-MD5, GSSAPI). SASL
automatically picks the most secure available
mechanism \- use this option to override.
.TP
\fB\-\-sasl\-service\-name\fR=\fI\,SASL_SERVICE_NAME\/\fR
SASL service name to use
.TP
\fB\-\-ssl\-certificate=\fR<cert>
Client SSL certificate (PEM Format)
.TP
\fB\-\-ssl\-key=\fR<key>
Client SSL private key (PEM Format)
.TP
\fB\-\-ha\-admin\fR
Allow connection to a HA backup broker.
.IP
Options for Listing Exchanges and Queues:
.TP
\fB\-\-ignore\-default\fR
Ignore the default exchange in exchange or queue list
.IP
Options for Adding Exchanges and Queues:
.TP
\fB\-\-alternate\-exchange=\fR<aexname>
Name of the alternate\-exchange for the new queue or
exchange. Exchanges route messages to the alternate
exchange if they are unable to route them elsewhere.
Queues route messages to the alternate exchange if
they are rejected by a subscriber or orphaned by queue
deletion.
.TP
\fB\-\-durable\fR
The new queue or exchange is durable.
.TP
\fB\-\-replicate=\fR<level>
Enable automatic replication in a HA cluster. <level>
is 'none', 'configuration' or 'all').
.IP
Options for Adding Queues:
.TP
\fB\-\-file\-count=\fR<n>
[legacystore] Number of files in queue's persistence
journal
.TP
\fB\-\-file\-size=\fR<n>
[legactystore] File size in pages (64KiB/page)
.TP
\fB\-\-efp\-partition\-num=\fR<n>
[linearstore] EFP partition number
.TP
\fB\-\-efp\-pool\-file\-size=\fR<n>
[linearstore] EFP file size (KiB)
.TP
\fB\-\-wcache\-page\-size=\fR<n>
[linearstore] Per\-queue buffer page size (kiB), value
may be powers of 2 starting at 4 (4, 8, 16, 32...)
.TP
\fB\-\-wcache\-num\-pages=\fR<n>
[linearstore] Per\-queue num buffer pages
.TP
\fB\-\-max\-queue\-size=\fR<n>
Maximum in\-memory queue size as bytes
.TP
\fB\-\-max\-queue\-count=\fR<n>
Maximum in\-memory queue size as a number of messages
.TP
\fB\-\-limit\-policy=\fR<policy>
Action to take when queue limit is reached
.TP
\fB\-\-lvq\-key=\fR<key>
Last Value Queue key
.TP
\fB\-\-flow\-stop\-size=\fR<n>
Turn on sender flow control when the number of queued
bytes exceeds this value.
.TP
\fB\-\-flow\-resume\-size=\fR<n>
Turn off sender flow control when the number of queued
bytes drops below this value.
.TP
\fB\-\-flow\-stop\-count=\fR<n>
Turn on sender flow control when the number of queued
messages exceeds this value.
.TP
\fB\-\-flow\-resume\-count=\fR<n>
Turn off sender flow control when the number of queued
messages drops below this value.
.TP
\fB\-\-group\-header=\fR<header\-name>
Enable message groups. Specify name of header that
holds group identifier.
.TP
\fB\-\-shared\-groups\fR
Allow message group consumption across multiple
consumers.
.TP
\fB\-\-argument=\fR<NAME=VALUE>
Specify a key\-value pair to add to queue arguments
.TP
\fB\-\-start\-replica=\fR<broker\-url>
Start replication from the same\-named queue at
<broker\-url>
.IP
Options for Adding Exchanges:
.TP
\fB\-\-sequence\fR
Exchange will insert a 'qpid.msg_sequence' field in
the message header
.TP
\fB\-\-ive\fR
Exchange will behave as an 'initial\-value\-exchange',
keeping a reference  to the last message forwarded and
enqueuing that message to newly bound queues.
.IP
Options for Deleting Queues:
.TP
\fB\-\-force\fR
Force delete of queue even if it's currently used or
it's not empty
.TP
\fB\-\-force\-if\-not\-empty\fR
Force delete of queue even if it's not empty
.TP
\fB\-\-force\-if\-used\fR
Force delete of queue even if it's currently used
.IP
Options for Declaring Bindings:
.TP
\fB\-f\fR <file.xq>, \fB\-\-file=\fR<file.xq>
For XML Exchange bindings \- specifies the name of a
file containing an XQuery.
.IP
Formatting options for 'list' action:
.TP
\fB\-\-show\-property=\fR<property\-name>
Specify a property of an object to be included in
output
.SH EXAMPLES

$ qpid-config add queue q

$ qpid-config add exchange direct d -a localhost:5672

$ qpid-config exchanges -b 10.1.1.7:10000

$ qpid-config queues -b guest/guest@broker-host:10000

Add Exchange <type> values:

    direct     Direct exchange for point-to-point communication
    fanout     Fanout exchange for broadcast communication
    topic      Topic exchange that routes messages using binding keys with wildcards
    headers    Headers exchange that matches header fields against the binding keys
    xml        XML Exchange - allows content filtering using an XQuery


Queue Limit Actions:

    none (default) - Use broker's default policy
    reject         - Reject enqueued messages
    ring           - Replace oldest unacquired message with new

Replication levels:

    none           - no replication
    configuration  - replicate queue and exchange existence and bindings, but not messages.
    all            - replicate configuration and messages

Log <logstring> value:

    Comma separated <module>:<level> pairs, e.g. 'info+,debug+:Broker,trace+:Queue'
.SH AUTHOR

The Apache Qpid Project, dev@qpid.apache.org
.SH "REPORTING BUGS"

Please report bugs to users@qpid.apache.org