Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
RABBITMQ-UPGRADE(8)	    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
       during  the upgrade of RabbitMQ nodes.  See the RabbitMQ	upgrade	guide:
       https://www.rabbitmq.com/docs/upgrade to	learn more about RabbitMQ  in-
       stallation 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 re-
	       duced when quiet	mode is	in effect.

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

       -t timeout, --timeout timeout
	       Operation  timeout  in seconds.	Not all	commands support time-
	       outs.  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/docs/clustering

       --erlang-cookie cookie
	       Shared secret to	use to authenticate to the target node.	  Pre-
	       fer  using  a local file	or the RABBITMQ_ERLANG_COOKIE environ-
	       ment 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
       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
	       quorum.	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
	       replicas.

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

       revive

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

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

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

AUTHOR
       The RabbitMQ Team <contact-tanzu-data.pdl@broadcom.com>

RabbitMQ Server			 June 22, 2023		   RABBITMQ-UPGRADE(8)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=rabbitmq-upgrade&sektion=8&manpath=FreeBSD+Ports+14.3.quarterly>

home | help