RABBITMQ-STREAMS(8) System Manager's Manual RABBITMQ-STREAMS(8) NAME rabbitmq-streams -- RabbitMQ stream management tools SYNOPSIS rabbitmq-streams [-q] [-s] [-l] [-n node] [-t timeout] command [command_options] DESCRIPTION rabbitmq-streams is a command line tool that provides commands used to man- age streams, for example, add or delete stream replicas. See the RabbitMQ streams overview. 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 --erlang-cookie cookie Shared secret to use to authenticate to the target node. Prefer using a local file or the RABBITMQ_ERLANG_COOKIE environment vari- able instead of specifying this option on the command line. To learn more, see the RabbitMQ CLI Tools guide COMMANDS help Displays general help and commands supported by rabbitmq-streams. Replication add_replica queue node --vhost virtual-host Adds a stream replica on the given node. Example: rabbitmq-streams add_replica --vhost "a-vhost" "a-queue" "rabbit@new-node" delete_replica queue node --vhost virtual-host Removes a stream replica on the given node. Example: rabbitmq-streams delete_replica --vhost "a-vhost" "a-queue" "rabbit@decomissioned-node" transfer_leadership stream node --vhost virtual-host Transfers the leadership of a stream to the given node. Example: rabbitmq-streams transfer_leadership --vhost "a-vhost" "a-stream" "rabbit@new-leader-node" Monitoring, observability and health checks stream_status stream --vhost virtual-host Displays the status of a stream. Example: rabbitmq-streams stream_status --vhost "a-vhost" "a-stream" restart_stream stream --vhost virtual-host --preferred-leader-node node Restarts a stream including all of it's replicas. The optional pre- ferred node flag instructs the command to try to place the leader on a specific node during the restart. Example: rabbitmq-streams restart_stream --vhost "a-vhost" "a-stream"
NAME | SYNOPSIS | DESCRIPTION | OPTIONS | COMMANDS
Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=rabbitmq-streams&sektion=8&manpath=FreeBSD+Ports+15.1.quarterly>