summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorDiana Corbacho <diana.corbacho@erlang-solutions.com>2016-02-25 11:42:43 +0000
committerDiana Corbacho <diana.corbacho@erlang-solutions.com>2016-02-25 11:42:43 +0000
commit4a540f50aa3792ef2ce870ecf2319edaf266fb8f (patch)
tree49532e816c9004930646ee9529e7543521fec89e /docs
parenta5713f090c873a85cff74ff3a281d5765919743e (diff)
downloadrabbitmq-server-git-4a540f50aa3792ef2ce870ecf2319edaf266fb8f.tar.gz
Add aliveness_test documentation
Diffstat (limited to 'docs')
-rw-r--r--docs/rabbitmqctl.1.xml15
1 files changed, 15 insertions, 0 deletions
diff --git a/docs/rabbitmqctl.1.xml b/docs/rabbitmqctl.1.xml
index c9b699d634..31de508482 100644
--- a/docs/rabbitmqctl.1.xml
+++ b/docs/rabbitmqctl.1.xml
@@ -1829,6 +1829,21 @@
</varlistentry>
<varlistentry>
+ <term><cmdsynopsis><command>aliveness_test</command></cmdsynopsis></term>
+ <listitem>
+ <para>
+ Health check of the RabbitMQ node. Verifies the rabbit application is
+ running, list_queues and list_channels return, and alarms are not set.
+ </para>
+ <para role="example-prefix">For example:</para>
+ <screen role="example">rabbitmqctl aliveness_test -n rabbit@stringer</screen>
+ <para role="example">
+ This command performs a health check on the RabbitMQ node.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
<term><cmdsynopsis><command>environment</command></cmdsynopsis></term>
<listitem>
<para>