source: vendor/current/docs/manpages/vfs_gpfs.8

Last change on this file was 989, checked in by Silvan Scherrer, 9 years ago

Samba Server: update vendor to version 4.4.7

File size: 14.2 KB
Line 
1'\" t
2.\" Title: vfs_gpfs
3.\" Author: [see the "AUTHOR" section]
4.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
5.\" Date: 10/25/2016
6.\" Manual: System Administration tools
7.\" Source: Samba 4.4
8.\" Language: English
9.\"
10.TH "VFS_GPFS" "8" "10/25/2016" "Samba 4\&.4" "System Administration tools"
11.\" -----------------------------------------------------------------
12.\" * Define some portability stuff
13.\" -----------------------------------------------------------------
14.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15.\" http://bugs.debian.org/507673
16.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18.ie \n(.g .ds Aq \(aq
19.el .ds Aq '
20.\" -----------------------------------------------------------------
21.\" * set default formatting
22.\" -----------------------------------------------------------------
23.\" disable hyphenation
24.nh
25.\" disable justification (adjust text to left margin only)
26.ad l
27.\" -----------------------------------------------------------------
28.\" * MAIN CONTENT STARTS HERE *
29.\" -----------------------------------------------------------------
30.SH "NAME"
31vfs_gpfs \- gpfs specific samba extensions like acls and prealloc
32.SH "SYNOPSIS"
33.HP \w'\ 'u
34vfs objects = gpfs
35.SH "DESCRIPTION"
36.PP
37This VFS module is part of the
38\fBsamba\fR(7)
39suite\&.
40.PP
41The
42gpfs
43VFS module is the home for all gpfs extensions that Samba requires for proper integration with GPFS\&. It uses the GPL library interfaces provided by GPFS\&.
44.PP
45Currently the gpfs vfs module provides extensions in following areas :
46.sp
47.RS 4
48.ie n \{\
49\h'-04'\(bu\h'+03'\c
50.\}
51.el \{\
52.sp -1
53.IP \(bu 2.3
54.\}
55NFSv4 ACL Interfaces with configurable options for GPFS
56.RE
57.sp
58.RS 4
59.ie n \{\
60\h'-04'\(bu\h'+03'\c
61.\}
62.el \{\
63.sp -1
64.IP \(bu 2.3
65.\}
66Kernel oplock support on GPFS
67.RE
68.sp
69.RS 4
70.ie n \{\
71\h'-04'\(bu\h'+03'\c
72.\}
73.el \{\
74.sp -1
75.IP \(bu 2.3
76.\}
77Lease support on GPFS
78.RE
79.sp
80.RE
81.PP
82NOTE:
83This module follows the posix\-acl behaviour and hence allows permission stealing via chown\&. Samba might allow at a later point in time, to restrict the chown via this module as such restrictions are the responsibility of the underlying filesystem than of Samba\&.
84.PP
85This module makes use of the smb\&.conf parameter
86\m[blue]\fBacl map full control\fR\m[]\&. When set to yes (the default), this parameter will add in the FILE_DELETE_CHILD bit on a returned ACE entry for a file (not a directory) that already contains all file permissions except for FILE_DELETE and FILE_DELETE_CHILD\&. This can prevent Windows applications that request GENERIC_ALL access from getting ACCESS_DENIED errors when running against a filesystem with NFSv4 compatible ACLs\&.
87.PP
88This module is stackable\&.
89.PP
90Since Samba 4\&.0 all options are per share options\&.
91.SH "OPTIONS"
92.PP
93gpfs:sharemodes = [ yes | no ]
94.RS 4
95Enable/Disable cross node sharemode handling for GPFS\&.
96.sp
97.RS 4
98.ie n \{\
99\h'-04'\(bu\h'+03'\c
100.\}
101.el \{\
102.sp -1
103.IP \(bu 2.3
104.\}
105yes(default)
106\- propagate sharemodes across all GPFS nodes\&.
107.RE
108.sp
109.RS 4
110.ie n \{\
111\h'-04'\(bu\h'+03'\c
112.\}
113.el \{\
114.sp -1
115.IP \(bu 2.3
116.\}
117no
118\- do not propagate sharemodes across all GPFS nodes\&. This should only be used if the GPFS file system is exclusively exported by Samba\&. Access by local unix application or NFS exports could lead to corrupted files\&.
119.RE
120.sp
121.RE
122.RE
123.PP
124gpfs:leases = [ yes | no ]
125.RS 4
126Enable/Disable cross node leases (oplocks) for GPFS\&. You should also set the
127oplocks
128and
129kernel oplocks
130options to the same value\&.
131.sp
132.RS 4
133.ie n \{\
134\h'-04'\(bu\h'+03'\c
135.\}
136.el \{\
137.sp -1
138.IP \(bu 2.3
139.\}
140yes(default)
141\- propagate leases across all GPFS nodes\&.
142.RE
143.sp
144.RS 4
145.ie n \{\
146\h'-04'\(bu\h'+03'\c
147.\}
148.el \{\
149.sp -1
150.IP \(bu 2.3
151.\}
152no
153\- do not propagate leases across all GPFS nodes\&. This should only be used if the GPFS file system is exclusively exported by Samba\&. Access by local unix application or NFS exports could lead to corrupted files\&.
154.RE
155.sp
156.RE
157.RE
158.PP
159gpfs:hsm = [ yes | no ]
160.RS 4
161Enable/Disable announcing if this FS has HSM enabled\&.
162.sp
163.RS 4
164.ie n \{\
165\h'-04'\(bu\h'+03'\c
166.\}
167.el \{\
168.sp -1
169.IP \(bu 2.3
170.\}
171no(default)
172\- Do not announce HSM\&.
173.RE
174.sp
175.RS 4
176.ie n \{\
177\h'-04'\(bu\h'+03'\c
178.\}
179.el \{\
180.sp -1
181.IP \(bu 2.3
182.\}
183yes
184\- Announce HSM\&.
185.RE
186.sp
187.RE
188.RE
189.PP
190gpfs:recalls = [ yes | no ]
191.RS 4
192When this option is set to no, an attempt to open an offline file will be rejected with access denied\&. This helps preventing recall storms triggered by careless applications like Finder and Explorer\&.
193.sp
194.RS 4
195.ie n \{\
196\h'-04'\(bu\h'+03'\c
197.\}
198.el \{\
199.sp -1
200.IP \(bu 2.3
201.\}
202yes(default)
203\- Open files that are offline\&. This will recall the files from HSM\&.
204.RE
205.sp
206.RS 4
207.ie n \{\
208\h'-04'\(bu\h'+03'\c
209.\}
210.el \{\
211.sp -1
212.IP \(bu 2.3
213.\}
214no
215\- Reject access to offline files with access denied\&. This will prevent recalls of files from HSM\&. Using this setting also requires gpfs:hsm to be set to yes\&.
216.RE
217.sp
218.RE
219.RE
220.PP
221gpfs:getrealfilename = [ yes | no ]
222.RS 4
223Enable/Disable usage of the
224gpfs_get_realfilename_path()
225function\&. This improves the casesensitive wildcard file name access\&.
226.sp
227.RS 4
228.ie n \{\
229\h'-04'\(bu\h'+03'\c
230.\}
231.el \{\
232.sp -1
233.IP \(bu 2.3
234.\}
235yes(default)
236\- use
237gpfs_get_realfilename_path()\&.
238.RE
239.sp
240.RS 4
241.ie n \{\
242\h'-04'\(bu\h'+03'\c
243.\}
244.el \{\
245.sp -1
246.IP \(bu 2.3
247.\}
248no
249\- do not use
250gpfs_get_realfilename_path()\&. It seems that
251gpfs_get_realfilename_path()
252doesn\*(Aqt work on AIX\&.
253.RE
254.sp
255.RE
256.RE
257.PP
258gpfs:winattr = [ yes | no ]
259.RS 4
260Enable/Disable usage of the windows attributes in GPFS\&. GPFS is able to store windows file attributes e\&.g\&. HIDDEN, READONLY, SYSTEM and others natively\&. That means Samba doesn\*(Aqt need to map them to permission bits or extended attributes\&.
261.sp
262.RS 4
263.ie n \{\
264\h'-04'\(bu\h'+03'\c
265.\}
266.el \{\
267.sp -1
268.IP \(bu 2.3
269.\}
270no(default)
271\- do not use GPFS windows attributes\&.
272.RE
273.sp
274.RS 4
275.ie n \{\
276\h'-04'\(bu\h'+03'\c
277.\}
278.el \{\
279.sp -1
280.IP \(bu 2.3
281.\}
282yes
283\- use GPFS windows attributes\&.
284.RE
285.sp
286.RE
287.RE
288.PP
289gpfs:merge_writeappend = [ yes | no ]
290.RS 4
291GPFS ACLs doesn\*(Aqt know about the \*(AqAPPEND\*(Aq right\&. This option lets Samba map the \*(AqAPPEND\*(Aq right to \*(AqWRITE\*(Aq\&.
292.sp
293.RS 4
294.ie n \{\
295\h'-04'\(bu\h'+03'\c
296.\}
297.el \{\
298.sp -1
299.IP \(bu 2.3
300.\}
301yes(default)
302\- map \*(AqAPPEND\*(Aq to \*(AqWRITE\*(Aq\&.
303.RE
304.sp
305.RS 4
306.ie n \{\
307\h'-04'\(bu\h'+03'\c
308.\}
309.el \{\
310.sp -1
311.IP \(bu 2.3
312.\}
313no
314\- do not map \*(AqAPPEND\*(Aq to \*(AqWRITE\*(Aq\&.
315.RE
316.sp
317.RE
318.RE
319.PP
320gpfs:acl = [ yes | no ]
321.RS 4
322This option lets Samba use or ignore GPFS ACLs\&.
323.sp
324.RS 4
325.ie n \{\
326\h'-04'\(bu\h'+03'\c
327.\}
328.el \{\
329.sp -1
330.IP \(bu 2.3
331.\}
332yes(default)
333\- use GPFS ACLs\&.
334.RE
335.sp
336.RS 4
337.ie n \{\
338\h'-04'\(bu\h'+03'\c
339.\}
340.el \{\
341.sp -1
342.IP \(bu 2.3
343.\}
344no
345\- do not use GPFS ACLs and pass everything to the next SMB_VFS module\&.
346.RE
347.sp
348.RE
349.RE
350.PP
351gpfs:refuse_dacl_protected = [ yes | no ]
352.RS 4
353As GPFS does not support the ACE4_FLAG_NO_PROPAGATE NFSv4 flag (which would be the mapping for the DESC_DACL_PROTECTED flag), the status of this flag is currently silently ignored by Samba\&. That means that if you deselect the "Allow inheritable permissions\&.\&.\&." checkbox in Windows\*(Aq ACL dialog and then apply the ACL, the flag will be back immediately\&.
354.sp
355To make sure that automatic migration with e\&.g\&. robocopy does not lead to ACLs silently (and unintentionally) changed, you can set
356gpfs:refuse_dacl_protected = yes
357to enable an explicit check for this flag and if set, it will return NT_STATUS_NOT_SUPPORTED so errors are shown up on the Windows side and the Administrator is aware of the ACLs not being settable like intended
358.sp
359.RS 4
360.ie n \{\
361\h'-04'\(bu\h'+03'\c
362.\}
363.el \{\
364.sp -1
365.IP \(bu 2.3
366.\}
367no(default)
368\- ignore the DESC_DACL_PROTECTED flags\&.
369.RE
370.sp
371.RS 4
372.ie n \{\
373\h'-04'\(bu\h'+03'\c
374.\}
375.el \{\
376.sp -1
377.IP \(bu 2.3
378.\}
379yes
380\- reject ACLs with DESC_DACL_PROTECTED\&.
381.RE
382.sp
383.RE
384.RE
385.PP
386gpfs:dfreequota = [ yes | no ]
387.RS 4
388Adjust reporting of the size and free space of a share according to quotas\&. If this setting is "yes", a request for size and free space will also evaluate the user quota of the user requesting the data and the group quota of the primary group of the user\&. Fileset quotas are not queried, since GPFS already provides the option \-\-dfreequota to reflect the fileset quota in the free space query\&. Please use that option to include fileset quotas in the reported disk space\&.
389.sp
390If any of the soft or hard quota limits has been reached, the free space will be reported as 0\&. If a quota is in place, but the limits have not been reached, the free space will be reported according to the space left in the quota\&. If more than one quota applies the free space will be reported as the smallest space left in those quotas\&. The size of the share will be reported according to the quota usage\&. If more than one quota applies, the smallest size will be reported for the share size according to these quotas\&.
391.sp
392.RS 4
393.ie n \{\
394\h'-04'\(bu\h'+03'\c
395.\}
396.el \{\
397.sp -1
398.IP \(bu 2.3
399.\}
400yes
401\- include the quotas when reporting the share size and free space
402.RE
403.sp
404.RS 4
405.ie n \{\
406\h'-04'\(bu\h'+03'\c
407.\}
408.el \{\
409.sp -1
410.IP \(bu 2.3
411.\}
412no(default)
413\- do not include quotas, simply report the size and free space of the file system
414.RE
415.sp
416.RE
417.RE
418.PP
419gpfs:prealloc = [ yes | no ]
420.RS 4
421If set to yes the gpfs_prealloc function will be used in the fallocate callback when appropriate\&. If set to no gpfs_prealloc will not be used\&. In both cases the system and libc calls are avoided\&.
422.sp
423.RS 4
424.ie n \{\
425\h'-04'\(bu\h'+03'\c
426.\}
427.el \{\
428.sp -1
429.IP \(bu 2.3
430.\}
431yes (default)
432\- Use gpfs_prealloc for the fallocate callback\&.
433.RE
434.sp
435.RS 4
436.ie n \{\
437\h'-04'\(bu\h'+03'\c
438.\}
439.el \{\
440.sp -1
441.IP \(bu 2.3
442.\}
443no
444\- Do not use gpfs_prealloc for the fallocate callback\&.
445.RE
446.sp
447.RE
448.RE
449.PP
450gpfs:settimes = [ yes | no ]
451.RS 4
452Use the gpfs_set_times API when changing the timestamps of a file or directory\&. If the GPFS API is not available the old method of using utime and the GPFS winattr call will be used instead\&.
453.sp
454.RS 4
455.ie n \{\
456\h'-04'\(bu\h'+03'\c
457.\}
458.el \{\
459.sp -1
460.IP \(bu 2.3
461.\}
462yes(default)
463\- Use gpfs_set_times\&. Fall back to utime and winattr when it is not available\&.
464.RE
465.sp
466.RS 4
467.ie n \{\
468\h'-04'\(bu\h'+03'\c
469.\}
470.el \{\
471.sp -1
472.IP \(bu 2.3
473.\}
474no
475\- Do not use gpfs_set_times\&.
476.RE
477.sp
478.RE
479.RE
480.PP
481nfs4:mode = [ simple | special ]
482.RS 4
483Controls substitution of special IDs (OWNER@ and GROUP@) on GPFS\&. The use of mode simple is recommended\&. In this mode only non inheriting ACL entries for the file owner and group are mapped to special IDs\&.
484.sp
485The following MODEs are understood by the module:
486.sp
487.RS 4
488.ie n \{\
489\h'-04'\(bu\h'+03'\c
490.\}
491.el \{\
492.sp -1
493.IP \(bu 2.3
494.\}
495simple(default)
496\- use OWNER@ and GROUP@ special IDs for non inheriting ACEs only\&.
497.RE
498.sp
499.RS 4
500.ie n \{\
501\h'-04'\(bu\h'+03'\c
502.\}
503.el \{\
504.sp -1
505.IP \(bu 2.3
506.\}
507special(deprecated)
508\- use OWNER@ and GROUP@ special IDs in ACEs for all file owner and group ACEs\&.
509.RE
510.sp
511.RE
512.RE
513.PP
514nfs4:acedup = [dontcare|reject|ignore|merge]
515.RS 4
516This parameter configures how Samba handles duplicate ACEs encountered in GPFS ACLs\&. GPFS allows/creates duplicate ACE for different bits for same ID\&.
517.sp
518Following is the behaviour of Samba for different values :
519.sp
520.RS 4
521.ie n \{\
522\h'-04'\(bu\h'+03'\c
523.\}
524.el \{\
525.sp -1
526.IP \(bu 2.3
527.\}
528dontcare (default)
529\- copy the ACEs as they come
530.RE
531.sp
532.RS 4
533.ie n \{\
534\h'-04'\(bu\h'+03'\c
535.\}
536.el \{\
537.sp -1
538.IP \(bu 2.3
539.\}
540reject
541\- stop operation and exit with error on ACL set op
542.RE
543.sp
544.RS 4
545.ie n \{\
546\h'-04'\(bu\h'+03'\c
547.\}
548.el \{\
549.sp -1
550.IP \(bu 2.3
551.\}
552ignore
553\- don\*(Aqt include the second matching ACE
554.RE
555.sp
556.RS 4
557.ie n \{\
558\h'-04'\(bu\h'+03'\c
559.\}
560.el \{\
561.sp -1
562.IP \(bu 2.3
563.\}
564merge
565\- bitwise OR the 2 ace\&.flag fields and 2 ace\&.mask fields of the 2 duplicate ACEs into 1 ACE
566.RE
567.sp
568.RE
569.RE
570.PP
571nfs4:chown = [yes|no]
572.RS 4
573This parameter allows enabling or disabling the chown supported by the underlying filesystem\&. This parameter should be enabled with care as it might leave your system insecure\&.
574.sp
575Some filesystems allow chown as a) giving b) stealing\&. It is the latter that is considered a risk\&.
576.sp
577Following is the behaviour of Samba for different values :
578.sp
579.RS 4
580.ie n \{\
581\h'-04'\(bu\h'+03'\c
582.\}
583.el \{\
584.sp -1
585.IP \(bu 2.3
586.\}
587yes
588\- Enable chown if as supported by the under filesystem
589.RE
590.sp
591.RS 4
592.ie n \{\
593\h'-04'\(bu\h'+03'\c
594.\}
595.el \{\
596.sp -1
597.IP \(bu 2.3
598.\}
599no (default)
600\- Disable chown
601.RE
602.sp
603.RE
604.RE
605.PP
606gpfs:syncio = [yes|no]
607.RS 4
608This parameter makes Samba open all files with O_SYNC\&. This triggers optimizations in GPFS for workloads that heavily share files\&.
609.sp
610Following is the behaviour of Samba for different values:
611.sp
612.RS 4
613.ie n \{\
614\h'-04'\(bu\h'+03'\c
615.\}
616.el \{\
617.sp -1
618.IP \(bu 2.3
619.\}
620yes
621\- Open files with O_SYNC
622.RE
623.sp
624.RS 4
625.ie n \{\
626\h'-04'\(bu\h'+03'\c
627.\}
628.el \{\
629.sp -1
630.IP \(bu 2.3
631.\}
632no (default)
633\- Open files as normal Samba would do
634.RE
635.sp
636.RE
637.RE
638.SH "EXAMPLES"
639.PP
640A GPFS mount can be exported via Samba as follows :
641.sp
642.if n \{\
643.RS 4
644.\}
645.nf
646 \fI[samba_gpfs_share]\fR
647 \m[blue]\fBvfs objects = gpfs\fR\m[]
648 \m[blue]\fBpath = /test/gpfs_mount\fR\m[]
649 \m[blue]\fBnfs4: mode = special\fR\m[]
650 \m[blue]\fBnfs4: acedup = merge\fR\m[]
651.fi
652.if n \{\
653.RE
654.\}
655.SH "CAVEATS"
656.PP
657Depending on the version of gpfs, the
658libgpfs_gpl
659library or the
660libgpfs
661library is needed at runtime by the
662gpfs
663VFS module: Starting with gpfs 3\&.2\&.1 PTF8, the complete
664libgpfs
665is available as open source and
666libgpfs_gpl
667does no longer exist\&. With earlier versions of gpfs, only the
668libgpfs_gpl
669library was open source and could be used at run time\&.
670.PP
671At build time, only the header file
672gpfs_gpl\&.h
673is required, which is a symlink to
674gpfs\&.h
675in gpfs versions newer than 3\&.2\&.1 PTF8\&.
676.SH "VERSION"
677.PP
678This man page is correct for version 3\&.0\&.25 of the Samba suite\&.
679.SH "AUTHOR"
680.PP
681The original Samba software and related utilities were created by Andrew Tridgell\&. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\&.
682.PP
683The GPFS VFS module was created with contributions from Volker Lendecke and the developers at IBM\&.
684.PP
685This manpage was created by the IBM FSCC team
Note: See TracBrowser for help on using the repository browser.