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