Merge pull request #2123 from rabbitmq/ctl-diagnostics-docs-update

Man pages: add missing diagnostics and ctl commands

1 files changed, 1259 insertions, 1023 deletions

diff --git a/docs/rabbitmqctl.8 b/docs/rabbitmqctl.8
index 53337d82e9..62b2233472 100644
--- a/docs/rabbitmqctl.8
+++ b/docs/rabbitmqctl.8
@@ -20,9 +20,9 @@
 .Sh NAME
 .Nm rabbitmqctl
 .Nd tool for managing RabbitMQ nodes
-.\" ------------------------------------------------------------------
+.\" ------------------------------------------------------------------------------------------------
 .Sh SYNOPSIS
-.\" ------------------------------------------------------------------
+.\" ------------------------------------------------------------------------------------------------
 .Nm
 .Op Fl q
 .Op Fl s
@@ -31,9 +31,9 @@
 .Op Fl t Ar timeout
 .Ar command
 .Op Ar command_options
-.\" ------------------------------------------------------------------
+.\" ------------------------------------------------------------------------------------------------
 .Sh DESCRIPTION
-.\" ------------------------------------------------------------------
+.\" ------------------------------------------------------------------------------------------------
 RabbitMQ is an open source multi-protocol messaging broker.
 .Pp
 .Nm
@@ -51,9 +51,9 @@ To learn more, see the
 .Lk https://www.rabbitmq.com/cli.html "RabbitMQ CLI Tools guide"
 and
 .Lk https://www.rabbitmq.com/networking.html "RabbitMQ Networking guide"
-.\" ------------------------------------------------------------------
+.\" ------------------------------------------------------------------------------------------------
 .Sh OPTIONS
-.\" ------------------------------------------------------------------
+.\" ------------------------------------------------------------------------------------------------
 .Bl -tag -width Ds
 .It Fl n Ar node
 Default node is
@@ -104,11 +104,12 @@ environment variable instead of specifying this option on the command line.
 To learn more, see the
 .Lk https://www.rabbitmq.com/cli.html "RabbitMQ CLI Tools guide"
 .El
-.\" ------------------------------------------------------------------
+.\" ------------------------------------------------------------------------------------------------
 .Sh COMMANDS
-.\" ------------------------------------------------------------------
+.\" ------------------------------------------------------------------------------------------------
 .Bl -tag -width Ds
 .It Cm help Oo Fl l Oc Op Ar command_name
+.Pp
 Prints usage for all available commands.
 .Bl -tag -width Ds
 .It Fl l , Fl -list-commands
@@ -116,55 +117,27 @@ List command usages only, without parameter explanation.
 .It Ar command_name
 Prints usage for the specified command.
 .El
+.\" ------------------------------------------------------------------
+.It Cm version
+.Pp
+Displays CLI tools version
 .El
-.Ss Application Management
+.\" ------------------------------------------------------------------
+.\" ## Nodes
+.\" ------------------------------------------------------------------
+.Ss Nodes
 .Bl -tag -width Ds
-.\" ------------------------------------
-.It Cm force_reset
-Forcefully returns a RabbitMQ node to its virgin state.
-.Pp
-The
-.Cm force_reset
-command differs from
-.Cm 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.
-.Pp
-For
-.Cm reset
-and
-.Cm force_reset
-to succeed the RabbitMQ application must have been stopped, e.g. with
-.Cm stop_app .
-.Pp
-For example, to reset the RabbitMQ node:
-.sp
-.Dl rabbitmqctl force_reset
-.\" ------------------------------------
-.It Cm hipe_compile Ar directory
-Performs HiPE-compilation and caches resulting
-.Pa .beam Ns -files in the given directory.
+.\" ------------------------------------------------------------------
+.It Cm await_startup
 .Pp
-Parent directories are created if necessary.
-Any existing
-.Pa .beam
-files from the directory are automatically deleted prior to compilation.
+Waits for the RabbitMQ application to start on the target node
 .Pp
-To use this precompiled files, you should set
-.Ev RABBITMQ_SERVER_CODE_PATH
-environment variable to directory specified in
-.Cm hipe_compile
-invocation.
-.Pp
-For example, to HiPE-compile modules and store them to
-.Pa /tmp/rabbit-hipe/ebin
-directory:
+For example, to wait for the RabbitMQ application to start:
 .sp
-.Dl rabbitmqctl hipe_compile /tmp/rabbit-hipe/ebin
-.\" ------------------------------------
+.Dl rabbitmqctl await_startup
+.\" ------------------------------------------------------------------
 .It Cm reset
+.Pp
 Returns a RabbitMQ node to its virgin state.
 .Pp
 Removes the node from any cluster it belongs to, removes all data from
@@ -181,8 +154,9 @@ to succeed the RabbitMQ application must have been stopped, e.g. with
 For example, to resets the RabbitMQ node:
 .sp
 .Dl rabbitmqctl reset
-.\" ------------------------------------
+.\" ------------------------------------------------------------------
 .It Cm rotate_logs
+.Pp
 Instructs the RabbitMQ node to perform internal log rotation.
 .Pp
 Log rotation is performed according to lager settings specified in
@@ -199,8 +173,9 @@ process:
 .Pp
 Rotation is performed asynchronously, so there is no guarantee that it
 will be completed when this command returns.
-.\" ------------------------------------
+.\" ------------------------------------------------------------------
 .It Cm shutdown
+.Pp
 Shuts down the node, both RabbitMQ and its runtime.
 The command is blocking and will return after the runtime process exits.
 If RabbitMQ fails to stop, it will return a non-zero exit code.
@@ -223,8 +198,9 @@ For example, this will shut down a locally running RabbitMQ node
 with default node name:
 .sp
 .Dl rabbitmqctl shutdown
-.\" ------------------------------------
+.\" ------------------------------------------------------------------
 .It Cm start_app
+.Pp
 Starts the RabbitMQ application.
 .Pp
 This command is typically run after performing other management actions
@@ -235,13 +211,14 @@ For example, to instruct the RabbitMQ node to start the RabbitMQ
 application:
 .sp
 .Dl rabbitmqctl start_app
-.\" ------------------------------------
+.\" ------------------------------------------------------------------
 .It Cm stop Op Ar pid_file
+.Pp
 Stops the Erlang node on which RabbitMQ is running.
 To restart the node follow the instructions for
 .Qq Running the Server
 in the
-.Lk https://www.rabbitmq.com/download.html installation guide .
+.Lk https://rabbitmq.com/download.html installation guide .
 .Pp
 If a
 .Ar pid_file
@@ -253,8 +230,9 @@ command for details on this file.
 For example, to instruct the RabbitMQ node to terminate:
 .sp
 .Dl rabbitmqctl stop
-.\" ------------------------------------
+.\" ------------------------------------------------------------------
 .It Cm stop_app
+.Pp
 Stops the RabbitMQ application, leaving the runtime (Erlang VM) running.
 .Pp
 This command is typically run prior to performing other management
@@ -265,8 +243,9 @@ For example, to instruct the RabbitMQ node to stop the RabbitMQ
 application:
 .sp
 .Dl rabbitmqctl stop_app
-.\" ------------------------------------
+.\" ------------------------------------------------------------------
 .It Cm wait Ar pid_file , Cm wait Fl -pid Ar pid
+.Pp
 Waits for the RabbitMQ application to start.
 .Pp
 This command will wait for the RabbitMQ application to start at the
@@ -297,75 +276,25 @@ For example, this command will return when the RabbitMQ node has started
 up:
 .sp
 .Dl rabbitmqctl wait /var/run/rabbitmq/pid
-.\" ------------------------------------
 .El
-.Ss Cluster Management
-.Bl -tag -width Ds
-.\" ------------------------------------
-.It Cm join_cluster Ar clusternode Op Fl -ram
+.\" ------------------------------------------------------------------
+.\" ## Cluster Operations
+.\" ------------------------------------------------------------------
+.Ss Cluster management
 .Bl -tag -width Ds
-.It Ar clusternode
-Node to cluster with.
-.It Fl -ram
-If provided, the node will join the cluster as a RAM node.
-.El
-.Pp
-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 succeed the RabbitMQ application must have been
-stopped, e.g. with
-.Cm stop_app .
-.Pp
-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.
-.Pp
-The node will be a disc node by default.
-If you wish to create a RAM node, provide the
-.Fl -ram
-flag.
-.Pp
-After executing the
-.Cm 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.
-.Pp
-To leave a cluster,
-.Cm reset
-the node.
-You can also remove nodes remotely with the
-.Cm forget_cluster_node
-command.
+.\" ------------------------------------------------------------------
+.It Cm await_online_nodes Ar count
 .Pp
-For more details see the
-.Lk https://www.rabbitmq.com/clustering.html Clustering guide .
+Waits for
+.Ar count
+nodes to join the cluster
 .Pp
-For example, this command instructs the RabbitMQ node to join the cluster that
-.Qq hare@elena
-is part of, as a ram node:
+For example, to wait for two RabbitMQ nodes to start:
 .sp
-.Dl rabbitmqctl join_cluster hare@elena --ram
-.\" ------------------------------------
-.It Cm cluster_status
-Displays all the nodes in the cluster grouped by node type, together
-with the currently running nodes.
-.Pp
-For example, this command displays the nodes in the cluster:
-.sp
-.Dl rabbitmqctl cluster_status
-.\" ------------------------------------
+.Dl rabbitmqctl await_online_nodes 2
+.\" ------------------------------------------------------------------
 .It Cm change_cluster_node_type Ar type
+.Pp
 Changes the type of the cluster node.
 .Pp
 The
@@ -385,7 +314,70 @@ cluster.
 For example, this command will turn a RAM node into a disc node:
 .sp
 .Dl rabbitmqctl change_cluster_node_type disc
-.\" ------------------------------------
+.\" ------------------------------------------------------------------
+.It Cm cluster_status
+.Pp
+Displays all the nodes in the cluster grouped by node type, together
+with the currently running nodes.
+.Pp
+For example, this command displays the nodes in the cluster:
+.sp
+.Dl rabbitmqctl cluster_status
+.\" ------------------------------------------------------------------
+.It Cm force_boot
+.Pp
+Ensures that the node will start next time, even if it was not the last
+to shut down.
+.Pp
+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.
+.Pp
+In such a case you can invoke
+.Cm force_boot
+while the node is down.
+This will tell the node to unconditionally start next time you ask it
+to.
+If any changes happened to the cluster after this node shut down, they
+will be lost.
+.Pp
+If the last node to go down is permanently lost then you should use
+.Cm forget_cluster_node Fl -offline
+in preference to this command, as it will ensure that mirrored queues
+which were mastered on the lost node get promoted.
+.Pp
+For example, this will force the node not to wait for other nodes next
+time it is started:
+.sp
+.Dl rabbitmqctl force_boot
+.\" ------------------------------------------------------------------
+.It Cm force_reset
+.Pp
+Forcefully returns a RabbitMQ node to its virgin state.
+.Pp
+The
+.Cm force_reset
+command differs from
+.Cm 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.
+.Pp
+For
+.Cm reset
+and
+.Cm force_reset
+to succeed the RabbitMQ application must have been stopped, e.g. with
+.Cm stop_app .
+.Pp
+For example, to reset the RabbitMQ node:
+.sp
+.Dl rabbitmqctl force_reset
+.\" ------------------------------------------------------------------
 .It Cm forget_cluster_node Op Fl -offline
 .Bl -tag -width Ds
 .It Fl -offline
@@ -421,8 +413,66 @@ from the node
 .Qq hare@mcnulty :
 .sp
 .Dl rabbitmqctl -n hare@mcnulty forget_cluster_node rabbit@stringer
-.\" ------------------------------------
+.\" ------------------------------------------------------------------
+.It Cm join_cluster Ar seed-node Op Fl -ram
+.Bl -tag -width Ds
+.It Ar seed-node
+Existing cluster member (seed node) to cluster with.
+.It Fl -ram
+If provided, the node will join the cluster as a RAM node.
+RAM node use is discouraged. Use only if you understand why
+exactly you need to use them.
+.El
+.Pp
+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 succeed the RabbitMQ application must have been
+stopped, e.g. with
+.Cm stop_app .
+.Pp
+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.
+.Pp
+The node will be a disc node by default.
+If you wish to create a RAM node, provide the
+.Fl -ram
+flag.
+.Pp
+After executing the
+.Cm 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.
+.Pp
+To leave a cluster,
+.Cm reset
+the node.
+You can also remove nodes remotely with the
+.Cm forget_cluster_node
+command.
+.Pp
+For example, this command instructs the RabbitMQ node to join the cluster that
+.Qq hare@elena
+is part of, as a ram node:
+.sp
+.Dl rabbitmqctl join_cluster hare@elena --ram
+.Pp
+To learn more, see the
+.Lk https://www.rabbitmq.com/clustering.html "RabbitMQ Clustering guide".
+.\" ------------------------------------------------------------------
 .It Cm rename_cluster_node Ar oldnode1 Ar newnode1 Op Ar oldnode2 Ar newnode2 ...
+.Pp
 Supports renaming of cluster nodes in the local database.
 .Pp
 This subcommand causes
@@ -481,14 +531,14 @@ mv \\
 .Ed
 .sp
 .It
-If you have
+If node name is configured e.g. using
 .Ar /etc/rabbitmq/rabbitmq-env.conf
-and configured the node name there, update this configuration.
+it has also be updated there.
 .sp
 .It
 Start the node when ready
 .El
-.\" ------------------------------------
+.\" ------------------------------------------------------------------
 .It Cm update_cluster_nodes Ar clusternode
 .Bl -tag -width Ds
 .It Ar clusternode
@@ -497,7 +547,7 @@ The node to consult for up-to-date information.
 .Pp
 Instructs an already clustered node to contact
 .Ar clusternode
-to cluster when waking up.
+to cluster when booting up.
 This is different from
 .Cm join_cluster
 since it does not join any cluster - it checks that the node is already
@@ -506,59 +556,44 @@ in a cluster with
 .Pp
 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
-.Va A
+Consider a situation where node
+.Va rabbit@A
 and
-.Va B
+.Va rabbit@B
 are clustered.
-.Va A
+.Va rabbit@A
 goes down,
-.Va C
+.Va rabbit@C
 clusters with
-.Va B ,
+.Va rabbit@B ,
 and then
-.Va B
+.Va rabbit@B
 leaves the cluster.
 When
-.Va A
-wakes up, it'll try to contact
-.Va B ,
+.Va rabbit@A
+starts back up, it'll try to contact
+.Va rabbit@B ,
 but this will fail since
-.Va B
+.Va rabbit@B
 is not in the cluster anymore.
-The following command will solve this situation:
+The following command will rename node
+.Va rabbit@B
+to
+.Va rabbit@C
+on node
+.Va rabbitA
 .sp
-.Dl update_cluster_nodes -n Va A Va C
-.\" ------------------------------------
-.It Cm force_boot
-Ensures that the node will start next time, even if it was not the last
-to shut down.
+.Dl update_cluster_nodes -n Va rabbit@A Va rabbit@B Va rabbit@C
 .Pp
-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.
-.Pp
-In such a case you can invoke
-.Cm force_boot
-while the node is down.
-This will tell the node to unconditionally start next time you ask it
-to.
-If any changes happened to the cluster after this node shut down, they
-will be lost.
-.Pp
-If the last node to go down is permanently lost then you should use
-.Cm forget_cluster_node Fl -offline
-in preference to this command, as it will ensure that mirrored queues
-which were mastered on the lost node get promoted.
-.Pp
-For example, this will force the node not to wait for other nodes next
-time it is started:
-.sp
-.Dl rabbitmqctl force_boot
-.\" ------------------------------------
+To learn more, see the
+.Lk https://www.rabbitmq.com/clustering.html "RabbitMQ Clustering guide"
+.El
+.\" ------------------------------------------------------------------
+.\" ## Classic Mirrored Queues
+.\" ------------------------------------------------------------------
+.Ss Replication
+.Bl -tag -width Ds
+.\" ------------------------------------------------------------------
 .It Cm sync_queue Oo Fl p Ar vhost Oc Ar queue
 .Bl -tag -width Ds
 .It Ar queue
@@ -576,7 +611,7 @@ To learn more, see the
 Note that queues with unsynchronised replicas and active consumers
 will become synchronised eventually (assuming that consumers make progress).
 This command is primarily useful for queues which do not have active consumers.
-.\" ------------------------------------
+.\" ------------------------------------------------------------------
 .It Cm cancel_sync_queue Oo Fl p Ar vhost Oc Ar queue
 .Bl -tag -width Ds
 .It Ar queue
@@ -584,28 +619,10 @@ The name of the queue to cancel synchronisation for.
 .El
 .Pp
 Instructs a synchronising mirrored queue to stop synchronising itself.
-.\" ------------------------------------
-.It Cm purge_queue Oo Fl p Ar vhost Oc Ar queue
-.Bl -tag -width Ds
-.It Ar queue
-The name of the queue to purge.
-.El
-.Pp
-Purges a queue (removes all messages in it).
-.\" ------------------------------------
-.It Cm set_cluster_name Ar name
-Sets the cluster name to
-.Ar name .
-The cluster name is announced to clients on connection, and used by the
-federation 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.
-.Pp
-For example, this sets the cluster name to
-.Qq london :
-.sp
-.Dl rabbitmqctl set_cluster_name london
 .El
+.\" ------------------------------------------------------------------
+.\" ## User management
+.\" ------------------------------------------------------------------
 .Ss User Management
 Note that all user management commands
 .Nm
@@ -614,7 +631,7 @@ Users from any alternative authentication backends such as LDAP cannot be inspec
 or managed with those commands.
 .Nm .
 .Bl -tag -width Ds
-.\" ------------------------------------
+.\" ------------------------------------------------------------------
 .It Cm add_user Ar username Ar password
 .Bl -tag -width Ds
 .It Ar username
@@ -629,18 +646,22 @@ with (initial) password
 .Qq changeit :
 .sp
 .Dl rabbitmqctl add_user janeway changeit
-.\" ------------------------------------
-.It Cm delete_user Ar username
+.\" ------------------------------------------------------------------
+.It Cm authenticate_user Ar username Ar password
 .Bl -tag -width Ds
 .It Ar username
-The name of the user to delete.
+The name of the user.
+.It Ar password
+The password of the user.
 .El
 .Pp
-For example, this command instructs the RabbitMQ broker to delete the user named
-.Qq janeway :
+For example, this command instructs the RabbitMQ broker to authenticate the user named
+.Qq janeway
+with password
+.Qq verifyit :
 .sp
-.Dl rabbitmqctl delete_user janeway
-.\" ------------------------------------
+.Dl rabbitmqctl authenticate_user janeway verifyit
+.\" ------------------------------------------------------------------
 .It Cm change_password Ar username Ar newpassword
 .Bl -tag -width Ds
 .It Ar username
@@ -656,7 +677,7 @@ to
 .Qq newpass :
 .sp
 .Dl rabbitmqctl change_password janeway newpass
-.\" ------------------------------------
+.\" ------------------------------------------------------------------
 .It Cm clear_password Ar username
 .Bl -tag -width Ds
 .It Ar username
@@ -671,22 +692,28 @@ password for the user named
 .Pp
 This user now cannot log in with a password (but may be able to through
 e.g. SASL EXTERNAL if configured).
-.\" ------------------------------------
-.It Cm authenticate_user Ar username Ar password
+.\" ------------------------------------------------------------------
+.It Cm delete_user Ar username
 .Bl -tag -width Ds
 .It Ar username
-The name of the user.
-.It Ar password
-The password of the user.
+The name of the user to delete.
 .El
 .Pp
-For example, this command instructs the RabbitMQ broker to authenticate the user named
-.Qq janeway
-with password
-.Qq verifyit :
+For example, this command instructs the RabbitMQ broker to delete the user named
+.Qq janeway :
 .sp
-.Dl rabbitmqctl authenticate_user janeway verifyit
-.\" ------------------------------------
+.Dl rabbitmqctl delete_user janeway
+.\" ------------------------------------------------------------------
+.It Cm list_users
+.Pp
+Lists users.
+Each result row will contain the user name followed by a list of the
+tags set for that user.
+.Pp
+For example, this command instructs the RabbitMQ broker to list all users:
+.sp
+.Dl rabbitmqctl list_users
+.\" ------------------------------------------------------------------
 .It Cm set_user_tags Ar username Op Ar tag ...
 .Bl -tag -width Ds
 .It Ar username
@@ -711,57 +738,146 @@ This command instructs the RabbitMQ broker to remove any tags from the user name
 .Qq janeway :
 .sp
 .Dl rabbitmqctl set_user_tags janeway
-.\" ------------------------------------
-.It Cm list_users
-Lists users.
-Each result row will contain the user name followed by a list of the
-tags set for that user.
-.Pp
-For example, this command instructs the RabbitMQ broker to list all users:
-.sp
-.Dl rabbitmqctl list_users
 .El
-.Ss Access Control
-Note that
-.Nm
-manages the RabbitMQ internal user database.
-Permissions for users from any alternative authorisation backend will
-not be visible to
-.Nm .
+.\" ------------------------------------------------------------------
+.\" ## Access Control
+.\" ------------------------------------------------------------------
+.Ss Access control
 .Bl -tag -width Ds
-.\" ------------------------------------
-.It Cm add_vhost Ar vhost
+.\" ------------------------------------------------------------------
+.It Cm clear_permissions Oo Fl p Ar vhost Oc Ar username
 .Bl -tag -width Ds
 .It Ar vhost
-The name of the virtual host entry to create.
+The name of the virtual host to which to deny the user access,
+defaulting to
+.Qq / .
+.It Ar username
+The name of the user to deny access to the specified virtual host.
 .El
 .Pp
-Creates a virtual host.
+Sets user permissions.
 .Pp
-For example, this command instructs the RabbitMQ broker to create a new
-virtual host called
-.Qq test :
+For example, this command instructs the RabbitMQ broker to deny the user
+named
+.Qq janeway
+access to the virtual host called
+.Qq my-vhost :
+.sp
+.Dl rabbitmqctl clear_permissions -p my-vhost janeway
+.\" ------------------------------------------------------------------
+.It Cm clear_topic_permissions Oo Fl p Ar vhost Oc Ar username Oo Ar exchange Oc
+.Bl -tag -width Ds
+.It Ar vhost
+The name of the virtual host to which to clear the topic permissions,
+defaulting to
+.Qq / .
+.It Ar username
+The name of the user to clear topic permissions to the specified virtual host.
+.It Ar exchange
+The name of the topic exchange to clear topic permissions, defaulting to all the
+topic exchanges the given user has topic permissions for.
+.El
 .Pp
-.Dl rabbitmqctl add_vhost test
-.\" ------------------------------------
-.It Cm delete_vhost Ar vhost
+Clear user topic permissions.
+.Pp
+For example, this command instructs the RabbitMQ broker to remove topic permissions for user
+named
+.Qq janeway
+for the topic exchange
+.Qq amq.topic
+in the virtual host called
+.Qq my-vhost :
+.sp
+.Dl rabbitmqctl clear_topic_permissions -p my-vhost janeway amq.topic
+.\" ------------------------------------------------------------------
+.It Cm list_permissions Op Fl p Ar vhost
 .Bl -tag -width Ds
 .It Ar vhost
-The name of the virtual host entry to delete.
+The name of the virtual host for which to list the users that have been
+granted access to it, and their permissions.
+Defaults to
+.Qq / .
 .El
 .Pp
-Deletes a virtual host.
+Lists permissions in a virtual host.
 .Pp
-Deleting a virtual host deletes all its exchanges, queues, bindings,
-user permissions, parameters and policies.
+For example, this command instructs the RabbitMQ broker to list all the
+users which have been granted access to the virtual host called
+.Qq my-vhost ,
+and the permissions they have for operations on resources in that
+virtual host.
+Note that an empty string means no permissions granted:
+.sp
+.Dl rabbitmqctl list_permissions -p my-vhost
+.\" ------------------------------------------------------------------
+.It Cm list_topic_permissions Op Fl p Ar vhost
+.Bl -tag -width Ds
+.It Ar vhost
+The name of the virtual host for which to list the users topic permissions.
+Defaults to
+.Qq / .
+.El
 .Pp
-For example, this command instructs the RabbitMQ broker to delete the
-virtual host called
-.Qq test :
+Lists topic permissions in a virtual host.
+.Pp
+For example, this command instructs the RabbitMQ broker to list all the
+users which have been granted topic permissions in the virtual host called
+.Qq my-vhost:
+.sp
+.Dl rabbitmqctl list_topic_permissions -p my-vhost
+.\" ------------------------------------------------------------------
+.It Cm list_user_permissions Ar username
+.Bl -tag -width Ds
+.It Ar username
+The name of the user for which to list the permissions.
+.El
+.Pp
+Lists user permissions.
+.Pp
+For example, this command instructs the RabbitMQ broker to list all the
+virtual hosts to which the user named
+.Qq janeway
+has been granted access, and the permissions the user has for operations
+on resources in these virtual hosts:
+.sp
+.Dl rabbitmqctl list_user_permissions janeway
+.\" ------------------------------------------------------------------
+.It Cm list_user_topic_permissions Ar username
+.Bl -tag -width Ds
+.It Ar username
+The name of the user for which to list the topic permissions.
+.El
+.Pp
+Lists user topic permissions.
+.Pp
+For example, this command instructs the RabbitMQ broker to list all the
+virtual hosts to which the user named
+.Qq janeway
+has been granted access, and the topic permissions the user has in these virtual hosts:
 .sp
-.Dl rabbitmqctl delete_vhost test
-.\" ------------------------------------
+.Dl rabbitmqctl list_topic_user_permissions janeway
+.El
+.\" ------------------------------------------------------------------
+.\" ## Parameter management
+.\" ------------------------------------------------------------------
+.Ss Parameter Management
+Certain features of RabbitMQ (such as the Federation plugin) are
+controlled by dynamic, cluster-wide
+.Em 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.
+.Bl -tag -width Ds
+.\" ------------------------------------------------------------------
 .It Cm list_vhosts Op Ar vhostinfoitem ...
+.Pp
 Lists virtual hosts.
 .Pp
 The
@@ -786,7 +902,7 @@ For example, this command instructs the RabbitMQ broker to list all
 virtual hosts:
 .sp
 .Dl rabbitmqctl list_vhosts name tracing
-.\" ------------------------------------
+.\" ------------------------------------------------------------------
 .It Cm set_permissions Oo Fl p Ar vhost Oc Ar user Ar conf Ar write Ar read
 .Bl -tag -width Ds
 .It Ar vhost
@@ -818,63 +934,7 @@ with configure permissions on all resources whose names starts with
 and write and read permissions on all resources:
 .sp
 .Dl rabbitmqctl set_permissions -p my-vhost janeway Qo ^janeway-.* Qc Qo .* Qc Qq .*
-.\" ------------------------------------
-.It Cm clear_permissions Oo Fl p Ar vhost Oc Ar username
-.Bl -tag -width Ds
-.It Ar vhost
-The name of the virtual host to which to deny the user access,
-defaulting to
-.Qq / .
-.It Ar username
-The name of the user to deny access to the specified virtual host.
-.El
-.Pp
-Sets user permissions.
-.Pp
-For example, this command instructs the RabbitMQ broker to deny the user
-named
-.Qq janeway
-access to the virtual host called
-.Qq my-vhost :
-.sp
-.Dl rabbitmqctl clear_permissions -p my-vhost janeway
-.\" ------------------------------------
-.It Cm list_permissions Op Fl p Ar vhost
-.Bl -tag -width Ds
-.It Ar 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
-.Qq / .
-.El
-.Pp
-Lists permissions in a virtual host.
-.Pp
-For example, this command instructs the RabbitMQ broker to list all the
-users which have been granted access to the virtual host called
-.Qq my-vhost ,
-and the permissions they have for operations on resources in that
-virtual host.
-Note that an empty string means no permissions granted:
-.sp
-.Dl rabbitmqctl list_permissions -p my-vhost
-.\" ------------------------------------
-.It Cm list_user_permissions Ar username
-.Bl -tag -width Ds
-.It Ar username
-The name of the user for which to list the permissions.
-.El
-.Pp
-Lists user permissions.
-.Pp
-For example, this command instructs the RabbitMQ broker to list all the
-virtual hosts to which the user named
-.Qq janeway
-has been granted access, and the permissions the user has for operations
-on resources in these virtual hosts:
-.sp
-.Dl rabbitmqctl list_user_permissions janeway
-.\" ------------------------------------
+.\" ------------------------------------------------------------------
 .It Cm set_topic_permissions Oo Fl p Ar vhost Oc Ar user Ar exchange Ar write Ar read
 .Bl -tag -width Ds
 .It Ar vhost
@@ -911,349 +971,337 @@ The previous example could be made more generic by using
 .Qq ^{username}-.* :
 .sp
 .Dl rabbitmqctl set_topic_permissions -p my-vhost janeway amq.topic Qo ^{username}-.* Qc Qo ^{username}-.* Qc
-.\" ------------------------------------
-.It Cm clear_topic_permissions Oo Fl p Ar vhost Oc Ar username Oo Ar exchange Oc
-.Bl -tag -width Ds
-.It Ar vhost
-The name of the virtual host to which to clear the topic permissions,
-defaulting to
-.Qq / .
-.It Ar username
-The name of the user to clear topic permissions to the specified virtual host.
-.It Ar exchange
-The name of the topic exchange to clear topic permissions, defaulting to all the
-topic exchanges the given user has topic permissions for.
 .El
+.\" ------------------------------------------------------------------
+.\" ## Monitoring and Observability
+.\" ------------------------------------------------------------------
+.Ss Monitoring, observability and health checks
+.Bl -tag -width Ds
+.\" ------------------------------------------------------------------
+.It Cm environment
 .Pp
-Clear user topic permissions.
+Displays the name and value of each variable in the application
+environment for each running application.
+.\" ------------------------------------------------------------------
+.It Cm list_bindings Oo Fl p Ar vhost Oc Op Ar bindinginfoitem ...
 .Pp
-For example, this command instructs the RabbitMQ broker to remove topic permissions for user
-named
-.Qq janeway
-for the topic exchange
-.Qq amq.topic
-in the virtual host called
-.Qq my-vhost :
-.sp
-.Dl rabbitmqctl clear_topic_permissions -p my-vhost janeway amq.topic
-.\" ------------------------------------
-.It Cm list_topic_permissions Op Fl p Ar vhost
+Returns binding details.
+By default the bindings for the
+.Qq /
+virtual host are returned.
+The
+.Fl p
+flag can be used to override this default.
+.Pp
+The
+.Ar 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.
+.Ar bindinginfoitem
+can take any value from the list that follows:
 .Bl -tag -width Ds
-.It Ar vhost
-The name of the virtual host for which to list the users topic permissions.
-Defaults to
-.Qq / .
+.It Cm source_name
+The name of the source of messages to which the binding is attached.
+With non-ASCII characters escaped as in C.
+.It Cm source_kind
+The kind of the source of messages to which the binding is attached.
+Currently always exchange.
+With non-ASCII characters escaped as in C.
+.It Cm destination_name
+The name of the destination of messages to which the binding is
+attached.
+With non-ASCII characters escaped as in C.
+.It Cm destination_kind
+The kind of the destination of messages to which the binding is
+attached.
+With non-ASCII characters escaped as in C.
+.It Cm routing_key
+The binding's routing key, with non-ASCII characters escaped as in C.
+.It Cm arguments
+The binding's arguments.
 .El
 .Pp
-Lists topic permissions in a virtual host.
+If no
+.Ar bindinginfoitem
+are specified then all above items are displayed.
 .Pp
-For example, this command instructs the RabbitMQ broker to list all the
-users which have been granted topic permissions in the virtual host called
-.Qq my-vhost:
+For example, this command displays the exchange name and queue name of
+the bindings in the virtual host named
+.Qq my-vhost
 .sp
-.Dl rabbitmqctl list_topic_permissions -p my-vhost
-.\" ------------------------------------
-.It Cm list_user_topic_permissions Ar username
-.Bl -tag -width Ds
-.It Ar username
-The name of the user for which to list the topic permissions.
-.El
+.Dl rabbitmqctl list_bindings -p my-vhost exchange_name queue_name
+.\" ------------------------------------------------------------------
+.It Cm list_channels Op Ar channelinfoitem ...
 .Pp
-Lists user topic permissions.
+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.
 .Pp
-For example, this command instructs the RabbitMQ broker to list all the
-virtual hosts to which the user named
-.Qq janeway
-has been granted access, and the topic permissions the user has in these virtual hosts:
-.sp
-.Dl rabbitmqctl list_topic_user_permissions janeway
-.El
-.Ss Parameter Management
-Certain features of RabbitMQ (such as the Federation plugin) are
-controlled by dynamic, cluster-wide
-.Em 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.
-.Bl -tag -width Ds
-.\" ------------------------------------
-.It Cm set_parameter Oo Fl p Ar vhost Oc Ar component_name Ar name Ar value
-Sets a parameter.
+The
+.Ar 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.
+.Ar channelinfoitem
+can take any value from the list that follows:
 .Bl -tag -width Ds
-.It Ar component_name
-The name of the component for which the parameter is being set.
-.It Ar name
-The name of the parameter being set.
-.It Ar value
-The value for the parameter, as a JSON term.
-In most shells you are very likely to need to quote this.
+.It Cm pid
+Id of the Erlang process associated with the connection.
+.It Cm connection
+Id of the Erlang process associated with the connection to which the
+channel belongs.
+.It Cm name
+Readable name for the channel.
+.It Cm number
+The number of the channel, which uniquely identifies it within a
+connection.
+.It Cm user
+Username associated with the channel.
+.It Cm vhost
+Virtual host in which the channel operates.
+.It Cm transactional
+True if the channel is in transactional mode, false otherwise.
+.It Cm confirm
+True if the channel is in confirm mode, false otherwise.
+.It Cm consumer_count
+Number of logical AMQP consumers retrieving messages via the channel.
+.It Cm messages_unacknowledged
+Number of messages delivered via this channel but not yet acknowledged.
+.It Cm messages_uncommitted
+Number of messages received in an as yet uncommitted transaction.
+.It Cm acks_uncommitted
+Number of acknowledgements received in an as yet uncommitted transaction.
+.It Cm messages_unconfirmed
+Number of published messages not yet confirmed.
+On channels not in confirm mode, this remains 0.
+.It Cm prefetch_count
+QoS prefetch limit for new consumers, 0 if unlimited.
+.It Cm global_prefetch_count
+QoS prefetch limit for the entire channel, 0 if unlimited.
 .El
 .Pp
-For example, this command sets the parameter
-.Qq node01
-for the
-.Qq federation-upstream
-component in the default virtual host to the following JSON
-.Qq guest :
-.sp
-.Dl rabbitmqctl set_parameter federation-upstream node01 '{"uri":"amqp://user:password@server/%2F","ack-mode":"on-publish"}'
-.\" ------------------------------------
-.It Cm clear_parameter Oo Fl p Ar vhost Oc Ar component_name Ar key
-Clears a parameter.
-.Bl -tag -width Ds
-.It Ar component_name
-The name of the component for which the parameter is being cleared.
-.It Ar name
-The name of the parameter being cleared.
-.El
+If no
+.Ar channelinfoitem
+are specified then pid, user, consumer_count, and
+messages_unacknowledged are assumed.
 .Pp
-For example, this command clears the parameter
-.Qq node01
-for the
-.Qq federation-upstream
-component in the default virtual host:
+For example, this command displays the connection process and count of
+unacknowledged messages for each channel:
 .sp
-.Dl rabbitmqctl clear_parameter federation-upstream node01
-.\" ------------------------------------
-.It Cm list_parameters Op Fl p Ar vhost
-Lists all parameters for a virtual host.
+.Dl rabbitmqctl list_channels connection messages_unacknowledged
+.\" ------------------------------------------------------------------
+.It Cm list_ciphers
 .Pp
-For example, this command lists all parameters in the default virtual
-host:
-.sp
-.Dl rabbitmqctl list_parameters
-.\" ------------------------------------
-.It Cm set_global_parameter Ar name Ar value
-Sets a global runtime parameter.
-This is similar to
-.Cm set_parameter
-but the key-value pair isn't tied to a virtual host.
-.Bl -tag -width Ds
-.It Ar name
-The name of the global runtime parameter being set.
-.It Ar value
-The value for the global runtime parameter, as a JSON term.
-In most shells you are very likely to need to quote this.
-.El
+Lists cipher suites supported by encoding commands.
 .Pp
-For example, this command sets the global runtime parameter
-.Qq mqtt_default_vhosts
-to the JSON term {"O=client,CN=guest":"/"}:
+For example, this command instructs the RabbitMQ broker to list all
+cipher suites supported by encoding commands:
 .sp
-.Dl rabbitmqctl set_global_parameter mqtt_default_vhosts '{"O=client,CN=guest":"/"}'
-.\" ------------------------------------
-.It Cm clear_global_parameter Ar name
-Clears a global runtime parameter.
-This is similar to
-.Cm clear_parameter
-but the key-value pair isn't tied to a virtual host.
-.Bl -tag -width Ds
-.It Ar name
-The name of the global runtime parameter being cleared.
-.El
+.Dl rabbitmqctl list_ciphers
+.\" ------------------------------------------------------------------
+.It Cm list_connections Op Ar connectioninfoitem ...
 .Pp
-For example, this command clears the global runtime parameter
-.Qq mqtt_default_vhosts :
-.sp
-.Dl rabbitmqctl clear_global_parameter mqtt_default_vhosts
-.\" ------------------------------------
-.It Cm list_global_parameters
-Lists all global runtime parameters.
-This is similar to
-.Cm list_parameters
-but the global runtime parameters are not tied to any virtual host.
+Returns TCP/IP connection statistics.
 .Pp
-For example, this command lists all global parameters:
-.sp
-.Dl rabbitmqctl list_global_parameters
-.El
-.Ss Policy Management
-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.
-.Bl -tag -width Ds
-.\" ------------------------------------
-.It Cm set_policy Oo Fl p Ar vhost Oc Oo Fl -priority Ar priority Oc Oo Fl -apply-to Ar apply-to Oc Ar name Ar pattern Ar definition
-Sets a policy.
+The
+.Ar 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.
+.Ar connectioninfoitem
+can take any value from the list that follows:
 .Bl -tag -width Ds
-.It Ar name
-The name of the policy.
-.It Ar pattern
-The regular expression, which when matches on a given resources causes
-the policy to apply.
-.It Ar definition
-The definition of the policy, as a JSON term.
-In most shells you are very likely to need to quote this.
-.It Ar priority
-The priority of the policy as an integer.
-Higher numbers indicate greater precedence.
-The default is 0.
-.It Ar apply-to
-Which types of object this policy should apply to.
-Possible values are:
+.It Cm pid
+Id of the Erlang process associated with the connection.
+.It Cm name
+Readable name for the connection.
+.It Cm port
+Server port.
+.It Cm host
+Server hostname obtained via reverse DNS, or its IP address if reverse
+DNS failed or was disabled.
+.It Cm peer_port
+Peer port.
+.It Cm peer_host
+Peer hostname obtained via reverse DNS, or its IP address if reverse DNS
+failed or was not enabled.
+.It Cm ssl
+Boolean indicating whether the connection is secured with SSL.
+.It Cm ssl_protocol
+SSL protocol (e.g.\&
+.Qq tlsv1 ) .
+.It Cm ssl_key_exchange
+SSL key exchange algorithm (e.g.\&
+.Qq rsa ) .
+.It Cm ssl_cipher
+SSL cipher algorithm (e.g.\&
+.Qq aes_256_cbc ) .
+.It Cm ssl_hash
+SSL hash function (e.g.\&
+.Qq sha ) .
+.It Cm peer_cert_subject
+The subject of the peer's SSL certificate, in RFC4514 form.
+.It Cm peer_cert_issuer
+The issuer of the peer's SSL certificate, in RFC4514 form.
+.It Cm peer_cert_validity
+The period for which the peer's SSL certificate is valid.
+.It Cm state
+Connection state; one of:
 .Bl -bullet -compact
 .It
-.Cm queues
+starting
 .It
-.Cm exchanges
+tuning
 .It
-.Cm all
-.El
-The default is
-.Cm all ..
-.El
-.Pp
-For example, this command sets the policy
-.Qq federate-me
-in the default virtual host so that built-in exchanges are federated:
-.sp
-.Dl rabbitmqctl set_policy federate-me "^amq." '{"federation-upstream-set":"all"}'
-.\" ------------------------------------
-.It Cm clear_policy Oo Fl p Ar vhost Oc Ar name
-Clears a policy.
-.Bl -tag -width Ds
-.It Ar name
-The name of the policy being cleared.
-.El
-.Pp
-For example, this command clears the
-.Qq federate-me
-policy in the default virtual host:
-.sp
-.Dl rabbitmqctl clear_policy federate-me
-.\" ------------------------------------
-.It Cm list_policies Op Fl p Ar vhost
-Lists all policies for a virtual host.
-.Pp
-For example, this command lists all policies in the default virtual
-host:
-.sp
-.Dl rabbitmqctl list_policies
-.\" ------------------------------------
-.It Cm set_operator_policy Oo Fl p Ar vhost Oc Oo Fl -priority Ar priority Oc Oo Fl -apply-to Ar apply-to Oc Ar name Ar pattern Ar definition
-Sets an operator policy that overrides a subset of arguments in user
-policies.
-Arguments are identical to those of
-.Cm set_policy .
-.Pp
-Supported arguments are:
-.Bl -bullet -compact
+opening
 .It
-expires
+running
 .It
-message-ttl
+flow
 .It
-max-length
+blocking
 .It
-max-length-bytes
-.El
-.\" ------------------------------------
-.It Cm clear_operator_policy Oo Fl p Ar vhost Oc Ar name
-Clears an operator policy.
-Arguments are identical to those of
-.Cm clear_policy .
-.\" ------------------------------------
-.It Cm list_operator_policies Op Fl p Ar vhost
-Lists operator policy overrides for a virtual host.
-Arguments are identical to those of
-.Cm list_policies .
+blocked
+.It
+closing
+.It
+closed
 .El
-.Ss Virtual Host Limits
-It is possible to enforce certain limits on virtual hosts.
-.Bl -tag -width Ds
-.\" ------------------------------------
-.It Cm set_vhost_limits Oo Fl p Ar vhost Oc Ar definition
-Sets virtual host limits.
-.Bl -tag -width Ds
-.It Ar definition
-The definition of the limits, as a JSON term.
-In most shells you are very likely to need to quote this.
-.Pp
-Recognised limits are:
+.It Cm channels
+Number of channels using the connection.
+.It Cm protocol
+Version of the AMQP protocol in use; currently one of:
 .Bl -bullet -compact
 .It
-max-connections
+{0,9,1}
 .It
-max-queues
+{0,8,0}
 .El
 .Pp
-Use a negative value to specify "no limit".
+Note that if a client requests an AMQP 0-9 connection, we treat it as
+AMQP 0-9-1.
+.It Cm auth_mechanism
+SASL authentication mechanism used, such as
+.Qq PLAIN .
+.It Cm user
+Username associated with the connection.
+.It Cm vhost
+Virtual host name with non-ASCII characters escaped as in C.
+.It Cm timeout
+Connection timeout / negotiated heartbeat interval, in seconds.
+.It Cm frame_max
+Maximum frame size (bytes).
+.It Cm channel_max
+Maximum number of channels on this connection.
+.It Cm client_properties
+Informational properties transmitted by the client during connection
+establishment.
+.It Cm recv_oct
+Octets received.
+.It Cm recv_cnt
+Packets received.
+.It Cm send_oct
+Octets send.
+.It Cm send_cnt
+Packets sent.
+.It Cm send_pend
+Send queue size.
+.It Cm connected_at
+Date and time this connection was established, as timestamp.
 .El
 .Pp
-For example, this command limits the max number of concurrent
-connections in vhost
-.Qq qa_env
-to 64:
-.sp
-.Dl rabbitmqctl set_vhost_limits -p qa_env '{"max-connections": 64}'
+If no
+.Ar connectioninfoitem
+are specified then user, peer host, peer port, time since flow control
+and memory block state are displayed.
 .Pp
-This command limits the max number of queues in vhost
-.Qq qa_env
-to 256:
+For example, this command displays the send queue size and server port
+for each connection:
 .sp
-.Dl rabbitmqctl set_vhost_limits -p qa_env '{"max-queues": 256}'
+.Dl rabbitmqctl list_connections send_pend port
+.\" ------------------------------------------------------------------
+.It Cm list_consumers Op Fl p Ar vhost
 .Pp
-This command clears the max number of connections limit in vhost
-.Qq qa_env :
-.sp
-.Dl rabbitmqctl set_vhost_limits -p qa_env '{"max\-connections": \-1}'
+Lists 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, a boolean indicating
+whether acknowledgements are expected for messages delivered to this
+consumer, an integer indicating the prefetch limit (with 0 meaning
+.Qq none ) ,
+and any arguments for this consumer.
+.\" ------------------------------------------------------------------
+.It Cm list_exchanges Oo Fl p Ar vhost Oc Op Ar exchangeinfoitem ...
 .Pp
-This command disables client connections in vhost
-.Qq qa_env :
-.sp
-.Dl rabbitmqctl set_vhost_limits -p qa_env '{"max-connections": 0}'
-.\" ------------------------------------
-.It Cm clear_vhost_limits Op Fl p Ar vhost
-Clears virtual host limits.
+Returns exchange details.
+Exchange details of the
+.Qq /
+virtual host are returned if the
+.Fl p
+flag is absent.
+The
+.Fl p
+flag can be used to override this default.
 .Pp
-For example, this command clears vhost limits in vhost
-.Qq qa_env :
-.sp
-.Dl rabbitmqctl clear_vhost_limits -p qa_env
-.\" ------------------------------------
-.It Cm list_vhost_limits Oo Fl p Ar vhost Oc Op Fl -global
-Displays configured virtual host limits.
+The
+.Ar exchangeinfoitem
+parameter is used to indicate which exchange information items to
+include in the results.
+The column order in the results will match the order of the parameters.
+.Ar exchangeinfoitem
+can take any value from the list that follows:
 .Bl -tag -width Ds
-.It Fl -global
-Show limits for all vhosts.
-Suppresses the
-.Fl p
-parameter.
+.It Cm name
+The name of the exchange with non-ASCII characters escaped as in C.
+.It Cm type
+The exchange type, such as:
+.Bl -bullet -compact
+.It
+direct
+.It
+topic
+.It
+headers
+.It
+fanout
 .El
+.It Cm durable
+Whether or not the exchange survives server restarts.
+.It Cm auto_delete
+Whether the exchange will be deleted automatically when no longer used.
+.It Cm internal
+Whether the exchange is internal, i.e. cannot be directly published to
+by a client.
+.It Cm arguments
+Exchange arguments.
+.It Cm policy
+Policy name for applying to the exchange.
 .El
-.Ss Topology Introspection
-The topology introspection commands list topology entities (e.g. queues) with tab-delimited columns.
-Some commands (
-.Cm list_queues ,
-.Cm list_exchanges ,
-.Cm list_bindings
-and
-.Cm list_consumers )
-accept an optional
-.Ar vhost
-parameter.
 .Pp
-The
-.Cm list_queues ,
-.Cm list_exchanges
-and
-.Cm list_bindings
-commands accept an optional virtual host parameter for which to display
-results.
-The default value is
-.Qq / .
-.Bl -tag -width Ds
-.\" ------------------------------------
+If no
+.Ar exchangeinfoitem
+are specified then exchange name and type are displayed.
+.Pp
+For example, this command displays the name and type for each exchange
+of the virtual host named
+.Qq my-vhost :
+.sp
+.Dl rabbitmqctl list_exchanges -p my-vhost name type
+.\" ------------------------------------------------------------------
+.It Cm list_hashes
+.Pp
+Lists hash functions supported by encoding commands.
+.Pp
+For example, this command instructs the RabbitMQ broker to list all hash
+functions supported by encoding commands:
+.sp
+.Dl rabbitmqctl list_hashes
+.\" ------------------------------------------------------------------
 .It Cm list_queues Oo Fl p Ar vhost Oc Oo Fl -offline | Fl -online | Fl -local Oc Op Ar queueinfoitem ...
+.Pp
 Returns queue details.
 Queue details of the
 .Qq /
@@ -1399,413 +1447,396 @@ each queue of the virtual host named
 .Qq my-vhost
 .sp
 .Dl rabbitmqctl list_queues -p my-vhost messages consumers
-.\" ------------------------------------
-.It Cm list_exchanges Oo Fl p Ar vhost Oc Op Ar exchangeinfoitem ...
-Returns exchange details.
-Exchange details of the
-.Qq /
-virtual host are returned if the
-.Fl p
-flag is absent.
-The
-.Fl p
-flag can be used to override this default.
+.\" ------------------------------------------------------------------
+.It Cm list_unresponsive_queues Oo Fl -local Oc Oo Fl -queue_timeout Ar milliseconds Oc Oo Ar column ... Oc Op Fl -no-table-headers
 .Pp
-The
-.Ar exchangeinfoitem
-parameter is used to indicate which exchange information items to
-include in the results.
-The column order in the results will match the order of the parameters.
-.Ar exchangeinfoitem
-can take any value from the list that follows:
+Tests queues to respond within timeout. Lists those which did not respond
+.Pp
+For example, this command lists only those unresponsive queues whose master process
+is located on the current node.
+.Sp
+.Dl rabbitmqctl list_unresponsive_queues --local name
+.\" ------------------------------------------------------------------
+.It Cm node_health_check
+.Pp
+Performs several health checks of the target node.
+.Pp
+Verifies the rabbit application is running and alarms are not set,
+then checks that every queue and channel on the node can emit basic stats.
+.sp
+Example:
+.Dl rabbitmqctl node_health_check -n rabbit@hostname
+.\" ------------------------------------------------------------------
+.It Cm ping
+.Pp
+Checks that the node OS process is up, registered with EPMD and CLI tools can authenticate with it
+.Pp
+Example:
+.Dl rabbitmqctl ping -n rabbit@hostname
+.\" ------------------------------------------------------------------
+.It Cm report
+.Pp
+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.
+.Pp
+For example, this command creates a server report which may be attached
+to a support request email:
+.sp
+.Dl rabbitmqctl report > server_report.txt
+.\" ------------------------------------------------------------------
+.It Cm schema_info Oo Fl -no-table-headers Oc Op Ar column ...
+.Pp
+Lists schema database tables and their properties
+.Pp
+For example, this command lists the table names and their active replicas:
+.sp
+.Dl rabbitmqctl schema_info name active_replicas
+.\" ------------------------------------------------------------------
+.It Cm status
+.Pp
+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
+.Cm cluster_status
+command to find out which nodes are clustered and running.)
+.Pp
+For example, this command displays information about the RabbitMQ
+broker:
+.sp
+.Dl rabbitmqctl status
+.El
+.\" ------------------------------------------------------------------
+.\" ## Runtime Parameters and Policies
+.\" ------------------------------------------------------------------
+.Ss Runtime Parameters and Policies
+Some settings must be identical on all cluster nodes and are likely
+to change at runtime. They are controlled via a mechanism
+called runtime 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.
 .Bl -tag -width Ds
-.It Cm name
-The name of the exchange with non-ASCII characters escaped as in C.
-.It Cm type
-The exchange type, such as:
-.Bl -bullet -compact
-.It
-direct
-.It
-topic
-.It
-headers
-.It
-fanout
+.\" ------------------------------------------------------------------
+.It Cm clear_global_parameter Ar name
+.Pp
+Clears a global runtime parameter.
+This is similar to
+.Cm clear_parameter
+but the key-value pair isn't tied to a virtual host.
+.Bl -tag -width Ds
+.It Ar name
+The name of the global runtime parameter being cleared.
 .El
-.It Cm durable
-Whether or not the exchange survives server restarts.
-.It Cm auto_delete
-Whether the exchange will be deleted automatically when no longer used.
-.It Cm internal
-Whether the exchange is internal, i.e. cannot be directly published to
-by a client.
-.It Cm arguments
-Exchange arguments.
-.It Cm policy
-Policy name for applying to the exchange.
+.Pp
+For example, this command clears the global runtime parameter
+.Qq mqtt_default_vhosts :
+.sp
+.Dl rabbitmqctl clear_global_parameter mqtt_default_vhosts
+.\" ------------------------------------------------------------------
+.It Cm clear_parameter Oo Fl p Ar vhost Oc Ar component_name Ar key
+.Pp
+Clears a parameter.
+.Bl -tag -width Ds
+.It Ar component_name
+The name of the component for which the parameter is being cleared.
+.It Ar name
+The name of the parameter being cleared.
 .El
 .Pp
-If no
-.Ar exchangeinfoitem
-are specified then exchange name and type are displayed.
+For example, this command clears the parameter
+.Qq node01
+for the
+.Qq federation-upstream
+component in the default virtual host:
+.sp
+.Dl rabbitmqctl clear_parameter federation-upstream node01
+.\" ------------------------------------------------------------------
+.It Cm list_global_parameters
 .Pp
-For example, this command displays the name and type for each exchange
-of the virtual host named
-.Qq my-vhost :
+Lists all global runtime parameters.
+This is similar to
+.Cm list_parameters
+but the global runtime parameters are not tied to any virtual host.
+.Pp
+For example, this command lists all global parameters:
 .sp
-.Dl rabbitmqctl list_exchanges -p my-vhost name type
-.\" ------------------------------------
-.It Cm list_bindings Oo Fl p Ar vhost Oc Op Ar bindinginfoitem ...
-Returns binding details.
-By default the bindings for the
-.Qq /
-virtual host are returned.
-The
-.Fl p
-flag can be used to override this default.
+.Dl rabbitmqctl list_global_parameters
+.\" ------------------------------------------------------------------
+.It Cm list_parameters Op Fl p Ar vhost
 .Pp
-The
-.Ar 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.
-.Ar bindinginfoitem
-can take any value from the list that follows:
+Lists all parameters for a virtual host.
+.Pp
+For example, this command lists all parameters in the default virtual
+host:
+.sp
+.Dl rabbitmqctl list_parameters
+.\" ------------------------------------------------------------------
+.It Cm set_global_parameter Ar name Ar value
+.Pp
+Sets a global runtime parameter.
+This is similar to
+.Cm set_parameter
+but the key-value pair isn't tied to a virtual host.
 .Bl -tag -width Ds
-.It Cm source_name
-The name of the source of messages to which the binding is attached.
-With non-ASCII characters escaped as in C.
-.It Cm source_kind
-The kind of the source of messages to which the binding is attached.
-Currently always exchange.
-With non-ASCII characters escaped as in C.
-.It Cm destination_name
-The name of the destination of messages to which the binding is
-attached.
-With non-ASCII characters escaped as in C.
-.It Cm destination_kind
-The kind of the destination of messages to which the binding is
-attached.
-With non-ASCII characters escaped as in C.
-.It Cm routing_key
-The binding's routing key, with non-ASCII characters escaped as in C.
-.It Cm arguments
-The binding's arguments.
+.It Ar name
+The name of the global runtime parameter being set.
+.It Ar value
+The value for the global runtime parameter, as a JSON term.
+In most shells you are very likely to need to quote this.
 .El
 .Pp
-If no
-.Ar bindinginfoitem
-are specified then all above items are displayed.
-.Pp
-For example, this command displays the exchange name and queue name of
-the bindings in the virtual host named
-.Qq my-vhost
+For example, this command sets the global runtime parameter
+.Qq mqtt_default_vhosts
+to the JSON term {"O=client,CN=guest":"/"}:
 .sp
-.Dl rabbitmqctl list_bindings -p my-vhost exchange_name queue_name
-.\" ------------------------------------
-.It Cm list_connections Op Ar connectioninfoitem ...
-Returns TCP/IP connection statistics.
+.Dl rabbitmqctl set_global_parameter mqtt_default_vhosts '{"O=client,CN=guest":"/"}'
+.\" ------------------------------------------------------------------
+.It Cm set_parameter Oo Fl p Ar vhost Oc Ar component_name Ar name Ar value
 .Pp
-The
-.Ar 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.
-.Ar connectioninfoitem
-can take any value from the list that follows:
+Sets a parameter.
 .Bl -tag -width Ds
-.It Cm pid
-Id of the Erlang process associated with the connection.
-.It Cm name
-Readable name for the connection.
-.It Cm port
-Server port.
-.It Cm host
-Server hostname obtained via reverse DNS, or its IP address if reverse
-DNS failed or was disabled.
-.It Cm peer_port
-Peer port.
-.It Cm peer_host
-Peer hostname obtained via reverse DNS, or its IP address if reverse DNS
-failed or was not enabled.
-.It Cm ssl
-Boolean indicating whether the connection is secured with SSL.
-.It Cm ssl_protocol
-SSL protocol (e.g.\&
-.Qq tlsv1 ) .
-.It Cm ssl_key_exchange
-SSL key exchange algorithm (e.g.\&
-.Qq rsa ) .
-.It Cm ssl_cipher
-SSL cipher algorithm (e.g.\&
-.Qq aes_256_cbc ) .
-.It Cm ssl_hash
-SSL hash function (e.g.\&
-.Qq sha ) .
-.It Cm peer_cert_subject
-The subject of the peer's SSL certificate, in RFC4514 form.
-.It Cm peer_cert_issuer
-The issuer of the peer's SSL certificate, in RFC4514 form.
-.It Cm peer_cert_validity
-The period for which the peer's SSL certificate is valid.
-.It Cm state
-Connection state; one of:
+.It Ar component_name
+The name of the component for which the parameter is being set.
+.It Ar name
+The name of the parameter being set.
+.It Ar value
+The value for the parameter, as a JSON term.
+In most shells you are very likely to need to quote this.
+.El
+.Pp
+For example, this command sets the parameter
+.Qq node01
+for the
+.Qq federation-upstream
+component in the default virtual host to the following JSON
+.Qq guest :
+.sp
+.Dl rabbitmqctl set_parameter federation-upstream node01 '{"uri":"amqp://user:password@server/%2F","ack-mode":"on-publish"}'
+.\" ------------------------------------------------------------------
+.It Cm list_policies Op Fl p Ar vhost
+.Pp
+Lists all policies for a virtual host.
+.Pp
+For example, this command lists all policies in the default virtual
+host:
+.sp
+.Dl rabbitmqctl list_policies
+.\" ------------------------------------------------------------------
+.It Cm set_operator_policy Oo Fl p Ar vhost Oc Oo Fl -priority Ar priority Oc Oo Fl -apply-to Ar apply-to Oc Ar name Ar pattern Ar definition
+.Pp
+Sets an operator policy that overrides a subset of arguments in user
+policies.
+Arguments are identical to those of
+.Cm set_policy .
+.Pp
+Supported arguments are:
 .Bl -bullet -compact
 .It
-starting
-.It
-tuning
-.It
-opening
-.It
-running
-.It
-flow
-.It
-blocking
+expires
 .It
-blocked
+message-ttl
 .It
-closing
+max-length
 .It
-closed
+max-length-bytes
 .El
-.It Cm channels
-Number of channels using the connection.
-.It Cm protocol
-Version of the AMQP protocol in use; currently one of:
+.\" ------------------------------------------------------------------
+.It Cm set_policy Oo Fl p Ar vhost Oc Oo Fl -priority Ar priority Oc Oo Fl -apply-to Ar apply-to Oc Ar name Ar pattern Ar definition
+.Pp
+Sets a policy.
+.Bl -tag -width Ds
+.It Ar name
+The name of the policy.
+.It Ar pattern
+The regular expression, which when matches on a given resources causes
+the policy to apply.
+.It Ar definition
+The definition of the policy, as a JSON term.
+In most shells you are very likely to need to quote this.
+.It Ar priority
+The priority of the policy as an integer.
+Higher numbers indicate greater precedence.
+The default is 0.
+.It Ar apply-to
+Which types of object this policy should apply to.
+Possible values are:
 .Bl -bullet -compact
 .It
-{0,9,1}
+queues
 .It
-{0,8,0}
+exchanges
+.It
+all
 .El
-.Pp
-Note that if a client requests an AMQP 0-9 connection, we treat it as
-AMQP 0-9-1.
-.It Cm auth_mechanism
-SASL authentication mechanism used, such as
-.Qq PLAIN .
-.It Cm user
-Username associated with the connection.
-.It Cm vhost
-Virtual host name with non-ASCII characters escaped as in C.
-.It Cm timeout
-Connection timeout / negotiated heartbeat interval, in seconds.
-.It Cm frame_max
-Maximum frame size (bytes).
-.It Cm channel_max
-Maximum number of channels on this connection.
-.It Cm client_properties
-Informational properties transmitted by the client during connection
-establishment.
-.It Cm recv_oct
-Octets received.
-.It Cm recv_cnt
-Packets received.
-.It Cm send_oct
-Octets send.
-.It Cm send_cnt
-Packets sent.
-.It Cm send_pend
-Send queue size.
-.It Cm connected_at
-Date and time this connection was established, as timestamp.
+The default is
+.Cm all ..
 .El
 .Pp
-If no
-.Ar connectioninfoitem
-are specified then user, peer host, peer port, time since flow control
-and memory block state are displayed.
-.Pp
-For example, this command displays the send queue size and server port
-for each connection:
+For example, this command sets the policy
+.Qq federate-me
+in the default virtual host so that built-in exchanges are federated:
 .sp
-.Dl rabbitmqctl list_connections send_pend port
-.\" ------------------------------------
-.It Cm list_channels Op Ar channelinfoitem ...
-Returns information on all current channels, the logical containers
-executing most AMQP commands.
-This includes channels that are part of ordinary AMQP connections, and
-channels created by various plug-ins and other extensions.
+.Dl rabbitmqctl set_policy federate-me "^amq." '{"federation-upstream-set":"all"}'
+.\" ------------------------------------------------------------------
+.It Cm clear_policy Oo Fl p Ar vhost Oc Ar name
 .Pp
-The
-.Ar 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.
-.Ar channelinfoitem
-can take any value from the list that follows:
+Clears a policy.
 .Bl -tag -width Ds
-.It Cm pid
-Id of the Erlang process associated with the connection.
-.It Cm connection
-Id of the Erlang process associated with the connection to which the
-channel belongs.
-.It Cm name
-Readable name for the channel.
-.It Cm number
-The number of the channel, which uniquely identifies it within a
-connection.
-.It Cm user
-Username associated with the channel.
-.It Cm vhost
-Virtual host in which the channel operates.
-.It Cm transactional
-True if the channel is in transactional mode, false otherwise.
-.It Cm confirm
-True if the channel is in confirm mode, false otherwise.
-.It Cm consumer_count
-Number of logical AMQP consumers retrieving messages via the channel.
-.It Cm messages_unacknowledged
-Number of messages delivered via this channel but not yet acknowledged.
-.It Cm messages_uncommitted
-Number of messages received in an as yet uncommitted transaction.
-.It Cm acks_uncommitted
-Number of acknowledgements received in an as yet uncommitted transaction.
-.It Cm messages_unconfirmed
-Number of published messages not yet confirmed.
-On channels not in confirm mode, this remains 0.
-.It Cm prefetch_count
-QoS prefetch limit for new consumers, 0 if unlimited.
-.It Cm global_prefetch_count
-QoS prefetch limit for the entire channel, 0 if unlimited.
+.It Ar name
+The name of the policy being cleared.
 .El
 .Pp
-If no
-.Ar channelinfoitem
-are specified then pid, user, consumer_count, and
-messages_unacknowledged are assumed.
-.Pp
-For example, this command displays the connection process and count of
-unacknowledged messages for each channel:
+For example, this command clears the
+.Qq federate-me
+policy in the default virtual host:
 .sp
-.Dl rabbitmqctl list_channels connection messages_unacknowledged
-.\" ------------------------------------
-.It Cm list_consumers Op Fl p Ar vhost
-Lists 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, a boolean indicating
-whether acknowledgements are expected for messages delivered to this
-consumer, an integer indicating the prefetch limit (with 0 meaning
-.Qq none ) ,
-and any arguments for this consumer.
-.\" ------------------------------------
-.It Cm status
-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
-.Cm cluster_status
-command to find out which nodes are clustered and running.)
+.Dl rabbitmqctl clear_policy federate-me
+.\" ------------------------------------------------------------------
+.It Cm clear_operator_policy Oo Fl p Ar vhost Oc Ar name
 .Pp
-For example, this command displays information about the RabbitMQ
-broker:
-.sp
-.Dl rabbitmqctl status
-.\" ------------------------------------
-.It Cm node_health_check
-Performs several health checks of the target node.
+Clears an operator policy.
+Arguments are identical to those of
+.Cm clear_policy .
+.\" ------------------------------------------------------------------
+.It Cm list_operator_policies Op Fl p Ar vhost
 .Pp
-Verifies the rabbit application is running and alarms are not set,
-then checks that every queue and channel on the node can emit basic stats.
-.sp
-Example:
-.Dl rabbitmqctl node_health_check -n rabbit@hostname
-.\" ------------------------------------
-.It Cm environment
-Displays the name and value of each variable in the application
-environment for each running application.
-.\" ------------------------------------
-.It Cm report
-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.
+Lists operator policy overrides for a virtual host.
+Arguments are identical to those of
+.Cm list_policies .
+.El
+.\" ------------------------------------------------------------------
+.\" ## Virtual Host Management
+.\" ------------------------------------------------------------------
+.Ss Virtual hosts
+Note that
+.Nm
+manages the RabbitMQ internal user database.
+Permissions for users from any alternative authorisation backend will
+not be visible to
+.Nm .
+.Bl -tag -width Ds
+.\" ------------------------------------------------------------------
+.It Cm add_vhost Ar vhost
+.Bl -tag -width Ds
+.It Ar vhost
+The name of the virtual host entry to create.
+.El
 .Pp
-For example, this command creates a server report which may be attached
-to a support request email:
-.sp
-.Dl rabbitmqctl report > server_report.txt
-.\" ------------------------------------
-.It Cm eval Ar expr
-Evaluate an arbitrary Erlang expression.
+Creates a virtual host.
 .Pp
-For example, this command returns the name of the node to which
-.Nm
-has connected:
+For example, this command instructs the RabbitMQ broker to create a new
+virtual host called
+.Qq test :
+.Pp
+.Dl rabbitmqctl add_vhost test
+.\" ------------------------------------------------------------------
+.It Cm clear_vhost_limits Op Fl p Ar vhost
+.Pp
+Clears virtual host limits.
+.Pp
+For example, this command clears vhost limits in vhost
+.Qq qa_env :
 .sp
-.Dl rabbitmqctl eval Qq node().
-.El
-.Ss Miscellaneous
-.Bl -tag -width Ds
-.\" ------------------------------------
-.It Cm close_connection Ar connectionpid Ar explanation
+.Dl rabbitmqctl clear_vhost_limits -p qa_env
+.\" ------------------------------------------------------------------
+.It Cm delete_vhost Ar vhost
 .Bl -tag -width Ds
-.It Ar connectionpid
-Id of the Erlang process associated with the connection to close.
-.It Ar explanation
-Explanation string.
+.It Ar vhost
+The name of the virtual host entry to delete.
 .El
 .Pp
-Instructs the broker to close the connection associated with the Erlang
-process id
-.Ar connectionpid
-(see also the
-.Cm list_connections
-command), passing the
-.Ar explanation
-string to the connected client as part of the AMQP connection shutdown
-protocol.
+Deletes a virtual host.
 .Pp
-For example, this command instructs the RabbitMQ broker to close the connection associated with the Erlang process id
-.Qq <rabbit@tanto.4262.0> ,
-passing the explanation
-.Qq go away
-to the connected client:
+Deleting a virtual host deletes all its exchanges, queues, bindings,
+user permissions, parameters and policies.
+.Pp
+For example, this command instructs the RabbitMQ broker to delete the
+virtual host called
+.Qq test :
 .sp
-.Dl rabbitmqctl close_connection Qo <rabbit@tanto.4262.0> Qc Qq go away
-.\" ------------------------------------
-.It Cm close_all_connections Oo Fl p Ar vhost Oc Oo Fl -global Oc Oo Fl -per-connection-delay Ar delay Oc Oo Fl -limit Ar limit Oc Ar explanation
+.Dl rabbitmqctl delete_vhost a-vhost
+.\" ------------------------------------------------------------------
+.It Cm list_vhost_limits Oo Fl p Ar vhost Oc Oo Fl -global Oc Op Fl -no-table-headers
+.Pp
+Displays configured virtual host limits.
 .Bl -tag -width Ds
-.It Fl p Ar vhost
-The name of the virtual host for which connections should be closed.
-Ignored when
-.Fl -global
-is specified.
 .It Fl -global
-If connections should be close for all vhosts.
-Overrides
+Show limits for all vhosts.
+Suppresses the
 .Fl p
-.It Fl -per-connection-delay Ar delay
-Time in milliseconds to wait after each connection closing.
-.It Fl -limit Ar limit
-Number of connection to close.
-Only works per vhost.
-Ignored when
-.Fl -global
-is specified.
-.It Ar explanation
-Explanation string.
+parameter.
+.El
+.\" ------------------------------------------------------------------
+.It Cm restart_vhost Ar vhost
+.Bl -tag -width Ds
+.It Ar vhost
+The name of the virtual host entry to restart.
 .El
 .Pp
-Instructs the broker to close all connections for the specified vhost or entire RabbitMQ node.
+Restarts a failed vhost data stores and queues.
 .Pp
-For example, this command instructs the RabbitMQ broker to close 10 connections on
+For example, this command instructs the RabbitMQ broker to restart a
+virtual host called
+.Qq test :
+.Pp
+.Dl rabbitmqctl restart_vhost test
+.\" ------------------------------------------------------------------
+.It Cm set_vhost_limits Oo Fl p Ar vhost Oc Ar definition
+.Pp
+Sets virtual host limits.
+.Bl -tag -width Ds
+.It Ar definition
+The definition of the limits, as a JSON term.
+In most shells you are very likely to need to quote this.
+.Pp
+Recognised limits are:
+.Bl -bullet -compact
+.It
+max-connections
+.It
+max-queues
+.El
+.Pp
+Use a negative value to specify "no limit".
+.El
+.Pp
+For example, this command limits the max number of concurrent
+connections in vhost
 .Qq qa_env
-vhost, passing the explanation
-.Qq Please close :
+to 64:
 .sp
-.Dl rabbitmqctl close_all_connections -p qa_env --limit 10 'Please close'
+.Dl rabbitmqctl set_vhost_limits -p qa_env '{"max-connections": 64}'
 .Pp
-This command instructs broker to close all connections to the node:
+This command limits the max number of queues in vhost
+.Qq qa_env
+to 256:
 .sp
-.Dl rabbitmqctl close_all_connections --global
+.Dl rabbitmqctl set_vhost_limits -p qa_env '{"max-queues": 256}'
+.Pp
+This command clears the max number of connections limit in vhost
+.Qq qa_env :
+.sp
+.Dl rabbitmqctl set_vhost_limits -p qa_env '{"max\-connections": \-1}'
+.Pp
+This command disables client connections in vhost
+.Qq qa_env :
 .sp
-.\" ------------------------------------
+.Dl rabbitmqctl set_vhost_limits -p qa_env '{"max-connections": 0}'
+.\" ------------------------------------------------------------------
+.It Cm trace_off Op Fl p Ar vhost
+.Bl -tag -width Ds
+.It Ar vhost
+The name of the virtual host for which to stop tracing.
+.El
+.Pp
+Stops tracing.
+.\" ------------------------------------------------------------------
 .It Cm trace_on Op Fl p Ar vhost
 .Bl -tag -width Ds
 .It Ar vhost
@@ -1814,24 +1845,110 @@ The name of the virtual host for which to start tracing.
 .Pp
 Starts tracing.
 Note that the trace state is not persistent; it will revert to being off
-if the server is restarted.
-.\" ------------------------------------
-.It Cm trace_off Op Fl p Ar vhost
+if the node is restarted.
+.El
+.\" ------------------------------------------------------------------
+.\" ## Configuration
+.\" ------------------------------------------------------------------
+.Ss Configuration
 .Bl -tag -width Ds
-.It Ar vhost
-The name of the virtual host for which to stop tracing.
+.\" ------------------------------------------------------------------
+.It Cm decode Ar value Ar passphrase Oo Fl -cipher Ar cipher Oc Oo Fl -hash Ar hash Oc Op Fl -iterations Ar iterations
+.Bl -tag -width Ds
+.It Ar value Ar passphrase
+Value to decrypt (as produced by the encode command) and passphrase.
+.Pp
+For example:
+.sp
+.Dl rabbitmqctl decode '{encrypted, <<"...">>}' mypassphrase
+.It Fl -cipher Ar cipher Fl -hash Ar hash Fl -iterations Ar iterations
+Options to specify the decryption settings.
+They can be used independently.
+.Pp
+For example:
+.sp
+.Dl rabbitmqctl decode --cipher blowfish_cfb64 --hash sha256 --iterations 10000 '{encrypted,<<"...">>} mypassphrase
 .El
+.\" ------------------------------------------------------------------
+.It Cm encode Ar value Ar passphrase Oo Fl -cipher Ar cipher Oc Oo Fl -hash Ar hash Oc Op Fl -iterations Ar iterations
+.Bl -tag -width Ds
+.It Ar value Ar passphrase
+Value to encrypt and passphrase.
 .Pp
-Stops tracing.
-.\" ------------------------------------
+For example:
+.sp
+.Dl rabbitmqctl encode '<<"guest">>' mypassphrase
+.It Fl -cipher Ar cipher Fl -hash Ar hash Fl -iterations Ar iterations
+Options to specify the encryption settings.
+They can be used independently.
+.Pp
+For example:
+.sp
+.Dl rabbitmqctl encode --cipher blowfish_cfb64 --hash sha256 --iterations 10000 '<<"guest">>' mypassphrase
+.El
+.\" ------------------------------------------------------------------
+.It Cm set_cluster_name Ar name
+.Pp
+Sets the cluster name to
+.Ar name .
+The cluster name is announced to clients on connection, and used by the
+federation 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.
+.Pp
+For example, this sets the cluster name to
+.Qq london :
+.sp
+.Dl rabbitmqctl set_cluster_name london
+.\" ------------------------------------------------------------------
+.It Cm set_disk_free_limit Ar disk_limit
+.Bl -tag -width Ds
+.It Ar disk_limit
+Lower bound limit as an integer in bytes or a string with memory unit symbols
+(see vm_memory_high_watermark), e.g. 512M or 1G.
+Once free disk space reaches the limit, a disk alarm will be set.
+.El
+.\" ------------------------------------------------------------------
+.It Cm set_disk_free_limit mem_relative Ar fraction
+.Bl -tag -width Ds
+.It Ar 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.
+.El
+.\" ------------------------------------------------------------------
+.It Cm set_log_level Op Ar log_level
+.Pp
+Sets log level in the running node
+.Pp
+Supported
+.Ar type
+values are:
+.Bl -bullet -compact
+.It
+debug
+.It
+info
+.It
+warning
+.It
+error
+.It
+none
+.El
+.Pp
+Example:
+.Sp
+.Dl rabbitmqctl log_level debug
+.\" ------------------------------------------------------------------
 .It Cm set_vm_memory_high_watermark Ar fraction
 .Bl -tag -width Ds
 .It Ar fraction
 The new memory threshold fraction at which flow control is triggered, as
 a floating point number greater than or equal to 0.
 .El
-.\" ------------------------------------
-.It Cm set_vm_memory_high_watermark absolute Ar memory_limit
+.\" ------------------------------------------------------------------
+.It Cm set_vm_memory_high_watermark Oo absolute Oc Ar memory_limit
 .Bl -tag -width Ds
 .It Ar memory_limit
 The new memory limit at which flow control is triggered, expressed in
@@ -1853,90 +1970,197 @@ megabytes (10^6 bytes)
 gigabytes (10^9 bytes)
 .El
 .El
-.\" ------------------------------------
-.It Cm set_disk_free_limit Ar disk_limit
-.Bl -tag -width Ds
-.It Ar disk_limit
-Lower bound limit as an integer in bytes or a string with memory unit symbols
-(see vm_memory_high_watermark), e.g. 512M or 1G.
-Once free disk space reaches the limit, a disk alarm will be set.
 .El
-.\" ------------------------------------
-.It Cm set_disk_free_limit mem_relative Ar fraction
+.\" ------------------------------------------------------------------
+.\" ## Feature Flags
+.\" ------------------------------------------------------------------
+.Ss Feature flags
 .Bl -tag -width Ds
-.It Ar 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.
+.\" ------------------------------------------------------------------
+.It Cm enable_feature_flag Ar feature_flag
+.Pp
+Enables a feature flag on the target node.
+.Pp
+Example:
+.Sp
+.Dl rabbitmqctl enable_feature_flag quorum_queue
+.\" ------------------------------------------------------------------
+.It Cm list_feature_flags Op Ar column ...
+.Pp
+Lists feature flags
+.Pp
+Supported
+.Ar column
+values are:
+.Bl -bullet -compact
+.It
+name
+.It
+state
+.It
+stability
+.It
+provided_by
+.It
+desc
+.It
+doc_url
 .El
-.\" ------------------------------------
-.It Cm encode Ar value Ar passphrase Oo Fl -cipher Ar cipher Oc Oo Fl -hash Ar hash Oc Op Fl -iterations Ar iterations
+.Pp
+Example:
+.Sp
+.Dl rabbitmqctl list_feature_flags name state
+.El
+.\" ------------------------------------------------------------------
+.\" ## Misc Operations
+.\" ------------------------------------------------------------------
+.Ss Connection Operations
 .Bl -tag -width Ds
-.It Ar value Ar passphrase
-Value to encrypt and passphrase.
+.\" ------------------------------------------------------------------
+.It Cm close_all_connections Oo Fl p Ar vhost Oc Oo Fl -global Oc Oo Fl -per-connection-delay Ar delay Oc Oo Fl -limit Ar limit Oc Ar explanation
+.Bl -tag -width Ds
+.It Fl p Ar vhost
+The name of the virtual host for which connections should be closed.
+Ignored when
+.Fl -global
+is specified.
+.It Fl -global
+If connections should be close for all vhosts.
+Overrides
+.Fl p
+.It Fl -per-connection-delay Ar delay
+Time in milliseconds to wait after each connection closing.
+.It Fl -limit Ar limit
+Number of connection to close.
+Only works per vhost.
+Ignored when
+.Fl -global
+is specified.
+.It Ar explanation
+Explanation string.
+.El
 .Pp
-For example:
+Instructs the broker to close all connections for the specified vhost or entire RabbitMQ node.
+.Pp
+For example, this command instructs the RabbitMQ broker to close 10 connections on
+.Qq qa_env
+vhost, passing the explanation
+.Qq Please close :
 .sp
-.Dl rabbitmqctl encode '<<"guest">>' mypassphrase
-.It Fl -cipher Ar cipher Fl -hash Ar hash Fl -iterations Ar iterations
-Options to specify the encryption settings.
-They can be used independently.
+.Dl rabbitmqctl close_all_connections -p qa_env --limit 10 'Please close'
 .Pp
-For example:
+This command instructs broker to close all connections to the node:
 .sp
-.Dl rabbitmqctl encode --cipher blowfish_cfb64 --hash sha256 --iterations 10000 '<<"guest">>' mypassphrase
-.El
-.\" ------------------------------------
-.It Cm decode Ar value Ar passphrase Oo Fl -cipher Ar cipher Oc Oo Fl -hash Ar hash Oc Op Fl -iterations Ar iterations
+.Dl rabbitmqctl close_all_connections --global
+.sp
+.\" ------------------------------------------------------------------
+.It Cm close_connection Ar connectionpid Ar explanation
 .Bl -tag -width Ds
-.It Ar value Ar passphrase
-Value to decrypt (as produced by the encode command) and passphrase.
+.It Ar connectionpid
+Id of the Erlang process associated with the connection to close.
+.It Ar explanation
+Explanation string.
+.El
 .Pp
-For example:
-.sp
-.Dl rabbitmqctl decode '{encrypted, <<"...">>}' mypassphrase
-.It Fl -cipher Ar cipher Fl -hash Ar hash Fl -iterations Ar iterations
-Options to specify the decryption settings.
-They can be used independently.
+Instructs the broker to close the connection associated with the Erlang
+process id
+.Ar connectionpid
+(see also the
+.Cm list_connections
+command), passing the
+.Ar explanation
+string to the connected client as part of the AMQP connection shutdown
+protocol.
 .Pp
-For example:
+For example, this command instructs the RabbitMQ broker to close the connection associated with the Erlang process id
+.Qq <rabbit@tanto.4262.0> ,
+passing the explanation
+.Qq go away
+to the connected client:
 .sp
-.Dl rabbitmqctl decode --cipher blowfish_cfb64 --hash sha256 --iterations 10000 '{encrypted,<<"...">>} mypassphrase
+.Dl rabbitmqctl close_connection Qo <rabbit@tanto.4262.0> Qc Qq go away
 .El
-.\" ------------------------------------
-.It Cm list_hashes
-Lists hash functions supported by encoding commands.
+.\" ------------------------------------------------------------------
+.\" ## Misc
+.\" ------------------------------------------------------------------
+.Ss Misc
+.Bl -tag -width Ds
+.\" ------------------------------------------------------------------
+.It Cm eval Ar expression
 .Pp
-For example, this command instructs the RabbitMQ broker to list all hash
-functions supported by encoding commands:
-.sp
-.Dl rabbitmqctl list_hashes
-.\" ------------------------------------
-.It Cm list_ciphers
-Lists cipher suites supported by encoding commands.
+Evaluates an Erlang expression on the target node
+.\" ------------------------------------------------------------------
+.It Cm hipe_compile Ar directory
 .Pp
-For example, this command instructs the RabbitMQ broker to list all
-cipher suites supported by encoding commands:
+Performs HiPE-compilation and caches resulting
+.Pa .beam Ns -files in the given directory.
+.Pp
+Parent directories are created if necessary.
+Any existing
+.Pa .beam
+files from the directory are automatically deleted prior to compilation.
+.Pp
+To use this precompiled files, you should set
+.Ev RABBITMQ_SERVER_CODE_PATH
+environment variable to directory specified in
+.Cm hipe_compile
+invocation.
+.Pp
+For example, to HiPE-compile modules and store them to
+.Pa /tmp/rabbit-hipe/ebin
+directory:
 .sp
-.Dl rabbitmqctl list_ciphers
+.Dl rabbitmqctl hipe_compile /tmp/rabbit-hipe/ebin
 .El
 .\" ------------------------------------------------------------------
-.Sh PLUGIN COMMANDS
+.\" ## Queue Operations
+.\" ------------------------------------------------------------------
+.Ss Queue Operations
+.Bl -tag -width Ds
+.\" ------------------------------------------------------------------
+.It Cm delete_queue Ar queue_name Oo Fl -if-empty | Fl e Oc Op Fl -if-unused | Fl u
+.Bl -tag -width Ds
+.It Ar queue_name
+The name of the queue to delete.
+.It Ar --if-empty
+Delete the queue if it is empty (has no messages ready for delivery)
+.It Ar --if-unused
+Delete the queue only if it has no consumers
+.El
+.Pp
+Deletes a queue.
 .\" ------------------------------------------------------------------
+.It Cm purge_queue Oo Fl p Ar vhost Oc Ar queue
+.Bl -tag -width Ds
+.It Ar queue
+The name of the queue to purge.
+.El
+.Pp
+Purges a queue (removes all messages in it).
+.El
+.\" ------------------------------------------------------------------------------------------------
+.Sh PLUGIN COMMANDS
+.\" ------------------------------------------------------------------------------------------------
 RabbitMQ plugins can extend rabbitmqctl tool to add new commands when enabled.
 Currently available commands can be found in
 .Cm rabbitmqctl help
 output.
 Following commands are added by RabbitMQ plugins, available in default
 distribution:
+.\" ------------------------------------------------------------------
+.\" ## Shovel
+.\" ------------------------------------------------------------------
 .Ss Shovel plugin
 .Bl -tag -width Ds
 .It Cm shovel_status
-Prints a list of configured shovels
+Prints a list of configured Shovels
 .It Cm delete_shovel Oo Fl p Ar vhost Oc Ar name
 Instructs the RabbitMQ node to delete the configured shovel by
 .Ar name .
 .El
+.\" ------------------------------------------------------------------
+.\" ## Federation
+.\" ------------------------------------------------------------------
 .Ss Federation plugin
 .Bl -tag -width Ds
 .It Cm federation_status Op Fl -only-down
@@ -1949,7 +2173,10 @@ Only list federation links which are not running.
 Instructs the RabbitMQ node to restart the federation link with specified
 .Ar link_id .
 .El
-.Ss AMQP-1.0 plugin
+.\" ------------------------------------------------------------------
+.\" ## AMQP 1.0
+.\" ------------------------------------------------------------------
+.Ss AMQP 1.0 plugin
 .Bl -tag -width Ds
 .It Cm list_amqp10_connections Op Ar amqp10_connectioninfoitem ...
 Similar to the
@@ -2028,6 +2255,9 @@ The period for which the peer's SSL certificate is valid.
 The node name of the RabbitMQ node to which connection is established.
 .El
 .El
+.\" ------------------------------------------------------------------
+.\" ## MQTT
+.\" ------------------------------------------------------------------
 .Ss MQTT plugin
 .Bl -tag -width Ds
 .It Cm list_mqtt_connections Op Ar mqtt_connectioninfoitem
@@ -2120,6 +2350,9 @@ Username associated with the connection.
 Virtual host name with non-ASCII characters escaped as in C.
 .El
 .El
+.\" ------------------------------------------------------------------
+.\" ## STOMP
+.\" ------------------------------------------------------------------
 .Ss STOMP plugin
 .Bl -tag -width Ds
 .It Cm list_stomp_connections Op Ar stomp_connectioninfoitem
@@ -2199,19 +2432,22 @@ Informational properties transmitted by the client during connection
 .It Cm ssl
 Boolean indicating whether the connection is secured with SSL.
 .It Cm ssl_protocol
-SSL protocol (e.g.\&
+TLS protocol (e.g.\&
 .Qq tlsv1 ) .
 .It Cm ssl_key_exchange
-SSL key exchange algorithm (e.g.\&
+TLS key exchange algorithm (e.g.\&
 .Qq rsa ) .
 .It Cm ssl_cipher
-SSL cipher algorithm (e.g.\&
+TLS cipher algorithm (e.g.\&
 .Qq aes_256_cbc ) .
 .It Cm ssl_hash
 SSL hash function (e.g.\&
 .Qq sha ) .
 .El
 .El
+.\" ------------------------------------------------------------------
+.\" ## Management Agent
+.\" ------------------------------------------------------------------
 .Ss Management agent plugin
 .Bl -tag -width Ds
 .It Cm reset_stats_db Op Fl -all
@@ -2221,9 +2457,9 @@ Reset management stats database for the RabbitMQ node.
 Reset stats database for all nodes in the cluster.
 .El
 .El
-.\" ------------------------------------------------------------------
+.\" ------------------------------------------------------------------------------------------------
 .Sh SEE ALSO
-.\" ------------------------------------------------------------------
+.\" ------------------------------------------------------------------------------------------------
 .Xr rabbitmq-diagnostics 8 ,
 .Xr rabbitmq-plugins 8 ,
 .Xr rabbitmq-server 8 ,
@@ -2232,7 +2468,7 @@ Reset stats database for all nodes in the cluster.
 .Xr rabbitmq-service 8 ,
 .Xr rabbitmq-env.conf 5 ,
 .Xr rabbitmq-echopid 8
-.\" ------------------------------------------------------------------
+.\" ------------------------------------------------------------------------------------------------
 .Sh AUTHOR
-.\" ------------------------------------------------------------------
+.\" ------------------------------------------------------------------------------------------------
 .An The RabbitMQ Team Aq Mt info@rabbitmq.com