summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorSimon MacMullen <simon@rabbitmq.com>2014-07-03 12:45:04 +0100
committerSimon MacMullen <simon@rabbitmq.com>2014-07-03 12:45:04 +0100
commitd7b8af73c4782bd608df5e12193e657f8219e841 (patch)
tree107740d3aaa220b9fb311724c0adb3149d135f14 /docs
parent06100a6456cb506f17a4caf5258cf0992fa36290 (diff)
downloadrabbitmq-server-d7b8af73c4782bd608df5e12193e657f8219e841.tar.gz
Add docs.
Diffstat (limited to 'docs')
-rw-r--r--docs/rabbitmqctl.1.xml38
1 files changed, 38 insertions, 0 deletions
diff --git a/docs/rabbitmqctl.1.xml b/docs/rabbitmqctl.1.xml
index 6cfd3e00..8882bd6b 100644
--- a/docs/rabbitmqctl.1.xml
+++ b/docs/rabbitmqctl.1.xml
@@ -454,6 +454,44 @@
</listitem>
</varlistentry>
<varlistentry>
+ <term><cmdsynopsis><command>force_boot</command></cmdsynopsis></term>
+ <listitem>
+ <para>
+ Ensure that the node will start next time, even if it
+ was not the last to shut down.
+ </para>
+ <para>
+ Normally when you shut down a RabbitMQ cluster
+ altogether, the first node you restart should be the
+ last one to go down, since it may have seen things
+ happen that other nodes did not. However, sometimes
+ that's not possible: for instance if the entire cluster
+ loses power then all nodes may think they were not the
+ last to shut down.
+ </para>
+ <para>
+ In such a case you can use <command>rabbitmqctl
+ force_boot</command> while the node is down. This will
+ tell the node to unconditionally start next time you ask
+ it to. If any changes happened to the cluster after this
+ node shut down, they will be lost.
+ </para>
+ <para>
+ If the last node to go down is lost then you should use
+ <command>rabbitmqctl forget_cluster_node
+ --offline</command> in preference to this command, as it
+ will ensure that mirrored queues which were mastered on
+ the lost node get promoted.
+ </para>
+ <para role="example-prefix">For example:</para>
+ <screen role="example">rabbitmqctl force_boot</screen>
+ <para role="example">
+ This will force the node not to wait for other nodes
+ next time it is started.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
<term><cmdsynopsis><command>sync_queue</command> <arg choice="req">queue</arg></cmdsynopsis>
</term>
<listitem>