Syntax##

1
rabbitmq-plugins [-n node] {command} [command options ...]

Description##

rabbitmq-plugins is used to enable, disable, and browse plugins. These operations must be performed by a user who has write permissions to the RabbitMQ configuration directory.

Some plugins depend on other plugins to work correctly. rabbitmq-plugins walks these dependency relationships and enables all required plugins. Plugins that you specify explicitly on the rabbitmq-plugins command line are marked as explicitly enabled; dependency plugins are marked as implicitly enabled. Implicitly enabled plugins will be automatically disabled when they are no longer needed.

The enable, disable, and set commands update the plugins file and then attempt to connect to the broker to ensure it is running all enabled plugins. By default, if the tool cannot connect to a running broker (for example, if it has been stopped), a warning is displayed. Use —online or —offline to change this behavior.

Commands##

1
list [-v] [-m] [-E] [-e] [pattern]
2
-v  Show detailed information for all plugins (verbose)
3
-m  Show only plugin names (minimal)
4
-E  Show only explicitly enabled plugins
5
-e  Show explicitly and implicitly enabled plugins

pattern is a pattern used to filter plugin names.
This command shows all plugins, their versions, dependencies, and descriptions. Each plugin line is prefixed by two status indicators enclosed in []. The first indicator is "" (empty) if the plugin is not enabled; “E” if the plugin is explicitly enabled; “e” if the plugin is implicitly enabled; or ”!” if the plugin is enabled but missing, and therefore cannot run.
The second indicator is "" (empty) if the plugin is not running; "*" if it is running. If an optional pattern is provided, only plugins whose names match the pattern are displayed.

1
rabbitmq-plugins list
2
# List all plugins, one per line
3

4
rabbitmq-plugins list -v
5
# List all plugins, including version and description
6

7
rabbitmq-plugins list -v management
8
# List all plugins whose names contain "management"
9

10
rabbitmq-plugins list -e rabbit
11
# List all explicitly or implicitly enabled plugins

1
rabbitmq-plugins enable [--offline] [--online] {plugin ...}
2
# --offline Only modify the enabled-plugins file
3
# --online Treat failure to connect to a running broker as a fatal error
4
# plugin One or more plugins to be enabled
5
# This command enables the specified plugins and all of their dependencies

1
rabbitmq-plugins disable [--offline] [--online] {plugin ...}
2
# --offline Only modify the enabled-plugins file
3
# --online Treat failure to connect to a running broker as a fatal error
4
# plugin One or more plugins to be disabled
5
# This command disables the specified plugins and all plugins that depend on them

1
rabbitmq-plugin set [--offline] [--online] {plugin ...}
2
# --offline Only modify the enabled-plugins file
3
# --online Treat failure to connect to a running broker as a fatal error
4
# plugin Zero or more plugins to be enabled
5
# This command enables the specified plugins and their dependencies. Unlike rabbitmq-plugins enable, it ignores and overrides any already enabled plugins.
6
# Calling rabbitmq-plugins set with no plugin arguments is valid and means "disable all plugins".
7
# rabbitmq-plugins set rabbitmq_management
8
# The command above enables the management plugin and disables all other plugins.

Usage##

Run rabbitmq-plugins enable rabbitmq_management to enable the rabbitmq_management plugin so you can check the cluster status via the web UI. Note the following points:

If you access RabbitMQ via localhost:15672, you can log in with the guest account to view server information. However, by default the guest account has full permissions and is also the default account. For security reasons, the guest user is only allowed to log in from localhost. It is best to change the guest account password and create a new account to manage and monitor the RabbitMQ server.