qpid-config(1)

1QPID-CONFIG(1)                   User Commands                  QPID-CONFIG(1)
2
3
4

NAME

6       qpid-config -  QPID Broker Configuration Tool
7

SYNOPSIS

9       qpid-config [OPTIONS] commands
10

DESCRIPTION

12       Usage:  qpid-config [OPTIONS]
13               qpid-config [OPTIONS] exchanges [filter-string]
14               qpid-config [OPTIONS] queues    [filter-string]
15               qpid-config   [OPTIONS]  add  exchange  <type>  <name>  [AddEx‐
16       changeOptions]
17               qpid-config [OPTIONS] del exchange <name>
18               qpid-config [OPTIONS] add queue <name> [AddQueueOptions]
19               qpid-config [OPTIONS] del queue <name> [DelQueueOptions]
20               qpid-config  [OPTIONS]  bind     <exchange-name>   <queue-name>
21       [binding-key]
22                         <for type xml>     [-f -|filename]
23                         <for type header>  [all|any] k1=v1 [, k2=v2...]
24               qpid-config   [OPTIONS]   unbind  <exchange-name>  <queue-name>
25       [binding-key]
26               qpid-config [OPTIONS] reload-acl
27               qpid-config [OPTIONS] add <type> <name> [--argument  <property-
28       name>=<property-value>]
29               qpid-config [OPTIONS] del <type> <name>
30               qpid-config  [OPTIONS]  list <type> [--show-property <property-
31       name>]
32               qpid-config [OPTIONS] log [<logstring>]
33               qpid-config [OPTIONS] shutdown"""
34

OPTIONS

36       -h, --help
37              show this help message and exit
38
39              General Options:
40
41       -t <secs>, --timeout=<secs>
42              Maximum time to wait for broker connection (in seconds)
43
44       -r, --recursive
45              Show bindings in queue or exchange list
46
47       -b <address>, --broker=<address>
48              Address of qpidd broker with syntax: [username/password@]  host‐
49              name | ip-address [:<port>]
50
51       -a <address>, --broker-addr=<address>
52
53       --sasl-mechanism=<mech>
54              SASL  mechanism  for  authentication  (e.g. EXTERNAL, ANONYMOUS,
55              PLAIN, CRAM-MD5, DIGEST-MD5, GSSAPI). SASL  automatically  picks
56              the  most  secure available mechanism - use this option to over‐
57              ride.
58
59       --sasl-service-name=SASL_SERVICE_NAME
60              SASL service name to use
61
62       --ssl-certificate=<cert>
63              Client SSL certificate (PEM Format)
64
65       --ssl-key=<key>
66              Client SSL private key (PEM Format)
67
68       --ha-admin
69              Allow connection to a HA backup broker.
70
71              Options for Listing Exchanges and Queues:
72
73       --ignore-default
74              Ignore the default exchange in exchange or queue list
75
76              Options for Adding Exchanges and Queues:
77
78       --alternate-exchange=<aexname>
79              Name of the alternate-exchange for the new  queue  or  exchange.
80              Exchanges  route  messages to the alternate exchange if they are
81              unable to route them elsewhere. Queues  route  messages  to  the
82              alternate  exchange  if  they  are  rejected  by a subscriber or
83              orphaned by queue deletion.
84
85       --durable
86              The new queue or exchange is durable.
87
88       --replicate=<level>
89              Enable automatic replication in a HA cluster. <level> is 'none',
90              'configuration' or 'all').
91
92              Options for Adding Queues:
93
94       --file-count=<n>
95              [legacystore] Number of files in queue's persistence journal
96
97       --file-size=<n>
98              [legactystore] File size in pages (64KiB/page)
99
100       --efp-partition-num=<n>
101              [linearstore] EFP partition number
102
103       --efp-pool-file-size=<n>
104              [linearstore] EFP file size (KiB)
105
106       --wcache-page-size=<n>
107              [linearstore]  Per-queue  buffer  page  size (kiB), value may be
108              powers of 2 starting at 4 (4, 8, 16, 32...)
109
110       --wcache-num-pages=<n>
111              [linearstore] Per-queue num buffer pages
112
113       --max-queue-size=<n>
114              Maximum in-memory queue size as bytes
115
116       --max-queue-count=<n>
117              Maximum in-memory queue size as a number of messages
118
119       --limit-policy=<policy>
120              Action to take when queue limit is reached
121
122       --lvq-key=<key>
123              Last Value Queue key
124
125       --flow-stop-size=<n>
126              Turn on sender flow control when  the  number  of  queued  bytes
127              exceeds this value.
128
129       --flow-resume-size=<n>
130              Turn  off  sender  flow  control when the number of queued bytes
131              drops below this value.
132
133       --flow-stop-count=<n>
134              Turn on sender flow control when the number of  queued  messages
135              exceeds this value.
136
137       --flow-resume-count=<n>
138              Turn  off sender flow control when the number of queued messages
139              drops below this value.
140
141       --group-header=<header-name>
142              Enable message groups. Specify name of header that  holds  group
143              identifier.
144
145       --shared-groups
146              Allow message group consumption across multiple consumers.
147
148       --argument=<NAME=VALUE>
149              Specify a key-value pair to add to queue arguments
150
151       --start-replica=<broker-url>
152              Start replication from the same-named queue at <broker-url>
153
154              Options for Adding Exchanges:
155
156       --sequence
157              Exchange  will insert a 'qpid.msg_sequence' field in the message
158              header
159
160       --ive  Exchange will behave as an 'initial-value-exchange',  keeping  a
161              reference  to the last message forwarded and enqueuing that mes‐
162              sage to newly bound queues.
163
164              Options for Deleting Queues:
165
166       --force
167              Force delete of queue even if it's currently used  or  it's  not
168              empty
169
170       --force-if-not-empty
171              Force delete of queue even if it's not empty
172
173       --force-if-used
174              Force delete of queue even if it's currently used
175
176              Options for Declaring Bindings:
177
178       -f <file.xq>, --file=<file.xq>
179              For  XML  Exchange  bindings - specifies the name of a file con‐
180              taining an XQuery.
181
182              Formatting options for 'list' action:
183
184       --show-property=<property-name>
185              Specify a property of an object to be included in output
186

EXAMPLES

188       $ qpid-config add queue q
189
190       $ qpid-config add exchange direct d -a localhost:5672
191
192       $ qpid-config exchanges -b 10.1.1.7:10000
193
194       $ qpid-config queues -b guest/guest@broker-host:10000
195
196       Add Exchange <type> values:
197
198           direct     Direct exchange for point-to-point communication
199           fanout     Fanout exchange for broadcast communication
200           topic      Topic exchange that routes messages using  binding  keys
201       with wildcards
202           headers     Headers exchange that matches header fields against the
203       binding keys
204           xml        XML Exchange - allows content filtering using an XQuery
205
206
207       Queue Limit Actions:
208
209           none (default) - Use broker's default policy
210           reject         - Reject enqueued messages
211           ring           - Replace oldest unacquired message with new
212
213       Replication levels:
214
215           none           - no replication
216           configuration  - replicate queue and exchange existence  and  bind‐
217       ings, but not messages.
218           all            - replicate configuration and messages
219
220       Log <logstring> value:
221
222           Comma  separated  <module>:<level>  pairs,  e.g. 'info+,debug+:Bro‐
223       ker,trace+:Queue'
224

AUTHOR

226       The Apache Qpid Project, dev@qpid.apache.org
227

REPORTING BUGS

229       Please report bugs to users@qpid.apache.org
230
231
232
233qpid-config  (qpid-cpp) version 1.3M8a.r0ch 2018                    QPID-CONFIG(1)