docs-xml/manpages-3/vfs_gpfs.8.xml

   1 <?xml version="1.0" encoding="iso-8859-1"?>
   2 <!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
   3 <refentry id="vfs_gpfs.8">
   4
   5 <refmeta>
   6         <refentrytitle>vfs_gpfs</refentrytitle>
   7         <manvolnum>8</manvolnum>
   8         <refmiscinfo class="source">Samba</refmiscinfo>
   9         <refmiscinfo class="manual">System Administration tools</refmiscinfo>
  10         <refmiscinfo class="version">3.4</refmiscinfo>
  11 </refmeta>
  12
  13
  14 <refnamediv>
  15         <refname>vfs_gpfs</refname>
  16         <refpurpose>gpfs specific samba extensions like acls and prealloc</refpurpose>
  17 </refnamediv>
  18
  19 <refsynopsisdiv>
  20         <cmdsynopsis>
  21                 <command>vfs objects = gpfs</command>
  22         </cmdsynopsis>
  23 </refsynopsisdiv>
  24
  25 <refsect1>
  26         <title>DESCRIPTION</title>
  27
  28         <para>This VFS module is part of the
  29         <citerefentry><refentrytitle>samba</refentrytitle>
  30         <manvolnum>7</manvolnum></citerefentry> suite.</para>
  31
  32         <para>The <command>gpfs</command> VFS module is the home
  33         for all gpfs extensions that Samba requires for proper integration
  34         with GPFS. It uses the GPL library interfaces provided by GPFS.
  35         </para>
  36
  37         <para>Currently the gpfs vfs module provides extensions in following areas :
  38         <itemizedlist>
  39         <listitem><para>NFSv4 ACL Interfaces with configurable options for GPFS</para></listitem>
  40         <listitem><para>Kernel oplock support on GPFS</para></listitem>
  41         <listitem><para>Lease support on GPFS</para></listitem>
  42         </itemizedlist>
  43         </para>
  44
  45         <para><command>NOTE:</command>This module follows the posix-acl behaviour
  46         and hence allows permission stealing via chown. Samba might allow at a later
  47         point in time, to restrict the chown via this module as such restrictions
  48         are the responsibility of the underlying filesystem than of Samba.
  49         </para>
  50
  51         <para>This module is stackable.</para>
  52
  53 </refsect1>
  54
  55
  56 <refsect1>
  57         <title>OPTIONS</title>
  58
  59         <variablelist>
  60
  61                 <varlistentry>
  62
  63                 <term>gpfs:sharemodes = [ yes | no ]</term>
  64                 <listitem>
  65                 <para>
  66                 Enable/Disable cross node sharemode handling for GPFS.
  67                 </para>
  68
  69                 <itemizedlist>
  70                 <listitem><para>
  71                 <command>yes(default)</command> - propagate sharemodes across all GPFS nodes.
  72                 </para></listitem>
  73                 <listitem><para>
  74                 <command>no</command> - do not propagate sharemodes across all GPFS nodes.
  75                 This should only be used if the GPFS file system is
  76                 exclusively exported by Samba. Access by local unix application or
  77                 NFS exports could lead to corrupted files.
  78                 </para></listitem>
  79                 </itemizedlist>
  80                 </listitem>
  81
  82                 </varlistentry>
  83                 <varlistentry>
  84
  85                 <term>gpfs:leases = [ yes | no ]</term>
  86                 <listitem>
  87                 <para>
  88                 Enable/Disable cross node leases (oplocks) for GPFS.
  89                 You should also set the <command>oplocks</command> and <command>kernel oplocks</command>
  90                 options to the same value.
  91                 </para>
  92
  93                 <itemizedlist>
  94                 <listitem><para>
  95                 <command>yes(default)</command> - propagate leases across all GPFS nodes.
  96                 </para></listitem>
  97                 <listitem><para>
  98                 <command>no</command> - do not propagate leases across all GPFS nodes.
  99                 This should only be used if the GPFS file system is
 100                 exclusively exported by Samba. Access by local unix application or
 101                 NFS exports could lead to corrupted files.
 102                 </para></listitem>
 103                 </itemizedlist>
 104                 </listitem>
 105
 106                 </varlistentry>
 107                 <varlistentry>
 108
 109                 <term>gpfs:getrealfilename = [ yes | no ]</term>
 110                 <listitem>
 111                 <para>
 112                 Enable/Disable usage of the <command>gpfs_get_realfilename_path()</command> function.
 113                 This improves the casesensitive wildcard file name access.
 114                 </para>
 115
 116                 <itemizedlist>
 117                 <listitem><para>
 118                 <command>yes(default)</command> - use <command>gpfs_get_realfilename_path()</command>.
 119                 </para></listitem>
 120                 <listitem><para>
 121                 <command>no</command> - do not use <command>gpfs_get_realfilename_path()</command>.
 122                 It seems that <command>gpfs_get_realfilename_path()</command> doesn't work on AIX.
 123                 </para></listitem>
 124                 </itemizedlist>
 125                 </listitem>
 126
 127                 </varlistentry>
 128                 <varlistentry>
 129
 130                 <term>nfs4:mode = [ simple | special ]</term>
 131                 <listitem>
 132                 <para>
 133                 Enable/Disable substitution of special IDs on GPFS. This parameter
 134                 should not affect the windows users in anyway. It only ensures that Samba
 135                 sets the special IDs - OWNER@ and GROUP@ ( mappings to simple uids )
 136                 that are relevant to GPFS.
 137                 </para>
 138
 139                 <para>The following MODEs are understood by the module:</para>
 140                 <itemizedlist>
 141                 <listitem><para><command>simple(default)</command> - do not use special IDs in GPFS ACEs</para></listitem>
 142                 <listitem><para><command>special</command> - use special IDs in GPFS ACEs. </para> </listitem>
 143                 </itemizedlist>
 144                 </listitem>
 145
 146                 </varlistentry>
 147
 148
 149                 <varlistentry>
 150                 <term>nfs4:acedup = [dontcare|reject|ignore|merge]</term>
 151                 <listitem>
 152                 <para>
 153                 This parameter configures how Samba handles duplicate ACEs encountered in GPFS ACLs.
 154                 GPFS allows/creates duplicate ACE for different bits for same ID.
 155                 </para>
 156
 157                 <para>Following is the behaviour of Samba for different values :</para>
 158                 <itemizedlist>
 159                 <listitem><para><command>dontcare (default)</command> - copy the ACEs as they come</para></listitem>
 160                 <listitem><para><command>reject</command> - stop operation and exit with error on ACL set op</para></listitem>
 161                 <listitem><para><command>ignore</command> - don't include the second matching ACE</para></listitem>
 162                 <listitem><para><command>merge</command> - bitwise OR the 2 ace.flag fields and 2 ace.mask fields of the 2 duplicate ACEs into 1 ACE</para></listitem>
 163                 </itemizedlist>
 164                 </listitem>
 165                 </varlistentry>
 166
 167
 168                 <varlistentry>
 169                 <term>nfs4:chown = [yes|no]</term>
 170                 <listitem>
 171                 <para>This parameter allows enabling or disabling the chown supported
 172                 by the underlying filesystem. This parameter should be enabled with
 173                 care as it might leave your system insecure.</para>
 174                 <para>Some filesystems allow chown as a) giving b) stealing. It is the latter
 175                 that is considered a risk.</para>
 176
 177                 <para>Following is the behaviour of Samba for different values : </para>
 178                 <itemizedlist>
 179                 <listitem><para><command>yes</command> - Enable chown if as supported by the under filesystem</para></listitem>
 180                 <listitem><para><command>no (default)</command> - Disable chown</para></listitem>
 181                 </itemizedlist>
 182                 </listitem>
 183                 </varlistentry>
 184
 185         </variablelist>
 186 </refsect1>
 187
 188 <refsect1>
 189         <title>EXAMPLES</title>
 190
 191         <para>A GPFS mount can be exported via Samba as follows :</para>
 192
 193 <programlisting>
 194         <smbconfsection name="[samba_gpfs_share]"/>
 195         <smbconfoption name="vfs objects">gpfs</smbconfoption>
 196         <smbconfoption name="path">/test/gpfs_mount</smbconfoption>
 197         <smbconfoption name="nfs4: mode">special</smbconfoption>
 198         <smbconfoption name="nfs4: acedup">merge</smbconfoption>
 199 </programlisting>
 200 </refsect1>
 201
 202 <refsect1>
 203         <title>CAVEATS</title>
 204         <para>The gpfs gpl libraries are required by <command>gpfs</command> VFS
 205         module during both compilation and runtime.
 206         Also this VFS module is tested to work on SLES 9/10 and RHEL 4.4
 207         </para>
 208 </refsect1>
 209
 210 <refsect1>
 211         <title>VERSION</title>
 212         <para>This man page is correct for version 3.0.25 of the Samba suite.
 213         </para>
 214 </refsect1>
 215
 216 <refsect1>
 217         <title>AUTHOR</title>
 218
 219         <para>The original Samba software and related utilities
 220         were created by Andrew Tridgell. Samba is now developed
 221         by the Samba Team as an Open Source project similar
 222         to the way the Linux kernel is developed.</para>
 223
 224         <para>The GPFS VFS module was created with contributions from
 225         Volker Lendecke and the developers at IBM.
 226         </para>
 227
 228         <para> This manpage was created by the IBM FSCC team </para>
 229 </refsect1>
 230
 231 </refentry>