1QPIDD(1)                         User Commands                        QPIDD(1)
2
3
4

NAME

6       qpidd - the Qpid AMQP Message Broker Daemon
7

SYNOPSIS

9       qpidd [OPTIONS]
10

DESCRIPTION

12       An AMQP message broker daemon that stores, routes and forwards messages
13       using the Advanced Message Queueing Protocol (AMQP).
14

OPTIONS

16       The options below are built-in to qpidd. Installing add-on modules pro‐
17       vides additional options. To see the full set of options available type
18       "qpidd --help"
19
20       Options may be specified via command line, environment variable or con‐
21       figuration file. See FILES and ENVIRONMENT below for details.
22
23       -h [ --help ]
24              Displays the help message
25
26       -v [ --version ]
27              Displays version information
28
29       --config FILE (/etc/qpid/qpidd.conf)
30              Reads configuration from FILE
31
32       --client-config FILE (/etc/qpid/qpidc.conf)
33              Reads client configuration from FILE (for cluster interconnect)
34
35   Module options:
36       --module-dir DIR (/usr/lib64/qpid/daemon)
37              Load all shareable modules in this directory
38
39       --load-module FILE
40              Specifies additional module(s) to be loaded
41
42       --no-module-dir
43              Don't load modules from module directory
44
45   Broker Options:
46       --data-dir DIR ($HOME/.qpidd)
47              Directory to contain persistent data generated by the broker
48
49       --no-data-dir
50              Don't use a data directory.  No persistent configuration will be
51              loaded or stored
52
53       --paging-dir DIR
54              Directory in which paging files will be created for paged queues
55
56       -p [ --port ] PORT (5672)
57              Tells the broker to listen on PORT
58
59       --interface <interface name>|<interface address>
60              Which network interfaces to use to listen for  incoming  connec‐
61              tions
62
63       --listen-disable <transport name>
64              Transports to disable listening
65
66       --protocols <protocol name+version>
67              Which protocol versions to allow
68
69       --worker-threads N (9)
70              Sets the broker thread pool size
71
72       --connection-backlog N (10)
73              Sets the connection backlog limit for the server socket
74
75       -m [ --mgmt-enable ] yes|no (1)
76              Enable Management
77
78       --mgmt-publish yes|no (1)
79              Enable Publish of Management Data ('no' implies query-only)
80
81       --mgmt-qmf2 yes|no (1)
82              Enable broadcast of management information over QMF v2
83
84       --mgmt-qmf1 yes|no (0)
85              Enable broadcast of management information over QMF v1
86
87       --mgmt-pub-interval SECONDS (10s)
88              Management Publish Interval
89
90       --queue-purge-interval SECONDS (600s)
91              Interval  between  attempts  to  purge any expired messages from
92              queues
93
94       --auth yes|no (1)
95              Enable authentication, if disabled all incoming connections will
96              be trusted
97
98       --realm REALM (QPID)
99              Use the given realm when performing authentication
100
101       --sasl-service-name NAME
102              The service name to specify for SASL
103
104       --default-queue-limit BYTES (104857600)
105              Default maximum size for queues (in bytes)
106
107       --tcp-nodelay
108              Set TCP_NODELAY on TCP connections
109
110       --require-encryption
111              Only accept connections that are encrypted
112
113       --known-hosts-url URL or 'none' (none)
114              URL  to  send  as 'known-hosts' to clients ('none' implies empty
115              list)
116
117       --sasl-config DIR
118              Allows SASL config path, if supported by platform, to  be  over‐
119              ridden.   For default location on Linux, see Cyrus SASL documen‐
120              tation.  There is no SASL config dir on Windows.
121
122       --default-flow-stop-threshold PERCENT (80)
123              Percent of queue's maximum capacity at  which  flow  control  is
124              activated.
125
126       --default-flow-resume-threshold PERCENT (70)
127              Percent  of  queue's  maximum  capacity at which flow control is
128              de-activated.
129
130       --default-event-threshold-ratio %age of limit (80)
131              The ratio of any specified queue limit at which an event will be
132              raised
133
134       --default-message-group GROUP-IDENTIFER (qpid.no-group)
135              Group  identifier  to  assign to messages delivered to a message
136              group queue that do not contain an identifier.
137
138       --enable-timestamp yes|no (0)
139              Add current time to each received message.
140
141       --link-maintenance-interval SECONDS (2s)
142              Interval to check federation link health and re-connect if  need
143              be
144
145       --link-heartbeat-interval SECONDS (120s)
146              Heartbeat interval for a federation link
147
148       --dtx-default-timeout SECONDS (60)
149              Default timeout for DTX transaction before aborting it
150
151       --dtx-max-timeout SECONDS (3600)
152              Maximum  allowed  timeout  for  DTX transaction. A value of zero
153              disables maximum timeout limit  checks  and  allows  arbitrarily
154              large timeout settings.
155
156       --max-negotiate-time MILLISECONDS (10000)
157              Maximum  time a connection can take to send the initial protocol
158              negotiation
159
160       --federation-tag NAME
161              Override the federation tag
162
163       --session-max-unacked DELIVERIES (5000)
164              Maximum number of un-acknowledged outoing messages per sesssion
165
166   Logging options:
167       -t [ --trace ]
168              Enables all logging
169
170       --log-enable RULE (notice+)
171              Enables logging for selected levels and components. RULE  is  in
172              the form 'LEVEL[+-][:PATTERN]' LEVEL is one of:
173
174       trace debug info notice warning error
175              critical  PATTERN  is  a  logging  category  name,  or  a names‐
176              pace-qualified function name or name fragment. Logging  category
177              names are:
178
179       Security Broker Management Protocol
180              System  HA Messaging Store Network Test Client Application Model
181              Unspecified For example: '--log-enable warning+' logs all  warn‐
182              ing,  error and critical messages.  '--log-enable trace+:Broker'
183              logs all category 'Broker' messages.  '--log-enable  debug:fram‐
184              ing'  logs  debug  messages from all functions with 'framing' in
185              the namespace or function name.  This option can be used  multi‐
186              ple times
187
188       --log-disable RULE
189              Disables  logging for selected levels and components. RULE is in
190              the form 'LEVEL[+-][:PATTERN]' LEVEL is one of:
191
192       trace debug info notice warning error
193              critical PATTERN  is  a  logging  category  name,  or  a  names‐
194              pace-qualified  function name or name fragment. Logging category
195              names are:
196
197       Security Broker Management Protocol
198              System HA Messaging Store Network Test Client Application  Model
199              Unspecified  For example: '--log-disable warning-' disables log‐
200              ging all warning,  notice,  info,  debug,  and  trace  messages.
201              '--log-disable  trace:Broker'  disables  all  category  'Broker'
202              trace messages.  '--log-disable debug-:qmf::'  disables  logging
203              debug  and trace messages from all functions with 'qmf::' in the
204              namespace.  This option can be used multiple times
205
206       --log-time yes|no (1)
207              Include time in log messages
208
209       --log-level yes|no (1)
210              Include severity level in log messages
211
212       --log-source yes|no (0)
213              Include source file:line in log messages
214
215       --log-thread yes|no (0)
216              Include thread ID in log messages
217
218       --log-function yes|no (0)
219              Include function signature in log messages
220
221       --log-hires-timestamp yes|no (0)
222              Use hi-resolution timestamps in log messages
223
224       --log-category yes|no (1)
225              Include category in log messages
226
227       --log-prefix STRING
228              Prefix to prepend to all log messages
229
230   Logging sink options:
231       --log-to-stderr yes|no (1)
232              Send logging output to stderr
233
234       --log-to-stdout yes|no (0)
235              Send logging output to stdout
236
237       --log-to-file FILE
238              Send log output to FILE.
239
240       --log-to-syslog yes|no (0)
241              Send logging output to syslog; customize using --syslog-name and
242              --syslog-facility
243
244       --syslog-name NAME (qpidd)
245              Name to use in syslog messages
246
247       --syslog-facility LOG_XXX (LOG_DAEMON)
248              Facility to use in syslog messages
249
250   Daemon options:
251       -d [ --daemon ]
252              Run as a daemon. Logs to syslog by default in this mode.
253
254       --transport TRANSPORT (tcp)
255              The transport for which to return the port
256
257       --pid-dir DIR ($HOME/.qpidd)
258              Directory where port-specific PID file is stored
259
260       --pidfile FILE
261              File name to store the PID in daemon mode. Used as-is, no direc‐
262              tory or suffixes added.
263
264       --close-fd FD
265              File descriptors that the daemon should close
266
267       -w [ --wait ] SECONDS (600)
268              Sets the maximum wait time to initialize or shutdown the daemon.
269              If the daemon fails to initialize/shutdown , prints an error and
270              returns 1
271
272       -c [ --check ]
273              Prints the daemon's process ID to stdout and returns  0  if  the
274              daemon is running, otherwise returns 1
275
276       -q [ --quit ]
277              Tells the daemon to shut down with an INT signal
278
279       -k [ --kill ]
280              Kill the daemon with a KILL signal.
281
282       --socket-fd FD
283              File descriptor for tcp listening socket
284
285   ACL Options:
286       --acl-file FILE
287              The policy file to load from, loaded from data dir
288
289       --connection-limit-per-user N (0)
290              The maximum number of connections allowed per user. 0 implies no
291              limit.
292
293       --max-connections N (500)
294              The maximum combined number of connections allowed. 0 implies no
295              limit.
296
297       --connection-limit-per-ip N (0)
298              The maximum number of connections allowed per host IP address. 0
299              implies no limit.
300
301       --max-queues-per-user N (0)
302              The maximum number of queues allowed  per  user.  0  implies  no
303              limit.
304
305   SSL Settings:
306       --ssl-use-export-policy
307              Use NSS export policy
308
309       --ssl-cert-password-file PATH
310              File  containing password to use for accessing certificate data‐
311              base
312
313       --ssl-cert-db PATH
314              Path to directory containing certificate database
315
316       --ssl-cert-name NAME (localhost.localdomain)
317              Name of the certificate to use
318
319       --ssl-port PORT (5671)
320              Port on which to listen for SSL connections
321
322       --ssl-require-client-authentication
323              Forces clients to authenticate in order to establish an SSL con‐
324              nection
325
326       --ssl-sasl-no-dict
327              Disables  SASL mechanisms that are vulnerable to passive dictio‐
328              nary-based password attacks
329
330   AMQP 1.0 Options:
331       --domain DOMAIN
332              Domain of this broker
333
334       --queue-patterns PATTERN
335              Pattern for on-demand queues
336
337       --topic-patterns PATTERN
338              Pattern for on-demand topics
339
340   HA Options:
341       --ha-cluster yes|no (0)
342              Join a HA active/passive cluster.
343
344       --ha-queue-replication yes|no (0)
345              Enable replication of specific queues without joining a cluster
346
347       --ha-brokers-url URL
348              URL with address of each broker in the cluster.
349
350       --ha-public-url URL
351              URL advertized to clients to connect to the cluster.
352
353       --ha-replicate LEVEL (none)
354              Replication level for creating queues and exchanges if there  is
355              no  qpid.replicate argument supplied. LEVEL is 'none', 'configu‐
356              ration' or 'all'
357
358       --ha-username USER
359              Username for connections between HA brokers
360
361       --ha-password PASS
362              Password for connections between HA brokers
363
364       --ha-mechanism MECH
365              Authentication mechanism for connections between HA brokers
366
367       --ha-backup-timeout SECONDS (10s)
368              Maximum time to wait for  an  expected  backup  to  connect  and
369              become ready.
370
371       --ha-flow-messages N (1000)
372              Flow  control  message  count  limit for replication, 0 means no
373              limit
374
375       --ha-flow-bytes N (0)
376              Flow control byte limit for replication, 0 means no limit
377
378   Linear Store Options:
379       --store-dir DIR
380              Store directory  location  for  persistence  (instead  of  using
381              --data-dir value). Required if --no-data-dir is also used.
382
383       --truncate yes|no (0)
384              If  yes|true|1,  will  truncate  the store (discard any existing
385              records). If no|false|0, will preserve the existing store  files
386              for recovery.
387
388       --wcache-page-size N (16)
389              Size of the pages in the write page cache in KiB. Allowable val‐
390              ues - powers of 2 starting at 4 (4, 8, 16, 32...)  Lower  values
391              decrease latency at the expense of throughput.
392
393       --wcache-num-pages N (16)
394              Number of pages in the write page cache. Minimum value: 4.
395
396       --tpl-wcache-page-size N (4)
397              Size  of  the  pages in the transaction prepared list write page
398              cache in KiB.  Allowable values - powers of 2 starting at: 4 (4,
399              8,  16,  32...)  Lower values decrease latency at the expense of
400              throughput.
401
402       --tpl-wcache-num-pages N (16)
403              Number of pages in the  transaction  prepared  list  write  page
404              cache. Minimum value: 4.
405
406       --efp-partition N (1)
407              Empty File Pool partition to use for finding empty journal files
408
409       --efp-file-size N (2048)
410              Empty  File Pool file size in KiB to use for journal files. Must
411              be a multiple of 4 KiB.
412
413       --overwrite-before-return yes|no (0)
414              If yes|true|1, will overwrite each store file with zeros  before
415              returning  it  to  the  Empty  File  Pool.  When not in use (the
416              default), then old message data remains  in  the  file,  but  is
417              overwritten  on  next use. This option should only be used where
418              security considerations justify it as it makes the  store  some‐
419              what slower.
420
421       --journal-flush-timeout SECONDS (500ms)
422              Maximum  time  to  wait  to flush journal.  Use ms, us units for
423              small time values (eg 10ms) - no space between value and unit.
424
425   Store Options:
426       --storage-provider PROVIDER
427              Name of the storage provider to use.
428

ENVIRONMENT

430       QPID_<option>
431              There is an environment variable for each option.
432
433       The environment variable is the option name in uppercase, prefixed with
434       QPID_  and  '.'  or '-' are replaced with '_'. Environment settings are
435       over-ridden by command line settings. For example:
436
437         export QPID_PORT=6000
438         export QPID_MAX_CONNECTIONS=10
439         export QPID_LOG_TO_FILE=/tmp/qpidd.log
440

FILES

442       /etc/qpidd.conf
443              Default configuration file.
444
445       Configuration file settings are over-ridden by command line or environ‐
446       ment   variable   settings.  '--config  <file>'  or  'export  QPID_CON‐
447       FIG=<file>' specifies an alternate file.
448
449       Each line is a name=value pair. Blank lines and lines beginning with  #
450       are ignored. For example:
451
452         # My qpidd configuration file.
453         port=6000
454         max-connections=10
455         log-to-file=/tmp/qpidd.log
456

AUTHOR

458       The Apache Qpid Project, dev@qpid.apache.org
459

REPORTING BUGS

461       Please report bugs to users@qpid.apache.org
462
463
464
465qpidd (qpid-cpp) version 1.39.0      2018                             QPIDD(1)
Impressum