/usr/bin/rabbitmqadmin

RabbitMQ CLI that uses the HTTP API. Version: 2.35.0

Usage: rabbitmqadmin [OPTIONS] <COMMAND>

Commands:
  auth_attempts        Authentication attempt statistics
  bindings             Operations on bindings
  channels             Operations on channels
  close                Closes connections
  config_file          Operations on the local configuration file
  connections          Operations on connections
  declare              Creates or declares objects
  definitions          Operations on definitions (everything except for messages: virtual hosts, queues, streams, exchanges, bindings, users, etc)
  delete               Deletes objects
  deprecated_features  Operations on deprecated features
  exchanges            Operations on exchanges
  export               See 'definitions export'
  feature_flags        Operations on feature flags
  federation           Operations on federation upstreams and links
  get                  Fetches message(s) from a queue via polling. Not available for streams. Only suitable for development and test environments.
  global_parameters    Operations on global runtime parameters
  health_check         Runs health checks
  import               See 'definitions import'
  list                 Lists objects
  nodes                Operations on nodes
  operator_policies    Operations on operator policies
  parameters           Operations on runtime parameters
  passwords            Operations on passwords
  permissions          Operations on user permissions
  plugins              Lists enabled plugins
  policies             Operations on policies
  publish              Publishes (inefficiently) message(s) to a queue or a stream. Only suitable for development and test environments.
  purge                Purges queues
  queues               Operations on queues
  rebalance            Rebalancing of leader replicas
  shell                Shell-related operations
  show                 Overview, memory footprint breakdown, and more
  shovels              Operations on shovels
  streams              Operations on streams
  tanzu                Tanzu RabbitMQ-specific commands
  users                Operations on users
  user_limits          Operations on per-user (resource) limits
  vhosts               Virtual host operations
  vhost_limits         Operations on virtual host (resource) limits
  help                 Print this message or the help of the given subcommand(s)

Options:
      --version
          Print version

  -c, --config <config_file_path>
          [env: RABBITMQADMIN_CONFIG_FILE_PATH=]
          [default: ~/.rabbitmqadmin.conf]

  -N, --node <node_alias>
          [env: RABBITMQADMIN_NODE_ALIAS=]
          [default: default]

  -H, --host <host>
          HTTP API hostname to use when connecting

          [env: RABBITMQADMIN_TARGET_HOST=]

  -P, --port <port>
          HTTP API port to use when connecting

          [env: RABBITMQADMIN_TARGET_PORT=]

  -U, --base-uri <base_uri>
          base HTTP API endpoint URI

          [env: RABBITMQADMIN_BASE_URI=]

      --path-prefix <path_prefix>
          use if target node uses a path prefix. Defaults to '/api'

          [env: RABBITMQADMIN_API_PATH_PREFIX=]

  -V, --vhost <vhost>
          target virtual host. Defaults to '/'

          [env: RABBITMQADMIN_TARGET_VHOST=]

  -u, --username <username>
          this user must have the permissions for HTTP API access, see https://rabbitmq.com/docs/management#permissions

          [env: RABBITMQADMIN_USERNAME=]

  -p, --password <password>
          requires username to be specified via --username or in the config file

          [env: RABBITMQADMIN_PASSWORD=]

  -k, --insecure
          disables TLS peer (certificate chain) verification

      --use-tls
          use TLS (HTTPS) for HTTP API requests

          [env: RABBITMQADMIN_USE_TLS=]

      --tls-ca-cert-file <ca_certificate_bundle_path>
          Local path to a CA certificate file in the PEM format

      --tls-cert-file <client_certificate_file_path>
          Local path to a client certificate file in the PEM format

      --tls-key-file <client_private_key_file_path>
          Local path to a client private key file in the PEM format

      --timeout <timeout>
          HTTP API request timeout in seconds. Must be greater than 0

          [env: RABBITMQADMIN_TIMEOUT=]
          [default: 60]

  -q, --quiet
          produce less output

          [env: RABBITMQADMIN_QUIET_MODE=]

  -v, --verbose
          enable verbose logging of HTTP requests and responses

          [env: RABBITMQADMIN_VERBOSE=]

      --non-interactive
          pass when invoking from scripts

          [env: RABBITMQADMIN_NON_INTERACTIVE_MODE=]

      --table-style <table_style>
          style preset to apply to output tables: modern, borderless, ascii, dots, psql, markdown, sharp

          [env: RABBITMQADMIN_TABLE_STYLE=]
          [possible values: modern, borderless, markdown, sharp, ascii, psql, dots]

  -h, --help
          Print help (see a summary with '-h')


Documentation and Community Resources

  rabbitmqadmin docs: https://rabbitmq.com/docs/management-cli
  RabbitMQ docs: https://rabbitmq.com/docs/
  GitHub Discussions: https://github.com/rabbitmq/rabbitmq-server/discussions
  Discord server: https://rabbitmq.com/discord/

Contribute

  On GitHub: https://github.com/rabbitmq/rabbitmqadmin-ng