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

FreeBSD Manual Pages

  
 
  

home | help
RABBITMQ-QUEUES(8)	FreeBSD	System Manager's Manual	    RABBITMQ-QUEUES(8)

NAME
     rabbitmq-queues --	RabbitMQ queue management tools

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

DESCRIPTION
     rabbitmq-queues is	a command line tool that provides commands used	to
     manage queues, mainly member handling for quorum queues.  See the
     RabbitMQ quorum queues guide: https://www.rabbitmq.com/quorum-queues.html
     and RabbitMQ classic mirrored queues guide:
     https://www.rabbitmq.com/ha.html to learn more about queue	types in Rab-
     bitMQ.

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 ef-
	     fect.

     -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-queues.

   Cluster
     grow node selector	--vhost-pattern	pattern	--queue-pattern	pattern
	     --errors-only

	     Adds a new	replica	on the given node for all or a half of match-
	     ing quorum	queues.

	     Supported selector	values are:

	     all     Selects all quorum	queues

	     even    Selects quorum queues with	an even	number of replicas

	     Example:
		   rabbitmq-queues grow	"rabbit@newhost" "all" --vhost-pattern
		   "a-vhost" --queue-pattern ".*"

     rebalance type --vhost-pattern pattern --queue-pattern pattern

	     Rebalances	queue master replicas across cluster nodes.

	     Supported type values are:

	     all     All queue types

	     quorum  Only quorum queues

	     classic
		     Only classic queues

	     Example:
		   rabbitmq-queues rebalance "all" --vhost-pattern "a-vhost"
		   --queue-pattern ".*"

     shrink node

	     Shrinks quorum queue clusters by removing any members (replicas)
	     on	the given node.

	     Example:
		   rabbitmq-queues shrink "rabbit@decomissioned-node"

   Replication
     add_member	queue node --vhost virtual-host

	     Adds a quorum queue member	(replica) on the given node.

	     Example:
		   rabbitmq-queues add_member --vhost "a-vhost"	"a-queue"
		   "rabbit@new-node"

     delete_member queue node --vhost virtual-host

	     Removes a quorum queue member (replica) on	the given node.

	     Example:
		   rabbitmq-queues delete_member --vhost "a-vhost" "a-queue"
		   "rabbit@decomissioned-node"

   Queues
     quorum_status queue --vhost virtual-host

	     Displays quorum status of a quorum	queue.

	     Example:
		   rabbitmq-queues quorum_status --vhost "a-vhost" "a-queue"

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

AUTHOR
     The RabbitMQ Team <info@rabbitmq.com>

RabbitMQ Server		      September	28, 2019	       RabbitMQ	Server

NAME | SYNOPSIS | DESCRIPTION | OPTIONS | COMMANDS | SEE ALSO | AUTHOR

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=rabbitmq-queues&sektion=8&manpath=FreeBSD+12.2-RELEASE+and+Ports>

home | help