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</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:acl = [ yes | no ]</term>
 208                 <listitem>
 209                 <para>
 210                 This option lets Samba use or ignore GPFS ACLs.
 211                 </para>
 212
 213                 <itemizedlist>
 214                 <listitem><para>
 215                 <command>yes(default)</command> - use GPFS ACLs.
 216                 </para></listitem>
 217                 <listitem><para>
 218                 <command>no</command> - do not use GPFS ACLs and pass everything
 219                 to the next SMB_VFS module.
 220                 </para></listitem>
 221                 </itemizedlist>
 222                 </listitem>
 223
 224                 </varlistentry>
 225                 <varlistentry>
 226
 227                 <term>gpfs:check_fstype = [ yes | no ]</term>
 228                 <listitem>
 229                 <para>
 230                 Check for a mounted GPFS file system on access to a SMB share.
 231                 </para>
 232
 233                 <itemizedlist>
 234                 <listitem><para>
 235                 <command>yes(default)</command> - Check that the SMB share path
 236                 is on a GPFS file system. Share access will be denied when a
 237                 different file system is found.
 238                 </para></listitem>
 239                 <listitem><para>
 240                 <command>no</command> - skip check for GPFS file system on SMB
 241                 share path.
 242                 </para></listitem>
 243                 </itemizedlist>
 244                 </listitem>
 245
 246                 </varlistentry>
 247                 <varlistentry>
 248
 249                 <term>gpfs:refuse_dacl_protected = [ yes | no ]</term>
 250                 <listitem>
 251                 <para>
 252                 As GPFS does not support the ACE4_FLAG_NO_PROPAGATE NFSv4 flag (which would be
 253                 the mapping for the DESC_DACL_PROTECTED flag), the status of this flag is
 254                 currently silently ignored by Samba. That means that if you deselect the "Allow
 255                 inheritable permissions..." checkbox in Windows' ACL dialog and then apply the
 256                 ACL, the flag will be back immediately.
 257                 </para>
 258                 <para>
 259                 To make sure that automatic migration with e.g. robocopy does not lead to
 260                 ACLs silently (and unintentionally) changed, you can set
 261                 <command>gpfs:refuse_dacl_protected = yes</command> to enable an explicit
 262                 check for this flag and if set, it will return NT_STATUS_NOT_SUPPORTED so
 263                 errors are shown up on the Windows side and the Administrator is aware of
 264                 the ACLs not being settable like intended
 265                 </para>
 266
 267                 <itemizedlist>
 268                 <listitem><para>
 269                 <command>no(default)</command> - ignore the DESC_DACL_PROTECTED flags.
 270                 </para></listitem>
 271                 <listitem><para>
 272                 <command>yes</command> - reject ACLs with DESC_DACL_PROTECTED.
 273                 </para></listitem>
 274                 </itemizedlist>
 275                 </listitem>
 276
 277                 </varlistentry>
 278                 <varlistentry>
 279
 280                 <term>gpfs:dfreequota = [ yes | no ]</term>
 281                 <listitem>
 282                 <para>
 283                 Adjust reporting of the size and free space of a share
 284                 according to quotas. If this setting is "yes", a
 285                 request for size and free space will also evaluate the
 286                 user quota of the user requesting the data and the
 287                 group quota of the primary group of the user. Fileset
 288                 quotas are not queried, since GPFS already provides
 289                 the option --dfreequota to reflect the fileset quota
 290                 in the free space query. Please use that option to
 291                 include fileset quotas in the reported disk space.
 292                 </para>
 293
 294                 <para>
 295                 If any of the soft or hard quota limits has been
 296                 reached, the free space will be reported as 0. If a
 297                 quota is in place, but the limits have not been
 298                 reached, the free space will be reported according to
 299                 the space left in the quota. If more than one quota
 300                 applies the free space will be reported as the smallest
 301                 space left in those quotas. The size of the share
 302                 will be reported according to the quota usage. If more
 303                 than one quota applies, the smallest size will be
 304                 reported for the share size according to these quotas.
 305                 </para>
 306
 307                 <itemizedlist>
 308                 <listitem><para>
 309                 <command>yes</command> - include the quotas
 310                 when reporting the share size and free space
 311                 </para></listitem>
 312                 <listitem><para>
 313                 <command>no(default)</command> - do not include quotas,
 314                 simply report the size and free space of the file system
 315                 </para></listitem>
 316                 </itemizedlist>
 317                 </listitem>
 318
 319                 </varlistentry>
 320                 <varlistentry>
 321
 322                 <term>gpfs:settimes = [ yes | no ]</term>
 323                 <listitem>
 324                 <para>
 325                 Use the gpfs_set_times API when changing the
 326                 timestamps of a file or directory. If the GPFS API is
 327                 not available the old method of using utime and the
 328                 GPFS winattr call will be used instead.
 329                 </para>
 330
 331                 <itemizedlist>
 332                 <listitem><para>
 333                 <command>yes(default)</command> - Use gpfs_set_times.
 334                 Fall back to utime and winattr when it is not available.
 335                 </para></listitem>
 336                 <listitem><para>
 337                 <command>no</command> - Do not use gpfs_set_times.
 338                 </para></listitem>
 339                 </itemizedlist>
 340                 </listitem>
 341
 342                 </varlistentry>
 343                 <varlistentry>
 344
 345                 <term>nfs4:mode = [ simple | special ]</term>
 346                 <listitem>
 347                 <para>
 348                 Controls substitution of special IDs (OWNER@ and GROUP@) on GPFS.
 349                 The use of mode simple is recommended.
 350                 In this mode only non inheriting ACL entries for the file owner
 351                 and group are mapped to special IDs.
 352                 </para>
 353
 354                 <para>The following MODEs are understood by the module:</para>
 355                 <itemizedlist>
 356                 <listitem><para><command>simple(default)</command> - use OWNER@ and GROUP@ special IDs for non inheriting ACEs only.</para></listitem>
 357                 <listitem><para><command>special(deprecated)</command> - use OWNER@ and GROUP@ special IDs in ACEs for all file owner and group ACEs.</para></listitem>
 358                 </itemizedlist>
 359                 </listitem>
 360
 361                 </varlistentry>
 362
 363
 364                 <varlistentry>
 365                 <term>nfs4:acedup = [dontcare|reject|ignore|merge]</term>
 366                 <listitem>
 367                 <para>
 368                 This parameter configures how Samba handles duplicate ACEs encountered in GPFS ACLs.
 369                 GPFS allows/creates duplicate ACE for different bits for same ID.
 370                 </para>
 371
 372                 <para>Following is the behaviour of Samba for different values :</para>
 373                 <itemizedlist>
 374                 <listitem><para><command>dontcare</command> - copy the ACEs as they come</para></listitem>
 375                 <listitem><para><command>reject (deprecated)</command> - stop operation and exit with error on ACL set op</para></listitem>
 376                 <listitem><para><command>ignore (deprecated)</command> - don't include the second matching ACE</para></listitem>
 377                 <listitem><para><command>merge (default)</command> - bitwise OR the 2 ace.flag fields and 2 ace.mask fields of the 2 duplicate ACEs into 1 ACE</para></listitem>
 378                 </itemizedlist>
 379                 </listitem>
 380                 </varlistentry>
 381
 382
 383                 <varlistentry>
 384                 <term>nfs4:chown = [yes|no]</term>
 385                 <listitem>
 386                 <para>This parameter allows enabling or disabling the chown supported
 387                 by the underlying filesystem. This parameter should be enabled with
 388                 care as it might leave your system insecure.</para>
 389                 <para>Some filesystems allow chown as a) giving b) stealing. It is the latter
 390                 that is considered a risk.</para>
 391
 392                 <para>Following is the behaviour of Samba for different values : </para>
 393                 <itemizedlist>
 394                 <listitem><para><command>yes</command> - Enable chown if as supported by the under filesystem</para></listitem>
 395                 <listitem><para><command>no (default)</command> - Disable chown</para></listitem>
 396                 </itemizedlist>
 397                 </listitem>
 398                 </varlistentry>
 399
 400                 <varlistentry>
 401                 <term>gpfs:syncio = [yes|no]</term>
 402                 <listitem>
 403                 <para>This parameter makes Samba open all files with O_SYNC.
 404                   This triggers optimizations in GPFS for workloads that
 405                   heavily share files.</para>
 406
 407                 <para>Following is the behaviour of Samba for different
 408                   values:
 409                 </para>
 410                 <itemizedlist>
 411                 <listitem><para><command>yes</command> - Open files with O_SYNC
 412                 </para></listitem>
 413                 <listitem><para><command>no (default)</command> - Open files as
 414                     normal Samba would do
 415                 </para></listitem>
 416                 </itemizedlist>
 417                 </listitem>
 418                 </varlistentry>
 419
 420         </variablelist>
 421 </refsect1>
 422
 423 <refsect1>
 424         <title>EXAMPLES</title>
 425
 426         <para>A GPFS mount can be exported via Samba as follows :</para>
 427
 428 <programlisting>
 429         <smbconfsection name="[samba_gpfs_share]"/>
 430         <smbconfoption name="vfs objects">gpfs</smbconfoption>
 431         <smbconfoption name="path">/test/gpfs_mount</smbconfoption>
 432         <smbconfoption name="nfs4: mode">special</smbconfoption>
 433         <smbconfoption name="nfs4: acedup">merge</smbconfoption>
 434 </programlisting>
 435 </refsect1>
 436
 437 <refsect1>
 438         <title>CAVEATS</title>
 439         <para>
 440         Depending on the version of gpfs, the <command>libgpfs_gpl</command>
 441         library or the <command>libgpfs</command> library is needed at
 442         runtime by the <command>gpfs</command> VFS module:
 443         Starting with gpfs 3.2.1 PTF8, the complete <command>libgpfs</command>
 444         is available as open source and <command>libgpfs_gpl</command> does no
 445         longer exist. With earlier versions of gpfs, only the
 446         <command>libgpfs_gpl</command> library was open source and could be
 447         used at run time.
 448         </para>
 449         <para>
 450         At build time, only the header file <command>gpfs_gpl.h</command>
 451         is required, which is a symlink to <command>gpfs.h</command> in
 452         gpfs versions newer than 3.2.1 PTF8.
 453         </para>
 454 </refsect1>
 455
 456 <refsect1>
 457         <title>VERSION</title>
 458         <para>This man page is part of version &doc.version; of the Samba suite.
 459         </para>
 460 </refsect1>
 461
 462 <refsect1>
 463         <title>AUTHOR</title>
 464
 465         <para>The original Samba software and related utilities
 466         were created by Andrew Tridgell. Samba is now developed
 467         by the Samba Team as an Open Source project similar
 468         to the way the Linux kernel is developed.</para>
 469
 470         <para>The GPFS VFS module was created with contributions from
 471         Volker Lendecke and the developers at IBM.
 472         </para>
 473
 474         <para> This manpage was created by the IBM FSCC team </para>
 475 </refsect1>
 476
 477 </refentry>