Go to main content

man pages section 8: System Administration Commands

Exit Print View

Updated: Wednesday, February 9, 2022
 
 

rabbitmq-upgrade (8)

Name

rabbitmq-upgrade - RabbitMQ installation upgrade tools

Synopsis

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

Description

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

NAME
     rabbitmq-upgrade -- RabbitMQ installation upgrade tools

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

DESCRIPTION
     rabbitmq-upgrade is a command line tool that provides commands used dur-
     ing the upgrade of RabbitMQ nodes.  See the RabbitMQ upgrade guide:
           https://www.rabbitmq.com/upgrade.html
     to learn more about RabbitMQ installation upgrades.

OPTIONS
     -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) for details of configuring a RabbitMQ node.

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

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

     -t timeout, --timeout timeout
             Operation timeout in seconds.  Not all commands support timeouts.
             Default is infinity.

     -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/clustering.html

     --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/cli.html

COMMANDS
     help

             Displays general help and commands supported by rabbitmq-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

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

     drain

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

             To learn more, see the RabbitMQ Upgrade guide:
                   https://www.rabbitmq.com/upgrade.html#maintenance-mode

     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/upgrade.html#maintenance-mode


ATTRIBUTES
     See attributes(7) for descriptions of the following attributes:

     +---------------+-----------------------+
     |ATTRIBUTE TYPE |   ATTRIBUTE VALUE     |
     +---------------+-----------------------+
     |Availability   | network/amqp/rabbitmq |
     +---------------+-----------------------+
     |Stability      | Pass-through volatile |
     +---------------+-----------------------+

SEE ALSO
     rabbitmqctl(8), rabbitmq-diagnostics(8), rabbitmq-server(8),
     rabbitmq-queues(8), rabbitmq-service(8), rabbitmq-env.conf(5),
     rabbitmq-echopid(8)

AUTHOR
     The RabbitMQ Team <info@rabbitmq.com>



NOTES
     Source code for open source software components in Oracle Solaris can be
     found at https://www.oracle.com/downloads/opensource/solaris-source-code-
     downloads.html.

     This software was built from source available at https://github.com/ora-
     cle/solaris-userland.  The original community source was downloaded from
     https://github.com/rabbitmq/rabbitmq-server/releases/down-
     load/v3.8.18/rabbitmq-server-3.8.18.tar.xz.

     Further information about this software can be found on the open source
     community website at https://www.rabbitmq.com/.

RabbitMQ Server                  June 19, 2021                 RabbitMQ Server