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                 <varlistentry>
 108
 109                 <term>gpfs:getrealfilename = [ yes | no ]</term>
 110                 <listitem>
 111                 <para>
 112                 Enable/Disable usage of the <command>gpfs_get_realfilename_path()</command> function.
 113                 This improves the casesensitive wildcard file name access.
 114                 </para>
 115
 116                 <itemizedlist>
 117                 <listitem><para>
 118                 <command>yes(default)</command> - use <command>gpfs_get_realfilename_path()</command>.
 119                 </para></listitem>
 120                 <listitem><para>
 121                 <command>no</command> - do not use <command>gpfs_get_realfilename_path()</command>.
 122                 It seems that <command>gpfs_get_realfilename_path()</command> doesn't work on AIX.
 123                 </para></listitem>
 124                 </itemizedlist>
 125                 </listitem>
 126
 127                 </varlistentry>
 128                 <varlistentry>
 129
 130                 <term>gpfs:winattr = [ yes | no ]</term>
 131                 <listitem>
 132                 <para>
 133                 Enable/Disable usage of the windows attributes in GPFS.
 134                 GPFS is able to store windows file attributes e.g. HIDDEN,
 135                 READONLY, SYSTEM and others natively. That means Samba doesn't
 136                 need to map them to permission bits or extended attributes.
 137                 </para>
 138
 139                 <itemizedlist>
 140                 <listitem><para>
 141                 <command>no(default)</command> - do not use GPFS windows attributes.
 142                 </para></listitem>
 143                 <listitem><para>
 144                 <command>yes</command> - use GPFS windows attributes.
 145                 </para></listitem>
 146                 </itemizedlist>
 147                 </listitem>
 148
 149                 </varlistentry>
 150                 <varlistentry>
 151
 152                 <term>gpfs:merge_writeappend = [ yes | no ]</term>
 153                 <listitem>
 154                 <para>
 155                 GPFS ACLs doesn't know about the 'APPEND' right.
 156                 This optionen lets Samba map the 'APPEND' right to 'WRITE'.
 157                 </para>
 158
 159                 <itemizedlist>
 160                 <listitem><para>
 161                 <command>yes(default)</command> - map 'APPEND' to 'WRITE'.
 162                 </para></listitem>
 163                 <listitem><para>
 164                 <command>no</command> - do not map 'APPEND' to 'WRITE'.
 165                 </para></listitem>
 166                 </itemizedlist>
 167                 </listitem>
 168
 169                 </varlistentry>
 170                 <varlistentry>
 171
 172                 <term>gpfs:refuse_dacl_protected = [ yes | no ]</term>
 173                 <listitem>
 174                 <para>
 175                 As GPFS does not support the ACE4_FLAG_NO_PROPAGATE NFSv4 flag (which would be
 176                 the mapping for the DESC_DACL_PROTECTED flag), the status of this flag is
 177                 currently silently ignored by Samba. That means that if you deselect the "Allow
 178                 inheritable permissions..." checkbox in Windows' ACL dialog and then apply the
 179                 ACL, the flag will be back immediately.
 180                 </para>
 181                 <para>
 182                 To make sure that automatic migration with e.g. robocopy does not lead to
 183                 ACLs silently (and unintentionally) changed, you can set
 184                 <command>gpfs:refuse_dacl_protected = yes</command> to enable an explicit
 185                 check for this flag and if set, it will return NT_STATUS_NOT_SUPPORTED so
 186                 errors are shown up on the Windows side and the Administrator is aware of
 187                 the ACLs not being settable like intended
 188                 </para>
 189
 190                 <itemizedlist>
 191                 <listitem><para>
 192                 <command>no(default)</command> - ignore the DESC_DACL_PROTECTED flags.
 193                 </para></listitem>
 194                 <listitem><para>
 195                 <command>yes</command> - reject ACLs with DESC_DACL_PROTECTED.
 196                 </para></listitem>
 197                 </itemizedlist>
 198                 </listitem>
 199
 200                 </varlistentry>
 201                 <varlistentry>
 202
 203                 <term>nfs4:mode = [ simple | special ]</term>
 204                 <listitem>
 205                 <para>
 206                 Enable/Disable substitution of special IDs on GPFS. This parameter
 207                 should not affect the windows users in anyway. It only ensures that Samba
 208                 sets the special IDs - OWNER@ and GROUP@ ( mappings to simple uids )
 209                 that are relevant to GPFS.
 210                 </para>
 211
 212                 <para>The following MODEs are understood by the module:</para>
 213                 <itemizedlist>
 214                 <listitem><para><command>simple(default)</command> - do not use special IDs in GPFS ACEs</para></listitem>
 215                 <listitem><para><command>special</command> - use special IDs in GPFS ACEs. </para> </listitem>
 216                 </itemizedlist>
 217                 </listitem>
 218
 219                 </varlistentry>
 220
 221
 222                 <varlistentry>
 223                 <term>nfs4:acedup = [dontcare|reject|ignore|merge]</term>
 224                 <listitem>
 225                 <para>
 226                 This parameter configures how Samba handles duplicate ACEs encountered in GPFS ACLs.
 227                 GPFS allows/creates duplicate ACE for different bits for same ID.
 228                 </para>
 229
 230                 <para>Following is the behaviour of Samba for different values :</para>
 231                 <itemizedlist>
 232                 <listitem><para><command>dontcare (default)</command> - copy the ACEs as they come</para></listitem>
 233                 <listitem><para><command>reject</command> - stop operation and exit with error on ACL set op</para></listitem>
 234                 <listitem><para><command>ignore</command> - don't include the second matching ACE</para></listitem>
 235                 <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>
 236                 </itemizedlist>
 237                 </listitem>
 238                 </varlistentry>
 239
 240
 241                 <varlistentry>
 242                 <term>nfs4:chown = [yes|no]</term>
 243                 <listitem>
 244                 <para>This parameter allows enabling or disabling the chown supported
 245                 by the underlying filesystem. This parameter should be enabled with
 246                 care as it might leave your system insecure.</para>
 247                 <para>Some filesystems allow chown as a) giving b) stealing. It is the latter
 248                 that is considered a risk.</para>
 249
 250                 <para>Following is the behaviour of Samba for different values : </para>
 251                 <itemizedlist>
 252                 <listitem><para><command>yes</command> - Enable chown if as supported by the under filesystem</para></listitem>
 253                 <listitem><para><command>no (default)</command> - Disable chown</para></listitem>
 254                 </itemizedlist>
 255                 </listitem>
 256                 </varlistentry>
 257
 258         </variablelist>
 259 </refsect1>
 260
 261 <refsect1>
 262         <title>EXAMPLES</title>
 263
 264         <para>A GPFS mount can be exported via Samba as follows :</para>
 265
 266 <programlisting>
 267         <smbconfsection name="[samba_gpfs_share]"/>
 268         <smbconfoption name="vfs objects">gpfs</smbconfoption>
 269         <smbconfoption name="path">/test/gpfs_mount</smbconfoption>
 270         <smbconfoption name="nfs4: mode">special</smbconfoption>
 271         <smbconfoption name="nfs4: acedup">merge</smbconfoption>
 272 </programlisting>
 273 </refsect1>
 274
 275 <refsect1>
 276         <title>CAVEATS</title>
 277         <para>
 278         Depending on the version of gpfs, the <command>libgpfs_gpl</command>
 279         library or the <command>libgpfs</command> library is needed at
 280         runtime by the <command>gpfs</command> VFS module:
 281         Starting with gpfs 3.2.1 PTF8, the complete <command>libgpfs</command>
 282         is available as open source and <command>libgpfs_gpl</command> does no
 283         longer exist. With earlier versions of gpfs, only the
 284         <command>libgpfs_gpl</command> library was open source and could be
 285         used at run time.
 286         </para>
 287         <para>
 288         At build time, only the header file <command>gpfs_gpl.h</command>
 289         is required , which is a symlink to <command>gpfs.h</command> in
 290         gpfs versions newer than 3.2.1 PTF8.
 291         </para>
 292 </refsect1>
 293
 294 <refsect1>
 295         <title>VERSION</title>
 296         <para>This man page is correct for version 3.0.25 of the Samba suite.
 297         </para>
 298 </refsect1>
 299
 300 <refsect1>
 301         <title>AUTHOR</title>
 302
 303         <para>The original Samba software and related utilities
 304         were created by Andrew Tridgell. Samba is now developed
 305         by the Samba Team as an Open Source project similar
 306         to the way the Linux kernel is developed.</para>
 307
 308         <para>The GPFS VFS module was created with contributions from
 309         Volker Lendecke and the developers at IBM.
 310         </para>
 311
 312         <para> This manpage was created by the IBM FSCC team </para>
 313 </refsect1>
 314
 315 </refentry>