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, mainly member handling for quorum queues.  See the
13     RabbitMQ quorum queues guide:
14           https://www.rabbitmq.com/quorum-queues.html
15     and RabbitMQ classic mirrored queues guide:
16           https://www.rabbitmq.com/ha.html
17     to learn more about queue types in RabbitMQ.
18

OPTIONS

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

COMMANDS

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

SEE ALSO

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

AUTHOR

150     The RabbitMQ Team <info@rabbitmq.com>
151
152RabbitMQ Server               September 28, 2019               RabbitMQ Server
Impressum