QPIDD(1)

📦 version 1.39.0, in nixos 26.05, nixpkgs unstable

🌸 NAME 🌸

okay bestie, welcome to qpidd(1) — the manual page for qpidd, aka the Qpid AMQP Message Broker Daemon. She stores, routes, and forwards messages, and honestly? main character energy. 💅

✨ SYNOPSIS ✨

qpidd [OPTIONS]

🦋 DESCRIPTION 🦋

qpidd is an AMQP message broker daemon. It stores, routes, and forwards messages using the Advanced Message Queueing Protocol (AMQP). It’s giving “backbone of your messaging setup” realness, fr fr.

🎀 OPTIONS 🎀

okay so these options are built-in to qpidd. If you install add-on modules, you get extra options on top. Wanna see the full set? Type qpidd --help.

Options can come from the command line, an environment variable, or a configuration file. Check FILES and ENVIRONMENT below for the details, iykyk.

  • -h, --help — displays the help message.
  • -v, --version — displays version information.
  • --config FILE — (default: /etc/qpid/qpidd.conf) reads configuration from FILE.
  • --client-config FILE — (default: /etc/qpid/qpidc.conf) reads client configuration from FILE, for cluster interconnect.

🧩 Module options

  • --module-dir DIR — (default: /usr/lib64/qpid/daemon) loads all shareable modules in this directory.
  • --load-module FILE — specifies additional module(s) to be loaded.
  • --no-module-dir — don’t load modules from the module directory.

🔥 Broker Options

  • --data-dir DIR — (default: $HOME/.qpidd) 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.
  • --paging-dir DIR — directory in which paging files will be created for paged queues.
  • -p, --port PORT — (default: 5672) tells the broker to listen on PORT.
  • --interface <interface name>|<interface address> — which network interfaces to use to listen for incoming connections.
  • --listen-disable <transport name> — transports to disable listening.
  • --protocols <protocol name+version> — which protocol versions to allow.
  • --worker-threads N — (default: 9) sets the broker thread pool size.
  • --connection-backlog N — (default: 10) sets the connection backlog limit for the server socket.
  • -m, --mgmt-enable yes|no — (default: 1) enable Management.
  • --mgmt-publish yes|no — (default: 1) enable Publish of Management Data (no implies query-only).
  • --mgmt-qmf2 yes|no — (default: 1) enable broadcast of management information over QMF v2.
  • --mgmt-qmf1 yes|no — (default: 0) enable broadcast of management information over QMF v1.
  • --mgmt-pub-interval SECONDS — (default: 10s) Management Publish Interval.
  • --queue-purge-interval SECONDS — (default: 600s) interval between attempts to purge any expired messages from queues.
  • --auth yes|no — (default: 1) enable authentication. If disabled, all incoming connections will be trusted. 👀
  • --realm REALM — (default: QPID) use the given realm when performing authentication.
  • --sasl-service-name NAME — the service name to specify for SASL.
  • --default-queue-limit BYTES — (default: 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' — (default: none) URL to send as known-hosts to clients (none implies empty list).
  • --sasl-config DIR — allows SASL config path, if supported by platform, to be overridden. For the default location on Linux, see Cyrus SASL documentation. There is no SASL config dir on Windows.
  • --default-flow-stop-threshold PERCENT — (default: 80) percent of queue’s maximum capacity at which flow control is activated.
  • --default-flow-resume-threshold PERCENT — (default: 70) percent of queue’s maximum capacity at which flow control is de-activated.
  • --default-event-threshold-ratio %age of limit — (default: 80) the ratio of any specified queue limit at which an event will be raised.
  • --default-message-group GROUP-IDENTIFER — (default: qpid.no-group) group identifier to assign to messages delivered to a message group queue that do not contain an identifier.
  • --enable-timestamp yes|no — (default: 0) add current time to each received message.
  • --link-maintenance-interval SECONDS — (default: 2s) interval to check federation link health and re-connect if need be.
  • --link-heartbeat-interval SECONDS — (default: 120s) heartbeat interval for a federation link.
  • --dtx-default-timeout SECONDS — (default: 60) default timeout for DTX transaction before aborting it.
  • --dtx-max-timeout SECONDS — (default: 3600) maximum allowed timeout for DTX transaction. A value of zero disables maximum timeout limit checks and allows arbitrarily large timeout settings.
  • --max-negotiate-time MILLISECONDS — (default: 10000) maximum time a connection can take to send the initial protocol negotiation.
  • --federation-tag NAME — override the federation tag.
  • --session-max-unacked DELIVERIES — (default: 5000) maximum number of un-acknowledged outgoing messages per session.

📝 Logging options

  • -t, --trace — enables all logging.
  • --log-enable RULE — (default: notice+) enables logging for selected levels and components. RULE is in the form LEVEL[+-][:PATTERN]. LEVEL is one of: trace, debug, info, notice, warning, error, critical. PATTERN is a logging category name, or a namespace-qualified function name, or a name fragment. Logging category names: Security, Broker, Management, Protocol, System, HA, Messaging, Store, Network, Test, Client, Application, Model, Unspecified. For example: --log-enable warning+ logs all warning, error and critical messages. --log-enable trace+:Broker logs all category Broker messages. --log-enable debug:framing logs debug messages from all functions with framing in the namespace or function name. This option can be used multiple times.
  • --log-disable RULE — disables logging for selected levels and components. RULE is in the form LEVEL[+-][:PATTERN]. LEVEL is one of: trace, debug, info, notice, warning, error, critical. PATTERN is a logging category name, or a namespace-qualified function name, or a name fragment. Logging category names: Security, Broker, Management, Protocol, System, HA, Messaging, Store, Network, Test, Client, Application, Model, Unspecified. For example: --log-disable warning- disables logging all warning, notice, info, debug, and trace messages. --log-disable trace:Broker disables all category Broker trace messages. --log-disable debug-:qmf:: disables logging debug and trace messages from all functions with qmf:: in the namespace. This option can be used multiple times.
  • --log-time yes|no — (default: 1) include time in log messages.
  • --log-level yes|no — (default: 1) include severity level in log messages.
  • --log-source yes|no — (default: 0) include source file:line in log messages.
  • --log-thread yes|no — (default: 0) include thread ID in log messages.
  • --log-function yes|no — (default: 0) include function signature in log messages.
  • --log-hires-timestamp yes|no — (default: 0) use hi-resolution timestamps in log messages.
  • --log-category yes|no — (default: 1) include category in log messages.
  • --log-prefix STRING — prefix to prepend to all log messages.

🧚 Logging sink options

  • --log-to-stderr yes|no — (default: 1) send logging output to stderr.
  • --log-to-stdout yes|no — (default: 0) send logging output to stdout.
  • --log-to-file FILE — send log output to FILE.
  • --log-to-syslog yes|no — (default: 0) send logging output to syslog; customize using --syslog-name and --syslog-facility.
  • --syslog-name NAME — (default: qpidd) name to use in syslog messages.
  • --syslog-facility LOG_XXX — (default: 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 — (default: tcp) the transport for which to return the port.
  • --pid-dir DIR — (default: $HOME/.qpidd) directory where port-specific PID file is stored.
  • --pidfile FILE — file name to store the PID in daemon mode. Used as-is, no directory or suffixes added.
  • --close-fd FD — file descriptors that the daemon should close.
  • -w, --wait SECONDS — (default: 600) sets the maximum wait time to initialize or shutdown the daemon. If the daemon fails to initialize/shutdown, 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 with an INT signal.
  • -k, --kill — kill the daemon with a KILL signal.
  • --socket-fd FD — file descriptor for tcp listening socket.

🔒 ACL Options

  • --acl-file FILE — the policy file to load from, loaded from data dir.
  • --connection-limit-per-user N — (default: 0) the maximum number of connections allowed per user. 0 implies no limit.
  • --max-connections N — (default: 500) the maximum combined number of connections allowed. 0 implies no limit.
  • --connection-limit-per-ip N — (default: 0) the maximum number of connections allowed per host IP address. 0 implies no limit.
  • --max-queues-per-user N — (default: 0) the maximum number of queues allowed per user. 0 implies no limit.

🌈 SSL Settings

  • --ssl-use-export-policy — use NSS export policy.
  • --ssl-cert-password-file PATH — file containing password to use for accessing certificate database.
  • --ssl-cert-db PATH — path to directory containing certificate database.
  • --ssl-cert-name NAME — (default: localhost.localdomain) name of the certificate to use.
  • --ssl-port PORT — (default: 5671) port on which to listen for SSL connections.
  • --ssl-require-client-authentication — forces clients to authenticate in order to establish an SSL connection.
  • --ssl-sasl-no-dict — disables SASL mechanisms that are vulnerable to passive dictionary-based password attacks.

🦄 AMQP 1.0 Options

  • --domain DOMAIN — domain of this broker.
  • --queue-patterns PATTERN — pattern for on-demand queues.
  • --topic-patterns PATTERN — pattern for on-demand topics.

💜 HA Options

  • --ha-cluster yes|no — (default: 0) join a HA active/passive cluster.
  • --ha-queue-replication yes|no — (default: 0) enable replication of specific queues without joining a cluster.
  • --ha-brokers-url URL — URL with address of each broker in the cluster.
  • --ha-public-url URL — URL advertized to clients to connect to the cluster.
  • --ha-replicate LEVEL (default: none) — sets the replication level used when creating queues and exchanges, but only if nobody handed in a qpid.replicate argument. LEVEL is one of 'none', 'configuration' or 'all' ✨
  • --ha-username USER — the username for connections between HA brokers 🫶
  • --ha-password PASS — the password for those same broker-to-broker HA connections 🔐
  • --ha-mechanism MECH — the authentication mechanism for connections between HA brokers, bestie 🎀
  • --ha-backup-timeout SECONDS (default: 10s) — the absolute maximum time to sit there waiting for an expected backup to connect and become ready. like, the patience limit ⏳
  • --ha-flow-messages N (default: 1000) — flow control message count limit for replication. 0 means no limit at all, go feral 💀
  • --ha-flow-bytes N (default: 0) — flow control byte limit for replication. 0 means no limit 🦋

🌸 Linear Store Options 🌸

okay this whole little cluster is about the linear store, and every one of these details matters so stay with me 💅

  • --store-dir DIR — where the store directory lives for persistence, used instead of the --data-dir value. Required if --no-data-dir is also used — no cap, it's mandatory in that case 📁
  • --truncate yes|no (default: 0) — if it's yes|true|1, it truncates the store, which means it discards any existing records 😭. If it's no|false|0, it preserves the existing store files for recovery. choose wisely bestie 🫶
  • --wcache-page-size N (default: 16) — the size of the pages in the write page cache, measured in KiB. Allowable values are powers of 2 starting at 4 (4, 8, 16, 32...). Lower values decrease latency at the expense of throughput — so like, snappier but less volume ⚡
  • --wcache-num-pages N (default: 16) — how many pages are in the write page cache. Minimum value: 4 🔢
  • --tpl-wcache-page-size N (default: 4) — size of the pages in the transaction prepared list write page cache, in KiB. Allowable values: powers of 2 starting at 4 (4, 8, 16, 32...). Lower values decrease latency at the expense of throughput, same deal 🌈
  • --tpl-wcache-num-pages N (default: 16) — number of pages in the transaction prepared list write page cache. Minimum value: 4 ✨
  • --efp-partition N (default: 1) — the Empty File Pool partition to use when it's out here finding empty journal files 🗂️
  • --efp-file-size N (default: 2048) — the Empty File Pool file size in KiB to use for journal files. Must be a multiple of 4 KiB — non-negotiable 💅
  • --overwrite-before-return yes|no (default: 0) — if yes|true|1, it overwrites each store file with zeros before returning it to the Empty File Pool. When it's not in use (which is the default), old message data stays in the file, but gets overwritten on next use. 🚨 This option should only be used where security considerations justify it, because it makes the store somewhat slower. so: secure but sluggish, pick your fighter ⚖️
  • --journal-flush-timeout SECONDS (default: 500ms) — maximum time to wait to flush the journal. For small time values use the ms and us units (like 10ms) — no space between the value and the unit, periodt 🕐

💜 Store Options 💜

  • --storage-provider PROVIDER — the name of the storage provider to use. that's it, that's the whole vibe 🎀

🌈 ENVIRONMENT 🌈

  • QPID_<option> — bestie, there is an environment variable for each option. every single one 👑

The environment variable is the option name in uppercase, prefixed with QPID_, and any . or - gets replaced with _. Environment settings get over-ridden by command line settings (command line is the main character here). For example:

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

🦋 FILES 🦋

  • /etc/qpidd.conf — the default configuration file 📄

Configuration file settings get over-ridden by command line or environment variable settings. And you can point at a different file with --config <file> or export QPID_CONFIG=<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@qpid.apache.org 💖

🩷 REPORTING BUGS 🩷

Please report bugs to users@qpid.apache.org — they genuinely wanna hear it, fr fr 🙈

and that's the whole page, bestie!! this one's qpidd from qpid-cpp, version 1.39.0, dated 2018, and it's QPIDD(1) — go forth and slay your message broker 💅✨🎀

📦 where this page comes from