rabbitmqadmin v2

rabbitmqadmin v2 is a major revision of one of the RabbitMQ's CLI tools.

If you are migrating from the original rabbitqadmin, please see CLI Changes to learn about a few breaking change in the interface.

To download a binary build, see Releases.

For usage documentation, see Usage.

Project Goals

This version of rabbitmqadmin has a few ideas in mind:

• This is a major version bump. Therefore, breaking changes are OK. rabbitmqadmin hasn't seen a revision in thirteen years
• rabbitmqadmin should be standalone binary. There are very few reasons not to build and distribute it that way
• v2 should be a distributed via GitHub releases and not a special rabbitmq_management endpoint
• There is a lot of room to improve validation of flags and arguments, since breaking changes are OK for v2
• Output should be revisited: what columns are output by default, whether columns should be selectable
• Support for JSON and CSV was a popular addition in rabbitmqctl, rabbitmq-diagnostics, etc. Perhaps rabbitmqadmin should consider supporting them, too?

Project Maturity

This version of rabbitmqadmin should be considered reasonably mature to be used.

Before migrating, please see CLI Changes to learn about a few breaking change in the interface.

Usage

Getting Help

To learn about what command groups and specific commands are available, run

rabbitmqadmin --help

Note that in this version, global flags must precede the command category (e.g. list) and the command itself:

rabbitmqadmin --vhost "events" declare queue --name "target.quorum.queue.name" --type "quorum" --durable true

The same command will display global flags. To learn about a specific command, append --help to it:

rabbitmqadmin declare queue --help

Listing cluster nodes

rabbitmqadmin list nodes

Listing virtual hosts

rabbitmqadmin list vhosts

Listing users

rabbitmqadmin list users

Listing queues

rabbitmqadmin list queues

rabbitmqadmin --vhost "monitoring" list queues

Listing exchanges

rabbitmqadmin list exchanges

rabbitmqadmin --vhost "events" list exchanges

Listing bindings

rabbitmqadmin list bindings

rabbitmqadmin --vhost "events" list bindings

Declare a queue

rabbitmqadmin --vhost "events" declare queue --name "target.quorum.queue.name" --type "quorum" --durable true

rabbitmqadmin --vhost "events" declare queue --name "target.stream.name" --type "stream" --durable true

rabbitmqadmin --vhost "events" declare queue --name "target.classic.queue.name" --type "classic" --durable false --auto_delete true

Delete a queue

rabbitmqadmin --vhost "events" delete queue --name "target.queue.name"

Differences from rabbitmq v1

Compared to the original rabbitmq, this version:

• Is distributed as a standalone binary and does not depend on Python
• Uses much stricter CLI argument validation and has (relatively minor) breaking changes in the CLI
• Is better documented

CLI Changes

Global Arguments Come First

Global flags in rabbitmqadmin v2 must precede the command category (e.g. list) and the command itself, namely various HTTP API endpoint options and --vhost:

rabbitmqadmin --vhost "events" declare queue --name "target.quorum.queue.name" --type "quorum" --durable true

Getting Help

Please use GitHub Discussions in this repository and RabbitMQ community Discord server.

License

This tool, rabbitmqadmin (v2 and later versions), is dual-licensed under the Apache Software License 2.0 and the MIT license.