doc/man-pages/pod1/fs_exportafs.pod

   1 =head1 NAME
   2
   3 fs_exportafs - Configures export of AFS to clients of other file systems
   4
   5 =head1 SYNOPSIS
   6
   7 =for html
   8 <div class="synopsis">
   9
  10 B<fs exportafs> S<<< B<-type> <I<exporter name>> >>>
  11     S<<< [B<-start> <I<start/stop translator (on | off)>>] >>>
  12     S<<< [B<-convert> <I<convert from afs to unix mode (on | off)>>] >>>
  13     S<<< [B<-uidcheck> <I<run on strict 'uid check' mode (on | off)>>] >>>
  14     S<<< [B<-submounts> <I<allow nfs mounts to subdirs of /afs/.. (on | off)>>] >>>
  15     [B<-help>]
  16
  17 B<fs exp> S<<< B<-t> <I<exporter name>> >>>
  18     S<<< [B<-st> <I<start/stop translator (on | off)>>] >>>
  19     S<<< [B<-c> <I<convert from afs to unix mode (on | off)>>] >>>
  20     S<<< [B<-u> <I<run on strict 'uid check' mode (on | off)>>] >>>
  21     S<<< [B<-su> <I<allow nfs mounts to subdirs of /afs/.. (on | off)>>] >>>
  22     [B<-h>]
  23
  24 =for html
  25 </div>
  26
  27 =head1 DESCRIPTION
  28
  29 The B<fs exportafs> command sets (if the B<-start> argument is provided)
  30 or reports (if it is omitted) whether the machine can reexport the AFS
  31 filespace to clients of a non-AFS file system. To control certain features
  32 of the translation protocol, use the following arguments:
  33
  34 =over 4
  35
  36 =item *
  37
  38 To control whether the UNIX group and other mode bits on an AFS file or
  39 directory are set to match the owner mode bits when it is exported to the
  40 non-AFS file system, use the B<-convert> argument.
  41
  42 =item *
  43
  44 To control whether tokens can be placed in a credential structure
  45 identified by a UID that differs from the local UID of the entity that is
  46 placing the tokens in the structure, use the B<-uidcheck> argument. The
  47 most common use is to control whether issuers of the B<knfs> command can
  48 specify a value for its B<-id> argument that does not match their local
  49 UID on the NFS/AFS translator machine.
  50
  51 =item *
  52
  53 To control whether users can create mounts in the non-AFS filespace to an
  54 AFS directory other than F</afs>, use the B<-submounts> argument.
  55
  56 =back
  57
  58 =head1 OPTIONS
  59
  60 =over 4
  61
  62 =item B<-type> <I<exporter name>>
  63
  64 Names the alternate file system to which to reexport the AFS
  65 filespace. The only acceptable value is C<nfs>, in lowercase letters only.
  66
  67 =item B<-start> on
  68 =item B<-start> off
  69
  70 Enables the local machine to reexport the AFS filespace if the value is
  71 C<on>, or disables it if the value is C<off>. Omit this argument to report
  72 the current setting for all of the configurable parameters.
  73
  74 =item B<-convert> on
  75 =item B<-convert> off
  76
  77 Controls the setting of the UNIX group and other mode bits on AFS files
  78 and directories exported to the non-AFS file system. If the value is
  79 C<on>, they are set to match the B<owner> mode bits. If the value is
  80 C<off>, the bits are not changed. If this argument is omitted, the default
  81 value is C<on>.
  82
  83 =item B<-uidcheck> on
  84 =item B<-uidcheck> off
  85
  86 Controls whether tokens can be placed in a credential structure identified
  87 by a UID that differs from the local UID of the entity that is placing the
  88 tokens in the structure.
  89
  90 =over 4
  91
  92 =item *
  93
  94 If the value is on, the UID that identifies the credential structure must
  95 match the local UID.
  96
  97 With respect to the B<knfs> command, this value means that the value of
  98 B<-id> argument must match the issuer's local UID on the translator
  99 machine. In practice, this setting makes it pointless to include the
 100 B<-id> argument to the B<knfs> command, because the only acceptable value
 101 (the issuer's local UID) is already used when the B<-id> argument is
 102 omitted.
 103
 104 Enabling UID checking also makes it impossible to issue the B<klog> and
 105 B<pagsh> commands on a client machine of the non-AFS file system even
 106 though it is a system type supported by AFS. For an explanation, see
 107 L<klog(1)>.
 108
 109 =item *
 110
 111 If the value is off (the default), tokens can be assigned to a local UID
 112 in the non-AFS file system that does not match the local UID of the entity
 113 assigning the tokens.
 114
 115 With respect to the B<knfs> command, it means that the issuer can use the
 116 B<-id> argument to assign tokens to a local UID on the NFS client machine
 117 that does not match his or her local UID on the translator machine. (An
 118 example is assigning tokens to the MFS client machine's local superuser
 119 C<root>.) This setting allows more than one issuer of the B<knfs> command
 120 to make tokens available to the same user on the NFS client machine. Each
 121 time a different user issues the B<knfs> command with the same value for
 122 the B<-id> argument, that user's tokens overwrite the existing ones. This
 123 can result in unpredictable access for the user on the NFS client machine.
 124
 125 =back
 126
 127 =item B<-submounts> on
 128 =item B<-submounts> off
 129
 130 Controls whether a user of the non-AFS filesystem can mount any directory
 131 in the AFS filespace other than the top-level F</afs> directory. If the
 132 value is C<on>, such submounts are allowed. If the value is C<off>, only
 133 mounts of the F</afs> directory are allowed. If this argument is omitted,
 134 the default value is C<off>.
 135
 136 =item B<-help>
 137
 138 Prints the online help for this command. All other valid options are
 139 ignored.
 140
 141 =back
 142
 143 =head1 OUTPUT
 144
 145 If the machine is not even configured as a server of the non-AFS file
 146 system, the following message appears:
 147
 148    Sorry, the <file_system>-exporter type is currently not supported on
 149    this AFS client
 150
 151 If the machine is configured as a server of the non-AFS file system but is
 152 not currently enabled to reexport AFS to it (because the B<-start>
 153 argument to this command is not set to C<on>), the message is as follows:
 154
 155    '<file_system>' translator is disabled
 156
 157 If the machine is enabled to reexport AFS, the following message precedes
 158 messages that report the settings of the other parameters.
 159
 160    '<file_system>' translator is enabled with the following options:
 161
 162 The following messages indicate that the B<-convert> argument is set to
 163 C<on> or C<off> respectively:
 164
 165    Running in convert owner mode bits to world/other mode
 166    Running in strict unix mode
 167
 168 The following messages indicate that the B<-uidcheck> argument is set to
 169 C<on> or C<off> respectively:
 170
 171    Running in strict 'passwd sync' mode
 172    Running in no 'passwd sync' mode
 173
 174 The following messages indicate that the B<-submounts> argument is set to
 175 C<on> or C<off> respectively:
 176
 177    Allow mounts of /afs/.. subdirs
 178    Only mounts to /afs allowed
 179
 180 =head1 EXAMPLES
 181
 182 The following example shows that the local machine can export AFS to NFS
 183 client machines.
 184
 185    % fs exportafs nfs
 186    'nfs' translator is enabled with the following options:
 187         Running in convert owner mode bits to world/other mode
 188         Running in no 'passwd sync' mode
 189         Only mounts to /afs allowed
 190
 191 The following example enables the machine as an NFS server and converts
 192 the UNIX group and other mode bits on exported AFS directories and files
 193 to match the UNIX owner mode bits.
 194
 195    % fs exportafs -type nfs -start on -convert on
 196
 197 The following example disables the machine from reexporting AFS to NFS
 198 client machines:
 199
 200    % fs exportafs -type nfs -start off
 201
 202 =head1 PRIVILEGE REQUIRED
 203
 204 The issuer must be logged in as the local superuser root.
 205
 206 =head1 SEE ALSO
 207
 208 L<klog(1)>,
 209 L<knfs(1)>
 210
 211 =head1 COPYRIGHT
 212
 213 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
 214
 215 This documentation is covered by the IBM Public License Version 1.0.  It was
 216 converted from HTML to POD by software written by Chas Williams and Russ
 217 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.