diff options
Diffstat (limited to 'docs/rabbitmq-queues.8')
| -rw-r--r-- | docs/rabbitmq-queues.8 | 138 |
1 files changed, 138 insertions, 0 deletions
diff --git a/docs/rabbitmq-queues.8 b/docs/rabbitmq-queues.8 new file mode 100644 index 0000000000..d597c6f015 --- /dev/null +++ b/docs/rabbitmq-queues.8 @@ -0,0 +1,138 @@ +.\" vim:ft=nroff: +.\" The contents of this file are subject to the Mozilla Public License +.\" Version 1.1 (the "License"); you may not use this file except in +.\" compliance with the License. You may obtain a copy of the License +.\" at https://www.mozilla.org/MPL/ +.\" +.\" Software distributed under the License is distributed on an "AS IS" +.\" basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See +.\" the License for the specific language governing rights and +.\" limitations under the License. +.\" +.\" The Original Code is RabbitMQ. +.\" +.\" The Initial Developer of the Original Code is Pivotal Software, Inc. +.\" Copyright (c) 2007-2019 Pivotal Software, Inc. All rights reserved. +.\" +.Dd September 24, 2019 +.Dt RABBITMQ-QUEUES 8 +.Os "RabbitMQ Server" +.Sh NAME +.Nm rabbitmq-queues +.Nd RabbitMQ queue management tools +.\" ------------------------------------------------------------------ +.Sh SYNOPSIS +.\" ------------------------------------------------------------------ +.Nm +.Op Fl q +.Op Fl s +.Op Fl l +.Op Fl n Ar node +.Op Fl t Ar timeout +.Ar command +.Op Ar command_options +.\" ------------------------------------------------------------------ +.Sh DESCRIPTION +.\" ------------------------------------------------------------------ +.Nm +is a command line tool that provides commands used to manage queues, +mainly member handling for quorum queues. +See the +.Lk https://www.rabbitmq.com/quorum-queues.html "RabbitMQ quorum queue guide" +and +.Lk https://www.rabbitmq.com/ha.html "RabbitMQ highly available (mirrored) queues guide" +to learn more about queue types in RabbitMQ. +. +.\" ------------------------------------------------------------------ +.Sh OPTIONS +.\" ------------------------------------------------------------------ +.Bl -tag -width Ds +.It Fl n Ar node +Default node is +.Qq Pf rabbit@ Ar target-hostname , +where +.Ar target-hostname +is the local host. +On a host named +.Qq myserver.example.com , +the node name will usually be +.Qq rabbit@myserver +(unless +.Ev RABBITMQ_NODENAME +has been overridden). +The output of +.Qq hostname -s +is usually the correct suffix to use after the +.Qq @ +sign. +See +.Xr rabbitmq-server 8 +for details of configuring a RabbitMQ node. +.It Fl q , -quiet +Quiet output mode is selected. +Informational messages are reduced when quiet mode is in effect. +.It Fl s , -silent +Silent output mode is selected. +Informational messages are reduced and table headers are suppressed when silent mode is in effect. +.It Fl t Ar timeout , Fl -timeout Ar timeout +Operation timeout in seconds. +Not all commands support timeouts. +Default is +.Cm infinity . +.It Fl l , Fl -longnames +Must be specified when the cluster is configured to use long (FQDN) node names. +To learn more, see the +.Lk https://www.rabbitmq.com/clustering.html "RabbitMQ Clustering guide" +.It Fl -erlang-cookie Ar cookie +Shared secret to use to authenticate to the target node. +Prefer using a local file or the +.Ev RABBITMQ_ERLANG_COOKIE +environment variable instead of specifying this option on the command line. +To learn more, see the +.Lk https://www.rabbitmq.com/cli.html "RabbitMQ CLI Tools guide" +.El +.\" ------------------------------------------------------------------ +.Sh COMMANDS +.\" ------------------------------------ +.Bl -tag -width Ds +.\" ------------------------------------ +.It Cm help +.Pp +Displays general help and commands supported by +.Nm . +.El +.Ss Cluster +.Bl -tag -width Ds +.\" ------------------------------------ +.It Cm grow +.Pp +Grows quorum queue clusters by adding a member (replica) to all or half of matching quorum queues on the given node. +.\" ------------------------------------ +.It Cm rebalance +.Pp +Rebalances queues. +.\" ------------------------------------ +.It Cm shrink +.Pp +Shrinks quorum queue clusters by removing any members (replicas) on the given node. +.\" ------------------------------------ +.El +.Ss Replication +.Bl -tag -width Ds +.\" ------------------------------------ +.It Cm add_member +.Pp +Adds a quorum queue member (replica) for a queue on the given node. +.\" ------------------------------------ +.It Cm delete_member +.Pp +Removes a quorum queue member (replica) for a queue on the given node. +.\" ------------------------------------ +.El +.Ss Queues +.Bl -tag -width Ds +.\" ------------------------------------ +.It Cm quorum_status +.Pp +Displays quorum status of a quorum queue. +.\" ------------------------------------ |