qpidd (1) - Linux Man Pages

qpidd: the Qpid AMQP Message Broker Daemon

NAME

qpidd - the Qpid AMQP Message Broker Daemon

SYNOPSIS

qpidd [-p port] [--config config_file] [--data-dir directory]

DESCRIPTION

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

OPTIONS

The options below are built-in to qpidd. Installing add-on modules provides additional options. To see the full set of options available type "qpidd --help"

Options may be specified via command line, environment variable or configuration file. See FILES and ENVIRONMENT below for details.

-h [ --help ]
Displays the help message
-v [ --version ]
Displays version information
--config FILE
Reads configuration from FILE

Module options:

--module-dir DIR
Load all shareable modules in this directory
--load-module FILE
Specifies additional module(s) to be loaded
--no-module-dir
Don't load modules from module directory

Broker Options:

--data-dir DIR
Directory to contain persistent data generated by the broker
--no-data-dir
Don't use a data directory. No persistent configuration will be loaded or stored
-p [ --port ] PORT (5672)
Tells the broker to listen on PORT
--worker-threads N (3)
Sets the broker thread pool size
--max-connections N (500)
Sets the maximum allowed connections
--connection-backlog N (10)
Sets the connection backlog limit for the server socket
-m [ --mgmt-enable ] yes|no (1)
Enable Management
--mgmt-qmf2 yes|no (1)
Enable broadcast of management information over QMF v2
--mgmt-qmf1 yes|no (1)
Enable broadcast of management information over QMF v1
--mgmt-pub-interval SECONDS (10)
Management Publish Interval
--queue-purge-interval SECONDS (600)
Interval between attempts to purge any expired messages from queues
--auth yes|no (1)
Enable authentication, if disabled all incoming connections will be trusted
--realm REALM (QPID)
Use the given realm when performing authentication
--default-queue-limit BYTES (104857600)
Default maximum size for queues (in bytes)
--tcp-nodelay
Set TCP_NODELAY on TCP connections
--require-encryption
Only accept connections that are encrypted
--known-hosts-url URL or 'none'
URL to send as 'known-hosts' to clients ('none' implies empty list)
--sasl-config DIR
gets sasl config info from nonstandard location
--max-session-rate MESSAGES/S (0)
Sets the maximum message rate per session (0=unlimited)
--async-queue-events yes|no (0)
Set Queue Events async, used for services like replication
--default-flow-stop-threshold PERCENT (80)
Percent of queue's maximum capacity at which flow control is activated.
--default-flow-resume-threshold PERCENT (70)
Percent of queue's maximum capacity at which flow control is de-activated.
--default-event-threshold-ratio %age of limit (80)
The ratio of any specified queue limit at which an event will be raised

Logging options:

-t [ --trace ]
Enables all logging
--log-enable RULE (notice+)
Enables logging for selected levels and components. RULE is in the form 'LEVEL[+][:PATTERN]' Levels are one of:
trace debug info notice warning error
critical For example: '--log-enable warning+' logs all warning, error and critical messages. '--log-enable debug:framing' logs debug messages from the framing namespace. This option can be used multiple times
--log-time yes|no (1)
Include time in log messages
--log-level yes|no (1)
Include severity level in log messages
--log-source yes|no (0)
Include source file:line in log messages
--log-thread yes|no (0)
Include thread ID in log messages
--log-function yes|no (0)
Include function signature in log messages
--log-prefix STRING
Prefix to append to all log messages

Logging sink options:

--log-to-stderr yes|no (1)
Send logging output to stderr
--log-to-stdout yes|no (0)
Send logging output to stdout
--log-to-file FILE
Send log output to FILE.
--log-to-syslog yes|no (0)
Send logging output to syslog; customize using --syslog-name and --syslog-facility
--syslog-name NAME (lt-qpidd)
Name to use in syslog messages
--syslog-facility LOG_XXX (LOG_DAEMON)
Facility to use in syslog messages

Daemon options:

-d [ --daemon ]
Run as a daemon. Logs to syslog by default in this mode.
--transport TRANSPORT (tcp)
The transport for which to return the port
--pid-dir DIR
Directory where port-specific PID file is stored
-w [ --wait ] SECONDS (600)
Sets the maximum wait time to initialize the daemon. If the daemon fails to initialize, prints an error and returns 1
-c [ --check ]
Prints the daemon's process ID to stdout and returns 0 if the daemon is running, otherwise returns 1
-q [ --quit ]
Tells the daemon to shut down

ENVIRONMENT

QPID_<option>
There is an environment variable for each option.

The environment variable is the option name in uppercase, prefixed with QPID_ and '.' or '-' are replaced with '_'. Environment settings are over-ridden by command line settings. For example:


  export QPID_PORT=6000
  export QPID_MAX_CONNECTIONS=10
  export QPID_LOG_TO_FILE=/tmp/qpidd.log

FILES

/etc/qpidd.conf
Default configuration file.

Configuration file settings are over-ridden by command line or environment variable settings. '--config <file>' or 'export QPID_CONFIG=<file>' specifies an alternate file.

Each line is a name=value pair. Blank lines and lines beginning with # are ignored. For example:


  My qpidd configuration file.
  port=6000
  max-connections=10
  log-to-file=/tmp/qpidd.log

AUTHOR

The Apache Qpid Project, dev [at] qpid.apache.org

REPORTING BUGS

Please report bugs to users [at] qpid.apache.org