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