NAME
rabbitmqctl - command line tool for managing a RabbitMQ broker
SYNOPSIS
rabbitmqctl [-n node] [-q] {command} [command options...]
DESCRIPTION
RabbitMQ is an implementation of AMQP, the emerging standard for high
performance enterprise messaging. The RabbitMQ server is a robust and
scalable implementation of an AMQP broker.
rabbitmqctl is a command line tool for managing a RabbitMQ broker. It
performs all actions by connecting to one of the broker's nodes.
OPTIONS
[-n node]
Default node is "rabbit@server", where server is the local host. On
a host named "server.example.com", the node name of the RabbitMQ
Erlang node will usually be rabbit@server (unless RABBITMQ_NODENAME
has been set to some non-default value at broker startup time). The
output of hostname -s is usually the correct suffix to use after
the "@" sign. See rabbitmq-server(1) for details of configuring the
RabbitMQ broker.
[-q]
Quiet output mode is selected with the "-q" flag. Informational
messages are suppressed when quiet mode is in effect.
Flags must precede all other parameters to rabbitmqctl.
COMMANDS
Application and Cluster Management
stop
Stops the Erlang node on which RabbitMQ is running. To restart the
node follow the instructions for Running the Server in the
installation guide[1].
stop_app
Stops the RabbitMQ application, leaving the Erlang node running.
This command is typically run prior to performing other management
actions that require the RabbitMQ application to be stopped, e.g.
reset.
start_app
Starts the RabbitMQ application.
This command is typically run after performing other management
actions that required the RabbitMQ application to be stopped, e.g.
reset.
status
Displays various information about the RabbitMQ broker, such as
whether the RabbitMQ application on the current node, its version
number, what nodes are part of the broker, which of these are
running.
reset
Return a RabbitMQ node to its virgin state.
Removes the node from any cluster it belongs to, removes all data
from the management database, such as configured users and vhosts,
and deletes all persistent messages.
For reset and force_reset to succeed the RabbitMQ application must
have been stopped, e.g. with stop_app.
force_reset
Forcefully return a RabbitMQ node to its virgin state.
The force_reset command differs from reset in that it resets the
node unconditionally, regardless of the current management database
state and cluster configuration. It should only be used as a last
resort if the database or cluster configuration has been corrupted.
For reset and force_reset to succeed the RabbitMQ application must
have been stopped, e.g. with stop_app.
rotate_logs {suffix}
Instruct the RabbitMQ node to rotate the log files.
The RabbitMQ broker will attempt to append the current contents of
the log file to the file with name composed of the original name
and the suffix. It will create a new file if such a file does not
already exist. When no suffix is specified, the empty log file is
simply created at the original location; no rotation takes place.
When an error occurs while appending the contents of the old log
file, the operation behaves in the same way as if no suffix was
specified.
This command might be helpful when you are e.g. writing your own
logrotate script and you do not want to restart the RabbitMQ node.
Cluster management
cluster {clusternode ...}
clusternode
Subset of the nodes of the cluster to which this node should be
connected.
Instruct the node to become member of a cluster with the specified
nodes.
Cluster nodes can be of two types: disk or ram. Disk nodes
replicate data in ram and on disk, thus providing redundancy in the
event of node failure and recovery from global events such as power
failure across all nodes. Ram nodes replicate data in ram only and
are mainly used for scalability. A cluster must always have at
least one disk node.
If the current node is to become a disk node it needs to appear in
the cluster node list. Otherwise it becomes a ram node. If the node
list is empty or only contains the current node then the node
becomes a standalone, i.e. non-clustered, (disk) node.
After executing the cluster command, whenever the RabbitMQ
application is started on the current node it will attempt to
connect to the specified nodes, thus becoming an active node in the
cluster comprising those nodes (and possibly others).
The list of nodes does not have to contain all the cluster's nodes;
a subset is sufficient. Also, clustering generally succeeds as long
as at least one of the specified nodes is active. Hence adjustments
to the list are only necessary if the cluster configuration is to
be altered radically.
For this command to succeed the RabbitMQ application must have been
stopped, e.g. with stop_app. Furthermore, turning a standalone node
into a clustered node requires the node be reset first, in order to
avoid accidental destruction of data with the cluster command.
For more details see the clustering guide[2].
Closing individual connections
close_connection {connectionpid} {explanation}
connectionpid
Id of the Erlang process associated with the connection to
close.
explanation
Explanation string.
Instruct the broker to close the connection associated with the
Erlang process id connectionpid (see also the list_connections
command), passing the explanation string to the connected client as
part of the AMQP connection shutdown protocol.
User management
add_user {username} {password}
username
The name of the user to create.
password
The password the created user will use to log in to the broker.
delete_user {username}
username
The name of the user to delete.
change_password {username} {newpassword}
username
The name of the user whose password is to be changed.
newpassword
The new password for the user.
list_users
Lists users
Access control
add_vhost {vhostpath}
vhostpath
The name of the virtual host entry to create.
Creates a virtual host.
delete_vhost {vhostpath}
vhostpath
The name of the virtual host entry to delete.
Deletes a virtual host.
Deleting a virtual host deletes all its exchanges, queues, user
mappings and associated permissions.
list_vhosts
Lists virtual hosts.
set_permissions [-p vhostpath] {username} {configure} {write} {read}
vhostpath
The name of the virtual host to which to grant the user access,
defaulting to /.
username
The name of the user to grant access to the specified virtual
host.
configure
A regular expression matching resource names for which the user
is granted configure permissions.
write
A regular expression matching resource names for which the user
is granted write permissions.
read
A regular expression matching resource names for which the user
is granted read permissions.
Sets user permissions.
clear_permissions [-p vhostpath] {username}
vhostpath
The name of the virtual host to which to deny the user access,
defaulting to /.
username
The name of the user to deny access to the specified virtual
host.
Sets user permissions.
list_permissions [-p vhostpath]
vhostpath
The name of the virtual host for which to list the users that
have been granted access to it, and their permissions. Defaults
to /.
Lists permissions in a virtual host.
list_user_permissions [-p vhostpath] {username}
username
The name of the user for which to list the permissions.
Lists user permissions.
Server Status
The server status queries interrogate the server and return a list of
results with tab-delimited columns. Some queries (list_queues,
list_exchanges, list_bindings, and list_consumers) accept an optional
vhost parameter. This parameter, if present, must be specified
immediately after the query.
The list_queues, list_exchanges and list_bindings commands accept an
optional virtual host parameter for which to display results. The
default value is "/".
list_queues [-p vhostpath] [queueinfoitem ...]
Returns queue details. Queue details of the / virtual host are
returned if the "-p" flag is absent. The "-p" flag can be used to
override this default.
The queueinfoitem parameter is used to indicate which queue
information items to include in the results. The column order in
the results will match the order of the parameters. queueinfoitem
can take any value from the list that follows:
name
The name of the queue with non-ASCII characters URL-escaped.
durable
Whether or not the queue survives server restarts.
auto_delete
Whether the queue will be deleted automatically when no longer
used.
arguments
Queue arguments.
pid
Id of the Erlang process associated with the queue.
owner_pid
Id of the Erlang process representing the connection which is
the exclusive owner of the queue. Empty if the queue is
non-exclusive.
exclusive_consumer_pid
Id of the Erlang process representing the channel of the
exclusive consumer subscribed to this queue. Empty if there is
no exclusive consumer.
exclusive_consumer_tag
Consumer tag of the exclusive consumer subscribed to this
queue. Empty if there is no exclusive consumer.
messages_ready
Number of messages ready to be delivered to clients.
messages_unacknowledged
Number of messages delivered to clients but not yet
acknowledged.
messages
Sum of ready and unacknowledged messages (queue depth).
consumers
Number of consumers.
memory
Bytes of memory consumed by the Erlang process associated with
the queue, including stack, heap and internal structures.
If no queueinfoitems are specified then queue name and depth are
displayed.
list_exchanges [-p vhostpath] [exchangeinfoitem ...]
Returns exchange details. Exchange details of the / virtual host
are returned if the "-p" flag is absent. The "-p" flag can be used
to override this default.
The exchangeinfoitem parameter is used to indicate which exchange
information items to include in the results. The column order in
the results will match the order of the parameters.
exchangeinfoitem can take any value from the list that follows:
name
The name of the exchange with non-ASCII characters URL-escaped.
type
The exchange type (one of [direct, topic, headers, fanout]).
durable
Whether or not the exchange survives server restarts.
auto_delete
Whether the exchange will be deleted automatically when no
longer used.
arguments
Exchange arguments.
If no exchangeinfoitems are specified then exchange name and type
are displayed.
list_bindings [-p vhostpath]
By default the bindings for the / virtual host are returned. The
"-p" flag can be used to override this default. Each result row
will contain an exchange name, queue name, routing key and binding
arguments, in that order. Non-ASCII characters will be URL-encoded.
The output format for "list_bindings" is a list of rows containing
exchange name, queue name, routing key and arguments, in that
order.
list_connections [connectioninfoitem ...]
Returns TCP/IP connection statistics.
The connectioninfoitem parameter is used to indicate which
connection information items to include in the results. The column
order in the results will match the order of the parameters.
connectioninfoitem can take any value from the list that follows:
pid
Id of the Erlang process associated with the connection.
address
Server IP address.
port
Server port.
peer_address
Peer address.
peer_port
Peer port.
state
Connection state (one of [starting, tuning, opening, running,
closing, closed]).
channels
Number of channels using the connection.
user
Username associated with the connection.
vhost
Virtual host name with non-ASCII characters URL-escaped.
timeout
Connection timeout.
frame_max
Maximum frame size (bytes).
client_properties
Informational properties transmitted by the client during
connection establishment.
recv_oct
Octets received.
recv_cnt
Packets received.
send_oct
Octets send.
send_cnt
Packets sent.
send_pend
Send queue size.
If no connectioninfoitems are specified then user, peer address,
peer port and connection state are displayed.
list_channels [channelinfoitem ...]
Returns information on all current channels, the logical containers
executing most AMQP commands. This includes channels that are part
of ordinary AMQP connections, and channels created by various
plug-ins and other extensions.
The channelinfoitem parameter is used to indicate which channel
information items to include in the results. The column order in
the results will match the order of the parameters.
channelinfoitem can take any value from the list that follows:
pid
Id of the Erlang process associated with the connection.
connection
Id of the Erlang process associated with the connection to
which the channel belongs.
number
The number of the channel, which uniquely identifies it within
a connection.
user
Username associated with the channel.
vhost
Virtual host in which the channel operates.
transactional
True if the channel is in transactional mode, false otherwise.
consumer_count
Number of logical AMQP consumers retrieving messages via the
channel.
messages_unacknowledged
Number of messages delivered via this channel but not yet
acknowledged.
acks_uncommitted
Number of acknowledgements received in an as yet uncommitted
transaction.
prefetch_count
QoS prefetch count limit in force, 0 if unlimited.
If no channelinfoitems are specified then pid, user, transactional,
consumer_count, and messages_unacknowledged are assumed.
list_consumers
List consumers, i.e. subscriptions to a queue's message stream.
Each line printed shows, separated by tab characters, the name of
the queue subscribed to, the id of the channel process via which
the subscription was created and is managed, the consumer tag which
uniquely identifies the subscription within a channel, and a
boolean indicating whether acknowledgements are expected for
messages delivered to this consumer.
The output format for "list_consumers" is a list of rows
containing, in order, the queue name, channel process id, consumer
tag, and a boolean indicating whether acknowledgements are expected
from the consumer.
EXAMPLES
rabbitmqctl stop
This command instructs the RabbitMQ node to terminate.
rabbitmqctl stop_app
This command instructs the RabbitMQ node to stop the RabbitMQ
application.
rabbitmqctl start_app
This command instructs the RabbitMQ node to start the RabbitMQ
application.
rabbitmqctl status
This command displays information about the RabbitMQ broker.
rabbitmqctl reset
This command resets the RabbitMQ node.
rabbitmqctl force_reset
This command resets the RabbitMQ node.
rabbitmqctl rotate_logs .1
This command instructs the RabbitMQ node to append the current
content of the log files to the files with names consisting of the
original logs' names and ".1" suffix, e.g. rabbit.log.1. Finally,
the old log files are reopened.
rabbitmqctl cluster rabbit@tanto hare@elena
This command instructs the RabbitMQ node to join the cluster with
nodes rabbit@tanto and hare@elena. If the node is one of these then
it becomes a disk node, otherwise a ram node.
rabbitmqctl close_connection "<rabbit@tanto.4262.0>" "go away"
This command instructs the RabbitMQ broker to close the connection
associated with the Erlang process id <rabbit@tanto.4262.0>,
passing the explanation go away to the connected client.
rabbitmqctl add_user tonyg changeit
This command instructs the RabbitMQ broker to create a user named
tonyg with (initial) password changeit.
rabbitmqctl delete_user tonyg
This command instructs the RabbitMQ broker to delete the user named
tonyg.
rabbitmqctl change_password tonyg newpass
This command instructs the RabbitMQ broker to change the password
for the user named tonyg to newpass.
rabbitmqctl list_users
This command instructs the RabbitMQ broker to list all users.
rabbitmqctl add_vhost test
This command instructs the RabbitMQ broker to create a new virtual
host called test.
rabbitmqctl delete_vhost test
This command instructs the RabbitMQ broker to delete the virtual
host called test.
rabbitmqctl list_vhosts
This command instructs the RabbitMQ broker to list all virtual
hosts.
rabbitmqctl set_permissions -p /myvhost tonyg "^tonyg-.*" ".*" ".*"
This command instructs the RabbitMQ broker to grant the user named
tonyg access to the virtual host called /myvhost, with configure
permissions on all resources whose names starts with "tonyg-", and
write and read permissions on all resources.
rabbitmqctl clear_permissions -p /myvhost tonyg
This command instructs the RabbitMQ broker to deny the user named
tonyg access to the virtual host called /myvhost.
rabbitmqctl list_permissions -p /myvhost
This command instructs the RabbitMQ broker to list all the users
which have been granted access to the virtual host called /myvhost,
and the permissions they have for operations on resources in that
virtual host.
rabbitmqctl list_user_permissions tonyg
This command instructs the RabbitMQ broker to list all the virtual
hosts to which the user named tonyg has been granted access, and
the permissions the user has for operations on resources in these
virtual hosts.
rabbitmqctl list_queues -p /myvhost messages consumers
This command displays the depth and number of consumers for each
queue of the virtual host named /myvhost.
rabbitmqctl list_exchanges -p /myvhost name type
This command displays the name and type for each exchange of the
virtual host named /myvhost.
rabbitmqctl list_connections send_pend server_port
This command displays the send queue size and server port for each
connection.
rabbitmqctl list_channels connection messages_unacknowledged
This command displays the connection process and count of
unacknowledged messages for each channel.
AUTHOR
The RabbitMQ Team <info@rabbitmq.com>
NOTES
1. installation guide
http://www.rabbitmq.com/install.html
2. clustering guide
http://www.rabbitmq.com/clustering.html