1RABBITMQ-QUEUES(8)        BSD System Manager's Manual       RABBITMQ-QUEUES(8)
2

NAME

4     rabbitmq-queues — RabbitMQ queue management tools
5

SYNOPSIS

7     rabbitmq-queues [-q] [-s] [-l] [-n node] [-t timeout] command
8                     [command_options]
9

DESCRIPTION

11     rabbitmq-queues is a command line tool that provides commands used to
12     manage queues, for example, grow, shrink or rebalance replicas of repli‐
13     cated queue types.  See the RabbitMQ quorum queues guide:
14     https://www.rabbitmq.com/quorum-queues.html and the general RabbitMQ
15     queues guide: https://www.rabbitmq.com/queues.html to learn more about
16     queue types in RabbitMQ.
17

OPTIONS

19     -n node
20             Default node is "rabbit@target-hostname", where target-hostname
21             is the local host.  On a host named "myserver.example.com", the
22             node name will usually be "rabbit@myserver" (unless
23             RABBITMQ_NODENAME has been overridden).  The output of "hostname
24             -s" is usually the correct suffix to use after the "@" sign.  See
25             rabbitmq-server(8) for details of configuring a RabbitMQ node.
26
27     -q, --quiet
28             Quiet output mode is selected.  Informational messages are re‐
29             duced when quiet mode is in effect.
30
31     -s, --silent
32             Silent output mode is selected.  Informational messages are re‐
33             duced and table headers are suppressed when silent mode is in ef‐
34             fect.
35
36     -t timeout, --timeout timeout
37             Operation timeout in seconds.  Not all commands support timeouts.
38             Default is infinity.
39
40     -l, --longnames
41             Must be specified when the cluster is configured to use long
42             (FQDN) node names.  To learn more, see the RabbitMQ Clustering
43             guide: https://www.rabbitmq.com/clustering.html
44
45     --erlang-cookie cookie
46             Shared secret to use to authenticate to the target node.  Prefer
47             using a local file or the RABBITMQ_ERLANG_COOKIE environment
48             variable instead of specifying this option on the command line.
49             To learn more, see the RabbitMQ CLI Tools guide:
50             https://www.rabbitmq.com/cli.html
51

COMMANDS

53     help
54
55             Displays general help and commands supported by rabbitmq-queues.
56
57   Cluster
58     grow node selector --vhost-pattern pattern --queue-pattern pattern
59             --errors-only
60
61             Adds a new replica on the given node for all or a half of match‐
62             ing quorum queues.
63
64             Supported selector values are:
65
66             all     Selects all quorum queues
67
68             even    Selects quorum queues with an even number of replicas
69
70             Example:
71                   rabbitmq-queues grow "rabbit@newhost" "all" --vhost-pattern
72                   "a-vhost" --queue-pattern ".*"
73
74     rebalance type --vhost-pattern pattern --queue-pattern pattern
75
76             Rebalances queue leader replicas across cluster nodes.
77
78             Supported type values are:
79
80             all     All queue types
81
82             quorum  Only quorum queues
83
84             classic
85                     Only classic queues
86
87             Example:
88                   rabbitmq-queues rebalance "all" --vhost-pattern "a-vhost"
89                   --queue-pattern ".*"
90
91     shrink node
92
93             Shrinks quorum queue clusters by removing any members (replicas)
94             on the given node.
95
96             Example:
97                   rabbitmq-queues shrink "rabbit@decomissioned-node"
98
99   Replication
100     add_member queue node --vhost virtual-host
101
102             Adds a quorum queue member (replica) on the given node.
103
104             Example:
105                   rabbitmq-queues add_member --vhost "a-vhost" "a-queue"
106                   "rabbit@new-node"
107
108     delete_member queue node --vhost virtual-host
109
110             Removes a quorum queue member (replica) on the given node.
111
112             Example:
113                   rabbitmq-queues delete_member --vhost "a-vhost" "a-queue"
114                   "rabbit@decomissioned-node"
115
116   Queues
117     quorum_status queue --vhost virtual-host
118
119             Displays quorum status of a quorum queue.
120
121             Example:
122                   rabbitmq-queues quorum_status --vhost "a-vhost" "a-queue"
123
124     check_if_node_is_mirror_sync_critical
125
126             Health check that exits with a non-zero code if there are classic
127             mirrored queues without online synchronised mirrors (queues that
128             would potentially lose data if the target node is shut down).
129
130             Example:
131                   rabbitmq-queues check_if_node_is_mirror_sync_critical
132
133     check_if_node_is_quorum_critical
134
135             Health check that exits with a non-zero code if there are queues
136             with minimum online quorum (queues that would lose their quorum
137             if the target node is shut down).
138
139             Example:
140                   rabbitmq-queues check_if_node_is_quorum_critical
141

SEE ALSO

143     rabbitmqctl(8), rabbitmq-diagnostics(8), rabbitmq-server(8),
144     rabbitmq-upgrade(8), rabbitmq-service(8), rabbitmq-env.conf(5),
145     rabbitmq-echopid(8)
146

AUTHOR

148     The RabbitMQ Team <info@rabbitmq.com>
149
150RabbitMQ Server                  June 19, 2021                 RabbitMQ Server
Impressum