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