1 '\" t

     2 .\"     Title: rabbitmqctl

     3 .\"    Author: The RabbitMQ Team <[email protected]>

     4 .\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>

     5 .\"      Date: 05/10/2013

     6 .\"    Manual: RabbitMQ Service

     7 .\"    Source: RabbitMQ Server

     8 .\"  Language: English

     9 .\"

    10 .TH "RABBITMQCTL" "1" "05/10/2013" "RabbitMQ Server" "RabbitMQ Service"

    11 .\" -----------------------------------------------------------------

    12 .\" * set default formatting

    13 .\" -----------------------------------------------------------------

    14 .\" disable hyphenation

    15 .nh

    16 .\" disable justification (adjust text to left margin only)

    17 .ad l

    18 .\" -----------------------------------------------------------------

    19 .\" * MAIN CONTENT STARTS HERE *

    20 .\" -----------------------------------------------------------------

    21 .SH "NAME"

    22 rabbitmqctl \- command line tool for managing a RabbitMQ broker

    23 .SH "SYNOPSIS"

    24 .HP \w'\fBrabbitmqctl\fR\ 'u

    25 \fBrabbitmqctl\fR [\-n\ \fInode\fR] [\-q] {\fIcommand\fR} [\fIcommand\ options\fR...]

    26 .SH "DESCRIPTION"

    27 .PP

    28 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\&.

    29 .PP

    30 

    31 \fBrabbitmqctl\fR

    32 is a command line tool for managing a RabbitMQ broker\&. It performs all actions by connecting to one of the broker\'s nodes\&.

    33 .PP

    34 Diagnostic information is displayed if the broker was not running, could not be reached, or rejected the connection due to mismatching Erlang cookies\&.

    35 .SH "OPTIONS"

    36 .PP

    37 [\-n \fInode\fR]

    38 .RS 4

    39 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

    40 \fBhostname \-s\fR

    41 is usually the correct suffix to use after the "@" sign\&. See rabbitmq\-server(1) for details of configuring the RabbitMQ broker\&.

    42 .RE

    43 .PP

    44 [\-q]

    45 .RS 4

    46 Quiet output mode is selected with the "\-q" flag\&. Informational messages are suppressed when quiet mode is in effect\&.

    47 .RE

    48 .SH "COMMANDS"

    49 .SS "Application and Cluster Management"

    50 .PP

    51 \fBstop\fR [\fIpid_file\fR]

    52 .RS 4

    53 Stops the Erlang node on which RabbitMQ is running\&. To restart the node follow the instructions for

    54 Running the Server

    55 in the

    56 \fBinstallation guide\fR\&\s-2\u[1]\d\s+2\&.

    57 .sp

    58 If a

    59 \fBpid_file\fR

    60 is specified, also waits for the process specified there to terminate\&. See the description of the

    61 \fBwait\fR

    62 command below for details on this file\&.

    63 .RE

    64 .PP

    65 \fBstop_app\fR

    66 .RS 4

    67 Stops the RabbitMQ application, leaving the Erlang node running\&.

    68 .sp

    69 This command is typically run prior to performing other management actions that require the RabbitMQ application to be stopped, e\&.g\&.

    70 \fBreset\fR\&.

    71 .RE

    72 .PP

    73 \fBstart_app\fR

    74 .RS 4

    75 Starts the RabbitMQ application\&.

    76 .sp

    77 This command is typically run after performing other management actions that required the RabbitMQ application to be stopped, e\&.g\&.

    78 \fBreset\fR\&.

    79 .RE

    80 .PP

    81 \fBwait\fR {\fIpid_file\fR}

    82 .RS 4

    83 Wait for the RabbitMQ application to start\&.

    84 .sp

    85 This command will wait for the RabbitMQ application to start at the node\&. It will wait for the pid file to be created, then for a process with a pid specified in the pid file to start, and then for the RabbitMQ application to start in that process\&. It will fail if the process terminates without starting the RabbitMQ application\&.

    86 .sp

    87 A suitable pid file is created by the

    88 \fBrabbitmq\-server\fR

    89 script\&. By default this is located in the Mnesia directory\&. Modify the

    90 \fBRABBITMQ_PID_FILE\fR

    91 environment variable to change the location\&.

    92 .RE

    93 .PP

    94 \fBreset\fR

    95 .RS 4

    96 Return a RabbitMQ node to its virgin state\&.

    97 .sp

    98 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\&.

    99 .sp

   100 For

   101 \fBreset\fR

   102 and

   103 \fBforce_reset\fR

   104 to succeed the RabbitMQ application must have been stopped, e\&.g\&. with

   105 \fBstop_app\fR\&.

   106 .RE

   107 .PP

   108 \fBforce_reset\fR

   109 .RS 4

   110 Forcefully return a RabbitMQ node to its virgin state\&.

   111 .sp

   112 The

   113 \fBforce_reset\fR

   114 command differs from

   115 \fBreset\fR

   116 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\&.

   117 .sp

   118 For

   119 \fBreset\fR

   120 and

   121 \fBforce_reset\fR

   122 to succeed the RabbitMQ application must have been stopped, e\&.g\&. with

   123 \fBstop_app\fR\&.

   124 .RE

   125 .PP

   126 \fBrotate_logs\fR {\fIsuffix\fR}

   127 .RS 4

   128 Instruct the RabbitMQ node to rotate the log files\&.

   129 .sp

   130 The RabbitMQ broker appends the contents of its log files to files with names composed of the original name and the suffix, and then resumes logging to freshly created files at the original location\&. I\&.e\&. effectively the current log contents are moved to the end of the suffixed files\&.

   131 .sp

   132 When the target files do not exist they are created\&. When no

   133 \fBsuffix\fR

   134 is specified, the empty log files are simply created at the original location; no rotation takes place\&.

   135 .RE

   136 .SS "Cluster management"

   137 .PP

   138 \fBjoin_cluster\fR {\fIclusternode\fR} [\-\-ram]

   139 .RS 4

   140 .PP

   141 clusternode

   142 .RS 4

   143 Node to cluster with\&.

   144 .RE

   145 .PP

   146 [\-\-ram]

   147 .RS 4

   148 If provided, the node will join the cluster as a RAM node\&.

   149 .RE

   150 .sp

   151 Instruct the node to become a member of the cluster that the specified node is in\&. Before clustering, the node is reset, so be careful when using this command\&. For this command to succeed the RabbitMQ application must have been stopped, e\&.g\&. with

   152 \fBstop_app\fR\&.

   153 .sp

   154 Cluster nodes can be of two types: disc or RAM\&. Disc nodes replicate data in RAM and on disc, 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 (with the exception of queue contents, which can reside on disc if the queue is persistent or too big to fit in memory) and are mainly used for scalability\&. RAM nodes are more performant only when managing resources (e\&.g\&. adding/removing queues, exchanges, or bindings)\&. A cluster must always have at least one disc node, and usually should have more than one\&.

   155 .sp

   156 The node will be a disc node by default\&. If you wish to create a RAM node, provide the

   157 \fB\-\-ram\fR

   158 flag\&.

   159 .sp

   160 After executing the

   161 \fBcluster\fR

   162 command, whenever the RabbitMQ application is started on the current node it will attempt to connect to the nodes that were in the cluster when the node went down\&.

   163 .sp

   164 To leave a cluster,

   165 \fBreset\fR

   166 the node\&. You can also remove nodes remotely with the

   167 \fBforget_cluster_node\fR

   168 command\&.

   169 .sp

   170 For more details see the

   171 \fBclustering guide\fR\&\s-2\u[2]\d\s+2\&.

   172 .RE

   173 .PP

   174 \fBcluster_status\fR

   175 .RS 4

   176 Displays all the nodes in the cluster grouped by node type, together with the currently running nodes\&.

   177 .RE

   178 .PP

   179 \fBchange_cluster_node_type\fR {disc | ram}

   180 .RS 4

   181 Changes the type of the cluster node\&. The node must be stopped for this operation to succeed, and when turning a node into a RAM node the node must not be the only disc node in the cluster\&.

   182 .RE

   183 .PP

   184 \fBforget_cluster_node\fR [\-\-offline]

   185 .RS 4

   186 .PP

   187 [\-\-offline]

   188 .RS 4

   189 Enables node removal from an offline node\&. This is only useful in the situation where all the nodes are offline and the last node to go down cannot be brought online, thus preventing the whole cluster from starting\&. It should not be used in any other circumstances since it can lead to inconsistencies\&.

   190 .RE

   191 .sp

   192 Removes a cluster node remotely\&. The node that is being removed must be offline, while the node we are removing from must be online, except when using the

   193 \fB\-\-offline\fR

   194 flag\&.

   195 .RE

   196 .PP

   197 \fBupdate_cluster_nodes\fR {clusternode}

   198 .RS 4

   199 .PP

   200 clusternode

   201 .RS 4

   202 The node to consult for up to date information\&.

   203 .RE

   204 .sp

   205 Instructs an already clustered node to contact

   206 \fBclusternode\fR

   207 to cluster when waking up\&. This is different from

   208 \fBjoin_cluster\fR

   209 since it does not join any cluster \- it checks that the node is already in a cluster with

   210 \fBclusternode\fR\&.

   211 .sp

   212 The need for this command is motivated by the fact that clusters can change while a node is offline\&. Consider the situation in which node A and B are clustered\&. A goes down, C clusters with B, and then B leaves the cluster\&. When A wakes up, it\'ll try to contact B, but this will fail since B is not in the cluster anymore\&.

   213 \fBupdate_cluster_nodes \-n A C\fR

   214 will solve this situation\&.

   215 .RE

   216 .PP

   217 \fBsync_queue\fR {queue}

   218 .RS 4

   219 .PP

   220 queue

   221 .RS 4

   222 The name of the queue to synchronise\&.

   223 .RE

   224 .sp

   225 Instructs a mirrored queue with unsynchronised slaves to synchronise itself\&. The queue will block while synchronisation takes place (all publishers to and consumers from the queue will block)\&. The queue must be mirrored for this command to succeed\&.

   226 .sp

   227 Note that unsynchronised queues from which messages are being drained will become synchronised eventually\&. This command is primarily useful for queues which are not being drained\&.

   228 .RE

   229 .PP

   230 \fBcancel_sync_queue\fR {queue}

   231 .RS 4

   232 .PP

   233 queue

   234 .RS 4

   235 The name of the queue to cancel synchronisation for\&.

   236 .RE

   237 .sp

   238 Instructs a synchronising mirrored queue to stop synchronising itself\&.

   239 .RE

   240 .SS "User management"

   241 .PP

   242 Note that

   243 \fBrabbitmqctl\fR

   244 manages the RabbitMQ internal user database\&. Users from any alternative authentication backend will not be visible to

   245 \fBrabbitmqctl\fR\&.

   246 .PP

   247 \fBadd_user\fR {\fIusername\fR} {\fIpassword\fR}

   248 .RS 4

   249 .PP

   250 username

   251 .RS 4

   252 The name of the user to create\&.

   253 .RE

   254 .PP

   255 password

   256 .RS 4

   257 The password the created user will use to log in to the broker\&.

   258 .RE

   259 .RE

   260 .PP

   261 \fBdelete_user\fR {\fIusername\fR}

   262 .RS 4

   263 .PP

   264 username

   265 .RS 4

   266 The name of the user to delete\&.

   267 .RE

   268 .RE

   269 .PP

   270 \fBchange_password\fR {\fIusername\fR} {\fInewpassword\fR}

   271 .RS 4

   272 .PP

   273 username

   274 .RS 4

   275 The name of the user whose password is to be changed\&.

   276 .RE

   277 .PP

   278 newpassword

   279 .RS 4

   280 The new password for the user\&.

   281 .RE

   282 .RE

   283 .PP

   284 \fBclear_password\fR {\fIusername\fR}

   285 .RS 4

   286 .PP

   287 username

   288 .RS 4

   289 The name of the user whose password is to be cleared\&.

   290 .RE

   291 .RE

   292 .PP

   293 \fBset_user_tags\fR {\fIusername\fR} {\fItag\fR \&.\&.\&.}

   294 .RS 4

   295 .PP

   296 username

   297 .RS 4

   298 The name of the user whose tags are to be set\&.

   299 .RE

   300 .PP

   301 tag

   302 .RS 4

   303 Zero, one or more tags to set\&. Any existing tags will be removed\&.

   304 .RE

   305 .RE

   306 .PP

   307 \fBlist_users\fR

   308 .RS 4

   309 Lists users\&. Each result row will contain the user name followed by a list of the tags set for that user\&.

   310 .RE

   311 .SS "Access control"

   312 .PP

   313 Note that

   314 \fBrabbitmqctl\fR

   315 manages the RabbitMQ internal user database\&. Permissions for users from any alternative authorisation backend will not be visible to

   316 \fBrabbitmqctl\fR\&.

   317 .PP

   318 \fBadd_vhost\fR {\fIvhostpath\fR}

   319 .RS 4

   320 .PP

   321 vhostpath

   322 .RS 4

   323 The name of the virtual host entry to create\&.

   324 .RE

   325 .sp

   326 Creates a virtual host\&.

   327 .RE

   328 .PP

   329 \fBdelete_vhost\fR {\fIvhostpath\fR}

   330 .RS 4

   331 .PP

   332 vhostpath

   333 .RS 4

   334 The name of the virtual host entry to delete\&.

   335 .RE

   336 .sp

   337 Deletes a virtual host\&.

   338 .sp

   339 Deleting a virtual host deletes all its exchanges, queues, bindings, user permissions, parameters and policies\&.

   340 .RE

   341 .PP

   342 \fBlist_vhosts\fR [\fIvhostinfoitem\fR \&.\&.\&.]

   343 .RS 4

   344 Lists virtual hosts\&.

   345 .sp

   346 The

   347 \fBvhostinfoitem\fR

   348 parameter is used to indicate which virtual host information items to include in the results\&. The column order in the results will match the order of the parameters\&.

   349 \fBvhostinfoitem\fR

   350 can take any value from the list that follows:

   351 .PP

   352 name

   353 .RS 4

   354 The name of the virtual host with non\-ASCII characters escaped as in C\&.

   355 .RE

   356 .PP

   357 tracing

   358 .RS 4

   359 Whether tracing is enabled for this virtual host\&.

   360 .RE

   361 .sp

   362 If no

   363 \fBvhostinfoitem\fRs are specified then the vhost name is displayed\&.

   364 .RE

   365 .PP

   366 \fBset_permissions\fR [\-p \fIvhostpath\fR] {\fIuser\fR} {\fIconf\fR} {\fIwrite\fR} {\fIread\fR}

   367 .RS 4

   368 .PP

   369 vhostpath

   370 .RS 4

   371 The name of the virtual host to which to grant the user access, defaulting to

   372 \fB/\fR\&.

   373 .RE

   374 .PP

   375 user

   376 .RS 4

   377 The name of the user to grant access to the specified virtual host\&.

   378 .RE

   379 .PP

   380 conf

   381 .RS 4

   382 A regular expression matching resource names for which the user is granted configure permissions\&.

   383 .RE

   384 .PP

   385 write

   386 .RS 4

   387 A regular expression matching resource names for which the user is granted write permissions\&.

   388 .RE

   389 .PP

   390 read

   391 .RS 4

   392 A regular expression matching resource names for which the user is granted read permissions\&.

   393 .RE

   394 .sp

   395 Sets user permissions\&.

   396 .RE

   397 .PP

   398 \fBclear_permissions\fR [\-p \fIvhostpath\fR] {\fIusername\fR}

   399 .RS 4

   400 .PP

   401 vhostpath

   402 .RS 4

   403 The name of the virtual host to which to deny the user access, defaulting to

   404 \fB/\fR\&.

   405 .RE

   406 .PP

   407 username

   408 .RS 4

   409 The name of the user to deny access to the specified virtual host\&.

   410 .RE

   411 .sp

   412 Sets user permissions\&.

   413 .RE

   414 .PP

   415 \fBlist_permissions\fR [\-p \fIvhostpath\fR]

   416 .RS 4

   417 .PP

   418 vhostpath

   419 .RS 4

   420 The name of the virtual host for which to list the users that have been granted access to it, and their permissions\&. Defaults to

   421 \fB/\fR\&.

   422 .RE

   423 .sp

   424 Lists permissions in a virtual host\&.

   425 .RE

   426 .PP

   427 \fBlist_user_permissions\fR {\fIusername\fR}

   428 .RS 4

   429 .PP

   430 username

   431 .RS 4

   432 The name of the user for which to list the permissions\&.

   433 .RE

   434 .sp

   435 Lists user permissions\&.

   436 .RE

   437 .SS "Parameter Management"

   438 .PP

   439 Certain features of RabbitMQ (such as the federation plugin) are controlled by dynamic, cluster\-wide

   440 \fIparameters\fR\&. Each parameter consists of a component name, a name and a value, and is associated with a virtual host\&. The component name and name are strings, and the value is an Erlang term\&. Parameters can be set, cleared and listed\&. In general you should refer to the documentation for the feature in question to see how to set parameters\&.

   441 .PP

   442 \fBset_parameter\fR [\-p \fIvhostpath\fR] {\fIcomponent_name\fR} {\fIname\fR} {\fIvalue\fR}

   443 .RS 4

   444 Sets a parameter\&.

   445 .PP

   446 component_name

   447 .RS 4

   448 The name of the component for which the parameter is being set\&.

   449 .RE

   450 .PP

   451 name

   452 .RS 4

   453 The name of the parameter being set\&.

   454 .RE

   455 .PP

   456 value

   457 .RS 4

   458 The value for the parameter, as a JSON term\&. In most shells you are very likely to need to quote this\&.

   459 .RE

   460 .RE

   461 .PP

   462 \fBclear_parameter\fR [\-p \fIvhostpath\fR] {\fIcomponent_name\fR} {\fIkey\fR}

   463 .RS 4

   464 Clears a parameter\&.

   465 .PP

   466 component_name

   467 .RS 4

   468 The name of the component for which the parameter is being cleared\&.

   469 .RE

   470 .PP

   471 name

   472 .RS 4

   473 The name of the parameter being cleared\&.

   474 .RE

   475 .RE

   476 .PP

   477 \fBlist_parameters\fR [\-p \fIvhostpath\fR]

   478 .RS 4

   479 Lists all parameters for a virtual host\&.

   480 .RE

   481 .SS "Policy Management"

   482 .PP

   483 Policies are used to control and modify the behaviour of queues and exchanges on a cluster\-wide basis\&. Policies apply within a given vhost, and consist of a name, pattern, definition and an optional priority\&. Policies can be set, cleared and listed\&.

   484 .PP

   485 \fBset_policy\fR [\-p \fIvhostpath\fR] {\fIname\fR} {\fIpattern\fR} {\fIdefinition\fR} [\fIpriority\fR]

   486 .RS 4

   487 Sets a policy\&.

   488 .PP

   489 name

   490 .RS 4

   491 The name of the policy\&.

   492 .RE

   493 .PP

   494 pattern

   495 .RS 4

   496 The regular expression, which when matches on a given resources causes the policy to apply\&.

   497 .RE

   498 .PP

   499 definition

   500 .RS 4

   501 The definition of the policy, as a JSON term\&. In most shells you are very likely to need to quote this\&.

   502 .RE

   503 .PP

   504 priority

   505 .RS 4

   506 The priority of the policy as an integer, defaulting to 0\&. Higher numbers indicate greater precedence\&.

   507 .RE

   508 .RE

   509 .PP

   510 \fBclear_policy\fR [\-p \fIvhostpath\fR] {\fIname\fR}

   511 .RS 4

   512 Clears a policy\&.

   513 .PP

   514 name

   515 .RS 4

   516 The name of the policy being cleared\&.

   517 .RE

   518 .RE

   519 .PP

   520 \fBlist_policies\fR [\-p \fIvhostpath\fR]

   521 .RS 4

   522 Lists all policies for a virtual host\&.

   523 .RE

   524 .SS "Server Status"

   525 .PP

   526 The server status queries interrogate the server and return a list of results with tab\-delimited columns\&. Some queries (\fBlist_queues\fR,

   527 \fBlist_exchanges\fR,

   528 \fBlist_bindings\fR, and

   529 \fBlist_consumers\fR) accept an optional

   530 \fBvhost\fR

   531 parameter\&. This parameter, if present, must be specified immediately after the query\&.

   532 .PP

   533 The list_queues, list_exchanges and list_bindings commands accept an optional virtual host parameter for which to display results\&. The default value is "/"\&.

   534 .PP

   535 \fBlist_queues\fR [\-p \fIvhostpath\fR] [\fIqueueinfoitem\fR \&.\&.\&.]

   536 .RS 4

   537 Returns queue details\&. Queue details of the

   538 \fB/\fR

   539 virtual host are returned if the "\-p" flag is absent\&. The "\-p" flag can be used to override this default\&.

   540 .sp

   541 The

   542 \fBqueueinfoitem\fR

   543 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\&.

   544 \fBqueueinfoitem\fR

   545 can take any value from the list that follows:

   546 .PP

   547 name

   548 .RS 4

   549 The name of the queue with non\-ASCII characters escaped as in C\&.

   550 .RE

   551 .PP

   552 durable

   553 .RS 4

   554 Whether or not the queue survives server restarts\&.

   555 .RE

   556 .PP

   557 auto_delete

   558 .RS 4

   559 Whether the queue will be deleted automatically when no longer used\&.

   560 .RE

   561 .PP

   562 arguments

   563 .RS 4

   564 Queue arguments\&.

   565 .RE

   566 .PP

   567 policy

   568 .RS 4

   569 Policy name applying to the queue\&.

   570 .RE

   571 .PP

   572 pid

   573 .RS 4

   574 Id of the Erlang process associated with the queue\&.

   575 .RE

   576 .PP

   577 owner_pid

   578 .RS 4

   579 Id of the Erlang process representing the connection which is the exclusive owner of the queue\&. Empty if the queue is non\-exclusive\&.

   580 .RE

   581 .PP

   582 exclusive_consumer_pid

   583 .RS 4

   584 Id of the Erlang process representing the channel of the exclusive consumer subscribed to this queue\&. Empty if there is no exclusive consumer\&.

   585 .RE

   586 .PP

   587 exclusive_consumer_tag

   588 .RS 4

   589 Consumer tag of the exclusive consumer subscribed to this queue\&. Empty if there is no exclusive consumer\&.

   590 .RE

   591 .PP

   592 messages_ready

   593 .RS 4

   594 Number of messages ready to be delivered to clients\&.

   595 .RE

   596 .PP

   597 messages_unacknowledged

   598 .RS 4

   599 Number of messages delivered to clients but not yet acknowledged\&.

   600 .RE

   601 .PP

   602 messages

   603 .RS 4

   604 Sum of ready and unacknowledged messages (queue depth)\&.

   605 .RE

   606 .PP

   607 consumers

   608 .RS 4

   609 Number of consumers\&.

   610 .RE

   611 .PP

   612 active_consumers

   613 .RS 4

   614 Number of active consumers\&. An active consumer is one which could immediately receive any messages sent to the queue \- i\&.e\&. it is not limited by its prefetch count, TCP congestion, flow control, or because it has issued channel\&.flow\&. At least one of messages_ready and active_consumers must always be zero\&.

   615 .sp

   616 Note that this value is an instantaneous snapshot \- when consumers are restricted by their prefetch count they may only appear to be active for small fractions of a second until more messages are sent out\&.

   617 .RE

   618 .PP

   619 memory

   620 .RS 4

   621 Bytes of memory consumed by the Erlang process associated with the queue, including stack, heap and internal structures\&.

   622 .RE

   623 .PP

   624 slave_pids

   625 .RS 4

   626 If the queue is mirrored, this gives the IDs of the current slaves\&.

   627 .RE

   628 .PP

   629 synchronised_slave_pids

   630 .RS 4

   631 If the queue is mirrored, this gives the IDs of the current slaves which are synchronised with the master \- i\&.e\&. those which could take over from the master without message loss\&.

   632 .RE

   633 .PP

   634 status

   635 .RS 4

   636 The status of the queue\&. Normally \'running\', but may be "{syncing, MsgCount}" if the queue is synchronising\&.

   637 .RE

   638 .sp

   639 If no

   640 \fBqueueinfoitem\fRs are specified then queue name and depth are displayed\&.

   641 .RE

   642 .PP

   643 \fBlist_exchanges\fR [\-p \fIvhostpath\fR] [\fIexchangeinfoitem\fR \&.\&.\&.]

   644 .RS 4

   645 Returns exchange details\&. Exchange details of the

   646 \fB/\fR

   647 virtual host are returned if the "\-p" flag is absent\&. The "\-p" flag can be used to override this default\&.

   648 .sp

   649 The

   650 \fBexchangeinfoitem\fR

   651 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\&.

   652 \fBexchangeinfoitem\fR

   653 can take any value from the list that follows:

   654 .PP

   655 name

   656 .RS 4

   657 The name of the exchange with non\-ASCII characters escaped as in C\&.

   658 .RE

   659 .PP

   660 type

   661 .RS 4

   662 The exchange type (such as [\fBdirect\fR,

   663 \fBtopic\fR,

   664 \fBheaders\fR,

   665 \fBfanout\fR])\&.

   666 .RE

   667 .PP

   668 durable

   669 .RS 4

   670 Whether or not the exchange survives server restarts\&.

   671 .RE

   672 .PP

   673 auto_delete

   674 .RS 4

   675 Whether the exchange will be deleted automatically when no longer used\&.

   676 .RE

   677 .PP

   678 internal

   679 .RS 4

   680 Whether the exchange is internal, i\&.e\&. cannot be directly published to by a client\&.

   681 .RE

   682 .PP

   683 arguments

   684 .RS 4

   685 Exchange arguments\&.

   686 .RE

   687 .PP

   688 policy

   689 .RS 4

   690 Policy name for applying to the exchange\&.

   691 .RE

   692 .sp

   693 If no

   694 \fBexchangeinfoitem\fRs are specified then exchange name and type are displayed\&.

   695 .RE

   696 .PP

   697 \fBlist_bindings\fR [\-p \fIvhostpath\fR] [\fIbindinginfoitem\fR \&.\&.\&.]

   698 .RS 4

   699 Returns binding details\&. By default the bindings for the

   700 \fB/\fR

   701 virtual host are returned\&. The "\-p" flag can be used to override this default\&.

   702 .sp

   703 The

   704 \fBbindinginfoitem\fR

   705 parameter is used to indicate which binding information items to include in the results\&. The column order in the results will match the order of the parameters\&.

   706 \fBbindinginfoitem\fR

   707 can take any value from the list that follows:

   708 .PP

   709 source_name

   710 .RS 4

   711 The name of the source of messages to which the binding is attached\&. With non\-ASCII characters escaped as in C\&.

   712 .RE

   713 .PP

   714 source_kind

   715 .RS 4

   716 The kind of the source of messages to which the binding is attached\&. Currently always exchange\&. With non\-ASCII characters escaped as in C\&.

   717 .RE

   718 .PP

   719 destination_name

   720 .RS 4

   721 The name of the destination of messages to which the binding is attached\&. With non\-ASCII characters escaped as in C\&.

   722 .RE

   723 .PP

   724 destination_kind

   725 .RS 4

   726 The kind of the destination of messages to which the binding is attached\&. With non\-ASCII characters escaped as in C\&.

   727 .RE

   728 .PP

   729 routing_key

   730 .RS 4

   731 The binding\'s routing key, with non\-ASCII characters escaped as in C\&.

   732 .RE

   733 .PP

   734 arguments

   735 .RS 4

   736 The binding\'s arguments\&.

   737 .RE

   738 .sp

   739 If no

   740 \fBbindinginfoitem\fRs are specified then all above items are displayed\&.

   741 .RE

   742 .PP

   743 \fBlist_connections\fR [\fIconnectioninfoitem\fR \&.\&.\&.]

   744 .RS 4

   745 Returns TCP/IP connection statistics\&.

   746 .sp

   747 The

   748 \fBconnectioninfoitem\fR

   749 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\&.

   750 \fBconnectioninfoitem\fR

   751 can take any value from the list that follows:

   752 .PP

   753 pid

   754 .RS 4

   755 Id of the Erlang process associated with the connection\&.

   756 .RE

   757 .PP

   758 name

   759 .RS 4

   760 Readable name for the connection\&.

   761 .RE

   762 .PP

   763 port

   764 .RS 4

   765 Server port\&.

   766 .RE

   767 .PP

   768 host

   769 .RS 4

   770 Server hostname obtained via reverse DNS, or its IP address if reverse DNS failed or was not enabled\&.

   771 .RE

   772 .PP

   773 peer_port

   774 .RS 4

   775 Peer port\&.

   776 .RE

   777 .PP

   778 peer_host

   779 .RS 4

   780 Peer hostname obtained via reverse DNS, or its IP address if reverse DNS failed or was not enabled\&.

   781 .RE

   782 .PP

   783 ssl

   784 .RS 4

   785 Boolean indicating whether the connection is secured with SSL\&.

   786 .RE

   787 .PP

   788 ssl_protocol

   789 .RS 4

   790 SSL protocol (e\&.g\&. tlsv1)

   791 .RE

   792 .PP

   793 ssl_key_exchange

   794 .RS 4

   795 SSL key exchange algorithm (e\&.g\&. rsa)

   796 .RE

   797 .PP

   798 ssl_cipher

   799 .RS 4

   800 SSL cipher algorithm (e\&.g\&. aes_256_cbc)

   801 .RE

   802 .PP

   803 ssl_hash

   804 .RS 4

   805 SSL hash function (e\&.g\&. sha)

   806 .RE

   807 .PP

   808 peer_cert_subject

   809 .RS 4

   810 The subject of the peer\'s SSL certificate, in RFC4514 form\&.

   811 .RE

   812 .PP

   813 peer_cert_issuer

   814 .RS 4

   815 The issuer of the peer\'s SSL certificate, in RFC4514 form\&.

   816 .RE

   817 .PP

   818 peer_cert_validity

   819 .RS 4

   820 The period for which the peer\'s SSL certificate is valid\&.

   821 .RE

   822 .PP

   823 last_blocked_by

   824 .RS 4

   825 The reason for which this connection was last blocked\&. One of \'resource\' \- due to a memory or disk alarm, \'flow\' \- due to internal flow control, or \'none\' if the connection was never blocked\&.

   826 .RE

   827 .PP

   828 last_blocked_age

   829 .RS 4

   830 Time, in seconds, since this connection was last blocked, or \'infinity\'\&.

   831 .RE

   832 .PP

   833 state

   834 .RS 4

   835 Connection state (one of [\fBstarting\fR,

   836 \fBtuning\fR,

   837 \fBopening\fR,

   838 \fBrunning\fR,

   839 \fBblocking\fR,

   840 \fBblocked\fR,

   841 \fBclosing\fR,

   842 \fBclosed\fR])\&.

   843 .RE

   844 .PP

   845 channels

   846 .RS 4

   847 Number of channels using the connection\&.

   848 .RE

   849 .PP

   850 protocol

   851 .RS 4

   852 Version of the AMQP protocol in use (currently one of

   853 \fB{0,9,1}\fR

   854 or

   855 \fB{0,8,0}\fR)\&. Note that if a client requests an AMQP 0\-9 connection, we treat it as AMQP 0\-9\-1\&.

   856 .RE

   857 .PP

   858 auth_mechanism

   859 .RS 4

   860 SASL authentication mechanism used, such as

   861 \fBPLAIN\fR\&.

   862 .RE

   863 .PP

   864 user

   865 .RS 4

   866 Username associated with the connection\&.

   867 .RE

   868 .PP

   869 vhost

   870 .RS 4

   871 Virtual host name with non\-ASCII characters escaped as in C\&.

   872 .RE

   873 .PP

   874 timeout

   875 .RS 4

   876 Connection timeout / negotiated heartbeat interval, in seconds\&.

   877 .RE

   878 .PP

   879 frame_max

   880 .RS 4

   881 Maximum frame size (bytes)\&.

   882 .RE

   883 .PP

   884 client_properties

   885 .RS 4

   886 Informational properties transmitted by the client during connection establishment\&.

   887 .RE

   888 .PP

   889 recv_oct

   890 .RS 4

   891 Octets received\&.

   892 .RE

   893 .PP

   894 recv_cnt

   895 .RS 4

   896 Packets received\&.

   897 .RE

   898 .PP

   899 send_oct

   900 .RS 4

   901 Octets send\&.

   902 .RE

   903 .PP

   904 send_cnt

   905 .RS 4

   906 Packets sent\&.

   907 .RE

   908 .PP

   909 send_pend

   910 .RS 4

   911 Send queue size\&.

   912 .RE

   913 .sp

   914 If no

   915 \fBconnectioninfoitem\fRs are specified then user, peer host, peer port, time since flow control and memory block state are displayed\&.

   916 .RE

   917 .PP

   918 \fBlist_channels\fR [\fIchannelinfoitem\fR \&.\&.\&.]

   919 .RS 4

   920 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\&.

   921 .sp

   922 The

   923 \fBchannelinfoitem\fR

   924 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\&.

   925 \fBchannelinfoitem\fR

   926 can take any value from the list that follows:

   927 .PP

   928 pid

   929 .RS 4

   930 Id of the Erlang process associated with the connection\&.

   931 .RE

   932 .PP

   933 connection

   934 .RS 4

   935 Id of the Erlang process associated with the connection to which the channel belongs\&.

   936 .RE

   937 .PP

   938 name

   939 .RS 4

   940 Readable name for the channel\&.

   941 .RE

   942 .PP

   943 number

   944 .RS 4

   945 The number of the channel, which uniquely identifies it within a connection\&.

   946 .RE

   947 .PP

   948 user

   949 .RS 4

   950 Username associated with the channel\&.

   951 .RE

   952 .PP

   953 vhost

   954 .RS 4

   955 Virtual host in which the channel operates\&.

   956 .RE

   957 .PP

   958 transactional

   959 .RS 4

   960 True if the channel is in transactional mode, false otherwise\&.

   961 .RE

   962 .PP

   963 confirm

   964 .RS 4

   965 True if the channel is in confirm mode, false otherwise\&.

   966 .RE

   967 .PP

   968 consumer_count

   969 .RS 4

   970 Number of logical AMQP consumers retrieving messages via the channel\&.

   971 .RE

   972 .PP

   973 messages_unacknowledged

   974 .RS 4

   975 Number of messages delivered via this channel but not yet acknowledged\&.

   976 .RE

   977 .PP

   978 messages_uncommitted

   979 .RS 4

   980 Number of messages received in an as yet uncommitted transaction\&.

   981 .RE

   982 .PP

   983 acks_uncommitted

   984 .RS 4

   985 Number of acknowledgements received in an as yet uncommitted transaction\&.

   986 .RE

   987 .PP

   988 messages_unconfirmed

   989 .RS 4

   990 Number of published messages not yet confirmed\&. On channels not in confirm mode, this remains 0\&.

   991 .RE

   992 .PP

   993 prefetch_count

   994 .RS 4

   995 QoS prefetch count limit in force, 0 if unlimited\&.

   996 .RE

   997 .PP

   998 client_flow_blocked

   999 .RS 4

  1000 True if the client issued a

  1001 \fBchannel\&.flow{active=false}\fR

  1002 command, blocking the server from delivering messages to the channel\'s consumers\&.

  1003 .RE

  1004 .sp

  1005 If no

  1006 \fBchannelinfoitem\fRs are specified then pid, user, consumer_count, and messages_unacknowledged are assumed\&.

  1007 .RE

  1008 .PP

  1009 \fBlist_consumers\fR [\-p \fIvhostpath\fR]

  1010 .RS 4

  1011 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\&.

  1012 .sp

  1013 The output 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\&.

  1014 .RE

  1015 .PP

  1016 \fBstatus\fR

  1017 .RS 4

  1018 Displays broker status information such as the running applications on the current Erlang node, RabbitMQ and Erlang versions, OS name, memory and file descriptor statistics\&. (See the

  1019 \fBcluster_status\fR

  1020 command to find out which nodes are clustered and running\&.)

  1021 .RE

  1022 .PP

  1023 \fBenvironment\fR

  1024 .RS 4

  1025 Display the name and value of each variable in the application environment\&.

  1026 .RE

  1027 .PP

  1028 \fBreport\fR

  1029 .RS 4

  1030 Generate a server status report containing a concatenation of all server status information for support purposes\&. The output should be redirected to a file when accompanying a support request\&.

  1031 .RE

  1032 .PP

  1033 \fBeval\fR {\fIexpr\fR}

  1034 .RS 4

  1035 Evaluate an arbitrary Erlang expression\&.

  1036 .RE

  1037 .SS "Miscellaneous"

  1038 .PP

  1039 \fBclose_connection\fR {\fIconnectionpid\fR} {\fIexplanation\fR}

  1040 .RS 4

  1041 .PP

  1042 connectionpid

  1043 .RS 4

  1044 Id of the Erlang process associated with the connection to close\&.

  1045 .RE

  1046 .PP

  1047 explanation

  1048 .RS 4

  1049 Explanation string\&.

  1050 .RE

  1051 .sp

  1052 Instruct the broker to close the connection associated with the Erlang process id

  1053 \fBconnectionpid\fR

  1054 (see also the

  1055 \fBlist_connections\fR

  1056 command), passing the

  1057 \fBexplanation\fR

  1058 string to the connected client as part of the AMQP connection shutdown protocol\&.

  1059 .RE

  1060 .PP

  1061 \fBtrace_on\fR [\-p \fIvhost\fR]

  1062 .RS 4

  1063 .PP

  1064 vhost

  1065 .RS 4

  1066 The name of the virtual host for which to start tracing\&.

  1067 .RE

  1068 .sp

  1069 Starts tracing\&.

  1070 .RE

  1071 .PP

  1072 \fBtrace_off\fR [\-p \fIvhost\fR]

  1073 .RS 4

  1074 .PP

  1075 vhost

  1076 .RS 4

  1077 The name of the virtual host for which to stop tracing\&.

  1078 .RE

  1079 .sp

  1080 Stops tracing\&.

  1081 .RE

  1082 .PP

  1083 \fBset_vm_memory_high_watermark\fR {\fIfraction\fR}

  1084 .RS 4

  1085 .PP

  1086 fraction

  1087 .RS 4

  1088 The new memory threshold fraction at which flow control is triggered, as a floating point number greater than or equal to 0\&.

  1089 .RE

  1090 .RE

  1091 .SH "EXAMPLES"

  1092 .PP

  1093 \fBrabbitmqctl stop\fR

  1094 .RS 4

  1095 This command instructs the RabbitMQ node to terminate\&.

  1096 .RE

  1097 .PP

  1098 \fBrabbitmqctl stop_app\fR

  1099 .RS 4

  1100 This command instructs the RabbitMQ node to stop the RabbitMQ application\&.

  1101 .RE

  1102 .PP

  1103 \fBrabbitmqctl start_app\fR

  1104 .RS 4

  1105 This command instructs the RabbitMQ node to start the RabbitMQ application\&.

  1106 .RE

  1107 .PP

  1108 \fBrabbitmqctl wait /var/run/rabbitmq/pid\fR

  1109 .RS 4

  1110 This command will return when the RabbitMQ node has started up\&.

  1111 .RE

  1112 .PP

  1113 \fBrabbitmqctl reset\fR

  1114 .RS 4

  1115 This command resets the RabbitMQ node\&.

  1116 .RE

  1117 .PP

  1118 \fBrabbitmqctl force_reset\fR

  1119 .RS 4

  1120 This command resets the RabbitMQ node\&.

  1121 .RE

  1122 .PP

  1123 \fBrabbitmqctl rotate_logs \&.1\fR

  1124 .RS 4

  1125 This command instructs the RabbitMQ node to append the contents of the log files to files with names consisting of the original logs\' names and "\&.1" suffix, e\&.g\&. rabbit@mymachine\&.log\&.1 and rabbit@mymachine\-sasl\&.log\&.1\&. Finally, logging resumes to fresh files at the old locations\&.

  1126 .RE

  1127 .PP

  1128 \fBrabbitmqctl join_cluster hare@elena \-\-ram\fR

  1129 .RS 4

  1130 This command instructs the RabbitMQ node to join the cluster that

  1131 \fBhare@elena\fR

  1132 is part of, as a ram node\&.

  1133 .RE

  1134 .PP

  1135 \fBrabbitmqctl cluster_status\fR