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>nfs4:mode = [ simple | special ]</term>
  86                 <listitem>
  87                 <para>
  88                 Enable/Disable substitution of special IDs on GPFS. This parameter
  89                 should not affect the windows users in anyway. It only ensures that Samba
  90                 sets the special IDs - OWNER@ and GROUP@ ( mappings to simple uids )
  91                 that are relevant to GPFS.
  92                 </para>
  93
  94                 <para>The following MODEs are understood by the module:</para>
  95                 <itemizedlist>
  96                 <listitem><para><command>simple(default)</command> - do not use special IDs in GPFS ACEs</para></listitem>
  97                 <listitem><para><command>special</command> - use special IDs in GPFS ACEs. </para> </listitem>
  98                 </itemizedlist>
  99                 </listitem>
 100
 101                 </varlistentry>
 102
 103
 104                 <varlistentry>
 105                 <term>nfs4:acedup = [dontcare|reject|ignore|merge]</term>
 106                 <listitem>
 107                 <para>
 108                 This parameter configures how Samba handles duplicate ACEs encountered in GPFS ACLs.
 109                 GPFS allows/creates duplicate ACE for different bits for same ID.
 110                 </para>
 111
 112                 <para>Following is the behaviour of Samba for different values :</para>
 113                 <itemizedlist>
 114                 <listitem><para><command>dontcare (default)</command> - copy the ACEs as they come</para></listitem>
 115                 <listitem><para><command>reject</command> - stop operation and exit with error on ACL set op</para></listitem>
 116                 <listitem><para><command>ignore</command> - don't include the second matching ACE</para></listitem>
 117                 <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>
 118                 </itemizedlist>
 119                 </listitem>
 120                 </varlistentry>
 121
 122
 123                 <varlistentry>
 124                 <term>nfs4:chown = [yes|no]</term>
 125                 <listitem>
 126                 <para>This parameter allows enabling or disabling the chown supported
 127                 by the underlying filesystem. This parameter should be enabled with
 128                 care as it might leave your system insecure.</para>
 129                 <para>Some filesystems allow chown as a) giving b) stealing. It is the latter
 130                 that is considered a risk.</para>
 131
 132                 <para>Following is the behaviour of Samba for different values : </para>
 133                 <itemizedlist>
 134                 <listitem><para><command>yes</command> - Enable chown if as supported by the under filesystem</para></listitem>
 135                 <listitem><para><command>no (default)</command> - Disable chown</para></listitem>
 136                 </itemizedlist>
 137                 </listitem>
 138                 </varlistentry>
 139
 140         </variablelist>
 141 </refsect1>
 142
 143 <refsect1>
 144         <title>EXAMPLES</title>
 145
 146         <para>A GPFS mount can be exported via Samba as follows :</para>
 147
 148 <programlisting>
 149         <smbconfsection name="[samba_gpfs_share]"/>
 150         <smbconfoption name="vfs objects">gpfs</smbconfoption>
 151         <smbconfoption name="path">/test/gpfs_mount</smbconfoption>
 152         <smbconfoption name="nfs4: mode">special</smbconfoption>
 153         <smbconfoption name="nfs4: acedup">merge</smbconfoption>
 154 </programlisting>
 155 </refsect1>
 156
 157 <refsect1>
 158         <title>CAVEATS</title>
 159         <para>The gpfs gpl libraries are required by <command>gpfs</command> VFS
 160         module during both compilation and runtime.
 161         Also this VFS module is tested to work on SLES 9/10 and RHEL 4.4
 162         </para>
 163 </refsect1>
 164
 165 <refsect1>
 166         <title>VERSION</title>
 167         <para>This man page is correct for version 3.0.25 of the Samba suite.
 168         </para>
 169 </refsect1>
 170
 171 <refsect1>
 172         <title>AUTHOR</title>
 173
 174         <para>The original Samba software and related utilities
 175         were created by Andrew Tridgell. Samba is now developed
 176         by the Samba Team as an Open Source project similar
 177         to the way the Linux kernel is developed.</para>
 178
 179         <para>The GPFS VFS module was created with contributions from
 180         Volker Lendecke and the developers at IBM.
 181         </para>
 182
 183         <para> This manpage was created by the IBM FSCC team </para>
 184 </refsect1>
 185
 186 </refentry>