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