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