docs/manpages/vfs_gpfs.8

   1 .\"     Title: vfs_gpfs
   2 .\"    Author: [see the "AUTHOR" section]
   3 .\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
   4 .\"      Date: 04/28/2009
   5 .\"    Manual: System Administration tools
   6 .\"    Source: Samba 3.3
   7 .\"  Language: English
   8 .\"
   9 .TH "VFS_GPFS" "8" "04/28/2009" "Samba 3\&.3" "System Administration tools"
  10 .\" -----------------------------------------------------------------
  11 .\" * (re)Define some macros
  12 .\" -----------------------------------------------------------------
  13 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  14 .\" toupper - uppercase a string (locale-aware)
  15 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  16 .de toupper
  17 .tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
  18 \\$*
  19 .tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
  20 ..
  21 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  22 .\" SH-xref - format a cross-reference to an SH section
  23 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  24 .de SH-xref
  25 .ie n \{\
  26 .\}
  27 .toupper \\$*
  28 .el \{\
  29 \\$*
  30 .\}
  31 ..
  32 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  33 .\" SH - level-one heading that works better for non-TTY output
  34 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  35 .de1 SH
  36 .\" put an extra blank line of space above the head in non-TTY output
  37 .if t \{\
  38 .sp 1
  39 .\}
  40 .sp \\n[PD]u
  41 .nr an-level 1
  42 .set-an-margin
  43 .nr an-prevailing-indent \\n[IN]
  44 .fi
  45 .in \\n[an-margin]u
  46 .ti 0
  47 .HTML-TAG ".NH \\n[an-level]"
  48 .it 1 an-trap
  49 .nr an-no-space-flag 1
  50 .nr an-break-flag 1
  51 \." make the size of the head bigger
  52 .ps +3
  53 .ft B
  54 .ne (2v + 1u)
  55 .ie n \{\
  56 .\" if n (TTY output), use uppercase
  57 .toupper \\$*
  58 .\}
  59 .el \{\
  60 .nr an-break-flag 0
  61 .\" if not n (not TTY), use normal case (not uppercase)
  62 \\$1
  63 .in \\n[an-margin]u
  64 .ti 0
  65 .\" if not n (not TTY), put a border/line under subheading
  66 .sp -.6
  67 \l'\n(.lu'
  68 .\}
  69 ..
  70 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  71 .\" SS - level-two heading that works better for non-TTY output
  72 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  73 .de1 SS
  74 .sp \\n[PD]u
  75 .nr an-level 1
  76 .set-an-margin
  77 .nr an-prevailing-indent \\n[IN]
  78 .fi
  79 .in \\n[IN]u
  80 .ti \\n[SN]u
  81 .it 1 an-trap
  82 .nr an-no-space-flag 1
  83 .nr an-break-flag 1
  84 .ps \\n[PS-SS]u
  85 \." make the size of the head bigger
  86 .ps +2
  87 .ft B
  88 .ne (2v + 1u)
  89 .if \\n[.$] \&\\$*
  90 ..
  91 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  92 .\" BB/BE - put background/screen (filled box) around block of text
  93 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  94 .de BB
  95 .if t \{\
  96 .sp -.5
  97 .br
  98 .in +2n
  99 .ll -2n
 100 .gcolor red
 101 .di BX
 102 .\}
 103 ..
 104 .de EB
 105 .if t \{\
 106 .if "\\$2"adjust-for-leading-newline" \{\
 107 .sp -1
 108 .\}
 109 .br
 110 .di
 111 .in
 112 .ll
 113 .gcolor
 114 .nr BW \\n(.lu-\\n(.i
 115 .nr BH \\n(dn+.5v
 116 .ne \\n(BHu+.5v
 117 .ie "\\$2"adjust-for-leading-newline" \{\
 118 \M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
 119 .\}
 120 .el \{\
 121 \M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
 122 .\}
 123 .in 0
 124 .sp -.5v
 125 .nf
 126 .BX
 127 .in
 128 .sp .5v
 129 .fi
 130 .\}
 131 ..
 132 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 133 .\" BM/EM - put colored marker in margin next to block of text
 134 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 135 .de BM
 136 .if t \{\
 137 .br
 138 .ll -2n
 139 .gcolor red
 140 .di BX
 141 .\}
 142 ..
 143 .de EM
 144 .if t \{\
 145 .br
 146 .di
 147 .ll
 148 .gcolor
 149 .nr BH \\n(dn
 150 .ne \\n(BHu
 151 \M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[]
 152 .in 0
 153 .nf
 154 .BX
 155 .in
 156 .fi
 157 .\}
 158 ..
 159 .\" -----------------------------------------------------------------
 160 .\" * set default formatting
 161 .\" -----------------------------------------------------------------
 162 .\" disable hyphenation
 163 .nh
 164 .\" disable justification (adjust text to left margin only)
 165 .ad l
 166 .\" -----------------------------------------------------------------
 167 .\" * MAIN CONTENT STARTS HERE *
 168 .\" -----------------------------------------------------------------
 169 .SH "Name"
 170 vfs_gpfs \- gpfs specific samba extensions like acls and prealloc
 171 .SH "Synopsis"
 172 .fam C
 173 .HP \w'\ 'u
 174 \FCvfs objects = gpfs\F[]
 175 .fam
 176 .SH "DESCRIPTION"
 177 .PP
 178 This VFS module is part of the
 179 \fBsamba\fR(7)
 180 suite\&.
 181 .PP
 182 The
 183 \FCgpfs\F[]
 184 VFS 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\&.
 185 .PP
 186 Currently the gpfs vfs module provides extensions in following areas :
 187 .sp
 188 .RS 4
 189 .ie n \{\
 190 \h'-04'\(bu\h'+03'\c
 191 .\}
 192 .el \{\
 193 .sp -1
 194 .IP \(bu 2.3
 195 .\}
 196 NFSv4 ACL Interfaces with configurable options for GPFS
 197 .RE
 198 .sp
 199 .RS 4
 200 .ie n \{\
 201 \h'-04'\(bu\h'+03'\c
 202 .\}
 203 .el \{\
 204 .sp -1
 205 .IP \(bu 2.3
 206 .\}
 207 Kernel oplock support on GPFS
 208 .RE
 209 .sp
 210 .RS 4
 211 .ie n \{\
 212 \h'-04'\(bu\h'+03'\c
 213 .\}
 214 .el \{\
 215 .sp -1
 216 .IP \(bu 2.3
 217 .\}
 218 Lease support on GPFS
 219 .sp
 220 .RE
 221 .PP
 222 \FCNOTE:\F[]This 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\&.
 223 .PP
 224 This module is stackable\&.
 225 .SH "OPTIONS"
 226 .PP
 227 nfs4:mode = [ simple | special ]
 228 .RS 4
 229 Enable/Disable substitution of special IDs on GPFS\&. This parameter should not affect the windows users in anyway\&. It only ensures that Samba sets the special IDs \- OWNER@ and GROUP@ ( mappings to simple uids ) that are relevant to GPFS\&.
 230 .sp
 231 The following MODEs are understood by the module:
 232 .sp
 233 .RS 4
 234 .ie n \{\
 235 \h'-04'\(bu\h'+03'\c
 236 .\}
 237 .el \{\
 238 .sp -1
 239 .IP \(bu 2.3
 240 .\}
 241 \FCsimple(default)\F[]
 242 \- do not use special IDs in GPFS ACEs
 243 .RE
 244 .sp
 245 .RS 4
 246 .ie n \{\
 247 \h'-04'\(bu\h'+03'\c
 248 .\}
 249 .el \{\
 250 .sp -1
 251 .IP \(bu 2.3
 252 .\}
 253 \FCspecial\F[]
 254 \- use special IDs in GPFS ACEs\&.
 255 .sp
 256 .RE
 257 .RE
 258 .PP
 259 nfs4:acedup = [dontcare|reject|ignore|merge]
 260 .RS 4
 261 This parameter configures how Samba handles duplicate ACEs encountered in GPFS ACLs\&. GPFS allows/creates duplicate ACE for different bits for same ID\&.
 262 .sp
 263 Following is the behaviour of Samba for different values :
 264 .sp
 265 .RS 4
 266 .ie n \{\
 267 \h'-04'\(bu\h'+03'\c
 268 .\}
 269 .el \{\
 270 .sp -1
 271 .IP \(bu 2.3
 272 .\}
 273 \FCdontcare (default)\F[]
 274 \- copy the ACEs as they come
 275 .RE
 276 .sp
 277 .RS 4
 278 .ie n \{\
 279 \h'-04'\(bu\h'+03'\c
 280 .\}
 281 .el \{\
 282 .sp -1
 283 .IP \(bu 2.3
 284 .\}
 285 \FCreject\F[]
 286 \- stop operation and exit with error on ACL set op
 287 .RE
 288 .sp
 289 .RS 4
 290 .ie n \{\
 291 \h'-04'\(bu\h'+03'\c
 292 .\}
 293 .el \{\
 294 .sp -1
 295 .IP \(bu 2.3
 296 .\}
 297 \FCignore\F[]
 298 \- don\'t include the second matching ACE
 299 .RE
 300 .sp
 301 .RS 4
 302 .ie n \{\
 303 \h'-04'\(bu\h'+03'\c
 304 .\}
 305 .el \{\
 306 .sp -1
 307 .IP \(bu 2.3
 308 .\}
 309 \FCmerge\F[]
 310 \- bitwise OR the 2 ace\&.flag fields and 2 ace\&.mask fields of the 2 duplicate ACEs into 1 ACE
 311 .sp
 312 .RE
 313 .RE
 314 .PP
 315 nfs4:chown = [yes|no]
 316 .RS 4
 317 This 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\&.
 318 .sp
 319 Some filesystems allow chown as a) giving b) stealing\&. It is the latter that is considered a risk\&.
 320 .sp
 321 Following is the behaviour of Samba for different values :
 322 .sp
 323 .RS 4
 324 .ie n \{\
 325 \h'-04'\(bu\h'+03'\c
 326 .\}
 327 .el \{\
 328 .sp -1
 329 .IP \(bu 2.3
 330 .\}
 331 \FCyes\F[]
 332 \- Enable chown if as supported by the under filesystem
 333 .RE
 334 .sp
 335 .RS 4
 336 .ie n \{\
 337 \h'-04'\(bu\h'+03'\c
 338 .\}
 339 .el \{\
 340 .sp -1
 341 .IP \(bu 2.3
 342 .\}
 343 \FCno (default)\F[]
 344 \- Disable chown
 345 .sp
 346 .RE
 347 .RE
 348 .SH "EXAMPLES"
 349 .PP
 350 A GPFS mount can be exported via Samba as follows :
 351 .sp
 352 .if n \{\
 353 .RS 4
 354 .\}
 355 .fam C
 356 .ps -1
 357 .nf
 358 .if t \{\
 359 .sp -1
 360 .\}
 361 .BB lightgray adjust-for-leading-newline
 362 .sp -1
 363
 364         \fI[samba_gpfs_share]\fR
 365         \m[blue]\fBvfs objects = gpfs\fR\m[]
 366         \m[blue]\fBpath = /test/gpfs_mount\fR\m[]
 367         \m[blue]\fBnfs4: mode = special\fR\m[]
 368         \m[blue]\fBnfs4: acedup = merge\fR\m[]
 369 .EB lightgray adjust-for-leading-newline
 370 .if t \{\
 371 .sp 1
 372 .\}
 373 .fi
 374 .fam
 375 .ps +1
 376 .if n \{\
 377 .RE
 378 .\}
 379 .SH "CAVEATS"
 380 .PP
 381 The gpfs gpl libraries are required by
 382 \FCgpfs\F[]
 383 VFS module during both compilation and runtime\&. Also this VFS module is tested to work on SLES 9/10 and RHEL 4\&.4
 384 .SH "VERSION"
 385 .PP
 386 This man page is correct for version 3\&.0\&.25 of the Samba suite\&.
 387 .SH "AUTHOR"
 388 .PP
 389 The 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\&.
 390 .PP
 391 The GPFS VFS module was created with contributions from Volker Lendecke and the developers at IBM\&.
 392 .PP
 393 This manpage was created by the IBM FSCC team