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