Document global parameters CLI commands

Part of rabbitmq/rabbitmq-mqtt#73

1 files changed, 73 insertions, 5 deletions

diff --git a/docs/rabbitmqctl.1.xml b/docs/rabbitmqctl.1.xml
index 217d2d93ca..dd26d5d7ba 100644
--- a/docs/rabbitmqctl.1.xml
+++ b/docs/rabbitmqctl.1.xml
@@ -1035,11 +1035,16 @@
       <para>
         Certain features of RabbitMQ (such as the federation plugin)
         are controlled by dynamic,
-        cluster-wide <emphasis>parameters</emphasis>. Each parameter
-        consists of a component name, a name and a value, and is
-        associated with a virtual host. The component name and name are
-        strings, and the value is an Erlang term. Parameters can be
-        set, cleared and listed. In general you should refer to the
+        cluster-wide <emphasis>parameters</emphasis>.
+        There are 2 kinds of parameters: parameters scoped to
+        a virtual host and global parameters.
+        Each vhost-scoped parameter
+        consists of a component name, a name and a value.
+        The component name and name are
+        strings, and the value is an Erlang term.
+        A global parameter consists of a name and value. The name
+        is a string and the value is an Erlang term.
+        Parameters can be set, cleared and listed. In general you should refer to the
         documentation for the feature in question to see how to set
         parameters.
       </para>
@@ -1121,6 +1126,69 @@
             </para>
           </listitem>
         </varlistentry>
+        <varlistentry>
+          <term><cmdsynopsis><command>set_global_parameter</command> <arg choice="req"><replaceable>name</replaceable></arg> <arg choice="req"><replaceable>value</replaceable></arg></cmdsynopsis></term>
+          <listitem>
+            <para>
+              Sets a global parameter.
+            </para>
+            <variablelist>
+              <varlistentry>
+                <term>name</term>
+                <listitem><para>
+                  The name of the global parameter being set.
+                </para></listitem>
+              </varlistentry>
+              <varlistentry>
+                <term>value</term>
+                <listitem><para>
+                  The value for the global parameter, as a
+                  JSON term. In most shells you are very likely to
+                  need to quote this.
+                </para></listitem>
+              </varlistentry>
+            </variablelist>
+            <para role="example-prefix">For example:</para>
+            <screen role="example">rabbitmqctl set_global_parameter mqtt_default_vhosts '{"O=client,CN=guest":"/"}'</screen>
+            <para role="example">
+              This command sets the global parameter <command>mqtt_default_vhosts</command> to the JSON term <command>{"O=client,CN=guest":"/"}</command>.
+            </para>
+          </listitem>
+        </varlistentry>
+        <varlistentry>
+          <term><cmdsynopsis><command>clear_global_parameter</command> <arg choice="req"><replaceable>name</replaceable></arg></cmdsynopsis></term>
+          <listitem>
+            <para>
+              Clears a global parameter.
+            </para>
+            <variablelist>
+              <varlistentry>
+                <term>name</term>
+                <listitem><para>
+                  The name of the global parameter being cleared.
+                </para></listitem>
+              </varlistentry>
+            </variablelist>
+            <para role="example-prefix">For example:</para>
+            <screen role="example">rabbitmqctl clear_global_parameter mqtt_default_vhosts</screen>
+            <para role="example">
+              This command clears the global parameter <command>mqtt_default_vhosts</command>.
+            </para>
+          </listitem>
+        </varlistentry>
+        <varlistentry>
+          <term><cmdsynopsis><command>list_global_parameters</command></cmdsynopsis></term>
+          <listitem>
+            <para>
+              Lists all global parameters.
+            </para>
+            <para role="example-prefix">For example:</para>
+            <screen role="example">rabbitmqctl list_global_parameters</screen>
+            <para role="example">
+              This command lists all global parameters.
+            </para>
+          </listitem>
+        </varlistentry>
       </variablelist>
     </refsect2>