RABBITMQ-UPGRADE(8) System Manager's Manual RABBITMQ-UPGRADE(8)

# [NAME](#NAME)

`rabbitmq-upgrade` — RabbitMQ installation upgrade tools

# [SYNOPSIS](#SYNOPSIS)

`rabbitmq-upgrade` \[`-q`] \[`-s`] \[`-l`] \[`-n` `node`] \[`-t` `timeout`] `command` \[`command_options`]

# [DESCRIPTION](#DESCRIPTION)

`rabbitmq-upgrade` is a command line tool that provides commands used during the upgrade of RabbitMQ nodes. See the [RabbitMQ upgrade guide](https://www.rabbitmq.com/docs/upgrade) to learn more about RabbitMQ installation upgrades.

# [OPTIONS](#OPTIONS)

[`-n`](#n) `node`

Default node is "rabbit@`target-hostname`", where `target-hostname` is the local host. On a host named "myserver.example.com", the node name will usually be "rabbit@myserver" (unless `RABBITMQ_NODENAME` has been overridden). The output of "hostname -s" is usually the correct suffix to use after the "@" sign. See [rabbitmq-server(8)](/man/enterprise-packages/rabbitmq-server-4.2/rabbitmq-server.8) for details of configuring a RabbitMQ node.

[`-q`](#q), `--quiet`

Quiet output mode is selected. Informational messages are reduced when quiet mode is in effect.

[`-s`](#s), `--silent`

Silent output mode is selected. Informational messages are reduced and table headers are suppressed when silent mode is in effect.

[`-t`](#t) `timeout`, `--timeout` `timeout`

Operation timeout in seconds. Not all commands support timeouts. Default is `infinity`.

[`-l`](#l), `--longnames`

Must be specified when the cluster is configured to use long (FQDN) node names. To learn more, see the [RabbitMQ Clustering guide](https://www.rabbitmq.com/docs/clustering)

[`--erlang-cookie`](#erlang-cookie) `cookie`

Shared secret to use to authenticate to the target node. Prefer using a local file or the `RABBITMQ_ERLANG_COOKIE` environment variable instead of specifying this option on the command line. To learn more, see the [RabbitMQ CLI Tools guide](https://www.rabbitmq.com/docs/cli)

# [COMMANDS](#COMMANDS)

[`help`](#help)

Displays general help and commands supported by `rabbitmq-upgrade`.

[`post_upgrade`](#post_upgrade)

Runs post-upgrade tasks. In the current version, it performs the rebalance of mirrored and quorum queues across all nodes in the cluster.

[`await_online_quorum_plus_one`](#await_online_quorum_plus_one)

Waits for all quorum queues to have an above minimum online quorum. This makes sure that no queues would lose their quorum if the target node is shut down.

[`drain`](#drain)

Puts the node in maintenance mode. Such nodes will not serve any client traffic or considered for hosting any queue leader replicas.

To learn more, see the [RabbitMQ Upgrade guide](https://www.rabbitmq.com/docs/upgrade#maintenance-mode)

[`revive`](#revive)

Puts the node out of maintenance and into regular operating mode. Such nodes will again serve client traffic and considered for queue leader replica placement.

To learn more, see the [RabbitMQ Upgrade guide](https://www.rabbitmq.com/docs/upgrade#maintenance-mode)

# [SEE ALSO](#SEE_ALSO)

[rabbitmqctl(8)](/man/enterprise-packages/rabbitmq-server-4.2/rabbitmqctl.8), [rabbitmq-diagnostics(8)](/man/enterprise-packages/rabbitmq-server-4.2/rabbitmq-diagnostics.8), [rabbitmq-server(8)](/man/enterprise-packages/rabbitmq-server-4.2/rabbitmq-server.8), [rabbitmq-queues(8)](/man/enterprise-packages/rabbitmq-server-4.2/rabbitmq-queues.8), [rabbitmq-streams(8)](/man/enterprise-packages/rabbitmq-server-4.2/rabbitmq-streams.8), [rabbitmq-service(8)](/man/enterprise-packages/rabbitmq-server-4.2/rabbitmq-service.8), [rabbitmq-env.conf(5)](/man/enterprise-packages/rabbitmq-server-4.2/rabbitmq-env.conf.5), [rabbitmq-echopid(8)](/man/enterprise-packages/rabbitmq-server-4.2/rabbitmq-echopid.8)

# [AUTHOR](#AUTHOR)

The RabbitMQ Team <[contact-tanzu-data.pdl@broadcom.com](mailto:contact-tanzu-data.pdl@broadcom.com)>

June 22, 2023 RabbitMQ Server

---

Document: rabbitmq-upgrade(8) from rabbitmq-server-4.2 4.2.9-r1 (Chainguard OS)
Source: https://github.com/rabbitmq/rabbitmq-server