docs:man:vfs_gpfs: Fix documented values for gpfs:hsm

[nivanova/samba-autobuild/.git] / docs-xml / manpages-3 / vfs_gpfs.8.xml

diff --git a/docs-xml/manpages-3/vfs_gpfs.8.xml b/docs-xml/manpages-3/vfs_gpfs.8.xml
index 4963ecd88a94960b370a36063e57e9e2c378ac11..eb5fbc18490ec5bf4365ea806196f3069019c65d 100644 (file)
--- a/docs-xml/manpages-3/vfs_gpfs.8.xml
+++ b/docs-xml/manpages-3/vfs_gpfs.8.xml
@@ -104,6 +104,27 @@
                </listitem>
 
                </varlistentry>
+
+               <varlistentry>
+
+               <term>gpfs:hsm = [ yes | no ]</term>
+               <listitem>
+               <para>
+               Enable/Disable announcing if this FS has HSM enabled.
+               </para>
+
+               <itemizedlist>
+               <listitem><para>
+               <command>no(default)</command> - Do not announce HSM.
+               </para></listitem>
+               <listitem><para>
+               <command>yes</command> - Announce HSM.
+               </para></listitem>
+               </itemizedlist>
+               </listitem>
+
+               </varlistentry>
+
                <varlistentry>
 
                <term>gpfs:getrealfilename = [ yes | no ]</term>
@@ -169,6 +190,37 @@
                </varlistentry>
                <varlistentry>
 
+               <term>gpfs:refuse_dacl_protected = [ yes | no ]</term>
+               <listitem>
+               <para>
+               As GPFS does not support the ACE4_FLAG_NO_PROPAGATE NFSv4 flag (which would be
+               the mapping for the DESC_DACL_PROTECTED flag), the status of this flag is
+               currently silently ignored by Samba. That means that if you deselect the "Allow
+               inheritable permissions..." checkbox in Windows' ACL dialog and then apply the
+               ACL, the flag will be back immediately.
+               </para>
+               <para>
+               To make sure that automatic migration with e.g. robocopy does not lead to
+               ACLs silently (and unintentionally) changed, you can set
+               <command>gpfs:refuse_dacl_protected = yes</command> to enable an explicit
+               check for this flag and if set, it will return NT_STATUS_NOT_SUPPORTED so
+               errors are shown up on the Windows side and the Administrator is aware of
+               the ACLs not being settable like intended
+               </para>
+
+               <itemizedlist>
+               <listitem><para>
+               <command>no(default)</command> - ignore the DESC_DACL_PROTECTED flags.
+               </para></listitem>
+               <listitem><para>
+               <command>yes</command> - reject ACLs with DESC_DACL_PROTECTED.
+               </para></listitem>
+               </itemizedlist>
+               </listitem>
+
+               </varlistentry>
+               <varlistentry>
+
                <term>nfs4:mode = [ simple | special ]</term>
                <listitem>
                <para>
@@ -224,6 +276,26 @@
                </listitem>
                </varlistentry>
 
+               <varlistentry>
+               <term>gpfs:syncio = [yes|no]</term>
+               <listitem>
+               <para>This parameter makes Samba open all files with O_SYNC.
+                 This triggers optimizations in GPFS for workloads that
+                 heavily share files.</para>
+
+               <para>Following is the behaviour of Samba for different
+                 values:
+               </para>
+               <itemizedlist>
+               <listitem><para><command>yes</command>Open files with O_SYNC
+               </para></listitem>
+               <listitem><para><command>no (default)</command>Open files as
+                   normal Samba would do
+               </para></listitem>
+               </itemizedlist>
+               </listitem>
+               </varlistentry>
+
        </variablelist>
 </refsect1>
 
@@ -243,9 +315,20 @@
 
 <refsect1>
        <title>CAVEATS</title>
-       <para>The gpfs gpl libraries are required by <command>gpfs</command> VFS
-       module during both compilation and runtime.
-       Also this VFS module is tested to work on SLES 9/10 and RHEL 4.4
+       <para>
+       Depending on the version of gpfs, the <command>libgpfs_gpl</command>
+       library or the <command>libgpfs</command> library is needed at
+       runtime by the <command>gpfs</command> VFS module:
+       Starting with gpfs 3.2.1 PTF8, the complete <command>libgpfs</command>
+       is available as open source and <command>libgpfs_gpl</command> does no
+       longer exist. With earlier versions of gpfs, only the
+       <command>libgpfs_gpl</command> library was open source and could be
+       used at run time.
+       </para>
+       <para>
+       At build time, only the header file <command>gpfs_gpl.h</command>
+       is required , which is a symlink to <command>gpfs.h</command> in
+       gpfs versions newer than 3.2.1 PTF8.
        </para>
 </refsect1>