1QPIDD(1) User Commands QPIDD(1)
2
6 qpidd - the Qpid AMQP Message Broker Daemon
7
10 qpidd [-p port] [--config config_file] [--data-dir directory]
11
14 An AMQP message broker daemon that stores, routes and forwards messages
15 using the Advanced Message Queueing Protocol (AMQP).
16
19 The options below are built-in to qpidd. Installing add-on modules pro‐
20 vides additional options. To see the full set of options available type
21 "qpidd --help"
22 Options may be specified via command line, environment variable or con‐
24 figuration file. See FILES and ENVIRONMENT below for details.
25 Options
28 -h [ --help ]
29 Displays the help message
30 -v [ --version ]
32 Displays version information
33 --config FILE
35 Reads configuration from FILE
36 --client-config FILE
38 Reads client configuration from FILE (for cluster interconnect)
39 Module options
42 --module-dir DIR
43 Load all shareable modules in this directory
44 --load-module FILE
46 Specifies additional module(s) to be loaded
47 --no-module-dir
49 Don't load modules from module directory
50 Broker Options
53 --data-dir DIR
54 Directory to contain persistent data generated by the broker
55 --no-data-dir
57 Don't use a data directory. No persistent configuration will be
58 loaded or stored
59 -p [ --port ] PORT (5672)
61 Tells the broker to listen on PORT
62 --worker-threads N (9)
64 Sets the broker thread pool size
65 --max-connections N (500)
67 Sets the maximum allowed connections
68 --connection-backlog N (10)
70 Sets the connection backlog limit for the server socket
71 -m [ --mgmt-enable ] yes|no (1)
73 Enable Management
74 --mgmt-qmf2 yes|no (1)
76 Enable broadcast of management information over QMF v2
77 --mgmt-qmf1 yes|no (1)
79 Enable broadcast of management information over QMF v1
80 --mgmt-pub-interval SECONDS (10)
82 Management Publish Interval
83 --queue-purge-interval SECONDS (600)
85 Interval between attempts to purge any expired messages from
86 queues
87 --auth yes|no (1)
89 Enable authentication, if disabled all incoming connections will
90 be trusted
91 --realm REALM (QPID)
93 Use the given realm when performing authentication
94 --default-queue-limit BYTES (104857600)
96 Default maximum size for queues (in bytes)
97 --tcp-nodelay
99 Set TCP_NODELAY on TCP connections
100 --require-encryption
102 Only accept connections that are encrypted
103 --known-hosts-url URL or 'none'
105 URL to send as 'known-hosts' to clients ('none' implies empty
106 list)
107 --sasl-config DIR
109 gets sasl config info from nonstandard location
110 --max-session-rate MESSAGES/S (0)
112 Sets the maximum message rate per session (0=unlimited)
113 --async-queue-events yes|no (0)
115 Set Queue Events async, used for services like replication
116 --default-flow-stop-threshold PERCENT (80)
118 Percent of queue's maximum capacity at which flow control is
119 activated.
120 --default-flow-resume-threshold PERCENT (70)
122 Percent of queue's maximum capacity at which flow control is
123 de-activated.
124 --default-event-threshold-ratio %age of limit (80)
126 The ratio of any specified queue limit at which an event will be
127 raised
128 --default-message-group GROUP-IDENTIFER (qpid.no-group)
130 Group identifier to assign to messages delivered to a message
131 group queue that do not contain an identifier.
132 --enable-timestamp yes|no (0)
134 Add current time to each received message.
135 --link-heartbeat-interval SECONDS (120)
137 Heartbeat interval for a federation link
138 --max-negotiate-time MILLISECONDS (10000)
140 Maximum time a connection can take to send the initial protocol
141 negotiation
142 Logging options
145 -t [ --trace ]
146 Enables all logging
147 --log-enable RULE (notice+)
149 Enables logging for selected levels and components. RULE is in
150 the form 'LEVEL[+][:PATTERN]' Levels are one of: trace debug
151 info notice warning error critical For example: '--log-enable
152 warning+' logs all warning, error and critical messages.
153 '--log-enable debug:framing' logs debug messages from the fram‐
154 ing namespace. This option can be used multiple times
155 --log-time yes|no (1)
157 Include time in log messages
158 --log-level yes|no (1)
160 Include severity level in log messages
161 --log-source yes|no (0)
163 Include source file:line in log messages
164 --log-thread yes|no (0)
166 Include thread ID in log messages
167 --log-function yes|no (0)
169 Include function signature in log messages
170 --log-hires-timestamp yes|no (0)
172 Use unformatted hi-res timestamp in log messages
173 --log-prefix STRING
175 Prefix to append to all log messages
176 Logging sink options
179 --log-to-stderr yes|no (1)
180 Send logging output to stderr
181 --log-to-stdout yes|no (0)
183 Send logging output to stdout
184 --log-to-file FILE
186 Send log output to FILE.
187 --log-to-syslog yes|no (0)
189 Send logging output to syslog; customize using --syslog-name and
190 --syslog-facility
191 --syslog-name NAME (lt-qpidd)
193 Name to use in syslog messages
194 --syslog-facility LOG_XXX (LOG_DAEMON)
196 Facility to use in syslog messages
197 Daemon options
200 -d [ --daemon ]
201 Run as a daemon. Logs to syslog by default in this mode.
202 --transport TRANSPORT (tcp)
204 The transport for which to return the port
205 --pid-dir DIR
207 Directory where port-specific PID file is stored
208 -w [ --wait ] SECONDS (600)
210 Sets the maximum wait time to initialize the daemon. If the dae‐
211 mon fails to initialize, prints an error and returns 1
212 -c [ --check ]
214 Prints the daemon's process ID to stdout and returns 0 if the
215 daemon is running, otherwise returns 1
216 -q [ --quit ]
218 Tells the daemon to shut down
219 ACL Options
222 --acl-file FILE
223 The policy file to load from, loaded from data dir
224 --connection-limit-per-user N (0)
226 The maximum number of connections allowed per user. 0 implies no
227 limit.
228 --connection-limit-per-ip N (0)
230 The maximum number of connections allowed per host IP address. 0
231 implies no limit.
232 Queue Replication Options
235 --replication-exchange-name EXCHANGE
236 Exchange to which events for other queues are routed
237 --replication-exchange-type direct|topic etc (direct)
239 Type of exchange to use
240 --replication-queue QUEUE
242 Queue on which events for other queues are recorded
243 --replication-listener-name NAME (replicator)
245 name by which to register the replicating event listener
246 --create-replication-queue
248 if set, the replication will be created if it does not exist
249
252 /etc/qpidd.conf
253 Default configuration file.
254 Configuration file settings are over-ridden by command line or environ‐
256 ment variable settings. '--config <file>' or 'export QPID_CON‐
257 FIG=<file>' specifies an alternate file.
258 Each line is a name=value pair. Blank lines and lines beginning with #
260 are ignored. For example:
261 # My qpidd configuration file.
263 port=6000
264 max-connections=10
265 log-to-file=/tmp/qpidd.log
266
269 QPID_<option>
270 There is an environment variable for each option.
271 The environment variable is the option name in uppercase, prefixed with
273 QPID_ and '.' or '-' are replaced with '_'. Environment settings are
274 over-ridden by command line settings. For example:
275 export QPID_PORT=6000
277 export QPID_MAX_CONNECTIONS=10
278 export QPID_LOG_TO_FILE=/tmp/qpidd.log
279
282 The Apache Qpid Project, dev@qpid.apache.org
283
286 Please report bugs to users@qpid.apache.org
287qpidd (qpidc) version 0.14 September 2012 QPIDD(1)