1RABBITMQ-PLUGINS(8) BSD System Manager's Manual RABBITMQ-PLUGINS(8)
2
4 rabbitmq-plugins — command line tool for managing RabbitMQ plugins
5
7 rabbitmq-plugins [-q] [-s] [-l] [-n node] [-t timeout] command
8 [command_options]
9
11 rabbitmq-plugins is a command line tool for managing RabbitMQ plugins.
12 See the RabbitMQ Plugins guide:
13 https://www.rabbitmq.com/plugins.html
14 for an overview of RabbitMQ plugins and how they are used.
15 rabbitmq-plugins allows the operator to enable, disable and inspect plug‐
17 ins. It must be run by a user with write permissions to the RabbitMQ
18 configuration directory.
19 Plugins can depend on other plugins. rabbitmq-plugins resolves the
21 dependencies and enables or disables all dependencies so that the user
22 doesn't have to manage them explicitly. Plugins listed on the
23 rabbitmq-plugins command line are marked as explicitly enabled; dependent
24 plugins are marked as implicitly enabled. Implicitly enabled plugins are
25 automatically disabled again when they are no longer required.
26 The enable, disable, and set commands will update the plugins file and
28 then attempt to connect to the broker and ensure it is running all
29 enabled plugins. By default if it is not possible to connect to and
30 authenticate with the target node (for example if it is stopped), the
31 operation will fail. If rabbitmq-plugins is used on the same host as the
32 target node, --offline can be specified to make rabbitmq-plugins resolve
33 and update plugin state directly (without contacting the node). Such
34 changes will only have an effect on next node start. To learn more, see
35 the RabbitMQ Plugins guide:
36 https://www.rabbitmq.com/plugins.html
37
39 -n node
40 Default node is "rabbit@target-hostname", where target-hostname
41 is the local host. On a host named "myserver.example.com", the
42 node name will usually be "rabbit@myserver" (unless
43 RABBITMQ_NODENAME has been overridden). The output of "hostname
44 -s" is usually the correct suffix to use after the "@" sign. See
45 rabbitmq-server(8) for details of configuring a RabbitMQ node.
46 -q, --quiet
48 Quiet output mode is selected. Informational messages are
49 reduced when quiet mode is in effect.
50 -s, --silent
52 Silent output mode is selected. Informational messages are
53 reduced and table headers are suppressed when silent mode is in
54 effect.
55 -t timeout, --timeout timeout
57 Operation timeout in seconds. Not all commands support timeouts.
58 Default is infinity.
59 -l, --longnames
61 Must be specified when the cluster is configured to use long
62 (FQDN) node names. To learn more, see the RabbitMQ Clustering
63 guide:
64 https://www.rabbitmq.com/clustering.html
65 --erlang-cookie cookie
67 Shared secret to use to authenticate to the target node. Prefer
68 using a local file or the RABBITMQ_ERLANG_COOKIE environment
69 variable instead of specifying this option on the command line.
70 To learn more, see the RabbitMQ CLI Tools guide:
71 https://www.rabbitmq.com/cli.html
72
74 list [-Eemv] [pattern]
75 -E Show only explicitly enabled plugins.
77 -e Show only explicitly or implicitly enabled plugins.
79 -m Show only plugin names (minimal).
81 -v Show all plugin details (verbose).
83 pattern
85 Pattern to filter the plugin names by.
86 Lists all plugins, their versions, dependencies and descriptions.
88 Each plugin is prefixed with two status indicator characters
89 inside [ ]. The first indicator can be:
90 <space> to indicate that the plugin is not enabled
91 E to indicate that it is explicitly enabled
92 e to indicate that it is implicitly enabled
93 to indicate that it is enabled but missing and thus not
94 operational
95 The second indicator can be:
97 <space> to show that the plugin is not running
98 * to show that it is
99 If the optional pattern is given, only plugins whose name matches
101 pattern are shown.
102 For example, this command lists all plugins, on one line each
104 rabbitmq-plugins list
106 This command lists all plugins:
108 rabbitmq-plugins list -v
110 This command lists all plugins whose name contains "management".
112 rabbitmq-plugins list -v management
114 This command lists all implicitly or explicitly enabled RabbitMQ
116 plugins.
117 rabbitmq-plugins list -e rabbit
119 enable [--offline] [--online] plugin ...
121 --offline
123 Modify node's enabled plugin state directly without con‐
124 tacting the node.
125 --online
127 Treat a failure to connect to the running broker as
128 fatal.
129 plugin One or more plugins to enable.
131 Enables the specified plugins and all their dependencies.
133 For example, this command enables the "shovel" and "management"
135 plugins and all their dependencies:
136 rabbitmq-plugins enable rabbitmq_shovel rabbitmq_management
138 disable [--offline] [--online] plugin ...
140 --offline
142 Modify node's enabled plugin state directly without con‐
143 tacting the node.
144 --online
146 Treat a failure to connect to the running broker as
147 fatal.
148 plugin One or more plugins to disable.
150 Disables the specified plugins and all their dependencies.
152 For example, this command disables "rabbitmq_management" and all
154 plugins that depend on it:
155 rabbitmq-plugins disable rabbitmq_management
157 set [--offline] [--online] [plugin ...]
159 --offline
161 Modify node's enabled plugin state directly without con‐
162 tacting the node.
163 --online
165 Treat a failure to connect to the running broker as
166 fatal.
167 plugin Zero or more plugins to disable.
169 Enables the specified plugins and all their dependencies. Unlike
171 enable, this command ignores and overwrites any existing enabled
172 plugins. set with no plugin arguments is a legal command meaning
173 "disable all plugins".
174 For example, this command enables the "management" plugin and its
176 dependencies and disables everything else:
177 rabbitmq-plugins set rabbitmq_management
179
181 rabbitmqctl(8), rabbitmq-diagnostics(8), rabbitmq-server(8),
182 rabbitmq-service(8), rabbitmq-env.conf(5), rabbitmq-echopid(8)
183
185 The RabbitMQ Team <info@rabbitmq.com>
186RabbitMQ Server January 25, 2019 RabbitMQ Server