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