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