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