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