1RABBITMQ-PLUGINS(1)            RabbitMQ Service            RABBITMQ-PLUGINS(1)
2
3
4

NAME

6       rabbitmq-plugins - command line tool for managing RabbitMQ broker
7       plugins
8

SYNOPSIS

10
11
12                        rabbitmq-plugins [-n node] {command}
13                        [command options...]
14

DESCRIPTION

16       rabbitmq-plugins is a command line tool for managing RabbitMQ broker
17       plugins. It allows one to enable, disable and browse plugins. It must
18       be run by a user with write permissions to the RabbitMQ configuration
19       directory.
20
21       Some plugins depend on others to work correctly.  rabbitmq-plugins
22       traverses these dependencies and enables all required plugins. Plugins
23       listed on the rabbitmq-plugins command line are marked as explicitly
24       enabled; dependent plugins are marked as implicitly enabled. Implicitly
25       enabled plugins are automatically disabled again when they are no
26       longer required.
27
28       The enable, disable and set commands will update the plugins file and
29       then attempt to connect to the broker and ensure it is running all
30       enabled plugins. By default if it is not possible to connect to the
31       running broker (for example if it is stopped) then a warning is
32       displayed. Specify --online or --offline to change this behaviour.
33

COMMANDS

35       list [-v] [-m] [-E] [-e] [pattern]
36
37           -v
38               Show all plugin details (verbose).
39
40           -m
41               Show only plugin names (minimal).
42
43           -E
44               Show only explicitly enabled plugins.
45
46           -e
47               Show only explicitly or implicitly enabled plugins.
48
49           pattern
50               Pattern to filter the plugin names by.
51
52           Lists all plugins, their versions, dependencies and descriptions.
53           Each plugin is prefixed with two status indicator characters inside
54           [ ]. The first indicator can be " " to indicate that the plugin is
55           not enabled, "E" to indicate that it is explicitly enabled, "e" to
56           indicate that it is implicitly enabled, or "!" to indicate that it
57           is enabled but missing and thus not operational. The second
58           indicator can be " " to show that the plugin is not running, or "*"
59           to show that it is.
60
61           If the optional pattern is given, only plugins whose name matches
62           pattern are shown.
63
64           For example:
65
66           rabbitmq-plugins list
67
68           This command lists all plugins, on one line each.
69
70           rabbitmq-plugins list -v
71
72           This command lists all plugins.
73
74           rabbitmq-plugins list -v management
75
76           This command lists all plugins whose name contains "management".
77
78           rabbitmq-plugins list -e rabbit
79
80           This command lists all implicitly or explicitly enabled RabbitMQ
81           plugins.
82
83       enable [--offline] [--online] {plugin ...}
84
85           --offline
86               Just modify the enabled plugins file.
87
88           --online
89               Treat failure to connect to the running broker as fatal.
90
91           plugin
92               One or more plugins to enable.
93
94           Enables the specified plugins and all their dependencies.
95
96           For example:
97
98           rabbitmq-plugins enable rabbitmq_shovel rabbitmq_management
99
100           This command enables the shovel and management plugins and all
101           their dependencies.
102
103       disable [--offline] [--online] {plugin ...}
104
105           --offline
106               Just modify the enabled plugins file.
107
108           --online
109               Treat failure to connect to the running broker as fatal.
110
111           plugin
112               One or more plugins to disable.
113
114           Disables the specified plugins and all their dependencies.
115
116           For example:
117
118           rabbitmq-plugins disable amqp_client
119
120           This command disables amqp_client and all plugins that depend on
121           it.
122
123       set [--offline] [--online] {plugin ...}
124
125           --offline
126               Just modify the enabled plugins file.
127
128           --online
129               Treat failure to connect to the running broker as fatal.
130
131           plugin
132               Zero or more plugins to enable.
133
134           Enables the specified plugins and all their dependencies. Unlike
135           rabbitmq-plugins enable this command ignores and overwrites any
136           existing enabled plugins.  rabbitmq-plugins set with no plugin
137           arguments is a legal command meaning "disable all plugins".
138
139           For example:
140
141           rabbitmq-plugins set rabbitmq_management
142
143           This command enables the management plugin and its dependencies and
144           disables everything else.
145

AUTHOR

147       The RabbitMQ Team <<info@rabbitmq.com>>
148
149
150
151RabbitMQ Server                   07/20/2018               RABBITMQ-PLUGINS(1)
Impressum