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