QPID-CONFIG(1)

📦 version 1.39.0, in nixos 26.05, nixpkgs unstable

👑 QPID-CONFIG(1) — the QPID Broker Configuration Tool, but make it make sense 💅

okay so first things first, bestie: this is the qpid-config page from the User Commands manual. It's your little remote control for a Qpid broker — adding queues, adding exchanges, binding stuff together, and generally being the main character of your message broker's configuration. let's get into it 🎀

✨ NAME ✨

qpid-config — the QPID Broker Configuration Tool. that's the whole vibe. it configures brokers. it's giving "I'm the one who knocks" but for AMQP. 🦋

🌸 SYNOPSIS 🌸

qpid-config [OPTIONS] commands

💜 DESCRIPTION 💜

here's the full menu of ways you can call it, copied out exactly so you don't have to squint at the original:

Usage:  qpid-config [OPTIONS]
        qpid-config [OPTIONS] exchanges [filter-string]
        qpid-config [OPTIONS] queues    [filter-string]
        qpid-config [OPTIONS] add exchange <type> <name>
[AddExchangeOptions]
        qpid-config [OPTIONS] del exchange <name>
        qpid-config [OPTIONS] add queue <name> [AddQueueOptions]
        qpid-config [OPTIONS] del queue <name> [DelQueueOptions]
        qpid-config [OPTIONS] bind   <exchange-name> <queue-name>
[binding-key]
                  <for type xml>     [-f -|filename]
                  <for type header>  [all|any] k1=v1 [, k2=v2...]
        qpid-config [OPTIONS] unbind <exchange-name> <queue-name>
[binding-key]
        qpid-config [OPTIONS] reload-acl
        qpid-config [OPTIONS] add <type> <name> [--argument <property-
name>=<property-value>]
        qpid-config [OPTIONS] del <type> <name>
        qpid-config [OPTIONS] list <type> [--show-property <property-
name>]
        qpid-config [OPTIONS] log [<logstring>]
        qpid-config [OPTIONS] shutdown"""
ngl the line wrapping in there is a whole situation (and yes, those quote marks at the end of shutdown are literally in the source, iykyk 💀). but everything is here, bestie — nothing skipped, nothing "cleaned up". 🫶

💅 OPTIONS 💅

⭐ General Options ⭐

  • -h, --help — show this help message and exit. the classic "what does this thing even do" button. 🙈
  • -t <secs>, --timeout=<secs> — maximum time to wait for broker connection (in seconds). your patience, but as a number ⏳
  • -r, --recursive — show bindings in queue or exchange list. it goes deeper. it's giving "and what's inside that" 🔍
  • -b <address>, --broker=<address> — address of qpidd broker with syntax: [username/password@] hostname | ip-address [:<port>] 🔥
  • -a <address>, --broker-addr=<address> — literally no description in the original page, bestie. it's just sitting there, mysterious, unbothered. 👑 (it takes an address. that's all we're told. no cap.)
  • --sasl-mechanism=<mech> — SASL mechanism for authentication (e.g. EXTERNAL, ANONYMOUS, PLAIN, CRAM-MD5, DIGEST-MD5, GSSAPI). SASL automatically picks the most secure available mechanism — use this option to override. it's the "I'll choose, thanks" of auth ✨
  • --sasl-service-name=SASL_SERVICE_NAME — SASL service name to use. yes, <kbd>-free, just vibes. 🎀
  • --ssl-certificate=<cert> — Client SSL certificate (PEM Format) 🔐
  • --ssl-key=<key> — Client SSL private key (PEM Format) 🗝️
  • --ha-admin — allow connection to a HA backup broker. backup bestie privileges 🫶

🌈 Options for Listing Exchanges and Queues 🌈

  • --ignore-default — ignore the default exchange in exchange or queue list. the default exchange said "notice me" and this option said "no 💀"

🦋 Options for Adding Exchanges and Queues 🦋

  • --alternate-exchange=<aexname> — name of the alternate-exchange for the new queue or exchange. Exchanges route messages to the alternate exchange if they are unable to route them elsewhere. Queues route messages to the alternate exchange if they are rejected by a subscriber or orphaned by queue deletion. it's the "if nobody wants me, I know a guy" option 😭
  • --durable — the new queue or exchange is durable. built to last, periodt 💪
  • --replicate=<level> — enable automatic replication in a HA cluster. <level> is 'none', 'configuration' or 'all'). 🧚

🌸 Options for Adding Queues 🌸

  • --file-count=<n> — [legacystore] Number of files in queue's persistence journal 📚
  • --file-size=<n> — [legactystore] File size in pages (64KiB/page). (yes, "legactystore" — that's how it's spelled in the source, bestie, I don't make the rules 🙈)
  • --efp-partition-num=<n> — [linearstore] EFP partition number
  • --efp-pool-file-size=<n> — [linearstore] EFP file size (KiB)
  • --wcache-page-size=<n> — [linearstore] Per-queue buffer page size (kiB), value may be powers of 2 starting at 4 (4, 8, 16, 32...) ✨
  • --wcache-num-pages=<n> — [linearstore] Per-queue num buffer pages
  • --max-queue-size=<n> — maximum in-memory queue size as bytes 📏
  • --max-queue-count=<n> — maximum in-memory queue size as a number of messages 🔢
  • --limit-policy=<policy> — action to take when queue limit is reached 🚦
  • --lvq-key=<key> — Last Value Queue key 🔑
  • --flow-stop-size=<n> — turn on sender flow control when the number of queued bytes exceeds this value. ✋
  • --flow-resume-size=<n> — turn off sender flow control when the number of queued bytes drops below this value. ▶️
  • --flow-stop-count=<n> — turn on sender flow control when the number of queued messages exceeds this value. ✋
  • --flow-resume-count=<n> — turn off sender flow control when the number of queued messages drops below this value. ▶️
  • --group-header=<header-name> — enable message groups. Specify name of header that holds group identifier. squad goals 🫂
  • --shared-groups — allow message group consumption across multiple consumers. sharing is caring 💖
  • --argument=<NAME=VALUE> — specify a key-value pair to add to queue arguments 🎀
  • --start-replica=<broker-url> — start replication from the same-named queue at <broker-url> 🧬

🔥 Options for Adding Exchanges 🔥

  • --sequence — exchange will insert a 'qpid.msg_sequence' field in the message header 🔢
  • --ive — exchange will behave as an 'initial-value-exchange', keeping a reference to the last message forwarded and enqueuing that message to newly bound queues. the "you missed it, here's a recap" exchange 👑

💀 Options for Deleting Queues 💀

  • --force — force delete of queue even if it's currently used or it's not empty. no thoughts, just deletion 😤
  • --force-if-not-empty — force delete of queue even if it's not empty. 🗑️
  • --force-if-used — force delete of queue even if it's currently used. 🗑️
ok but fr fr these three are the "are you SURE" options — the original page doesn't sugarcoat it, and neither will I. they delete things that are still in use or still full of messages. be careful, bestie 😭

🎀 Options for Declaring Bindings 🎀

  • -f <file.xq>, --file=<file.xq> — for XML Exchange bindings — specifies the name of a file containing an XQuery. 📄

💜 Formatting options for 'list' action 💜

  • --show-property=<property-name> — specify a property of an object to be included in output ✨

🦋 EXAMPLES 🦋

okay these are the real ones, copy-paste ready, exactly as written:

$ qpid-config add queue q

$ qpid-config add exchange direct d -a localhost:5672

$ qpid-config exchanges -b 10.1.1.7:10000

$ qpid-config queues -b guest/guest@broker-host:10000

🌈 Add Exchange <type> values 🌈

  • direct — Direct exchange for point-to-point communication
  • fanout — Fanout exchange for broadcast communication
  • topic — Topic exchange that routes messages using binding keys with wildcards
  • headers — Headers exchange that matches header fields against the binding keys
  • xml — XML Exchange — allows content filtering using an XQuery ✨

⭐ Queue Limit Actions ⭐

  • none (default) — Use broker's default policy
  • reject — Reject enqueued messages
  • ring — Replace oldest unacquired message with new 💫

💅 Replication levels 💅

  • none — no replication
  • configuration — replicate queue and exchange existence and bindings, but not messages.
  • all — replicate configuration and messages 🔥

🎀 Log <logstring> value 🎀

  • Comma separated <module>:<level> pairs, e.g. 'info+,debug+:Broker,trace+:Queue' 📝

👑 AUTHOR 👑

The Apache Qpid Project, dev@qpid.apache.org. absolute icons, no notes. 💖

🫶 REPORTING BUGS 🫶

Please report bugs to users@qpid.apache.org. be nice, they're doing their best 🌸

okay that's the whole page, nothing skipped, nothing invented, every flag accounted for 🧚

and as a little sign-off: this gorgeous thing is qpid-config from (qpid-cpp), version... (yes, it literally just says "version..." 😭) dated March 2018. oldie but a baddie. bye bestie, go configure some brokers 💅✨🎀

📦 where this page comes from