diff options
Diffstat (limited to 'docs/rabbitmqctl.1.pod')
| -rw-r--r-- | docs/rabbitmqctl.1.pod | 390 |
1 files changed, 235 insertions, 155 deletions
diff --git a/docs/rabbitmqctl.1.pod b/docs/rabbitmqctl.1.pod index 58fbb100c8..ae3809adce 100644 --- a/docs/rabbitmqctl.1.pod +++ b/docs/rabbitmqctl.1.pod @@ -18,58 +18,69 @@ It performs all actions by connecting to one of the broker's nodes. =head1 OPTIONS -B<-n> I<node> - default node is C<rabbit@server>, where server is the local host. -On a host named C<server.example.com>, the node name of the RabbitMQ +=over + +=item B<-n> I<node> + +Default node is C<rabbit@server>, where server is the local host. On +a host named C<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. -B<-q> - quiet output mode is selected with the B<-q> flag. Informational +=item B<-q> + +Quiet output mode is selected with the B<-q> flag. Informational messages are suppressed when quiet mode is in effect. +=back + =head1 COMMANDS =head2 APPLICATION AND CLUSTER MANAGEMENT -stop - stop the Erlang node on which RabbitMQ broker is running. - -stop_app - stop 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. I<reset>. - -start_app - start the RabbitMQ application. - This command is typically run prior to performing other management -actions that require the RabbitMQ application to be stopped, -e.g. I<reset>. - -status - display 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, vhosts and -deletes all persistent messages. - -force_reset - the same as I<reset> command, but resets the node unconditionally, +=over + +=item stop + +Stop the Erlang node on which RabbitMQ broker is running. + +=item stop_app + +Stop 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. I<reset>. + +=item start_app + +Start the RabbitMQ application. This command is typically run prior +to performing other management actions that require the RabbitMQ +application to be stopped, e.g. I<reset>. + +=item status + +Display 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. + +=item 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, vhosts and deletes all persistent messages. + +=item force_reset + +The same as I<reset> command, but 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. +configuration. It should only be used as a last resort if the +database or cluster configuration has been corrupted. -rotate_logs [suffix] - instruct the RabbitMQ node to rotate the log files. The RabbitMQ +=item 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 the name composed of the original name and the suffix. It will create a new file if such a file does not already @@ -77,200 +88,269 @@ exist. When no I<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 I<suffix> was specified. - This command might be helpful when you are e.g. writing your own +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 I<clusternode> ... - instruct the node to become member of a cluster with the specified +=item cluster I<clusternode> ... + +Instruct the node to become member of a cluster with the specified nodes determined by I<clusternode> option(s). See -http://www.rabbitmq.com/clustering.html for more information about +L<http://www.rabbitmq.com/clustering.html> for more information about clustering. +=back + =head2 USER MANAGEMENT -add_user I<username> I<password> - create a user named I<username> with (initial) password I<password>. +=over + +=item add_user I<username> I<password> -delete_user I<username> - delete the user named I<username>. +Create a user named I<username> with (initial) password I<password>. -change_password I<username> I<newpassword> - change the password for the user named I<username> to I<newpassword>. +=item delete_user I<username> -list_users - list all users. +Delete the user named I<username>. + +=item change_password I<username> I<newpassword> + +Change the password for the user named I<username> to I<newpassword>. + +=item list_users + +List all users. + +=back =head2 ACCESS CONTROL -add_vhost I<vhostpath> - create a new virtual host called I<vhostpath>. +=over + +=item add_vhost I<vhostpath> + +Create a new virtual host called I<vhostpath>. + +=item delete_vhost I<vhostpath> + +Delete a virtual host I<vhostpath>. This command deletes also all its +exchanges, queues and user mappings. + +=item list_vhosts -delete_vhost I<vhostpath> - delete a virtual host I<vhostpath>. - That command deletes also all its exchanges, queues and user -mappings. - -list_vhosts - list all virtual hosts. +List all virtual hosts. -set_permissions [-p I<vhostpath>] I<username> I<regexp> I<regexp> I<regexp> - set the permissions for the user named I<username> in the virtual -host I<vhostpath>, granting 'configure', 'write' and 'read' access to +=item set_permissions [-p I<vhostpath>] I<username> I<regexp> I<regexp> I<regexp> + +Set the permissions for the user named I<username> in the virtual host +I<vhostpath>, granting 'configure', 'write' and 'read' access to resources with names matching the first, second and third I<regexp>, respectively. -clear_permissions [-p I<vhostpath>] I<username> - remove the permissions for the user named I<username> in the -virtual host I<vhostpath>. +=item clear_permissions [-p I<vhostpath>] I<username> + +Remove the permissions for the user named I<username> in the virtual +host I<vhostpath>. + +=item list_permissions [-p I<vhostpath>] -list_permissions [-p I<vhostpath>] - list all the users and their permissions in the virtual host +List all the users and their permissions in the virtual host I<vhostpath>. -list_user_permissions I<username> - list the permissions of the user named I<username> across all -virtual hosts. +=item list_user_permissions I<username> + +List the permissions of the user named I<username> across all virtual +hosts. + +=back =head2 SERVER STATUS -list_queues [-p I<vhostpath>] [I<queueinfoitem> ...] - list queue information by virtual host. If no I<queueinfoitem>s -are specified then then name and number of messages is displayed for -each queue. +=over + +=item list_queues [-p I<vhostpath>] [I<queueinfoitem> ...] + +List queue information by virtual host. If no I<queueinfoitem>s are +specified then then name and number of messages is displayed for each +queue. + +=back =head3 Queue information items -=over 4 +=over -name - URL-encoded name of the queue +=item name -durable - whether the queue survives server restarts +URL-encoded name of the queue -auto_delete - whether the queue will be deleted when no longer used +=item durable -arguments - queue arguments +whether the queue survives server restarts -node - node on which the process associated with the queue resides +=item auto_delete -messages_ready - number of messages ready to be delivered to clients +whether the queue will be deleted when no longer used -messages_unacknowledged - number of messages delivered to clients but not yet acknowledged +=item arguments -messages_uncommitted - number of messages published in as yet uncommitted transactions +queue arguments -messages - sum of ready, unacknowledged and uncommitted messages +=item node -acks_uncommitted - number of acknowledgements received in as yet uncommitted -transactions +node on which the process associated with the queue resides -consumers - number of consumers +=item messages_ready -transactions - number of transactions +number of messages ready to be delivered to clients -memory - bytes of memory consumed by the Erlang process for the queue, +=item messages_unacknowledged + +number of messages delivered to clients but not yet acknowledged + +=item messages_uncommitted + +number of messages published in as yet uncommitted transactions + +=item messages + +sum of ready, unacknowledged and uncommitted messages + +=item acks_uncommitted + +number of acknowledgements received in as yet uncommitted transactions + +=item consumers + +number of consumers + +=item transactions + +number of transactions + +=item memory + +bytes of memory consumed by the Erlang process for the queue, including stack, heap and internal structures =back -list_exchanges [-p I<vhostpath>] [I<exchangeinfoitem> ...] - list exchange information by virtual host. If no -I<exchangeinfoitem>s are specified then name and type is displayed for -each exchange. +=over + +=item list_exchanges [-p I<vhostpath>] [I<exchangeinfoitem> ...] + +List exchange information by virtual host. If no I<exchangeinfoitem>s +are specified then name and type is displayed for each exchange. + +=back =head3 Exchange information items -=over 4 +=over + +=item name + +URL-encoded name of the exchange + +=item type + +exchange type (B<direct>, B<topic>, B<fanout>, or B<headers>) + +=item durable -name - URL-encoded name of the exchange +whether the exchange survives server restarts -type - exchange type (B<direct>, B<topic>, B<fanout>, or B<headers>) +=item auto_delete -durable - whether the exchange survives server restarts +whether the exchange is deleted when no longer used -auto_delete - whether the exchange is deleted when no longer used +=item arguments -arguments - exchange arguments +exchange arguments =back -list_bindings [-p I<vhostpath>] - list bindings by virtual host. Each line contains exchange name, +=over + +=item list_bindings [-p I<vhostpath>] + +List bindings by virtual host. Each line contains exchange name, routing key and queue name (all URL encoded) and arguments. -list_connections [I<connectioninfoitem> ...] - list connection information. If no I<connectioninfoitem>s are +=item list_connections [I<connectioninfoitem> ...] + +List connection information. If no I<connectioninfoitem>s are specified then the user, peer address and peer port are displayed. +=back + =head3 Connection information items -=over 4 +=over + +=item node + +node on which the process associated with the connection resides + +=item address + +server IP number + +=item port + +server port -node - node on which the process associated with the connection resides +=item peer_address -address - server IP number +peer address -port - server port +=item peer_port -peer_address - peer address +peer port -peer_port - peer port +=item state -state - connection state (B<pre-init>, B<starting>, B<tuning>, B<opening>, +connection state (B<pre-init>, B<starting>, B<tuning>, B<opening>, B<running>, B<closing>, B<closed>) -channels - number of channels using the connection +=item channels + +number of channels using the connection + +=item user + +username associated with the connection + +=item vhost + +URL-encoded virtual host + +=item timeout + +connection timeout + +=item frame_max + +maximum frame size (bytes) + +=item recv_oct -user - username associated with the connection +octets received -vhost - URL-encoded virtual host +=item recv_cnt -timeout - connection timeout +packets received -frame_max - maximum frame size (bytes) +=item send_oct -recv_oct - octets received +octets sent -recv_cnt - packets received +=item send_cnt -send_oct - octets sent +packets sent -send_cnt - packets sent +=item send_pend -send_pend - send queue size +send queue size =back @@ -306,4 +386,4 @@ The RabbitMQ Team <info@rabbitmq.com> =head1 REFERENCES -RabbitMQ Web Site: http://www.rabbitmq.com +RabbitMQ Web Site: L<http://www.rabbitmq.com> |