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 October 30, 2014
  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 If the file system type is specified as ``oldnfs'', which implies this
  67 command is run as ``mount_oldnfs'', then it forces use of the old NFS
  68 client, which does not support the
  69 .Cm nfsv4
  70 option.
  71 .Pp
  72 By default,
  73 .Nm
  74 keeps retrying until the mount succeeds.
  75 This behaviour is intended for file systems listed in
  76 .Xr fstab 5
  77 that are critical to the boot process.
  78 For non-critical file systems, the
  79 .Cm bg
  80 and
  81 .Cm retrycnt
  82 options provide mechanisms to prevent the boot process from hanging
  83 if the server is unavailable.
  84 .Pp
  85 If the server becomes unresponsive while an NFS file system is
  86 mounted, any new or outstanding file operations on that file system
  87 will hang uninterruptibly until the server comes back.
  88 To modify this default behaviour, see the
  89 .Cm intr
  90 and
  91 .Cm soft
  92 options.
  93 .Pp
  94 The options are:
  95 .Bl -tag -width indent
  96 .It Fl o
  97 Options are specified with a
  98 .Fl o
  99 flag followed by a comma separated string of options.
 100 See the
 101 .Xr mount 8
 102 man page for possible options and their meanings.
 103 The following NFS specific options are also available:
 104 .Bl -tag -width indent
 105 .It Cm acregmin Ns = Ns Aq Ar seconds
 106 .It Cm acregmax Ns = Ns Aq Ar seconds
 107 .It Cm acdirmin Ns = Ns Aq Ar seconds
 108 .It Cm acdirmax Ns = Ns Aq Ar seconds
 109 When attributes of files are cached, a timeout calculated to determine
 110 whether a given cache entry has expired.
 111 These four values determine the upper and lower bounds of the timeouts for
 112 .Dq directory
 113 attributes and
 114 .Dq regular
 115 (ie: everything else).
 116 The default values are 3 -> 60 seconds
 117 for regular files, and 30 -> 60 seconds for directories.
 118 The algorithm to calculate the timeout is based on the age of the file.
 119 The older the file,
 120 the longer the cache is considered valid, subject to the limits above.
 121 .It Cm actimeo Ns = Ns Aq Ar seconds
 122 Set four cache timeouts above to specified value.
 123 .It Cm allgssname
 124 This option can be used along with
 125 .Fl o Cm gssname
 126 to specify that all operations should use the host-based initiator
 127 credential.
 128 This may be used for clients that run system daemons that need to
 129 access files on the NFSv4 mounted volume.
 130 .It Cm bg
 131 If an initial attempt to contact the server fails, fork off a child to keep
 132 trying the mount in the background.
 133 Useful for
 134 .Xr fstab 5 ,
 135 where the file system mount is not critical to multiuser operation.
 136 .It Cm deadthresh Ns = Ns Aq Ar value
 137 Set the
 138 .Dq "dead server threshold"
 139 to the specified number of round trip timeout intervals before a
 140 .Dq "server not responding"
 141 message is displayed.
 142 .It Cm dumbtimer
 143 Turn off the dynamic retransmit timeout estimator.
 144 This may be useful for UDP mounts that exhibit high retry rates,
 145 since it is possible that the dynamically estimated timeout interval is too
 146 short.
 147 .It Cm fg
 148 Same as not specifying
 149 .Cm bg .
 150 .It Cm gssname Ns = Ns Aq Ar service-principal-name
 151 This option can be used with the KerberosV security flavors for NFSv4 mounts
 152 to specify the
 153 .Dq "service-principal-name"
 154 of a host-based entry in the default
 155 keytab file that is used for system operations.
 156 It allows the mount to be performed by
 157 .Dq "root"
 158 and avoids problems with
 159 cached credentials for the system operations expiring.
 160 The
 161 .Dq "service-prinicpal-name"
 162 should be specified without instance or domain and is typically
 163 .Dq "host" ,
 164 .Dq "nfs"
 165 or
 166 .Dq "root" .
 167 .It Cm hard
 168 Same as not specifying
 169 .Cm soft .
 170 .It Cm intr
 171 Make the mount interruptible, which implies that file system calls that
 172 are delayed due to an unresponsive server will fail with EINTR when a
 173 termination signal is posted for the process.
 174 .It Cm maxgroups Ns = Ns Aq Ar value
 175 Set the maximum size of the group list for the credentials to the
 176 specified value.
 177 This should be used for mounts on old servers that cannot handle a
 178 group list size of 16, as specified in RFC 1057.
 179 Try 8, if users in a lot of groups cannot get response from the mount
 180 point.
 181 .It Cm mntudp
 182 Force the mount protocol to use UDP transport, even for TCP NFS mounts.
 183 (Necessary for some old
 184 .Bx
 185 servers.)
 186 .It Cm nametimeo Ns = Ns Aq Ar value
 187 Override the default of NFS_DEFAULT_NAMETIMEO for the timeout (in seconds)
 188 for positive name cache entries.
 189 If this is set to 0 it disables positive name caching for the mount point.
 190 .It Cm negnametimeo Ns = Ns Aq Ar value
 191 Override the default of NFS_DEFAULT_NEGNAMETIMEO for the timeout (in seconds)
 192 for negative name cache entries. If this is set to 0 it disables negative
 193 name caching for the mount point.
 194 .It Cm nfsv2
 195 Use the NFS Version 2 protocol (the default is to try version 3 first
 196 then version 2).
 197 Note that NFS version 2 has a file size limit of 2 gigabytes.
 198 .It Cm nfsv3
 199 Use the NFS Version 3 protocol.
 200 .It Cm nfsv4
 201 Use the NFS Version 4 protocol.
 202 This option will force the mount to use
 203 TCP transport.
 204 .It Cm minorversion Ns = Ns Aq Ar value
 205 Override the default of 0 for the minor version of the NFS Version 4 protocol.
 206 The only minor version currently supported is 1.
 207 This option is only meaningful when used with the
 208 .Cm nfsv4
 209 option.
 210 .It Cm pnfs
 211 Enable support for parallel NFS (pNFS) for minor version 1 of the
 212 NFS Version 4 protocol.
 213 This option is only meaningful when used with the
 214 .Cm minorversion
 215 option.
 216 .It Cm noac
 217 Disable attribute caching.
 218 .It Cm noconn
 219 For UDP mount points, do not do a
 220 .Xr connect 2 .
 221 This must be used if the server does not reply to requests from the standard
 222 NFS port number 2049 or replies to requests using a different IP address
 223 (which can occur if the server is multi-homed).
 224 Setting the
 225 .Va vfs.nfs.nfs_ip_paranoia
 226 sysctl to 0 will make this option the default.
 227 .It Cm nocto
 228 Normally, NFS clients maintain the close-to-open cache coherency.
 229 This works by flushing at close time and checking at open time.
 230 Checking at open time is implemented by getting attributes from
 231 the server and purging the data cache if they do not match
 232 attributes cached by the client.
 233 .Pp
 234 This option disables checking at open time.
 235 It may improve performance for read-only mounts,
 236 but should only be used if the data on the server changes rarely.
 237 Be sure to understand the consequences before enabling this option.
 238 .It Cm noinet4 , noinet6
 239 Disables
 240 .Dv AF_INET
 241 or
 242 .Dv AF_INET6
 243 connections.
 244 Useful for hosts that have
 245 both an A record and an AAAA record for the same name.
 246 .It Cm nolockd
 247 Do
 248 .Em not
 249 forward
 250 .Xr fcntl 2
 251 locks over the wire.
 252 All locks will be local and not seen by the server
 253 and likewise not seen by other NFS clients.
 254 This removes the need to run the
 255 .Xr rpcbind 8
 256 service and the
 257 .Xr rpc.statd 8
 258 and
 259 .Xr rpc.lockd 8
 260 servers on the client.
 261 Note that this option will only be honored when performing the
 262 initial mount, it will be silently ignored if used while updating
 263 the mount options.
 264 .It Cm noncontigwr
 265 This mount option allows the NFS client to
 266 combine non-contiguous byte ranges being written
 267 such that the dirty byte range becomes a superset of the bytes
 268 that are dirty.
 269 This reduces the number of writes significantly for software
 270 builds.
 271 The merging of byte ranges isn't done if the file has been file
 272 locked, since most applications modifying a file from multiple
 273 clients will use file locking.
 274 As such, this option could result in a corrupted file for the
 275 rare case of an application modifying the file from multiple
 276 clients concurrently without using file locking.
 277 .It Cm principal
 278 For the RPCSEC_GSS security flavors, such as krb5, krb5i and krb5p,
 279 this option sets the name of the host based principal name expected
 280 by the server. This option overrides the default, which will be
 281 ``nfs@<server-fqdn>'' and should normally be sufficient.
 282 .It Cm noresvport
 283 Do
 284 .Em not
 285 use a reserved socket port number (see below).
 286 .It Cm port Ns = Ns Aq Ar port_number
 287 Use specified port number for NFS requests.
 288 The default is to query the portmapper for the NFS port.
 289 .It Cm proto Ns = Ns Aq Ar protocol
 290 Specify transport protocol version to use.
 291 Currently, they are:
 292 .Bd -literal
 293 udp -   Use UDP over IPv4
 294 tcp -   Use TCP over IPv4
 295 udp6 -  Use UDP over IPv6
 296 tcp6 -  Use TCP over IPv6
 297 .Ed
 298 .It Cm rdirplus
 299 Used with NFSV3 to specify that the \fBReaddirPlus\fR RPC should
 300 be used.
 301 For NFSV4, setting this option has a similar effect, in that it will make
 302 the Readdir Operation get more attributes.
 303 This option reduces RPC traffic for cases such as
 304 .Dq "ls -l" ,
 305 but tends to flood the attribute and name caches with prefetched entries.
 306 Try this option and see whether performance improves or degrades.
 307 Probably
 308 most useful for client to server network interconnects with a large bandwidth
 309 times delay product.
 310 .It Cm readahead Ns = Ns Aq Ar value
 311 Set the read-ahead count to the specified value.
 312 This may be in the range of 0 - 4, and determines how many blocks
 313 will be read ahead when a large file is being read sequentially.
 314 Trying a value greater than 1 for this is suggested for
 315 mounts with a large bandwidth * delay product.
 316 .It Cm readdirsize Ns = Ns Aq Ar value
 317 Set the readdir read size to the specified value.
 318 The value should normally
 319 be a multiple of
 320 .Dv DIRBLKSIZ
 321 that is <= the read size for the mount.
 322 .It Cm resvport
 323 Use a reserved socket port number.
 324 This flag is obsolete, and only retained for compatibility reasons.
 325 Reserved port numbers are used by default now.
 326 (For the rare case where the client has a trusted root account
 327 but untrustworthy users and the network cables are in secure areas this does
 328 help, but for normal desktop clients this does not apply.)
 329 .It Cm retrans Ns = Ns Aq Ar value
 330 Set the retransmit timeout count for soft mounts to the specified value.
 331 .It Cm retrycnt Ns = Ns Aq Ar count
 332 Set the mount retry count to the specified value.
 333 The default is a retry count of zero, which means to keep retrying
 334 forever.
 335 There is a 60 second delay between each attempt.
 336 .It Cm rsize Ns = Ns Aq Ar value
 337 Set the read data size to the specified value.
 338 It should normally be a power of 2 greater than or equal to 1024.
 339 This should be used for UDP mounts when the
 340 .Dq "fragments dropped due to timeout"
 341 value is getting large while actively using a mount point.
 342 (Use
 343 .Xr netstat 1
 344 with the
 345 .Fl s
 346 option to see what the
 347 .Dq "fragments dropped due to timeout"
 348 value is.)
 349 .It Cm sec Ns = Ns Aq Ar flavor
 350 This option specifies what security flavor should be used for the mount.
 351 Currently, they are:
 352 .Bd -literal
 353 krb5 -  Use KerberosV authentication
 354 krb5i - Use KerberosV authentication and
 355         apply integrity checksums to RPCs
 356 krb5p - Use KerberosV authentication and
 357         encrypt the RPC data
 358 sys -   The default AUTH_SYS, which uses a
 359         uid + gid list authenticator
 360 .Ed
 361 .It Cm soft
 362 A soft mount, which implies that file system calls will fail
 363 after
 364 .Ar retrycnt
 365 round trip timeout intervals.
 366 .It Cm tcp
 367 Use TCP transport.
 368 This is the default option, as it provides for increased reliability on both
 369 LAN and WAN configurations compared to UDP.
 370 Some old NFS servers do not support this method; UDP mounts may be required
 371 for interoperability.
 372 .It Cm timeout Ns = Ns Aq Ar value
 373 Set the initial retransmit timeout to the specified value,
 374 expressed in tenths of a second.
 375 May be useful for fine tuning UDP mounts over internetworks
 376 with high packet loss rates or an overloaded server.
 377 Try increasing the interval if
 378 .Xr nfsstat 1
 379 shows high retransmit rates while the file system is active or reducing the
 380 value if there is a low retransmit rate but long response delay observed.
 381 (Normally, the
 382 .Cm dumbtimer
 383 option should be specified when using this option to manually
 384 tune the timeout
 385 interval.)
 386 .It Cm timeo Ns = Ns Aq Ar value
 387 Alias for
 388 .Cm timeout .
 389 .It Cm udp
 390 Use UDP transport.
 391 .It Cm vers Ns = Ns Aq Ar vers_number
 392 Use the specified version number for NFS requests.
 393 See the
 394 .Cm nfsv2 ,
 395 .Cm nfsv3 ,
 396 and
 397 .Cm nfsv4
 398 options for details.
 399 .It Cm wcommitsize Ns = Ns Aq Ar value
 400 Set the maximum pending write commit size to the specified value.
 401 This determines the maximum amount of pending write data that the NFS
 402 client is willing to cache for each file.
 403 .It Cm wsize Ns = Ns Aq Ar value
 404 Set the write data size to the specified value.
 405 Ditto the comments w.r.t.\& the
 406 .Cm rsize
 407 option, but using the
 408 .Dq "fragments dropped due to timeout"
 409 value on the server instead of the client.
 410 Note that both the
 411 .Cm rsize
 412 and
 413 .Cm wsize
 414 options should only be used as a last ditch effort at improving performance
 415 when mounting servers that do not support TCP mounts.
 416 .El
 417 .El
 418 .Sh COMPATIBILITY
 419 The following command line flags are equivalent to
 420 .Fl o
 421 named options and are supported for compatibility with older
 422 installations.
 423 .Bl -tag -width indent
 424 .It Fl 2
 425 Same as
 426 .Fl o Cm nfsv2
 427 .It Fl 3
 428 Same as
 429 .Fl o Cm nfsv3
 430 .It Fl D
 431 Same as
 432 .Fl o Cm deadthresh
 433 .It Fl I
 434 Same as
 435 .Fl o Cm readdirsize Ns = Ns Aq Ar value
 436 .It Fl L
 437 Same as
 438 .Fl o Cm nolockd
 439 .It Fl N
 440 Same as
 441 .Fl o Cm noresvport
 442 .It Fl P
 443 Use a reserved socket port number.
 444 This flag is obsolete, and only retained for compatibility reasons.
 445 (For the rare case where the client has a trusted root account
 446 but untrustworthy users and the network cables are in secure areas this does
 447 help, but for normal desktop clients this does not apply.)
 448 .It Fl R
 449 Same as
 450 .Fl o Cm retrycnt Ns = Ns Aq Ar value
 451 .It Fl T
 452 Same as
 453 .Fl o Cm tcp
 454 .It Fl U
 455 Same as
 456 .Fl o Cm mntudp
 457 .It Fl a
 458 Same as
 459 .Fl o Cm readahead Ns = Ns Aq Ar value
 460 .It Fl b
 461 Same as
 462 .Fl o Cm bg
 463 .It Fl c
 464 Same as
 465 .Fl o Cm noconn
 466 .It Fl d
 467 Same as
 468 .Fl o Cm dumbtimer
 469 .It Fl g
 470 Same as
 471 .Fl o Cm maxgroups
 472 .It Fl i
 473 Same as
 474 .Fl o Cm intr
 475 .It Fl l
 476 Same as
 477 .Fl o Cm rdirplus
 478 .It Fl r
 479 Same as
 480 .Fl o Cm rsize Ns = Ns Aq Ar value
 481 .It Fl s
 482 Same as
 483 .Fl o Cm soft
 484 .It Fl t
 485 Same as
 486 .Fl o Cm retransmit Ns = Ns Aq Ar value
 487 .It Fl w
 488 Same as
 489 .Fl o Cm wsize Ns = Ns Aq Ar value
 490 .It Fl x
 491 Same as
 492 .Fl o Cm retrans Ns = Ns Aq Ar value
 493 .El
 494 .Pp
 495 The following
 496 .Fl o
 497 named options are equivalent to other
 498 .Fl o
 499 named options and are supported for compatibility with other
 500 operating systems (e.g., Linux, Solaris, and OSX) to ease usage of
 501 .Xr autofs 5
 502 support.
 503 .Bl -tag -width indent
 504 .It Fl o Cm vers Ns = Ns 2
 505 Same as
 506 .Fl o Cm nfsv2
 507 .It Fl o Cm vers Ns = Ns 3
 508 Same as
 509 .Fl o Cm nfsv3
 510 .It Fl o Cm vers Ns = Ns 4
 511 Same as
 512 .Fl o Cm nfsv4
 513 .El
 514 .Sh SEE ALSO
 515 .Xr nmount 2 ,
 516 .Xr unmount 2 ,
 517 .Xr nfsv4 4 ,
 518 .Xr fstab 5 ,
 519 .Xr gssd 8 ,
 520 .Xr mount 8 ,
 521 .Xr nfsd 8 ,
 522 .Xr nfsiod 8 ,
 523 .Xr showmount 8
 524 .Sh BUGS
 525 Since nfsv4 performs open/lock operations that have their ordering strictly
 526 enforced by the server, the options
 527 .Cm intr
 528 and
 529 .Cm soft
 530 cannot be safely used.
 531 .Cm hard
 532 nfsv4 mounts are strongly recommended.