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