diff options
| author | Simon MacMullen <simon@rabbitmq.com> | 2014-01-31 13:54:56 +0000 |
|---|---|---|
| committer | Simon MacMullen <simon@rabbitmq.com> | 2014-01-31 13:54:56 +0000 |
| commit | 0c1a92653169ac160022ac9ee1c04b1244d94b71 (patch) | |
| tree | b114f08f5a21f6d837b4d702146a7dc6dd3dae5e /docs | |
| parent | 3849d60196fc4563c2b0fd269c1a92752855dd35 (diff) | |
| download | rabbitmq-server-0c1a92653169ac160022ac9ee1c04b1244d94b71.tar.gz | |
Document set_cluster_name.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/rabbitmqctl.1.xml | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/docs/rabbitmqctl.1.xml b/docs/rabbitmqctl.1.xml index d19acd00..ed97e779 100644 --- a/docs/rabbitmqctl.1.xml +++ b/docs/rabbitmqctl.1.xml @@ -502,6 +502,23 @@ </para> </listitem> </varlistentry> + <varlistentry> + <term><cmdsynopsis><command>set_cluster_name</command> <arg choice="req">name</arg></cmdsynopsis></term> + <listitem> + <para> + Sets the cluster name. The cluster name is announced to + clients on connection, and used by the federation and + shovel plugins to describe where a message has been. The + cluster name is by default derived from the hostname of + the first node in the cluster, but can be changed. + </para> + <para role="example-prefix">For example:</para> + <screen role="example">rabbitmqctl set_cluster_name london</screen> + <para role="example"> + This sets the cluster name to "london". + </para> + </listitem> + </varlistentry> </variablelist> </refsect2> |