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">
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>
15 <refname>vfs_gpfs</refname>
16 <refpurpose>gpfs specific samba extensions like acls and prealloc</refpurpose>
21 <command>vfs objects = gpfs</command>
26 <title>DESCRIPTION</title>
28 <para>This VFS module is part of the
29 <citerefentry><refentrytitle>samba</refentrytitle>
30 <manvolnum>7</manvolnum></citerefentry> suite.</para>
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.
37 <para>Currently the gpfs vfs module provides extensions in following areas :
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>
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.
51 <para>This module is stackable.</para>
57 <title>OPTIONS</title>
63 <term>gpfs:sharemodes = [ yes | no ]</term>
66 Enable/Disable cross node sharemode handling for GPFS.
71 <command>yes(default)</command> - propagate sharemodes across all GPFS nodes.
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.
85 <term>gpfs:leases = [ yes | no ]</term>
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.
95 <command>yes(default)</command> - propagate leases across all GPFS nodes.
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.
109 <term>gpfs:getrealfilename = [ yes | no ]</term>
112 Enable/Disable usage of the <command>gpfs_get_realfilename_path()</command> function.
113 This improves the casesensitive wildcard file name access.
118 <command>yes(default)</command> - use <command>gpfs_get_realfilename_path()</command>.
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.
130 <term>gpfs:winattr = [ yes | no ]</term>
133 Enable/Disable usage of the windows attributes in GPFS.
134 GPFS is able to store windows file attributes e.g. HIDDEN,
135 READONLY, SYSTEM and others natively. That means Samba doesn't
136 need to map them to permission bits or extended attributes.
141 <command>no(default)</command> - do not use GPFS windows attributes.
144 <command>yes</command> - use GPFS windows attributes.
152 <term>gpfs:merge_writeappend = [ yes | no ]</term>
155 GPFS ACLs doesn't know about the 'APPEND' right.
156 This optionen lets Samba map the 'APPEND' right to 'WRITE'.
161 <command>yes(default)</command> - map 'APPEND' to 'WRITE'.
164 <command>no</command> - do not map 'APPEND' to 'WRITE'.
172 <term>nfs4:mode = [ simple | special ]</term>
175 Enable/Disable substitution of special IDs on GPFS. This parameter
176 should not affect the windows users in anyway. It only ensures that Samba
177 sets the special IDs - OWNER@ and GROUP@ ( mappings to simple uids )
178 that are relevant to GPFS.
181 <para>The following MODEs are understood by the module:</para>
183 <listitem><para><command>simple(default)</command> - do not use special IDs in GPFS ACEs</para></listitem>
184 <listitem><para><command>special</command> - use special IDs in GPFS ACEs. </para> </listitem>
192 <term>nfs4:acedup = [dontcare|reject|ignore|merge]</term>
195 This parameter configures how Samba handles duplicate ACEs encountered in GPFS ACLs.
196 GPFS allows/creates duplicate ACE for different bits for same ID.
199 <para>Following is the behaviour of Samba for different values :</para>
201 <listitem><para><command>dontcare (default)</command> - copy the ACEs as they come</para></listitem>
202 <listitem><para><command>reject</command> - stop operation and exit with error on ACL set op</para></listitem>
203 <listitem><para><command>ignore</command> - don't include the second matching ACE</para></listitem>
204 <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>
211 <term>nfs4:chown = [yes|no]</term>
213 <para>This parameter allows enabling or disabling the chown supported
214 by the underlying filesystem. This parameter should be enabled with
215 care as it might leave your system insecure.</para>
216 <para>Some filesystems allow chown as a) giving b) stealing. It is the latter
217 that is considered a risk.</para>
219 <para>Following is the behaviour of Samba for different values : </para>
221 <listitem><para><command>yes</command> - Enable chown if as supported by the under filesystem</para></listitem>
222 <listitem><para><command>no (default)</command> - Disable chown</para></listitem>
231 <title>EXAMPLES</title>
233 <para>A GPFS mount can be exported via Samba as follows :</para>
236 <smbconfsection name="[samba_gpfs_share]"/>
237 <smbconfoption name="vfs objects">gpfs</smbconfoption>
238 <smbconfoption name="path">/test/gpfs_mount</smbconfoption>
239 <smbconfoption name="nfs4: mode">special</smbconfoption>
240 <smbconfoption name="nfs4: acedup">merge</smbconfoption>
245 <title>CAVEATS</title>
246 <para>The gpfs gpl libraries are required by <command>gpfs</command> VFS
247 module during both compilation and runtime.
248 Also this VFS module is tested to work on SLES 9/10 and RHEL 4.4
253 <title>VERSION</title>
254 <para>This man page is correct for version 3.0.25 of the Samba suite.
259 <title>AUTHOR</title>
261 <para>The original Samba software and related utilities
262 were created by Andrew Tridgell. Samba is now developed
263 by the Samba Team as an Open Source project similar
264 to the way the Linux kernel is developed.</para>
266 <para>The GPFS VFS module was created with contributions from
267 Volker Lendecke and the developers at IBM.
270 <para> This manpage was created by the IBM FSCC team </para>