sbin/mount_nfs/mount_nfs.8

   1 .\" Copyright (c) 1992, 1993, 1994, 1995
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 4. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     @(#)mount_nfs.8 8.3 (Berkeley) 3/29/95
  29 .\" $FreeBSD$
  30 .\"
  31 .Dd February 11, 2008
  32 .Dt MOUNT_NFS 8
  33 .Os
  34 .Sh NAME
  35 .Nm mount_nfs
  36 .Nd mount NFS file systems
  37 .Sh SYNOPSIS
  38 .Nm
  39 .Op Fl 23bcdiLlNPsTU
  40 .Op Fl a Ar maxreadahead
  41 .Op Fl D Ar deadthresh
  42 .Op Fl g Ar maxgroups
  43 .Op Fl I Ar readdirsize
  44 .Op Fl o Ar options
  45 .Op Fl R Ar retrycnt
  46 .Op Fl r Ar readsize
  47 .Op Fl t Ar timeout
  48 .Op Fl w Ar writesize
  49 .Op Fl x Ar retrans
  50 .Ar rhost : Ns Ar path node
  51 .Sh DESCRIPTION
  52 The
  53 .Nm
  54 utility calls the
  55 .Xr nmount 2
  56 system call to prepare and graft a remote NFS file system
  57 .Pq Ar rhost : Ns Ar path
  58 on to the file system tree at the point
  59 .Ar node .
  60 This command is normally executed by
  61 .Xr mount 8 .
  62 It implements the mount protocol as described in RFC 1094, Appendix A and
  63 .%T "NFS: Network File System Version 3 Protocol Specification" ,
  64 Appendix I.
  65 .Pp
  66 By default,
  67 .Nm
  68 keeps retrying until the mount succeeds.
  69 This behaviour is intended for file systems listed in
  70 .Xr fstab 5
  71 that are critical to the boot process.
  72 For non-critical file systems, the
  73 .Cm bg
  74 and
  75 .Cm retrycnt
  76 options provide mechanisms to prevent the boot process from hanging
  77 if the server is unavailable.
  78 .Pp
  79 If the server becomes unresponsive while an NFS file system is
  80 mounted, any new or outstanding file operations on that file system
  81 will hang uninterruptibly until the server comes back.
  82 To modify this default behaviour, see the
  83 .Cm intr
  84 and
  85 .Cm soft
  86 options.
  87 .Pp
  88 The options are:
  89 .Bl -tag -width indent
  90 .It Fl o
  91 Options are specified with a
  92 .Fl o
  93 flag followed by a comma separated string of options.
  94 See the
  95 .Xr mount 8
  96 man page for possible options and their meanings.
  97 The following NFS specific options are also available:
  98 .Bl -tag -width indent
  99 .It Cm acregmin Ns = Ns Aq Ar seconds
 100 .It Cm acregmax Ns = Ns Aq Ar seconds
 101 .It Cm acdirmin Ns = Ns Aq Ar seconds
 102 .It Cm acdirmax Ns = Ns Aq Ar seconds
 103 When attributes of files are cached, a timeout calculated to determine
 104 whether a given cache entry has expired.
 105 These four values determine the upper and lower bounds of the timeouts for
 106 .Dq directory
 107 attributes and
 108 .Dq regular
 109 (ie: everything else).
 110 The default values are 3 -> 60 seconds
 111 for regular files, and 30 -> 60 seconds for directories.
 112 The algorithm to calculate the timeout is based on the age of the file.
 113 The older the file,
 114 the longer the cache is considered valid, subject to the limits above.
 115 .It Cm bg
 116 If an initial attempt to contact the server fails, fork off a child to keep
 117 trying the mount in the background.
 118 Useful for
 119 .Xr fstab 5 ,
 120 where the file system mount is not critical to multiuser operation.
 121 .It Cm deadthresh Ns = Ns Aq Ar value
 122 Set the
 123 .Dq "dead server threshold"
 124 to the specified number of round trip timeout intervals before a
 125 .Dq "server not responding"
 126 message is displayed.
 127 .It Cm dumbtimer
 128 Turn off the dynamic retransmit timeout estimator.
 129 This may be useful for UDP mounts that exhibit high retry rates,
 130 since it is possible that the dynamically estimated timeout interval is too
 131 short.
 132 .It Cm fg
 133 Same as not specifying
 134 .Cm bg .
 135 .It Cm gssname Ns = Ns Aq Ar name
 136 For the RPCSEC_GSS security flavors, such as krb5, krb5i and krb5p when being
 137 used for an NFSv4 mount, this option specifies the host based principal
 138 name to be used for the state related operations SetClientID,
 139 SetClientIDConfirm, ReleaseLockOwner and Renew.
 140 It is also used for other operations, such as Getattr for
 141 .Xr statfs 2
 142 information and during open/lock state recovery.
 143 An entry for this principal must exist
 144 in the client machine's default keytab file.
 145 If possible, the keytab entry should be created using DES_CBC_CRC
 146 encryption. If another encryption algorithm is used, the sysctl variable
 147 .Va vfs.newnfs.keytab_enctype
 148 must be set to the numeric value representing that encryption algorithm.
 149 (The numeric values can be found in /usr/include/krb5_asn1.h. Look
 150 for constants named ETYPE_xxx.)
 151 If this option is given
 152 as a name without an ``@<client-fqdn>'', such as ``root'' or ``nfs'',
 153 ``@<client-fqdn>'' will be appended to it.
 154 .sp
 155 If this option is not specified
 156 for NFSv4 mounts using krb5[ip], the above operations will be done using the
 157 user principal for the user that performed the mount. This
 158 only works for mounts done by a user other than ``root'' and the user must
 159 have a valid TGT in their credentials cache at the time the mount is done.
 160 (Setting the
 161 .Va vfs.usermount
 162 to non-zero will allow users to do mounts.)
 163 Because the user's TGT is used to acquire credentials for these operations,
 164 it is important that that user's TGT does not expire before
 165 .Xr umount 8
 166 is done.
 167 .It Cm allgssname
 168 This option can be used along with
 169 .Cm gssname
 170 to indicate that all accesses to the mount point are to be done using
 171 the host based principal specified by the
 172 .Cm gssname
 173 option.
 174 This might be useful for nfsv4 mounts using sec=krb5[ip] that are being accessed
 175 by batch utilities over long periods of time.
 176 .It Cm hard
 177 Same as not specifying
 178 .Cm soft .
 179 .It Cm intr
 180 Make the mount interruptible, which implies that file system calls that
 181 are delayed due to an unresponsive server will fail with EINTR when a
 182 termination signal is posted for the process.
 183 .It Cm maxgroups Ns = Ns Aq Ar value
 184 Set the maximum size of the group list for the credentials to the
 185 specified value.
 186 This should be used for mounts on old servers that cannot handle a
 187 group list size of 16, as specified in RFC 1057.
 188 Try 8, if users in a lot of groups cannot get response from the mount
 189 point.
 190 .It Cm mntudp
 191 Force the mount protocol to use UDP transport, even for TCP NFS mounts.
 192 (Necessary for some old
 193 .Bx
 194 servers.)
 195 .It Cm nfsv2
 196 Use the NFS Version 2 protocol (the default is to try version 3 first
 197 then version 2).
 198 Note that NFS version 2 has a file size limit of 2 gigabytes.
 199 .It Cm nfsv3
 200 Use the NFS Version 3 protocol.
 201 .It Cm nfsv4
 202 Use the NFS Version 4 protocol.
 203 This option will force the mount to use the experimental nfs subsystem and
 204 TCP transport.
 205 To use the experimental nfs subsystem for nfsv2 and nfsv3 mounts, you
 206 must specify the ``newnfs'' file system type instead of ``nfs''.
 207 .It Cm noconn
 208 For UDP mount points, do not do a
 209 .Xr connect 2 .
 210 This must be used if the server does not reply to requests from the standard
 211 NFS port number 2049 or replies to requests using a different IP address
 212 (which can occur if the server is multi-homed).
 213 Setting the
 214 .Va vfs.nfs.nfs_ip_paranoia
 215 sysctl to 0 will make this option the default.
 216 .It Cm noinet4 , noinet6
 217 Disables
 218 .Dv AF_INET
 219 or
 220 .Dv AF_INET6
 221 connections.
 222 Useful for hosts that have
 223 both an A record and an AAAA record for the same name.
 224 .It Cm nolockd
 225 Do
 226 .Em not
 227 forward
 228 .Xr fcntl 2
 229 locks over the wire.
 230 All locks will be local and not seen by the server
 231 and likewise not seen by other NFS clients.
 232 This removes the need to run the
 233 .Xr rpcbind 8
 234 service and the
 235 .Xr rpc.statd 8
 236 and
 237 .Xr rpc.lockd 8
 238 servers on the client.
 239 Note that this option will only be honored when performing the
 240 initial mount, it will be silently ignored if used while updating
 241 the mount options.
 242 .It Cm principal
 243 For the RPCSEC_GSS security flavors, such as krb5, krb5i and krb5p,
 244 this option sets the name of the host based principal name expected
 245 by the server. This option overrides the default, which will be
 246 ``nfs@<server-fqdn>'' and should normally be sufficient.
 247 .It Cm noresvport
 248 Do
 249 .Em not
 250 use a reserved socket port number (see below).
 251 .It Cm port Ns = Ns Aq Ar port_number
 252 Use specified port number for NFS requests.
 253 The default is to query the portmapper for the NFS port.
 254 .It Cm rdirplus
 255 Used with NFSV3 to specify that the \fBReaddirPlus\fR RPC should
 256 be used.
 257 For NFSV4, setting this option has a similar effect, in that it will make
 258 the Readdir Operation get more attributes.
 259 This option reduces RPC traffic for cases such as
 260 .Dq "ls -l" ,
 261 but tends to flood the attribute and name caches with prefetched entries.
 262 Try this option and see whether performance improves or degrades.
 263 Probably
 264 most useful for client to server network interconnects with a large bandwidth
 265 times delay product.
 266 .It Cm readahead Ns = Ns Aq Ar value
 267 Set the read-ahead count to the specified value.
 268 This may be in the range of 0 - 4, and determines how many blocks
 269 will be read ahead when a large file is being read sequentially.
 270 Trying a value greater than 1 for this is suggested for
 271 mounts with a large bandwidth * delay product.
 272 .It Cm readdirsize Ns = Ns Aq Ar value
 273 Set the readdir read size to the specified value.
 274 The value should normally
 275 be a multiple of
 276 .Dv DIRBLKSIZ
 277 that is <= the read size for the mount.
 278 .It Cm resvport
 279 Use a reserved socket port number.
 280 This flag is obsolete, and only retained for compatibility reasons.
 281 Reserved port numbers are used by default now.
 282 (For the rare case where the client has a trusted root account
 283 but untrustworthy users and the network cables are in secure areas this does
 284 help, but for normal desktop clients this does not apply.)
 285 .It Cm retrans Ns = Ns Aq Ar value
 286 Set the retransmit timeout count for soft mounts to the specified value.
 287 .It Cm retrycnt Ns = Ns Aq Ar count
 288 Set the mount retry count to the specified value.
 289 The default is a retry count of zero, which means to keep retrying
 290 forever.
 291 There is a 60 second delay between each attempt.
 292 .It Cm rsize Ns = Ns Aq Ar value
 293 Set the read data size to the specified value.
 294 It should normally be a power of 2 greater than or equal to 1024.
 295 This should be used for UDP mounts when the
 296 .Dq "fragments dropped due to timeout"
 297 value is getting large while actively using a mount point.
 298 (Use
 299 .Xr netstat 1
 300 with the
 301 .Fl s
 302 option to see what the
 303 .Dq "fragments dropped due to timeout"
 304 value is.)
 305 .It Cm sec Ns = Ns Aq Ar flavor
 306 This option specifies what security flavor should be used for the mount.
 307 Currently, they are:
 308 .Bd -literal
 309 krb5 -  Use KerberosV authentication
 310 krb5i - Use KerberosV authentication and
 311         apply integrity checksums to RPCs
 312 krb5p - Use KerberosV authentication and
 313         encrypt the RPC data
 314 sys -   The default AUTH_SYS, which uses a
 315         uid + gid list authenticator
 316 .Ed
 317 .It Cm soft
 318 A soft mount, which implies that file system calls will fail
 319 after
 320 .Ar retrycnt
 321 round trip timeout intervals.
 322 .It Cm tcp
 323 Use TCP transport.
 324 This is the default option, as it provides for increased reliability on both
 325 LAN and WAN configurations compared to UDP.
 326 Some old NFS servers do not support this method; UDP mounts may be required
 327 for interoperability.
 328 .It Cm timeout Ns = Ns Aq Ar value
 329 Set the initial retransmit timeout to the specified value.
 330 May be useful for fine tuning UDP mounts over internetworks
 331 with high packet loss rates or an overloaded server.
 332 Try increasing the interval if
 333 .Xr nfsstat 1
 334 shows high retransmit rates while the file system is active or reducing the
 335 value if there is a low retransmit rate but long response delay observed.
 336 (Normally, the
 337 .Cm dumbtimer
 338 option should be specified when using this option to manually
 339 tune the timeout
 340 interval.)
 341 .It Cm udp
 342 Use UDP transport.
 343 .It Cm wsize Ns = Ns Aq Ar value
 344 Set the write data size to the specified value.
 345 Ditto the comments w.r.t.\& the
 346 .Cm rsize
 347 option, but using the
 348 .Dq "fragments dropped due to timeout"
 349 value on the server instead of the client.
 350 Note that both the
 351 .Cm rsize
 352 and
 353 .Cm wsize
 354 options should only be used as a last ditch effort at improving performance
 355 when mounting servers that do not support TCP mounts.
 356 .El
 357 .El
 358 .Sh COMPATIBILITY
 359 The following command line flags are equivalent to
 360 .Fl o
 361 named options and are supported for compatibility with older
 362 installations.
 363 .Bl -tag -width indent
 364 .It Fl 2
 365 Same as
 366 .Fl o Cm nfsv2
 367 .It Fl 3
 368 Same as
 369 .Fl o Cm nfsv3
 370 .It Fl D
 371 Same as
 372 .Fl o Cm deadthresh
 373 .It Fl I
 374 Same as
 375 .Fl o Cm readdirsize Ns = Ns Aq Ar value
 376 .It Fl L
 377 Same as
 378 .Fl o Cm nolockd
 379 .It Fl N
 380 Same as
 381 .Fl o Cm noresvport
 382 .It Fl P
 383 Use a reserved socket port number.
 384 This flag is obsolete, and only retained for compatibility reasons.
 385 (For the rare case where the client has a trusted root account
 386 but untrustworthy users and the network cables are in secure areas this does
 387 help, but for normal desktop clients this does not apply.)
 388 .It Fl R
 389 Same as
 390 .Fl o Cm retrycnt Ns = Ns Aq Ar value
 391 .It Fl T
 392 Same as
 393 .Fl o Cm tcp
 394 .It Fl U
 395 Same as
 396 .Fl o Cm mntudp
 397 .It Fl a
 398 Same as
 399 .Fl o Cm readahead Ns = Ns Aq Ar value
 400 .It Fl b
 401 Same as
 402 .Fl o Cm bg
 403 .It Fl c
 404 Same as
 405 .Fl o Cm noconn
 406 .It Fl d
 407 Same as
 408 .Fl o Cm dumbtimer
 409 .It Fl g
 410 Same as
 411 .Fl o Cm maxgroups
 412 .It Fl i
 413 Same as
 414 .Fl o Cm intr
 415 .It Fl l
 416 Same as
 417 .Fl o Cm rdirplus
 418 .It Fl r
 419 Same as
 420 .Fl o Cm rsize Ns = Ns Aq Ar value
 421 .It Fl s
 422 Same as
 423 .Fl o Cm soft
 424 .It Fl t
 425 Same as
 426 .Fl o Cm retransmit Ns = Ns Aq Ar value
 427 .It Fl w
 428 Same as
 429 .Fl o Cm wsize Ns = Ns Aq Ar value
 430 .It Fl x
 431 Same as
 432 .Fl o Cm retrans Ns = Ns Aq Ar value
 433 .El
 434 .Sh SEE ALSO
 435 .Xr nmount 2 ,
 436 .Xr unmount 2 ,
 437 .Xr nfsv4 4 ,
 438 .Xr fstab 5 ,
 439 .Xr gssd 8 ,
 440 .Xr mount 8 ,
 441 .Xr nfsd 8 ,
 442 .Xr nfsiod 8 ,
 443 .Xr showmount 8
 444 .Sh BUGS
 445 Since nfsv4 performs open/lock operations that have their ordering strictly
 446 enforced by the server, the options
 447 .Cm intr
 448 and
 449 .Cm soft
 450 cannot be safely used.
 451 .Cm hard
 452 nfsv4 mounts are strongly recommended.