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

NAME

4     rabbitmq-upgrade — RabbitMQ installation upgrade tools
5

SYNOPSIS

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

DESCRIPTION

11     rabbitmq-upgrade is a command line tool that provides commands used dur‐
12     ing the upgrade of RabbitMQ nodes.  See the RabbitMQ upgrade guide:
13     https://www.rabbitmq.com/upgrade.html to learn more about RabbitMQ in‐
14     stallation upgrades.
15

OPTIONS

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

COMMANDS

51     help
52
53             Displays general help and commands supported by rabbitmq-upgrade.
54
55     post_upgrade
56
57             Runs post-upgrade tasks. In the current version, it performs the
58             rebalance of mirrored and quorum queues across all nodes in the
59             cluster.
60
61     await_online_quorum_plus_one
62
63             Waits for all quorum queues to have an above minimum online quo‐
64             rum.  This makes sure that no queues would lose their quorum if
65             the target node is shut down.
66
67     drain
68
69             Puts the node in maintenance mode. Such nodes will not serve any
70             client traffic or considered for hosting any queue leader repli‐
71             cas.
72
73             To learn more, see the RabbitMQ Upgrade guide:
74             https://www.rabbitmq.com/upgrade.html#maintenance-mode
75
76     revive
77
78             Puts the node out of maintenance and into regular operating mode.
79             Such nodes will again serve client traffic and considered for
80             queue leader replica placement.
81
82             To learn more, see the RabbitMQ Upgrade guide:
83             https://www.rabbitmq.com/upgrade.html#maintenance-mode
84

SEE ALSO

86     rabbitmqctl(8), rabbitmq-diagnostics(8), rabbitmq-server(8),
87     rabbitmq-queues(8), rabbitmq-streams(8), rabbitmq-service(8),
88     rabbitmq-env.conf(5), rabbitmq-echopid(8)
89

AUTHOR

91     The RabbitMQ Team <info@rabbitmq.com>
92
93RabbitMQ Server                  June 19, 2021                 RabbitMQ Server
Impressum