docs-xml: vfs_gpfs: fix typo
[Samba/gebeck_regimport.git] / docs-xml / manpages-3 / vfs_gpfs.8.xml
blob53d7e33b5273c3aad2edb6589edc7bf4970873d2
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">
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.6</refmiscinfo>
11 </refmeta>
14 <refnamediv>
15         <refname>vfs_gpfs</refname>
16         <refpurpose>gpfs specific samba extensions like acls and prealloc</refpurpose>
17 </refnamediv>
19 <refsynopsisdiv>
20         <cmdsynopsis>
21                 <command>vfs objects = gpfs</command>
22         </cmdsynopsis>
23 </refsynopsisdiv>
25 <refsect1>
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.
35         </para>
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>
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>
51         <para>This module is stackable.</para>
53 </refsect1>
56 <refsect1>
57         <title>OPTIONS</title>
59         <variablelist>
61                 <varlistentry>
63                 <term>gpfs:sharemodes = [ yes | no ]</term>
64                 <listitem>
65                 <para>
66                 Enable/Disable cross node sharemode handling for GPFS.
67                 </para>
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>
82                 </varlistentry>
83                 <varlistentry>
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>
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>
106                 </varlistentry>
108                 <varlistentry>
110                 <term>gpfs:hsm = [ yes | no ]</term>
111                 <listitem>
112                 <para>
113                 Enable/Disable announcing if this FS has HSM enabled.
114                 </para>
116                 <itemizedlist>
117                 <listitem><para>
118                 <command>no(default)</command> - Do not announce HSM.
119                 </para></listitem>
120                 <listitem><para>
121                 <command>yes</command> - Announce HSM.
122                 </para></listitem>
123                 </itemizedlist>
124                 </listitem>
126                 </varlistentry>
128                 <varlistentry>
130                 <term>gpfs:getrealfilename = [ yes | no ]</term>
131                 <listitem>
132                 <para>
133                 Enable/Disable usage of the <command>gpfs_get_realfilename_path()</command> function.
134                 This improves the casesensitive wildcard file name access.
135                 </para>
137                 <itemizedlist>
138                 <listitem><para>
139                 <command>yes(default)</command> - use <command>gpfs_get_realfilename_path()</command>.
140                 </para></listitem>
141                 <listitem><para>
142                 <command>no</command> - do not use <command>gpfs_get_realfilename_path()</command>.
143                 It seems that <command>gpfs_get_realfilename_path()</command> doesn't work on AIX.
144                 </para></listitem>
145                 </itemizedlist>
146                 </listitem>
148                 </varlistentry>
149                 <varlistentry>
151                 <term>gpfs:winattr = [ yes | no ]</term>
152                 <listitem>
153                 <para>
154                 Enable/Disable usage of the windows attributes in GPFS.
155                 GPFS is able to store windows file attributes e.g. HIDDEN,
156                 READONLY, SYSTEM and others natively. That means Samba doesn't
157                 need to map them to permission bits or extended attributes.
158                 </para>
160                 <itemizedlist>
161                 <listitem><para>
162                 <command>no(default)</command> - do not use GPFS windows attributes.
163                 </para></listitem>
164                 <listitem><para>
165                 <command>yes</command> - use GPFS windows attributes.
166                 </para></listitem>
167                 </itemizedlist>
168                 </listitem>
170                 </varlistentry>
171                 <varlistentry>
173                 <term>gpfs:merge_writeappend = [ yes | no ]</term>
174                 <listitem>
175                 <para>
176                 GPFS ACLs doesn't know about the 'APPEND' right.
177                 This option lets Samba map the 'APPEND' right to 'WRITE'.
178                 </para>
180                 <itemizedlist>
181                 <listitem><para>
182                 <command>yes(default)</command> - map 'APPEND' to 'WRITE'.
183                 </para></listitem>
184                 <listitem><para>
185                 <command>no</command> - do not map 'APPEND' to 'WRITE'.
186                 </para></listitem>
187                 </itemizedlist>
188                 </listitem>
190                 </varlistentry>
191                 <varlistentry>
193                 <term>gpfs:acl = [ yes | no ]</term>
194                 <listitem>
195                 <para>
196                 This option lets Samba use or ignore GPFS ACLs.
197                 </para>
199                 <itemizedlist>
200                 <listitem><para>
201                 <command>yes(default)</command> - use GPFS ACLs.
202                 </para></listitem>
203                 <listitem><para>
204                 <command>no</command> - do not use GPFS ACLs and pass everything
205                 to the next SMB_VFS module.
206                 </para></listitem>
207                 </itemizedlist>
208                 </listitem>
210                 </varlistentry>
211                 <varlistentry>
213                 <term>gpfs:refuse_dacl_protected = [ yes | no ]</term>
214                 <listitem>
215                 <para>
216                 As GPFS does not support the ACE4_FLAG_NO_PROPAGATE NFSv4 flag (which would be
217                 the mapping for the DESC_DACL_PROTECTED flag), the status of this flag is
218                 currently silently ignored by Samba. That means that if you deselect the "Allow
219                 inheritable permissions..." checkbox in Windows' ACL dialog and then apply the
220                 ACL, the flag will be back immediately.
221                 </para>
222                 <para>
223                 To make sure that automatic migration with e.g. robocopy does not lead to
224                 ACLs silently (and unintentionally) changed, you can set
225                 <command>gpfs:refuse_dacl_protected = yes</command> to enable an explicit
226                 check for this flag and if set, it will return NT_STATUS_NOT_SUPPORTED so
227                 errors are shown up on the Windows side and the Administrator is aware of
228                 the ACLs not being settable like intended
229                 </para>
231                 <itemizedlist>
232                 <listitem><para>
233                 <command>no(default)</command> - ignore the DESC_DACL_PROTECTED flags.
234                 </para></listitem>
235                 <listitem><para>
236                 <command>yes</command> - reject ACLs with DESC_DACL_PROTECTED.
237                 </para></listitem>
238                 </itemizedlist>
239                 </listitem>
241                 </varlistentry>
242                 <varlistentry>
244                 <term>gpfs:dfreequota = [ yes | no ]</term>
245                 <listitem>
246                 <para>
247                 Adjust reporting of the size and free space of a share
248                 according to quotas. If this setting is "yes", a
249                 request for size and free space will also evaluate the
250                 user quota of the user requesting the data, the group
251                 quota of the primary group of the user and the fileset
252                 quota for the fileset containing the top level
253                 directory of the share.
254                 </para>
256                 <para>
257                 If any of the soft or hard quota limits has been
258                 reached, the free space will be reported as 0. If a
259                 quota is in place, but the limits have not been
260                 reached, the free space will be reported according to
261                 the space left in the quota. If more than one quota
262                 applies the free space will be reported as the smallest
263                 space left in those quotas. The size of the share
264                 will be reported according to the quota usage. If more
265                 than one quota applies, the smallest size will be
266                 reported for the share size according to these quotas.
267                 </para>
269                 <itemizedlist>
270                 <listitem><para>
271                 <command>yes</command> - include the quotas
272                 when reporting the share size and free space
273                 </para></listitem>
274                 <listitem><para>
275                 <command>no(default)</command> - do not include quotas,
276                 simply report the size and free space of the file system
277                 </para></listitem>
278                 </itemizedlist>
279                 </listitem>
281                 </varlistentry>
282                 <varlistentry>
284                 <term>gpfs:prealloc = [ yes | no ]</term>
285                 <listitem>
286                 <para>
287                 If set to yes the gpfs_prealloc function will be used in the
288                 fallocate callback when appropriate. If set to no gpfs_prealloc
289                 will not be used. In both cases the system and libc calls are
290                 avoided.
291                 </para>
293                 <itemizedlist>
294                 <listitem><para>
295                 <command>yes (default)</command> - Use gpfs_prealloc for the
296                 fallocate callback.
297                 </para></listitem>
298                 <listitem><para>
299                 <command>no</command> - Do not use gpfs_prealloc for the
300                 fallocate callback.
301                 </para></listitem>
302                 </itemizedlist>
303                 </listitem>
305                 </varlistentry>
307                 <varlistentry>
309                 <term>nfs4:mode = [ simple | special ]</term>
310                 <listitem>
311                 <para>
312                 Enable/Disable substitution of special IDs on GPFS. This parameter
313                 should not affect the windows users in anyway. It only ensures that Samba
314                 sets the special IDs - OWNER@ and GROUP@ ( mappings to simple uids )
315                 that are relevant to GPFS.
316                 </para>
318                 <para>The following MODEs are understood by the module:</para>
319                 <itemizedlist>
320                 <listitem><para><command>simple(default)</command> - do not use special IDs in GPFS ACEs</para></listitem>
321                 <listitem><para><command>special</command> - use special IDs in GPFS ACEs. </para> </listitem>
322                 </itemizedlist>
323                 </listitem>
325                 </varlistentry>
328                 <varlistentry>
329                 <term>nfs4:acedup = [dontcare|reject|ignore|merge]</term>
330                 <listitem>
331                 <para>
332                 This parameter configures how Samba handles duplicate ACEs encountered in GPFS ACLs.
333                 GPFS allows/creates duplicate ACE for different bits for same ID.
334                 </para>
336                 <para>Following is the behaviour of Samba for different values :</para>
337                 <itemizedlist>
338                 <listitem><para><command>dontcare (default)</command> - copy the ACEs as they come</para></listitem>
339                 <listitem><para><command>reject</command> - stop operation and exit with error on ACL set op</para></listitem>
340                 <listitem><para><command>ignore</command> - don't include the second matching ACE</para></listitem>
341                 <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>
342                 </itemizedlist>
343                 </listitem>
344                 </varlistentry>
347                 <varlistentry>
348                 <term>nfs4:chown = [yes|no]</term>
349                 <listitem>
350                 <para>This parameter allows enabling or disabling the chown supported
351                 by the underlying filesystem. This parameter should be enabled with
352                 care as it might leave your system insecure.</para>
353                 <para>Some filesystems allow chown as a) giving b) stealing. It is the latter
354                 that is considered a risk.</para>
356                 <para>Following is the behaviour of Samba for different values : </para>
357                 <itemizedlist>
358                 <listitem><para><command>yes</command> - Enable chown if as supported by the under filesystem</para></listitem>
359                 <listitem><para><command>no (default)</command> - Disable chown</para></listitem>
360                 </itemizedlist>
361                 </listitem>
362                 </varlistentry>
364                 <varlistentry>
365                 <term>gpfs:syncio = [yes|no]</term>
366                 <listitem>
367                 <para>This parameter makes Samba open all files with O_SYNC.
368                   This triggers optimizations in GPFS for workloads that
369                   heavily share files.</para>
371                 <para>Following is the behaviour of Samba for different
372                   values:
373                 </para>
374                 <itemizedlist>
375                 <listitem><para><command>yes</command> - Open files with O_SYNC
376                 </para></listitem>
377                 <listitem><para><command>no (default)</command> - Open files as
378                     normal Samba would do
379                 </para></listitem>
380                 </itemizedlist>
381                 </listitem>
382                 </varlistentry>
384         </variablelist>
385 </refsect1>
387 <refsect1>
388         <title>EXAMPLES</title>
390         <para>A GPFS mount can be exported via Samba as follows :</para>
392 <programlisting>
393         <smbconfsection name="[samba_gpfs_share]"/>
394         <smbconfoption name="vfs objects">gpfs</smbconfoption>
395         <smbconfoption name="path">/test/gpfs_mount</smbconfoption>
396         <smbconfoption name="nfs4: mode">special</smbconfoption>
397         <smbconfoption name="nfs4: acedup">merge</smbconfoption>
398 </programlisting>
399 </refsect1>
401 <refsect1>
402         <title>CAVEATS</title>
403         <para>
404         Depending on the version of gpfs, the <command>libgpfs_gpl</command>
405         library or the <command>libgpfs</command> library is needed at
406         runtime by the <command>gpfs</command> VFS module:
407         Starting with gpfs 3.2.1 PTF8, the complete <command>libgpfs</command>
408         is available as open source and <command>libgpfs_gpl</command> does no
409         longer exist. With earlier versions of gpfs, only the
410         <command>libgpfs_gpl</command> library was open source and could be
411         used at run time.
412         </para>
413         <para>
414         At build time, only the header file <command>gpfs_gpl.h</command>
415         is required , which is a symlink to <command>gpfs.h</command> in
416         gpfs versions newer than 3.2.1 PTF8.
417         </para>
418 </refsect1>
420 <refsect1>
421         <title>VERSION</title>
422         <para>This man page is correct for version 3.0.25 of the Samba suite.
423         </para>
424 </refsect1>
426 <refsect1>
427         <title>AUTHOR</title>
429         <para>The original Samba software and related utilities
430         were created by Andrew Tridgell. Samba is now developed
431         by the Samba Team as an Open Source project similar
432         to the way the Linux kernel is developed.</para>
434         <para>The GPFS VFS module was created with contributions from
435         Volker Lendecke and the developers at IBM.
436         </para>
438         <para> This manpage was created by the IBM FSCC team </para>
439 </refsect1>
441 </refentry>