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 </refmeta>
   9
  10
  11 <refnamediv>
  12         <refname>vfs_gpfs</refname>
  13         <refpurpose>gpfs specific samba extensions like acls and prealloc</refpurpose>
  14 </refnamediv>
  15
  16 <refsynopsisdiv>
  17         <cmdsynopsis>
  18                 <command>vfs objects = gpfs</command>
  19         </cmdsynopsis>
  20 </refsynopsisdiv>
  21
  22 <refsect1>
  23         <title>DESCRIPTION</title>
  24
  25         <para>This VFS module is part of the
  26         <citerefentry><refentrytitle>samba</refentrytitle>
  27         <manvolnum>7</manvolnum></citerefentry> suite.</para>
  28
  29         <para>The <command>gpfs</command> VFS module is the home
  30         for all gpfs extensions that Samba requires for proper integration
  31         with GPFS. For this it utilizes the gpl-ed library interfaces provided by
  32         GPFS team.
  33         </para>
  34
  35         <para>Currently the gpfs vfs module provides extensions in following areas :
  36         <itemizedlist>
  37         <listitem><para>NFSv4 ACL Interfaces with configurable options for gpfs</para></listitem>
  38         <listitem><para>Kernel oplock support on GPFS</para></listitem>
  39         </itemizedlist>
  40         </para>
  41
  42         <para><command>NOTE:</command>This module follows the posix-acl behaviour
  43         and hence allows permission stealing via chown. Samba might allow at a later
  44         point in time, to restrict the chown via this module as such restrictions
  45         are the responsibility of the underlying filesystem than of Samba.
  46         </para>
  47
  48         <para>This module is stackable.</para>
  49
  50 </refsect1>
  51
  52
  53 <refsect1>
  54         <title>OPTIONS</title>
  55
  56         <variablelist>
  57
  58                 <varlistentry>
  59
  60                 <term>nfs4:mode = [ simple | special ]</term>
  61                 <listitem>
  62                 <para>
  63                 Enable/Disable substitution of special ids on GPFS. This parameter
  64                 should not affect the windows users in anyway. It only ensures that Samba
  65                 sets the special ids - OWNER@ and GROUP@ ( mappings to simple uids )
  66                 that are relevant to GPFS.
  67                 </para>
  68
  69                 <para>The following MODE are understood by the module:</para>
  70                 <itemizedlist>
  71                 <listitem><para><command>simple(default)</command> - do not use special IDs in GPFS ACEs</para></listitem>
  72                 <listitem><para><command>special</command> - use special IDs in GPFS ACEs. </para> </listitem>
  73                 </itemizedlist>
  74                 </listitem>
  75
  76                 </varlistentry>
  77
  78                 <varlistentry>
  79                 <term>nfs4:acedup = [dontcare|reject|ignore|merge]</term>
  80                 <para>
  81                 This parameter configures how Samba handles duplicate ACEs encountered in GPFS ACLs.
  82                 GPFS allows/creates duplicate ACE for different bits for same ID.
  83                 </para>
  84
  85                 <para>Following is the behaviour of Samba for different values :</para>
  86                 <itemizedlist>
  87                 <listitem><para><command>dontcare (default)</command> - copy the ACEs as they come</para></listitem>
  88                 <listitem><para><command>reject</command> - stop operation and exit with error on ACL set op</para></listitem>
  89                 <listitem><para><command>ignore</command> - don't include the second matching ACE</para></listitem>
  90                 <listitem><para><command>merge</command> - OR 2 ace.flag fields and 2 ace.mask fields of the 2 duplicate ACEs into 1 ACE</para></listitem>
  91                 </itemizedlist>
  92                 </varlistentry>
  93
  94         </variablelist>
  95 </refsect1>
  96
  97 <refsect1>
  98         <title>EXAMPLES</title>
  99
 100         <para>A GPFS mount can be exported via Samba as follows :</para>
 101
 102 <programlisting>
 103         <smbconfsection name="[samba_gpfs_share]"/>
 104         <smbconfoption name="path">/test/gpfs_mount</smbconfoption>
 105         <smbconfoption name="nfs4: mode">special</smbconfoption>
 106         <smbconfoption name="nfs4: acedup">merge</smbconfoption>
 107 </programlisting>
 108 </refsect1>
 109
 110 <refsect1>
 111         <title>CAVEATS</title>
 112         <para>The gpfs gpl libraries are required by <command>gpfs</command> VFS
 113         module during both compilation and runtime.
 114         Also this VFS module is tested to work on SLES 9/10 and RHEL 4.4
 115         </para>
 116 </refsect1>
 117
 118 <refsect1>
 119         <title>VERSION</title>
 120         <para>This man page is correct for version 3.0.25 of the Samba suite.
 121         </para>
 122 </refsect1>
 123
 124 <refsect1>
 125         <title>AUTHOR</title>
 126
 127         <para>The original Samba software and related utilities
 128         were created by Andrew Tridgell. Samba is now developed
 129         by the Samba Team as an Open Source project similar
 130         to the way the Linux kernel is developed.</para>
 131
 132         <para>The GPFS VFS module was created with contributions from
 133         Volker Lendecke and the developers at IBM.
 134         </para>
 135
 136         <para> This manpage was created by the IBM FSCC team </para>
 137 </refsect1>
 138
 139 </refentry>