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 September 10, 2016
  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.
 187 If this is set to 0 it disables negative 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 pnfs
 205 Enable support for parallel NFS (pNFS) for minor version 1 of the
 206 NFS Version 4 protocol.
 207 This option is only meaningful when used with the
 208 .Cm minorversion
 209 option.
 210 .It Cm noac
 211 Disable attribute caching.
 212 .It Cm noconn
 213 For UDP mount points, do not do a
 214 .Xr connect 2 .
 215 This must be used if the server does not reply to requests from the standard
 216 NFS port number 2049 or replies to requests using a different IP address
 217 (which can occur if the server is multi-homed).
 218 Setting the
 219 .Va vfs.nfs.nfs_ip_paranoia
 220 sysctl to 0 will make this option the default.
 221 .It Cm nocto
 222 Normally, NFS clients maintain the close-to-open cache coherency.
 223 This works by flushing at close time and checking at open time.
 224 Checking at open time is implemented by getting attributes from
 225 the server and purging the data cache if they do not match
 226 attributes cached by the client.
 227 .Pp
 228 This option disables checking at open time.
 229 It may improve performance for read-only mounts,
 230 but should only be used if the data on the server changes rarely.
 231 Be sure to understand the consequences before enabling this option.
 232 .It Cm noinet4 , noinet6
 233 Disables
 234 .Dv AF_INET
 235 or
 236 .Dv AF_INET6
 237 connections.
 238 Useful for hosts that have
 239 both an A record and an AAAA record for the same name.
 240 .It Cm nolockd
 241 Do
 242 .Em not
 243 forward
 244 .Xr fcntl 2
 245 locks over the wire.
 246 All locks will be local and not seen by the server
 247 and likewise not seen by other NFS clients.
 248 This removes the need to run the
 249 .Xr rpcbind 8
 250 service and the
 251 .Xr rpc.statd 8
 252 and
 253 .Xr rpc.lockd 8
 254 servers on the client.
 255 Note that this option will only be honored when performing the
 256 initial mount, it will be silently ignored if used while updating
 257 the mount options.
 258 .It Cm noncontigwr
 259 This mount option allows the NFS client to
 260 combine non-contiguous byte ranges being written
 261 such that the dirty byte range becomes a superset of the bytes
 262 that are dirty.
 263 This reduces the number of writes significantly for software
 264 builds.
 265 The merging of byte ranges is not done if the file has been file
 266 locked, since most applications modifying a file from multiple
 267 clients will use file locking.
 268 As such, this option could result in a corrupted file for the
 269 rare case of an application modifying the file from multiple
 270 clients concurrently without using file locking.
 271 .It Cm principal
 272 For the RPCSEC_GSS security flavors, such as krb5, krb5i and krb5p,
 273 this option sets the name of the host based principal name expected
 274 by the server.
 275 This option overrides the default, which will be ``nfs@<server-fqdn>''
 276 and should normally be sufficient.
 277 .It Cm noresvport
 278 Do
 279 .Em not
 280 use a reserved socket port number (see below).
 281 .It Cm port Ns = Ns Aq Ar port_number
 282 Use specified port number for NFS requests.
 283 The default is to query the portmapper for the NFS port.
 284 .It Cm proto Ns = Ns Aq Ar protocol
 285 Specify transport protocol version to use.
 286 Currently, they are:
 287 .Bd -literal
 288 udp -   Use UDP over IPv4
 289 tcp -   Use TCP over IPv4
 290 udp6 -  Use UDP over IPv6
 291 tcp6 -  Use TCP over IPv6
 292 .Ed
 293 .It Cm rdirplus
 294 Used with NFSV3 to specify that the \fBReaddirPlus\fR RPC should
 295 be used.
 296 For NFSV4, setting this option has a similar effect, in that it will make
 297 the Readdir Operation get more attributes.
 298 This option reduces RPC traffic for cases such as
 299 .Dq "ls -l" ,
 300 but tends to flood the attribute and name caches with prefetched entries.
 301 Try this option and see whether performance improves or degrades.
 302 Probably
 303 most useful for client to server network interconnects with a large bandwidth
 304 times delay product.
 305 .It Cm readahead Ns = Ns Aq Ar value
 306 Set the read-ahead count to the specified value.
 307 This may be in the range of 0 - 4, and determines how many blocks
 308 will be read ahead when a large file is being read sequentially.
 309 Trying a value greater than 1 for this is suggested for
 310 mounts with a large bandwidth * delay product.
 311 .It Cm readdirsize Ns = Ns Aq Ar value
 312 Set the readdir read size to the specified value.
 313 The value should normally
 314 be a multiple of
 315 .Dv DIRBLKSIZ
 316 that is <= the read size for the mount.
 317 .It Cm resvport
 318 Use a reserved socket port number.
 319 This flag is obsolete, and only retained for compatibility reasons.
 320 Reserved port numbers are used by default now.
 321 (For the rare case where the client has a trusted root account
 322 but untrustworthy users and the network cables are in secure areas this does
 323 help, but for normal desktop clients this does not apply.)
 324 .It Cm retrans Ns = Ns Aq Ar value
 325 Set the retransmit timeout count for soft mounts to the specified value.
 326 .It Cm retrycnt Ns = Ns Aq Ar count
 327 Set the mount retry count to the specified value.
 328 The default is a retry count of zero, which means to keep retrying
 329 forever.
 330 There is a 60 second delay between each attempt.
 331 .It Cm rsize Ns = Ns Aq Ar value
 332 Set the read data size to the specified value.
 333 It should normally be a power of 2 greater than or equal to 1024.
 334 This should be used for UDP mounts when the
 335 .Dq "fragments dropped due to timeout"
 336 value is getting large while actively using a mount point.
 337 (Use
 338 .Xr netstat 1
 339 with the
 340 .Fl s
 341 option to see what the
 342 .Dq "fragments dropped due to timeout"
 343 value is.)
 344 .It Cm sec Ns = Ns Aq Ar flavor
 345 This option specifies what security flavor should be used for the mount.
 346 Currently, they are:
 347 .Bd -literal
 348 krb5 -  Use KerberosV authentication
 349 krb5i - Use KerberosV authentication and
 350         apply integrity checksums to RPCs
 351 krb5p - Use KerberosV authentication and
 352         encrypt the RPC data
 353 sys -   The default AUTH_SYS, which uses a
 354         uid + gid list authenticator
 355 .Ed
 356 .It Cm soft
 357 A soft mount, which implies that file system calls will fail
 358 after
 359 .Ar retrycnt
 360 round trip timeout intervals.
 361 .It Cm tcp
 362 Use TCP transport.
 363 This is the default option, as it provides for increased reliability on both
 364 LAN and WAN configurations compared to UDP.
 365 Some old NFS servers do not support this method; UDP mounts may be required
 366 for interoperability.
 367 .It Cm timeout Ns = Ns Aq Ar value
 368 Set the initial retransmit timeout to the specified value,
 369 expressed in tenths of a second.
 370 May be useful for fine tuning UDP mounts over internetworks
 371 with high packet loss rates or an overloaded server.
 372 Try increasing the interval if
 373 .Xr nfsstat 1
 374 shows high retransmit rates while the file system is active or reducing the
 375 value if there is a low retransmit rate but long response delay observed.
 376 (Normally, the
 377 .Cm dumbtimer
 378 option should be specified when using this option to manually
 379 tune the timeout
 380 interval.)
 381 .It Cm timeo Ns = Ns Aq Ar value
 382 Alias for
 383 .Cm timeout .
 384 .It Cm udp
 385 Use UDP transport.
 386 .It Cm vers Ns = Ns Aq Ar vers_number
 387 Use the specified version number for NFS requests.
 388 See the
 389 .Cm nfsv2 ,
 390 .Cm nfsv3 ,
 391 and
 392 .Cm nfsv4
 393 options for details.
 394 .It Cm wcommitsize Ns = Ns Aq Ar value
 395 Set the maximum pending write commit size to the specified value.
 396 This determines the maximum amount of pending write data that the NFS
 397 client is willing to cache for each file.
 398 .It Cm wsize Ns = Ns Aq Ar value
 399 Set the write data size to the specified value.
 400 Ditto the comments w.r.t.\& the
 401 .Cm rsize
 402 option, but using the
 403 .Dq "fragments dropped due to timeout"
 404 value on the server instead of the client.
 405 Note that both the
 406 .Cm rsize
 407 and
 408 .Cm wsize
 409 options should only be used as a last ditch effort at improving performance
 410 when mounting servers that do not support TCP mounts.
 411 .El
 412 .El
 413 .Sh COMPATIBILITY
 414 The following command line flags are equivalent to
 415 .Fl o
 416 named options and are supported for compatibility with older
 417 installations.
 418 .Bl -tag -width indent
 419 .It Fl 2
 420 Same as
 421 .Fl o Cm nfsv2
 422 .It Fl 3
 423 Same as
 424 .Fl o Cm nfsv3
 425 .It Fl D
 426 Same as
 427 .Fl o Cm deadthresh
 428 .It Fl I
 429 Same as
 430 .Fl o Cm readdirsize Ns = Ns Aq Ar value
 431 .It Fl L
 432 Same as
 433 .Fl o Cm nolockd
 434 .It Fl N
 435 Same as
 436 .Fl o Cm noresvport
 437 .It Fl P
 438 Use a reserved socket port number.
 439 This flag is obsolete, and only retained for compatibility reasons.
 440 (For the rare case where the client has a trusted root account
 441 but untrustworthy users and the network cables are in secure areas this does
 442 help, but for normal desktop clients this does not apply.)
 443 .It Fl R
 444 Same as
 445 .Fl o Cm retrycnt Ns = Ns Aq Ar value
 446 .It Fl T
 447 Same as
 448 .Fl o Cm tcp
 449 .It Fl U
 450 Same as
 451 .Fl o Cm mntudp
 452 .It Fl a
 453 Same as
 454 .Fl o Cm readahead Ns = Ns Aq Ar value
 455 .It Fl b
 456 Same as
 457 .Fl o Cm bg
 458 .It Fl c
 459 Same as
 460 .Fl o Cm noconn
 461 .It Fl d
 462 Same as
 463 .Fl o Cm dumbtimer
 464 .It Fl g
 465 Same as
 466 .Fl o Cm maxgroups
 467 .It Fl i
 468 Same as
 469 .Fl o Cm intr
 470 .It Fl l
 471 Same as
 472 .Fl o Cm rdirplus
 473 .It Fl r
 474 Same as
 475 .Fl o Cm rsize Ns = Ns Aq Ar value
 476 .It Fl s
 477 Same as
 478 .Fl o Cm soft
 479 .It Fl t
 480 Same as
 481 .Fl o Cm retransmit Ns = Ns Aq Ar value
 482 .It Fl w
 483 Same as
 484 .Fl o Cm wsize Ns = Ns Aq Ar value
 485 .It Fl x
 486 Same as
 487 .Fl o Cm retrans Ns = Ns Aq Ar value
 488 .El
 489 .Pp
 490 The following
 491 .Fl o
 492 named options are equivalent to other
 493 .Fl o
 494 named options and are supported for compatibility with other
 495 operating systems (e.g., Linux, Solaris, and OSX) to ease usage of
 496 .Xr autofs 5
 497 support.
 498 .Bl -tag -width indent
 499 .It Fl o Cm vers Ns = Ns 2
 500 Same as
 501 .Fl o Cm nfsv2
 502 .It Fl o Cm vers Ns = Ns 3
 503 Same as
 504 .Fl o Cm nfsv3
 505 .It Fl o Cm vers Ns = Ns 4
 506 Same as
 507 .Fl o Cm nfsv4
 508 .El
 509 .Sh SEE ALSO
 510 .Xr nmount 2 ,
 511 .Xr unmount 2 ,
 512 .Xr nfsv4 4 ,
 513 .Xr fstab 5 ,
 514 .Xr gssd 8 ,
 515 .Xr mount 8 ,
 516 .Xr nfsd 8 ,
 517 .Xr nfsiod 8 ,
 518 .Xr showmount 8
 519 .Sh HISTORY
 520 A version of the
 521 .Nm
 522 utility appeared in
 523 .Bx 4.4 .
 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.