Go to main content

man pages section 8: System Administration Commands

Exit Print View

Updated: Wednesday, February 9, 2022
 
 

rabbitmq-plugins (8)

Name

rabbitmq-plugins - command line tool for managing RabbitMQ plugins

Synopsis

rabbitmq-plugins [-q] [-s] [-l] [-n node] [-t timeout] command
[command_options]

Description


RABBITMQ-PLUGINS(8)       BSD System Manager's Manual      RABBITMQ-PLUGINS(8)

NAME
     rabbitmq-plugins -- command line tool for managing RabbitMQ plugins

SYNOPSIS
     rabbitmq-plugins [-q] [-s] [-l] [-n node] [-t timeout] command
                      [command_options]

DESCRIPTION
     rabbitmq-plugins is a command line tool for managing RabbitMQ plugins.
     See the RabbitMQ Plugins guide:
           https://www.rabbitmq.com/plugins.html
     for an overview of RabbitMQ plugins and how they are used.

     rabbitmq-plugins allows the operator to enable, disable and inspect plug-
     ins.  It must be run by a user with write permissions to the RabbitMQ
     configuration directory.

     Plugins can depend on other plugins.  rabbitmq-plugins resolves the
     dependencies and enables or disables all dependencies so that the user
     doesn't have to manage them explicitly.  Plugins listed on the
     rabbitmq-plugins command line are marked as explicitly enabled; dependent
     plugins are marked as implicitly enabled.  Implicitly enabled plugins are
     automatically disabled again when they are no longer required.

     The enable, disable, and set commands will update the plugins file and
     then attempt to connect to the broker and ensure it is running all
     enabled plugins.  By default if it is not possible to connect to and
     authenticate with the target node (for example if it is stopped), the
     operation will fail.  If rabbitmq-plugins is used on the same host as the
     target node, --offline can be specified to make rabbitmq-plugins resolve
     and update plugin state directly (without contacting the node).  Such
     changes will only have an effect on next node start.  To learn more, see
     the RabbitMQ Plugins guide:
           https://www.rabbitmq.com/plugins.html

OPTIONS
     -n node
             Default node is "rabbit@target-hostname", where target-hostname
             is the local host.  On a host named "myserver.example.com", the
             node name will usually be "rabbit@myserver" (unless
             RABBITMQ_NODENAME has been overridden).  The output of "hostname
             -s" is usually the correct suffix to use after the "@" sign.  See
             rabbitmq-server(8) for details of configuring a RabbitMQ node.

     -q, --quiet
             Quiet output mode is selected.  Informational messages are
             reduced when quiet mode is in effect.

     -s, --silent
             Silent output mode is selected.  Informational messages are
             reduced and table headers are suppressed when silent mode is in
             effect.

     -t timeout, --timeout timeout
             Operation timeout in seconds.  Not all commands support timeouts.
             Default is infinity.

     -l, --longnames
             Must be specified when the cluster is configured to use long
             (FQDN) node names.  To learn more, see the RabbitMQ Clustering
             guide:
                   https://www.rabbitmq.com/clustering.html

     --erlang-cookie cookie
             Shared secret to use to authenticate to the target node.  Prefer
             using a local file or the RABBITMQ_ERLANG_COOKIE environment
             variable instead of specifying this option on the command line.
             To learn more, see the RabbitMQ CLI Tools guide:
                   https://www.rabbitmq.com/cli.html

COMMANDS
     list [-Eemv] [pattern]

             -E      Show only explicitly enabled plugins.

             -e      Show only explicitly or implicitly enabled plugins.

             -m      Show only plugin names (minimal).

             -v      Show all plugin details (verbose).

             pattern
                     Pattern to filter the plugin names by.

             Lists all plugins, their versions, dependencies and descriptions.
             Each plugin is prefixed with two status indicator characters
             inside [ ].  The first indicator can be:
             <space>  to indicate that the plugin is not enabled
             E        to indicate that it is explicitly enabled
             e        to indicate that it is implicitly enabled
                      to indicate that it is enabled but missing and thus not
                      operational

             The second indicator can be:
             <space>  to show that the plugin is not running
             *        to show that it is

             If the optional pattern is given, only plugins whose name matches
             pattern are shown.

             For example, this command lists all plugins, on one line each

                   rabbitmq-plugins list

             This command lists all plugins:

                   rabbitmq-plugins list -v

             This command lists all plugins whose name contains "management".

                   rabbitmq-plugins list -v management

             This command lists all implicitly or explicitly enabled RabbitMQ
             plugins.

                   rabbitmq-plugins list -e rabbit

     enable [--offline] [--online] plugin ...

             --offline
                     Modify node's enabled plugin state directly without con-
                     tacting the node.

             --online
                     Treat a failure to connect to the running broker as
                     fatal.

             plugin  One or more plugins to enable.

             Enables the specified plugins and all their dependencies.

             For example, this command enables the "shovel" and "management"
             plugins and all their dependencies:

                   rabbitmq-plugins enable rabbitmq_shovel rabbitmq_management

     disable [--offline] [--online] plugin ...

             --offline
                     Modify node's enabled plugin state directly without con-
                     tacting the node.

             --online
                     Treat a failure to connect to the running broker as
                     fatal.

             plugin  One or more plugins to disable.

             Disables the specified plugins and all their dependencies.

             For example, this command disables "rabbitmq_management" and all
             plugins that depend on it:

                   rabbitmq-plugins disable rabbitmq_management

     set [--offline] [--online] [plugin ...]

             --offline
                     Modify node's enabled plugin state directly without con-
                     tacting the node.

             --online
                     Treat a failure to connect to the running broker as
                     fatal.

             plugin  Zero or more plugins to disable.

             Enables the specified plugins and all their dependencies.  Unlike
             enable, this command ignores and overwrites any existing enabled
             plugins.  set with no plugin arguments is a legal command meaning
             "disable all plugins".

             For example, this command enables the "management" plugin and its
             dependencies and disables everything else:

                   rabbitmq-plugins set rabbitmq_management


ATTRIBUTES
     See attributes(7) for descriptions of the following attributes:

     +---------------+-----------------------+
     |ATTRIBUTE TYPE |   ATTRIBUTE VALUE     |
     +---------------+-----------------------+
     |Availability   | network/amqp/rabbitmq |
     +---------------+-----------------------+
     |Stability      | Pass-through volatile |
     +---------------+-----------------------+

SEE ALSO
     rabbitmqctl(8), rabbitmq-diagnostics(8), rabbitmq-server(8),
     rabbitmq-queues(8), rabbitmq-upgrade(8), rabbitmq-service(8),
     rabbitmq-env.conf(5),

AUTHOR
     The RabbitMQ Team <info@rabbitmq.com>



NOTES
     Source code for open source software components in Oracle Solaris can be
     found at https://www.oracle.com/downloads/opensource/solaris-source-code-
     downloads.html.

     This software was built from source available at https://github.com/ora-
     cle/solaris-userland.  The original community source was downloaded from
     https://github.com/rabbitmq/rabbitmq-server/releases/down-
     load/v3.8.18/rabbitmq-server-3.8.18.tar.xz.

     Further information about this software can be found on the open source
     community website at https://www.rabbitmq.com/.

RabbitMQ Server               September 28, 2019               RabbitMQ Server