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