FreeBSD Manual Pages
RABBITMQCTL(8) System Manager's Manual RABBITMQCTL(8) NAME rabbitmqctl -- tool for managing RabbitMQ nodes SYNOPSIS rabbitmqctl [-q] [-s] [-l] [-n node] [-t timeout] command [command_options] DESCRIPTION RabbitMQ is an open-source multi-protocol messaging broker. rabbitmqctl is the main command line tool for managing a RabbitMQ server node, together with rabbitmq-diagnostics , rabbitmq-upgrade , and others. It performs all actions by connecting to the target RabbitMQ node on a dedicated CLI tool communication port and authenticating using a shared secret (known as the cookie file). Diagnostic information is displayed if the connection failed, the tar- get node was not running, or rabbitmqctl could not authenticate to the target node successfully. To learn more, see the RabbitMQ CLI Tools guide: https://www.rabbitmq.com/docs/cli OPTIONS -n node The default node is "rabbit@target-hostname", where target-hostname is the local host. On a host named "myserver.example.com", the node name will usually be "rabbit@myserver" (unless RABBITMQ_NODENAME has been overrid- den, in which case you'll need to use --longnames ). The output of "hostname -s" is usually the correct hostname to use after the "@" sign. See rabbitmq-server(8) for details of configuring a RabbitMQ node. -q, --quiet Quiet output mode is selected. Informational messages are re- duced when quiet mode is in effect. -s, --silent Silent output mode is selected. Informational messages are re- duced and table headers are suppressed when silent mode is in effect. --no-table-headers Do not output headers for tabular data. --dry-run Do not run the command. Only print informational messages. -t timeout, --timeout timeout Operation timeout in seconds. Not all commands support time- outs. The default is infinity. -l, --longnames Must be specified when the cluster is configured to use long (FQDN) node names. To learn more, see the RabbitMQ Clustering guide: https://www.rabbitmq.com/docs/clustering --erlang-cookie cookie Shared secret to use to authenticate to the target node. Pre- fer using a local file or the RABBITMQ_ERLANG_COOKIE environ- ment variable instead of specifying this option on the command line. To learn more, see the RabbitMQ CLI Tools guide: https://www.rabbitmq.com/docs/cli COMMANDS help [-l] [command_name] Prints usage for all available commands. -l, --list-commands List command usages only, without parameter explana- tion. command_name Prints usage for the specified command. version Displays CLI tools version Nodes await_startup Waits for the RabbitMQ application to start on the target node For example, to wait for the RabbitMQ application to start: rabbitmqctl await_startup reset Returns 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. For example, to reset the RabbitMQ node: rabbitmqctl reset rotate_logs Instructs the RabbitMQ node to perform internal log rotation. Log rotation is performed according to the logging settings specified in the configuration file. The rotation operation is asynchronous, there is no guarantee that it will complete be- fore this command returns. Note that there is no need to call this command in case of ex- ternal log rotation (e.g. from logrotate(8)). For example, to initial log rotation: rabbitmqctl rotate_logs shutdown Shuts down the node, both RabbitMQ and its runtime. The com- mand is blocking and will return after the runtime process ex- its. If RabbitMQ fails to stop, it will return a non-zero exit code. This command infers the OS PID of the target node and therefore can only be used to shut down nodes running on the same host (or broadly speaking, in the same operating system, e.g. in the same VM or container) Unlike the stop command, the shutdown command: • does not require a pid_file to wait for the runtime process to exit • returns a non-zero exit code if the RabbitMQ node is not running For example, this will shut down a local RabbitMQ node running with the default node name: rabbitmqctl shutdown start_app Starts the RabbitMQ application. This command is typically run after performing other management actions that require the RabbitMQ application to be stopped, e.g. reset. For example, to instruct the RabbitMQ node to start the Rab- bitMQ application: rabbitmqctl start_app stop [pid_file] Stops the Erlang node on which RabbitMQ is running. To restart the node follow the instructions for "Running the Server" in the installation guide: https://www.rabbitmq.com/docs/download. If a pid_file is specified, also waits for the process speci- fied there to terminate. See the description of the wait com- mand for details on this file. For example, to instruct the RabbitMQ node to terminate: rabbitmqctl stop stop_app Stops the RabbitMQ application, leaving the runtime (Erlang VM) running. This command is typically run before performing other manage- ment actions that require the RabbitMQ application to be stopped, e.g. reset. For example, to instruct the RabbitMQ node to stop the RabbitMQ application: rabbitmqctl stop_app wait pid_file, wait --pid pid Waits for the RabbitMQ application to start. This command will wait for the RabbitMQ application to start at the node. It will wait for the pid file to be created if pidfile is specified, then for a process with a pid specified in the pid file or the --pid argument, and then for the Rab- bitMQ application to start in that process. It will fail if the process terminates without starting the RabbitMQ applica- tion. If the specified pidfile is not created or the erlang node is not started within --timeout the command will fail. The de- fault timeout is 10 seconds. A suitable pid file is created by the rabbitmq-server(8) script. By default, this is located in the Mnesia directory. Modify the RABBITMQ_PID_FILE environment variable to change the location. For example, this command will return when the RabbitMQ node has started up: rabbitmqctl wait /var/run/rabbitmq/pid Cluster management await_online_nodes count Waits for count nodes to join the cluster For example, to wait for two RabbitMQ nodes to start: rabbitmqctl await_online_nodes 2 change_cluster_node_type type Changes the type of the cluster node. The type must be one of the following: • disc • ram 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. For example, this command will turn a RAM node into a disc node: rabbitmqctl change_cluster_node_type disc cluster_status Displays all the nodes in the cluster grouped by node type, to- gether with the currently running nodes. For example, this command displays the nodes in the cluster: rabbitmqctl cluster_status force_boot Ensures that the node will start next time, even if it was not the last to shut down. Normally when you shut down a RabbitMQ cluster altogether, the first node you restart should be the last one to go down, since it may have seen things happen that other nodes did not. But sometimes that's not possible: for instance, if the entire cluster loses power then all nodes may think they were not the last to shut down. In such a case you can invoke force_boot while the node is down. This will tell the node to unconditionally start the next time you ask it. Any changes to the cluster after this node shut down will be lost. If the last node to go down is permanently lost then you should use forget_cluster_node --offline instead of this command, as it will ensure that mirrored queues whose leader replica was on the lost node get promoted. For example, this will force the node not to wait for other nodes the next time it is started: rabbitmqctl force_boot force_reset (deprecated) Forcefully returns 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. The force_reset command is deprecated. It remains available when the Mnesia metadata store is used. It is unsupported with the Khepri metadata store. For reset and force_reset to succeed the RabbitMQ application must have been stopped, e.g. with stop_app. For example, to reset the RabbitMQ node: rabbitmqctl force_reset forget_cluster_node [--offline] --offline 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 start- ing. It should not be used in any other circumstances since it can lead to inconsistencies. Removes a cluster node remotely. The node that is being re- moved must be offline, while the node we are removing from must be online, except when using the --offline flag. When using the --offline flag , rabbitmqctl will not attempt to connect to a node as normal; instead it will temporarily become the node in order to make the change. This is useful if the node cannot be started normally. In this case, the node will become the canonical source for cluster metadata (e.g. which queues exist), even if it was not before. Therefore you should use this command on the latest node to shut down if at all pos- sible. For example, this command will remove the node "rabbit@stringer" from the node "hare@mcnulty": rabbitmqctl -n hare@mcnulty forget_cluster_node rabbit@stringer join_cluster seed-node [--ram] seed-node Existing cluster member (seed node) to cluster with. --ram If provided, the node will join the cluster as a RAM node. RAM node use is discouraged. Use only if you un- derstand why exactly you need to use them. Instructs 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 suc- ceed the RabbitMQ application must have been stopped, e.g. with stop_app. Cluster nodes can be of two types: disc or RAM. Disc 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 (except for queue contents, which can reside on disk 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, ex- changes, or bindings). A cluster must always have at least one disc node and usually should have more than one. The node will be a disc node by default. If you wish to create a RAM node, provide the --ram flag. After executing the join_cluster 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. To leave a cluster, reset the node. You can also remove nodes remotely with the forget_cluster_node command. For example, this command instructs the RabbitMQ node to join the cluster that "hare@elena" is part of, as a ram node: rabbitmqctl join_cluster hare@elena --ram To learn more, see the RabbitMQ Clustering guide: https://www.rabbitmq.com/docs/clustering. User Management Note that all user management commands rabbitmqctl only can manage users in the internal RabbitMQ database. Users from any alternative authentication backends such as LDAP cannot be in- spected or managed with those commands. rabbitmqctl. 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. For example, this command instructs the RabbitMQ broker to create a (non-administrative) user named "janeway" with (initial) password "changeit": rabbitmqctl add_user janeway changeit authenticate_user username password username The name of the user. password The password of the user. For example, this command instructs the RabbitMQ broker to authenticate the user named "janeway" with the pass- word "verifyit": rabbitmqctl authenticate_user janeway verifyit change_password username newpassword username The name of the user whose password is to be changed. newpassword The new password for the user. For example, this command instructs the RabbitMQ broker to change the password for the user named "janeway" to "newpass": rabbitmqctl change_password janeway newpass clear_password username username The name of the user whose password is to be cleared. For example, this command instructs the RabbitMQ broker to clear the password for the user named "janeway": rabbitmqctl clear_password janeway This user now cannot log in with a password (but may be able to through e.g. SASL EXTERNAL if configured). hash_password plaintext plaintext The plaintext password to hash Hashes a plaintext password according to the currently configured password hashing algorithm delete_user username username The name of the user to delete. For example, this command instructs the RabbitMQ broker to delete the user named "janeway": rabbitmqctl delete_user janeway list_users Lists users. Each result row will contain the user name followed by a list of the tags set for that user. For example, this command instructs the RabbitMQ broker to list all users: rabbitmqctl list_users set_user_tags username [tag ...] username The name of the user whose tags are to be set. tag Zero, one or more tags to set. Any existing tags will be removed. For example, this command instructs the RabbitMQ broker to ensure the user named "janeway" is an administrator: rabbitmqctl set_user_tags janeway administrator This has no effect when the user authenticates using a messaging protocol, but can be used to permit the user to manage users, virtual hosts and permissions when the user logs in via some other means (for example with the management plugin). This command instructs the RabbitMQ broker to remove any tags from the user named "janeway": rabbitmqctl set_user_tags janeway Access control clear_permissions [-p vhost] username vhost 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. For example, this command instructs the RabbitMQ broker to deny the user named "janeway" access to the virtual host called "my-vhost": rabbitmqctl clear_permissions -p my-vhost janeway clear_topic_permissions [-p vhost] username [exchange] vhost The name of the virtual host to which to clear the topic permissions, defaulting to "/". username The name of the user to clear topic permissions to the specified virtual host. exchange The name of the topic exchange to clear topic permissions, defaulting to all the topic ex- changes the given user has topic permissions for. Clear user topic permissions. For example, this command instructs the RabbitMQ broker to remove topic permissions for the user named "janeway" for the topic exchange "amq.topic" in the virtual host called "my-vhost": rabbitmqctl clear_topic_permissions -p my-vhost janeway amq.topic list_permissions [-p vhost] vhost 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. For example, this command instructs the RabbitMQ broker to list all the users who have been granted access to the virtual host called "my-vhost", and the permissions they have for operations on resources in that virtual host. Note that an empty string means no permissions are granted: rabbitmqctl list_permissions -p my-vhost list_topic_permissions [-p vhost] vhost The name of the virtual host for which to list the user's topic permissions. Defaults to "/". Lists topic permissions in a virtual host. For example, this command instructs the RabbitMQ broker to list all the users who have been granted topic per- missions in the virtual host called "my-vhost:" rabbitmqctl list_topic_permissions -p my-vhost list_user_permissions username username The name of the user for which to list the per- missions. Lists user permissions. For example, this command instructs the RabbitMQ broker to list all the virtual hosts to which the user named "janeway" has been granted access, and the permissions the user has for operations on resources in these vir- tual hosts: rabbitmqctl list_user_permissions janeway list_user_topic_permissions username username The name of the user for which to list the topic permissions. Lists user topic permissions. For example, this command instructs the RabbitMQ broker to list all the virtual hosts to which the user named "janeway" has been granted access, and the topic per- missions the user has in these virtual hosts: rabbitmqctl list_user_topic_permissions janeway list_vhosts [vhostinfoitem ...] Lists virtual hosts. The vhostinfoitem parameter is used to indicate which virtual host information items to include in the re- sults. The column order in the results will match the order of the parameters. vhostinfoitem can take any value from the list that follows: name The name of the virtual host with non-ASCII characters escaped as in C. tracing Whether tracing is enabled for this virtual host. default_queue_type Default queue type for this vhost. description Virtual host description. tags Virtual host tags. cluster_state Virtual host state: nodedown, running, stopped. If no vhostinfoitem s are specified then the vhost name is displayed. For example, this command instructs the RabbitMQ broker to list all virtual hosts: rabbitmqctl list_vhosts name tracing set_permissions [-p vhost] user conf write read vhost The name of the virtual host to which to grant the user access, defaulting to "/". user The name of the user to grant access to the specified virtual host. conf A regular expression matching resource names for which the user is granted configure permis- sions. write A regular expression matching resource names for which the user is granted write permis- sions. read A regular expression matching resource names for which the user is granted read permissions. Sets user permissions. For example, this command instructs the RabbitMQ broker to grant the user named "janeway" access to the virtual host called "my-vhost", with configured permissions on all resources whose names start with "janeway-", and write and read permissions on all resources: rabbitmqctl set_permissions -p my-vhost janeway "^janeway-.*" ".*" ".*" set_permissions_globally username conf write read username The name of the user to grant access to the specified virtual host. conf A regular expression matching resource names for which the user is granted configure permis- sions. write A regular expression matching resource names for which the user is granted write permis- sions. read A regular expression matching resource names for which the user is granted read permissions. Sets user permissions in all vhosts. For example, this command instructs the RabbitMQ broker to grant the user named "janeway" access to all virtual hosts with configure permissions on all resources whose names starts with "janeway-", and write and read per- missions on all resources: rabbitmqctl set_permissions_globally janeway "^janeway-.*" ".*" ".*" set_topic_permissions [-p vhost] user exchange write read vhost The name of the virtual host to which to grant the user access, defaulting to "/". user The name of the user the permissions apply to in the target virtual host. exchange The name of the topic exchange to which the au- thorisation check will be applied. write A regular expression matching the routing key of the published message. read A regular expression matching the routing key of the consumed message. Sets user topic permissions. For example, this command instructs the RabbitMQ broker to let the user named "janeway" publish and consume messages going through the "amp.topic" exchange of the "my-vhost" virtual host with a routing key starting with "janeway-": rabbitmqctl set_topic_permissions -p my-vhost janeway amq.topic "^janeway-.*" "^janeway-.*" Topic permissions support variable expansion for the following variables: username, vhost, and client_id. Note that client_id is expanded only when using MQTT. The previous example could be made more generic by us- ing "^{username}-.*": rabbitmqctl set_topic_permissions -p my-vhost janeway amq.topic "^{username}-.*" "^{username}-.*" Monitoring, observability and health checks environment Displays the name and value of each variable in the ap- plication environment for each running application. list_bindings [-p vhost] [bindinginfoitem ...] Returns binding details. By default, the bindings for the "/" virtual host are returned. The -p flag can be used to override this default. The bindinginfoitem 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. bindinginfoitem can take any value from the list that follows: source_name The name of the source of messages to which the binding is attached. With non-ASCII characters escaped as in C. source_kind The kind of the source of messages to which the binding is attached. Currently always ex- change. With non-ASCII characters escaped as in C. destination_name The name of the destination of messages to which the binding is attached. With non-ASCII characters escaped as in C. destination_kind The kind of destination of messages to which the binding is attached. With non-ASCII char- acters escaped as in C. routing_key The binding's routing key with non-ASCII char- acters escaped as in C. arguments The binding's arguments. If no bindinginfoitem s are specified then all the above items are displayed. For example, this command displays the exchange name and queue name of the bindings in the virtual host named "my-vhost" rabbitmqctl list_bindings -p my-vhost exchange_name queue_name list_channels [channelinfoitem ...] Returns information on all current channels, the logi- cal containers executing most AMQP commands. This in- cludes channels that are part of ordinary AMQP connec- tions 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. name Readable name for the channel. number The number of the channel uniquely identifying it within a connection. user The username associated with the channel. vhost Virtual host in which the channel operates. transactional True if the channel is in transactional mode, false otherwise. confirm True if the channel is in confirm mode, false otherwise. consumer_count The number of logical AMQP consumers retrieving messages via the channel. messages_unacknowledged The number of messages delivered via this chan- nel but not yet acknowledged. messages_uncommitted The number of messages received in an as-yet uncommitted transaction. acks_uncommitted The number of acknowledgements received in an as-yet uncommitted transaction. messages_unconfirmed The number of not yet confirmed published mes- sages. On channels not in confirm mode, this remains 0. prefetch_count QoS prefetch limit for new consumers, 0 if un- limited. If no channelinfoitem s are specified then pid, user, consumer_count, and messages_unacknowledged are as- sumed. For example, this command displays the connection process and count of unacknowledged messages for each channel: rabbitmqctl list_channels connection messages_unacknowledged list_ciphers Lists cipher suites supported by encoding commands. For example, this command instructs the RabbitMQ broker to list all cipher suites supported by encoding com- mands: rabbitmqctl list_ciphers 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. name Readable name for the connection. port Server port. host Server hostname obtained via reverse DNS, or its IP address if reverse DNS failed or was turned off. peer_port Peer port. peer_host Peer hostname obtained via reverse DNS, or its IP address if reverse DNS failed or was not en- abled. ssl Boolean indicating whether the connection is secured with SSL. ssl_protocol SSL protocol (e.g. "tlsv1"). ssl_key_exchange SSL key exchange algorithm (e.g. "rsa"). ssl_cipher SSL cipher algorithm (e.g. "aes_256_cbc"). ssl_hash SSL hash function (e.g. "sha"). peer_cert_subject The subject of the peer's SSL certificate in RFC4514 form. peer_cert_issuer The issuer of the peer's SSL certificate, in RFC4514 form. peer_cert_validity The period for which the peer's SSL certificate is valid. state Connection state; one of: • starting • tuning • opening • running • flow • blocking • blocked • closing • closed channels The number of channels using the connection. protocol The version of the AMQP protocol in use -- cur- rently one of: • {0,9,1} • {0,8,0} Note that if a client requests an AMQP 0-9 con- nection, we treat it as AMQP 0-9-1. auth_mechanism SASL authentication mechanism used, such as "PLAIN". user The username associated with the connection. vhost Virtual hostname with non-ASCII characters es- caped as in C. timeout Connection timeout / negotiated heartbeat in- terval, in seconds. frame_max Maximum frame size (bytes). channel_max Maximum number of channels on this connection. 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. connected_at Date and time this connection was established, as a timestamp. If no connectioninfoitem s are specified then user, peer host, peer port, time since flow control, and mem- ory block state are displayed. For example, this command displays the send queue size and server port for each connection: rabbitmqctl list_connections send_pend port list_consumers [-p vhost] Lists consumers, i.e. subscriptions to a queue's mes- sage 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, a boolean indicating whether acknowledgements are expected for messages delivered to this consumer, an integer indi- cating the prefetch limit (with 0 meaning "none"), and any arguments for this consumer. list_exchanges [-p vhost] [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 re- sults. 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 charac- ters escaped as in C. type The exchange type, such as: • direct • topic • headers • fanout durable Whether or not the exchange survives server restarts. auto_delete Whether the exchange will be deleted automati- cally when no longer used. internal Whether the exchange is internal, i.e. clients cannot publish to it directly. arguments Exchange arguments. policy Policy name for applying to the exchange. If no exchangeinfoitem s are specified then exchange name and type are displayed. For example, this command displays the name and type for each exchange of the virtual host named "my-vhost": rabbitmqctl list_exchanges -p my-vhost name type list_hashes Lists hash functions supported by encoding commands. For example, this command instructs the RabbitMQ broker to list all hash functions supported by encoding com- mands: rabbitmqctl list_hashes list_queues [-p vhost] [--offline | --online | --local] [queueinfoitem ...] Returns queue details. Queue details of the "/" vir- tual host are returned if the -p flag is absent. The -p flag can be used to override this default. Displayed queues can be filtered by their status or lo- cation using one of the following mutually exclusive options: --offline List only those durable queues that are not currently available (more specifically, their leader node isn't). --online List queues that are currently available (their leader node is). --local List only those queues whose leader replica is located on the current node. 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 escaped as in C. 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. policy Name of the user policy that is applied to the queue. operator_policy Name of the operator policy that is applied to the queue. effective_policy_definition Effective policy definition for the queue: both user and operator policy definitions merged. pid Erlang process identifier of the queue. owner_pid Id of the Erlang process of the connection which is the exclusive owner of the queue. Empty if the queue is non-exclusive. exclusive True if the queue is exclusive (i.e. has owner_pid), false otherwise. exclusive_consumer_pid Id of the Erlang process representing the chan- nel of the exclusive consumer subscribed to this queue. Empty if there is no exclusive consumer. exclusive_consumer_tag The consumer tag of the exclusive consumer sub- scribed to this queue. Empty if there is no exclusive consumer. messages_ready The number of messages ready to be delivered to clients. messages_unacknowledged The number of messages delivered to clients but not yet acknowledged. messages The sum of ready and unacknowledged messages (queue depth). messages_ready_ram The number of messages from messages_ready which are resident in ram. messages_unacknowledged_ram The number of messages from messages_unacknowl- edged which are resident in ram. messages_ram Total number of messages which are resident in ram. messages_persistent Total number of persistent messages in the queue (will always be 0 for transient queues). message_bytes The sum of the size of all message bodies in the queue. This does not include the message properties (including headers) or any overhead. message_bytes_ready Like message_bytes but counting only those mes- sages ready to be delivered to clients. message_bytes_unacknowledged Like message_bytes but counting only those mes- sages delivered to clients but not yet acknowl- edged. message_bytes_ram Like message_bytes but counting only those mes- sages that are currently held in RAM. message_bytes_persistent Like message_bytes but counting only those mes- sages which are persistent. head_message_timestamp The timestamp property of the first message in the queue, if present. Timestamps of messages only appear when they are in the paged-in state. disk_reads Total number of times messages have been read from disk by this queue since it started. disk_writes Total number of times messages have been writ- ten to disk by this queue since it started. consumers The number of consumers. consumer_utilisation Fraction of the time (between 0.0 and 1.0) that the queue is able to immediately deliver mes- sages to consumers. This can be less than 1.0 if consumers are limited by network congestion or prefetch count. memory Bytes of memory allocated by the runtime for the queue, including stack, heap, and internal structures. mirror_pids If the queue is mirrored, this lists the IDs of the mirrors (follower replicas). To learn more, see the RabbitMQ Mirroring guide: https://www.rabbitmq.com/docs/3.13/ha synchronised_mirror_pids If the queue is mirrored, this gives the IDs of the mirrors (follower replicas) which are in sync with the leader replica. To learn more, see the RabbitMQ Mirroring guide: https://www.rabbitmq.com/docs/3.13/ha state The state of the queue. Normally "running", but may be "{syncing, message_count}" if the queue is synchronising. Queues that are located on cluster nodes that are currently down will be shown with a status of "down" (and most other queueinfoitem will be unavailable). type Queue type, one of: quorum, stream, classic. If no queueinfoitem s are specified then queue name and depth are displayed. For example, this command displays the depth and number of consumers for each queue of the virtual host named "my-vhost" rabbitmqctl list_queues -p my-vhost messages consumers list_unresponsive_queues [--local] [--queue-timeout milliseconds] [queueinfoitem ...] [--no-table-headers] Tests queue leader replicas to respond within the given timeout. Lists those that did not respond in time. Displayed queues can be filtered by their status or lo- cation using one of the following mutually exclusive options: --all List all queues. --local List only those queues whose leader replica is located on the current node. 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 escaped as in C. durable Whether or not the queue should survive server restarts. auto_delete Whether the queue will be deleted automatically when all of its explicit bindings are deleted. arguments Queue arguments. policy Effective policy name for the queue. pid Erlang process identifier of the leader replica. recoverable_mirrors Erlang process identifiers of the mirror repli- cas that are considered reachable (available). type Queue type, one of: quorum, stream, classic. For example, this command lists only those unresponsive queues whose leader replica is hosted on the target node. rabbitmqctl list_unresponsive_queues --local name ping Checks that the node OS process is up, registered with EPMD, and CLI tools can authenticate with it Example: rabbitmqctl ping -n rabbit@hostname report Generate a server status report containing a concatena- tion of all server status information for support pur- poses. The output should be redirected to a file when accompanying a support request. For example, this command creates a server report which may be attached to a support request email: rabbitmqctl report > server_report.txt schema_info [--no-table-headers] [column ...] Lists schema database tables and their properties For example, this command lists the table names and their active replicas: rabbitmqctl schema_info name active_replicas status Displays broker status information such as the running applications on the current Erlang node, RabbitMQ and Erlang versions, OS name, and memory and file descrip- tor statistics. (See the cluster_status command to find out which nodes are clustered and running.) For example, this command displays information about the RabbitMQ broker: rabbitmqctl status Runtime Parameters and Policies Certain features of RabbitMQ (such as the Federation plugin) are controlled by dynamic, cluster-wide parameters. There are 2 kinds of parameters: parameters scoped to a virtual host and global parameters. Each vhost-scoped parameter consists of a component name, a name, and a value. The component name and name are strings, and the value is a valid JSON document. A global parameter consists of a name and value. The name is a string and the value is an arbitrary Erlang data structure. 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. Policies is a feature built on top of runtime parameters. 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. clear_global_parameter name Clears a global runtime parameter. This is similar to clear_parameter but the key-value pair isn't tied to a virtual host. name The name of the global runtime parameter being cleared. For example, this command clears the global runtime pa- rameter "mqtt_default_vhosts": rabbitmqctl clear_global_parameter mqtt_default_vhosts clear_parameter [-p vhost] component_name key Clears a parameter. component_name The name of the component for which the parame- ter is being cleared. name The name of the parameter being cleared. For example, this command clears the parameter "node01" for the "federation-upstream" component in the default virtual host: rabbitmqctl clear_parameter federation-upstream node01 list_global_parameters Lists all global runtime parameters. This is similar to list_parameters but the global runtime parameters are not tied to any virtual host. For example, this command lists all global parameters: rabbitmqctl list_global_parameters list_parameters [-p vhost] Lists all parameters for a virtual host. For example, this command lists all parameters in the default virtual host: rabbitmqctl list_parameters set_global_parameter name value Sets a global runtime parameter. This is similar to set_parameter but the key-value pair isn't tied to a virtual host. name The name of the global runtime parameter being set. value The value for the global runtime parameter, as a JSON document. In most shells you are very likely to need to quote this. For example, this command sets the global runtime para- meter "mqtt_default_vhosts" to the JSON document {"O=client,CN=guest":"/"}: rabbitmqctl set_global_parameter mqtt_default_vhosts '{"O=client,CN=guest":"/"}' set_parameter [-p vhost] component_name name value Sets a parameter. component_name The name of the component for which the parame- ter is being set. name The name of the parameter being set. value The value for the parameter, as a JSON docu- ment. In most shells you are very likely to need to quote this. For example, this command sets the parameter "node01" for the "federation-upstream" component in the default virtual host to the following JSON "guest": rabbitmqctl set_parameter federation-upstream node01 '{"uri":"amqp://user:password@server/%2F","ack-mode":"on-publish"}' list_policies [-p vhost] Lists all policies for a virtual host. For example, this command lists all policies in the de- fault virtual host: rabbitmqctl list_policies set_operator_policy [-p vhost] [--priority priority] [--apply-to apply-to] name pattern definition Sets an operator policy that overrides a subset of ar- guments in user policies. Arguments are identical to those of set_policy. Supported arguments are: • expires • message-ttl • max-length • max-length-bytes set_policy [-p vhost] [--priority priority] [--apply-to apply-to] name pattern definition Sets a policy. name The name of the policy. pattern The regular expression allows the policy to ap- ply if it matches a resource name. definition The definition of the policy, as a JSON docu- ment. In most shells you are very likely to need to quote this. priority The priority of the policy as an integer. Higher numbers indicate greater precedence. The default is 0. apply-to Which types of objects this policy should apply to. Possible values are: • queues (all queue types, including streams) • classic_queues (classic queues only) • quorum_queues (quorum queues only) • streams (streams only) • exchanges • all The default is all. For example, this command sets the policy "federate-me" in the default virtual host so that built-in exchanges are federated: rabbitmqctl set_policy federate-me ^amq. '{"federation-upstream-set":"all"}' clear_policy [-p vhost] name Clears a policy. name The name of the policy being cleared. For example, this command clears the "federate-me" pol- icy in the default virtual host: rabbitmqctl clear_policy federate-me clear_operator_policy [-p vhost] name Clears an operator policy. Arguments are identical to those of clear_policy. list_operator_policies [-p vhost] Lists operator policy overrides for a virtual host. Arguments are identical to those of list_policies. Virtual hosts Note that rabbitmqctl manages the RabbitMQ internal user data- base. Permissions for users from any alternative authorisation backend will not be visible to rabbitmqctl. add_vhost vhost [--description desc --tags tags --default-queue-type default-q-type] vhost The name of the virtual host entry to create. desc Arbitrary virtual host description, e.g. its purpose, for the operator's convenience. tags A comma-separated list of virtual host tags for the operator's convenience. default-q-type If clients do not specify queue type explic- itly, this type will be used. One of: quorum, stream. Creates a virtual host. For example, this command instructs the RabbitMQ broker to create a new virtual host called "project9_dev_18": rabbitmqctl add_vhost project9_dev_18 --description 'Dev environment no. 18' --tags dev,project9 clear_vhost_limits [-p vhost] Clears virtual host limits. For example, this command clears vhost limits in vhost "qa_env": rabbitmqctl clear_vhost_limits -p qa_env delete_vhost vhost vhost The name of the virtual host entry to delete. Deletes a virtual host. Deleting a virtual host deletes all its exchanges, queues, bindings, user permissions, parameters, and policies. For example, this command instructs the RabbitMQ broker to delete the virtual host called "test": rabbitmqctl delete_vhost a-vhost list_vhost_limits [-p vhost] [--global] [--no-table-headers] Displays configured virtual host limits. --global Show limits for all vhosts. Suppresses the -p parameter. restart_vhost [-p vhost] vhost The name of the virtual host entry to restart, defaulting to "/". Restarts a failed vhost data stores and queues. For example, this command instructs the RabbitMQ broker to restart a virtual host called "test": rabbitmqctl restart_vhost test set_vhost_limits [-p vhost] definition Sets virtual host limits. definition The definition of the limits, as a JSON docu- ment. In most shells you are very likely to need to quote this. Recognised limits are: • max-connections • max-queues Use a negative value to specify "no limit". For example, this command limits the maximum number of concurrent connections in vhost "qa_env" to 64: rabbitmqctl set_vhost_limits -p qa_env '{"max-connections": 64}' This command limits the maximum number of queues in vhost "qa_env" to 256: rabbitmqctl set_vhost_limits -p qa_env '{"max-queues": 256}' This command clears the maximum number of connections limit in vhost "qa_env": rabbitmqctl set_vhost_limits -p qa_env '{"max-connections": -1}' This command disables client connections in vhost "qa_env": rabbitmqctl set_vhost_limits -p qa_env '{"max-connections": 0}' ] username ] definition set_user_limits Sets user limits. username The name of the user to apply limits to definition The definition of the limits, as a JSON docu- ment. In most shells you are very likely to need to quote this. Recognised limits are: • max-connections • max-channels Use a negative value to specify "no limit". For example, this command limits the maximum number of concurrent connections a user is allowed to open "limited_user" to 64: rabbitmqctl set_user_limits limited_user '{"max-connections": 64}' This command limits the maximum number of channels a user is allowed to open on a connection "limited_user" to 16: rabbitmqctl set_user_limits limited_user '{"max-channels": 16}' This command clears the maximum number of connections limit for user "limited_user": rabbitmqctl clear_user_limits limited_user 'max-connections' This command disables client connections for user "limited_user": rabbitmqctl set_user_limits limited_user '{"max-connections": 0}' ] username ] limit clear_user_limits Clears user limits. username The name of the user to clear the limits of limit The name of the limit or "all" to clear all limits at once. Recognised limits are: • max-connections • max-channels For example, this command clears the maximum connection limits of user "limited_user": rabbitmqctl clear_user_limits limited_user 'max-connections' This command clears all limits of user "limited_user": rabbitmqctl clear_user_limits limited_user all trace_off [-p vhost] vhost The name of the virtual host for which to stop tracing. Stops tracing. trace_on [-p vhost] vhost The name of the virtual host for which to start tracing. Starts tracing. Note that the trace state is not per- sistent; it will revert to being off if the node is restarted. Configuration decode value passphrase [--cipher cipher] [--hash hash] [--iterations iterations] value passphrase Value to decrypt (as produced by the encode command) and passphrase. For example: rabbitmqctl decode '{encrypted, <<"...">>}' mypassphrase --cipher cipher --hash hash --iterations iterations Options to specify the decryption settings. They can be used independently. For example: rabbitmqctl decode --cipher blowfish_cfb64 --hash sha256 --iterations 10000 '{encrypted,<<"...">>} mypassphrase encode value passphrase [--cipher cipher] [--hash hash] [--iterations iterations] value passphrase Value to encrypt and passphrase. For example: rabbitmqctl encode '<<"guest">>' mypassphrase --cipher cipher --hash hash --iterations iterations Options to specify the encryption settings. They can be used independently. For example: rabbitmqctl encode --cipher blowfish_cfb64 --hash sha256 --iterations 10000 '<<"guest">>' mypassphrase set_cluster_name name Sets the cluster name to name. The cluster name is an- nounced to clients on connection, and used by the fed- eration and shovel plugins to record where a message has been. The cluster name is by default derived from the hostname of the first node in the cluster but can be changed. For example, this sets the cluster name to "london": rabbitmqctl set_cluster_name london set_disk_free_limit disk_limit disk_limit Lower bound limit as an integer in bytes or a string with a memory unit symbol (see vm_mem- ory_high_watermark), e.g. 512M or 1G. Once free disk space reaches the limit, a disk alarm will be set. set_disk_free_limit mem_relative fraction fraction Limit relative to the total amount available RAM as a non-negative floating point number. Values lower than 1.0 can be dangerous and should be used carefully. set_log_level [log_level] Sets log level in the running node Supported log_level values are: • debug • info • warning • error • critical • none Example: rabbitmqctl set_log_level debug set_vm_memory_high_watermark fraction fraction The new memory threshold fraction at which flow control is triggered, as a floating point num- ber greater than or equal to 0. set_vm_memory_high_watermark [absolute] memory_limit memory_limit The new memory limit at which flow control is triggered, expressed in bytes as an integer number greater than or equal to 0 or as a string with memory unit symbol(e.g. 512M or 1G). Available unit symbols are: k, kiB kibibytes (2^10 bytes) M, MiB mebibytes (2^20 bytes) G, GiB gibibytes (2^30 bytes) kB kilobytes (10^3 bytes) MB megabytes (10^6 bytes) GB gigabytes (10^9 bytes) Feature flags enable_feature_flag feature_flag Enables a feature flag on the target node. Example: rabbitmqctl enable_feature_flag restart_streams You can also enable all feature flags by specifying "all": rabbitmqctl enable_feature_flag all list_feature_flags [column ...] Lists feature flags Supported column values are: • name • state • stability • provided_by • desc • doc_url Example: rabbitmqctl list_feature_flags name state Connection Operations close_all_connections [-p vhost] [--global] [--per-connection-delay delay] [--limit limit] explanation -p vhost The name of the virtual host for which connec- tions should be closed. Ignored when --global is specified. --global If connections should be closed for all vhosts. Overrides -p --per-connection-delay delay Time in milliseconds to wait after each connec- tion closing. --limit limit The number of connections to close. Only works per vhost. Ignored when --global is specified. explanation Explanation string. Instructs the broker to close all connections for the specified vhost or entire RabbitMQ node. For example, this command instructs the RabbitMQ broker to close 10 connections on "qa_env" vhost, passing the explanation "Please close": rabbitmqctl close_all_connections -p qa_env --limit 10 'Please close' This command instructs broker to close all connections to the node: rabbitmqctl close_all_connections --global close_connection connectionpid explanation connectionpid Id of the Erlang process associated with the connection to close. explanation Explanation string. Instructs 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 con- nection shutdown protocol. For example, this command instructs the RabbitMQ broker to close the connection associated with the Erlang process id "<rabbit@tanto.4262.0>", passing the expla- nation "go away" to the connected client: rabbitmqctl close_connection "<rabbit@tanto.4262.0>" "go away" Misc eval expression Evaluates an Erlang expression on the target node Queue Operations delete_queue queue_name [--if-empty | -e] [--if-unused | -u] queue_name The name of the queue to delete. --if-empty Delete the queue if it is empty (has no messages ready for delivery) --if-unused Delete the queue only if it has no con- sumers Deletes a queue. purge_queue [-p vhost] queue queue The name of the queue to purge. Purges a queue (removes all messages in it). PLUGIN COMMANDS RabbitMQ plugins can extend the rabbitmqctl tool to add new commands when enabled. Currently available commands can be found in the rabbitmqctl help output. The following commands are added by RabbitMQ plugins, available in the default distribution: Shovel plugin shovel_status Prints a list of configured Shovels delete_shovel [-p vhost] name Instructs the RabbitMQ node to delete the configured shovel by name. Federation plugin federation_status [--only-down] Prints a list of federation links. --only-down Only list federation links that are not running. restart_federation_link link_id Instructs the RabbitMQ node to restart the federation link with the specified link_id. AMQP 1.0 plugin list_amqp10_connections [amqp10_connectioninfoitem ...] Similar to the list_connections command, but returns fields that make sense for AMQP-1.0 connections. amqp10_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 parame- ters. amqp10_connectioninfoitem can take any value from the list that follows: pid Id of the Erlang process associated with the connec- tion. auth_mechanism SASL authentication mechanism used, such as "PLAIN". host Server hostname obtained via reverse DNS, or its IP ad- dress if reverse DNS failed or was turned off. frame_max Maximum frame size (bytes). timeout Connection timeout / negotiated heartbeat interval, in seconds. user Username associated with the connection. state Connection state; one of: • starting • waiting_amqp0100 • securing • running • blocking • blocked • closing • closed recv_oct Octets received. recv_cnt Packets received. send_oct Octets send. send_cnt Packets sent. ssl Boolean indicating whether the connection is secured with SSL. ssl_protocol SSL protocol (e.g. "tlsv1"). ssl_key_exchange SSL key exchange algorithm (e.g. "rsa"). ssl_cipher SSL cipher algorithm (e.g. "aes_256_cbc"). ssl_hash SSL hash function (e.g. "sha"). peer_cert_subject The subject of the peer's SSL certificate, in RFC4514 form. peer_cert_issuer The issuer of the peer's SSL certificate, in RFC4514 form. peer_cert_validity The period for which the peer's SSL certificate is valid. node The node name of the RabbitMQ node to which the connec- tion is established. MQTT plugin list_mqtt_connections [mqtt_connectioninfoitem] Similar to the list_connections command, but returns fields that make sense for MQTT connections. mqtt_connectioninfoitem parameter is used to indicate which connection information items to include in the results. The column order in the re- sults will match the order of the parameters. mqtt_connectioninfoitem can take any value from the list that follows: host Server hostname obtained via reverse DNS, or its IP ad- dress if reverse DNS failed or was turned off. port Server port. peer_host Peer hostname obtained via reverse DNS, or its IP ad- dress if reverse DNS failed or was not enabled. peer_port Peer port. protocol MQTT protocol version, which can be one of the follow- ing: • {'MQTT', N/A} • {'MQTT', 3.1.0} • {'MQTT', 3.1.1} channels The number of channels using the connection. channel_max Maximum number of channels on this connection. frame_max Maximum frame size (bytes). client_properties Informational properties transmitted by the client dur- ing connection establishment. ssl Boolean indicating whether the connection is secured with SSL. ssl_protocol SSL protocol (e.g. "tlsv1"). ssl_key_exchange SSL key exchange algorithm (e.g. "rsa"). ssl_cipher SSL cipher algorithm (e.g. "aes_256_cbc"). ssl_hash SSL hash function (e.g. "sha"). conn_name Readable name for the connection. connection_state Connection state; one of: • starting • running • blocked connection Id of the Erlang process associated with the internal amqp direct connection. consumer_tags A tuple of consumer tags for QOS0 and QOS1. message_id The last Packet ID sent in a control message. client_id MQTT client identifier for the connection. clean_sess MQTT clean session flag. will_msg MQTT Will message sent in CONNECT frame. exchange Exchange to route MQTT messages configured in rab- bitmq_mqtt application environment. ssl_login_name SSL peer cert auth name retainer_pid Id of the Erlang process associated with retain storage for the connection. user Username associated with the connection. vhost Virtual host name with non-ASCII characters escaped as in C. decommission_mqtt_node Before the plugin is disabled on a node, or a node removed from the cluster, it must be decommissioned. For example, this command will remove the node rabbit@stringer: rabbitmqctl decommission_mqtt_node rabbit@stringer STOMP plugin list_stomp_connections [stomp_connectioninfoitem] Similar to the list_connections command, but returns fields that make sense for STOMP connections. stomp_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 parame- ters. stomp_connectioninfoitem can take any value from the list that follows: conn_name Readable name for the connection. connection Id of the Erlang process associated with the internal amqp direct connection. connection_state Connection state; one of: • running • blocking • blocked session_id STOMP protocol session identifier channel AMQP channel associated with the connection version Negotiated STOMP protocol version for the connection. implicit_connect Indicates if the connection was established using im- plicit connect (without CONNECT frame) auth_login Effective username for the connection. auth_mechanism STOMP authorization mechanism. Can be one of: • config • ssl • stomp_headers port Server port. host Server hostname obtained via reverse DNS, or its IP ad- dress if reverse DNS failed or was not enabled. peer_port Peer port. peer_host Peer hostname obtained via reverse DNS, or its IP ad- dress if reverse DNS failed or was not enabled. protocol STOMP protocol version, which can be one of the follow- ing: • {'STOMP', 0} • {'STOMP', 1} • {'STOMP', 2} channels The number of channels using the connection. channel_max Maximum number of channels on this connection. frame_max Maximum frame size (bytes). client_properties Informational properties transmitted by the client dur- ing connection ssl Boolean indicating whether the connection is secured with SSL. ssl_protocol TLS protocol (e.g. "tlsv1"). ssl_key_exchange TLS key exchange algorithm (e.g. "rsa"). ssl_cipher TLS cipher algorithm (e.g. "aes_256_cbc"). ssl_hash SSL hash function (e.g. "sha"). Management agent plugin reset_stats_db [--all] Reset the management stats database for the RabbitMQ node. --all Reset the stats database for all nodes in the cluster. SEE ALSO rabbitmq-diagnostics(8), rabbitmq-plugins(8), rabbitmq-server(8), rabbitmq-queues(8), rabbitmq-streams(8), rabbitmq-upgrade(8), rabbitmq-service(8), rabbitmq-env.conf(5), rabbitmq-echopid(8) AUTHOR The RabbitMQ Team <contact-tanzu-data.pdl@broadcom.com> RabbitMQ Server June 22, 2023 RABBITMQCTL(8)
NAME | SYNOPSIS | DESCRIPTION | OPTIONS | COMMANDS | PLUGIN COMMANDS | SEE ALSO | AUTHOR
Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=rabbitmqctl&sektion=8&manpath=FreeBSD+Ports+14.3.quarterly>