LUDOC-166 mgs: Document new "lctl set_param -P" option

The new "lctl set_param -P" syntax for setting permanent
configuration parameters in LU-3155 needs to be added to
the Lustre manual.

Xyratex-bug-id: MRP-272
Signed-off-by: Artem Blagodarenko <artem_blagodarenko@xyratex.com>
Change-Id: I44d89d1219ed865d87368ef958a9f5aa207db49e
Reviewed-on: http://review.whamcloud.com/7458
Tested-by: Hudson
Reviewed-by: Richard Henwood <richard.henwood@intel.com>

diff --git a/LustreOperations.xml b/LustreOperations.xml
index 33860d8..89b1a38 100644 (file)
--- a/LustreOperations.xml
+++ b/LustreOperations.xml
@@ -256,6 +256,22 @@ $ lctl conf_param testfs.sys.timeout=40 </screen>
           <para>Parameters specified with the <literal>lctl conf_param</literal> command are set permanently in the file system&apos;s configuration file on the MGS.</para>
         </caution>
       </section>
+      <section xml:id="dbdoclet.setparamp" condition='l25'>
+       <title>Setting Permanent Parameters with lctl set_param -P</title>
+       <para> Use the <literal>lctl set_param -P</literal> to set parameters permanently. This command must be issued on the MGS. The given parameter is set on every host using <literal>lctl</literal> upcall. Parameters map to items in <literal>/proc/{fs,sys}/{lnet,lustre}</literal>. The <literal>lctl set_param</literal> command uses this syntax:</para>
+       <screen>lctl set_param -P <replaceable>obdtype</replaceable>.<replaceable>obdname</replaceable>.<replaceable>proc_file_name</replaceable>=<replaceable>value</replaceable></screen>
+       <para>For example:</para>
+       <screen># lctl set_param -P osc.*.max_dirty_mb=1024
+osc.myth-OST0000-osc.max_dirty_mb=32
+osc.myth-OST0001-osc.max_dirty_mb=32
+osc.myth-OST0002-osc.max_dirty_mb=32
+osc.myth-OST0003-osc.max_dirty_mb=32
+osc.myth-OST0004-osc.max_dirty_mb=32 </screen>
+       <para>Use <literal>-d </literal>  (only with -P) option to delete permanent parameter. Syntax:</para>
+       <screen>lctl set_param -P -d<replaceable>obdtype</replaceable>.<replaceable>obdname</replaceable>.<replaceable>proc_file_name</replaceable></screen>
+       <para>For example:</para>
+       <screen># lctl set_param -P -d osc.*.max_dirty_mb </screen>
+      </section>
       <section xml:id="dbdoclet.50438194_88217">
         <title>Listing Parameters</title>
         <para>To list Lustre or LNET parameters that are available to set, use the <literal>lctl list_param</literal> command. For example:</para>

diff --git a/SystemConfigurationUtilities.xml b/SystemConfigurationUtilities.xml
index 4dd84ff..4080633 100644 (file)
--- a/SystemConfigurationUtilities.xml
+++ b/SystemConfigurationUtilities.xml
@@ -212,9 +212,12 @@ quit</screen>
       <title>Setting Parameters with lctl</title>
       <para>Lustre parameters are not always accessible using the procfs interface, as it is platform-specific. As a solution, lctl {get,set}_param has been introduced as a platform-independent interface to the Lustre tunables. Avoid direct references to /proc/{fs,sys}/{lustre,lnet}. For future portability, use lctl {get,set}_param .</para>
       <para>When the file system is running, use the <literal>lctl set_param</literal> command on the affected node(s) to <emphasis>temporarily</emphasis> set parameters (mapping to items in /proc/{fs,sys}/{lnet,lustre}). The <literal>lctl set_param</literal> command uses this syntax:</para>
-      <screen>lctl set_param [-n] <replaceable>obdtype.obdname.property</replaceable>=<replaceable>value</replaceable></screen>
+      <screen>lctl set_param [-n] [-P] [-d] <replaceable>obdtype.obdname.property</replaceable>=<replaceable>value</replaceable></screen>
       <para>For example:</para>
       <screen>mds# lctl set_param mdt.testfs-MDT0000.identity_upcall=NONE</screen>
+      <para condition='l25'>Use <literal>-P</literal> option to set parameters permanently. Option <literal>-d </literal>deletes permanent parameters. For example:
+             <screen>mgs# lctl set_param -P mdt.testfs-MDT0000.identity_upcall=NONE
+mgs# lctl set_param -P -d mdt.testfs-MDT0000.identity_upcall</screen></para>
       <para>Many permanent parameters can be set with <literal>lctl conf_param</literal>. In general, <literal>lctl conf_param</literal> can be used to specify any OBD device parameter settable in a /proc/fs/lustre file. The <literal>lctl conf_param</literal> command must be run on the MGS node, and uses this syntax:</para>
       <screen><replaceable>obd|fsname</replaceable>.obdtype.property=<replaceable>value</replaceable>) </screen>
       <para>For example:</para>