rabbitmq-plugins#
rabbitmq-plugins is a command-line tool for managing RabbitMQ broker plugins.
Syntax#
rabbitmq-plugins [-n node] {command} [command options ...]
Description#
rabbitmq-plugins is used to enable, disable, and browse plugins for RabbitMQ. These operations must be performed by a user with write permissions to the RabbitMQ configuration directory.
Some plugins depend on other plugins to function properly. rabbitmq-plugins traverses these dependencies and enables all required plugins. Plugins listed in the rabbitmq-plugins command line are marked as explicitly enabled, while dependency plugins are marked as implicitly enabled. Implicitly enabled plugins are automatically disabled when they are no longer needed.
The enable, disable, and set commands update the plugin files and then attempt to connect to the broker and ensure that it is running all enabled plugins. By default, a warning is displayed if a connection cannot be made to a running broker (e.g., if it has been stopped). Use the --online or --offline options to change this behavior.
Commands#
list [-v] [-m] [-E] [-e] [pattern]
-v Display details for all plugins
-m Display only the names of the plugins
-E Display only explicitly enabled plugins
-e Display both explicitly and implicitly enabled plugins
The pattern represents a pattern used to filter plugin names. This command displays all plugins, their version numbers, dependencies, and descriptions. Each plugin displayed is prefixed with two status indicators enclosed in []. The first indicator is "", indicating that the plugin is not enabled; "E" indicates that the plugin is explicitly enabled; "e" indicates that the plugin is implicitly enabled; or "!" indicates that the plugin is enabled but missing and therefore cannot run. The second indicator is "", indicating that the plugin is not running; "*" indicates that it is running. If an optional pattern is provided, only plugins with names matching the pattern are displayed.
rabbitmq-plugins list
# Display all plugins, one per line
rabbitmq-plugins list -v
# Display all plugins, including their version numbers and descriptions
rabbitmq-plugins list -v management
# Display all plugins with "management" in their names
rabbitmq-plugins list -e rabbit
# Display all explicitly or implicitly enabled plugins
rabbitmq-plugins enable [--offline] [--online] {plugin ...}
# --offline Modify only the plugin files used at startup
# --online Treat failure to connect to a running broker as a fatal error
# plugin One or more plugins to enable
# This command enables the specified plugins and all their dependencies.
rabbitmq-plugins disable [--offline] [--online] {plugin ...}
# --offline Modify only the plugin files used at startup
# --online Treat failure to connect to a running broker as a fatal error
# plugin One or more plugins to disable
# This command disables the specified plugins and all their dependencies.
rabbitmq-plugin set [--offline] [--online] {plugin ...}
# --offline Modify only the plugin files used at startup
# --online Treat failure to connect to a running broker as a fatal error
# plugin Zero or more plugins to enable
# This command enables the specified plugins and all their dependencies. Unlike rabbitmq-plugins enable, this command ignores and overrides any existing enabled plugins.
# rabbitmq-plugins set is valid with no plugin arguments, which disables all plugins.
# rabbitmq-plugins set rabbitmq_management
# The above command enables the management plugin and disables all other plugins.
Usage#
To start the rabbitmq_management plugin and view the cluster's status through the web interface, use the command rabbitmq-plugins enable rabbitmq_management. Here are some important points to note:
If you want to view the information of the RabbitMQ server through localhost:15672, you can log in and authenticate using the guest account. However, by default, the guest account has all the operational privileges and is the default account. For security reasons, the guest user can only log in and use the account through localhost. It is recommended to change the password for the guest account and create a new account to manage and view the RabbitMQ server.