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

NAME

4     rabbitmq-plugins — command line tool for managing RabbitMQ plugins
5

SYNOPSIS

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

DESCRIPTION

11     rabbitmq-plugins is a command line tool for managing RabbitMQ plugins.
12     See the RabbitMQ Plugins guide: https://www.rabbitmq.com/plugins.html for
13     an overview of RabbitMQ plugins and how they are used.
14
15     rabbitmq-plugins allows the operator to enable, disable and inspect plug‐
16     ins.  It must be run by a user with write permissions to the RabbitMQ
17     configuration directory.
18
19     Plugins can depend on other plugins.  rabbitmq-plugins resolves the de‐
20     pendencies and enables or disables all dependencies so that the user
21     doesn't have to manage them explicitly.  Plugins listed on the
22     rabbitmq-plugins command line are marked as explicitly enabled; dependent
23     plugins are marked as implicitly enabled.  Implicitly enabled plugins are
24     automatically disabled again when they are no longer required.
25
26     The enable, disable, and set commands will update the plugins file and
27     then attempt to connect to the broker and ensure it is running all en‐
28     abled plugins.  By default if it is not possible to connect to and au‐
29     thenticate with the target node (for example if it is stopped), the oper‐
30     ation will fail.  If rabbitmq-plugins is used on the same host as the
31     target node, --offline can be specified to make rabbitmq-plugins resolve
32     and update plugin state directly (without contacting the node).  Such
33     changes will only have an effect on next node start.  To learn more, see
34     the RabbitMQ Plugins guide: https://www.rabbitmq.com/plugins.html
35

OPTIONS

37     -n node
38             Default node is "rabbit@target-hostname", where target-hostname
39             is the local host.  On a host named "myserver.example.com", the
40             node name will usually be "rabbit@myserver" (unless
41             RABBITMQ_NODENAME has been overridden).  The output of "hostname
42             -s" is usually the correct suffix to use after the "@" sign.  See
43             rabbitmq-server(8) for details of configuring a RabbitMQ node.
44
45     -q, --quiet
46             Quiet output mode is selected.  Informational messages are re‐
47             duced when quiet mode is in effect.
48
49     -s, --silent
50             Silent output mode is selected.  Informational messages are re‐
51             duced and table headers are suppressed when silent mode is in ef‐
52             fect.
53
54     -t timeout, --timeout timeout
55             Operation timeout in seconds.  Not all commands support timeouts.
56             Default is infinity.
57
58     -l, --longnames
59             Must be specified when the cluster is configured to use long
60             (FQDN) node names.  To learn more, see the RabbitMQ Clustering
61             guide: https://www.rabbitmq.com/clustering.html
62
63     --erlang-cookie cookie
64             Shared secret to use to authenticate to the target node.  Prefer
65             using a local file or the RABBITMQ_ERLANG_COOKIE environment
66             variable instead of specifying this option on the command line.
67             To learn more, see the RabbitMQ CLI Tools guide:
68             https://www.rabbitmq.com/cli.html
69

COMMANDS

71     list [-Eemv] [pattern]
72
73             -E      Show only explicitly enabled plugins.
74
75             -e      Show only explicitly or implicitly enabled plugins.
76
77             -m      Show only plugin names (minimal).
78
79             -v      Show all plugin details (verbose).
80
81             pattern
82                     Pattern to filter the plugin names by.
83
84             Lists all plugins, their versions, dependencies and descriptions.
85             Each plugin is prefixed with two status indicator characters in‐
86             side [ ].  The first indicator can be:
87             <space>  to indicate that the plugin is not enabled
88             E        to indicate that it is explicitly enabled
89             e        to indicate that it is implicitly enabled
90                      to indicate that it is enabled but missing and thus not
91                      operational
92
93             The second indicator can be:
94             <space>  to show that the plugin is not running
95             *        to show that it is
96
97             If the optional pattern is given, only plugins whose name matches
98             pattern are shown.
99
100             For example, this command lists all plugins, on one line each
101
102                   rabbitmq-plugins list
103
104             This command lists all plugins:
105
106                   rabbitmq-plugins list -v
107
108             This command lists all plugins whose name contains "management".
109
110                   rabbitmq-plugins list -v management
111
112             This command lists all implicitly or explicitly enabled RabbitMQ
113             plugins.
114
115                   rabbitmq-plugins list -e rabbit
116
117     enable [--offline] [--online] plugin ...
118
119             --offline
120                     Modify node's enabled plugin state directly without con‐
121                     tacting the node.
122
123             --online
124                     Treat a failure to connect to the running broker as fa‐
125                     tal.
126
127             plugin  One or more plugins to enable.
128
129             Enables the specified plugins and all their dependencies.
130
131             For example, this command enables the "shovel" and "management"
132             plugins and all their dependencies:
133
134                   rabbitmq-plugins enable rabbitmq_shovel rabbitmq_management
135
136     disable [--offline] [--online] plugin ...
137
138             --offline
139                     Modify node's enabled plugin state directly without con‐
140                     tacting the node.
141
142             --online
143                     Treat a failure to connect to the running broker as fa‐
144                     tal.
145
146             plugin  One or more plugins to disable.
147
148             Disables the specified plugins and all their dependencies.
149
150             For example, this command disables "rabbitmq_management" and all
151             plugins that depend on it:
152
153                   rabbitmq-plugins disable rabbitmq_management
154
155     set [--offline] [--online] [plugin ...]
156
157             --offline
158                     Modify node's enabled plugin state directly without con‐
159                     tacting the node.
160
161             --online
162                     Treat a failure to connect to the running broker as fa‐
163                     tal.
164
165             plugin  Zero or more plugins to disable.
166
167             Enables the specified plugins and all their dependencies.  Unlike
168             enable, this command ignores and overwrites any existing enabled
169             plugins.  set with no plugin arguments is a legal command meaning
170             "disable all plugins".
171
172             For example, this command enables the "management" plugin and its
173             dependencies and disables everything else:
174
175                   rabbitmq-plugins set rabbitmq_management
176

SEE ALSO

178     rabbitmqctl(8), rabbitmq-diagnostics(8), rabbitmq-server(8),
179     rabbitmq-queues(8), rabbitmq-upgrade(8), rabbitmq-service(8),
180     rabbitmq-env.conf(5), rabbitmq-echopid(8)
181

AUTHOR

183     The RabbitMQ Team <info@rabbitmq.com>
184
185RabbitMQ Server               September 28, 2019               RabbitMQ Server