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 11, 2003
  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 mount 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 .Fl b
  74 and
  75 .Fl R
  76 flags 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 .Fl i
  84 and
  85 .Fl s
  86 flags.
  87 .Pp
  88 The options are:
  89 .Bl -tag -width indent
  90 .It Fl 2
  91 Use the NFS Version 2 protocol (the default is to try version 3 first
  92 then version 2).
  93 Note that NFS version 2 has a file size limit of 2 gigabytes.
  94 .It Fl 3
  95 Use the NFS Version 3 protocol.
  96 .It Fl D
  97 Set the
  98 .Dq "dead server threshold"
  99 to the specified number of round trip timeout intervals before a
 100 .Dq "server not responding"
 101 message is displayed.
 102 .It Fl I
 103 Set the readdir read size to the specified value.
 104 The value should normally
 105 be a multiple of
 106 .Dv DIRBLKSIZ
 107 that is <= the read size for the mount.
 108 .It Fl L
 109 Do
 110 .Em not
 111 forward
 112 .Xr fcntl 2
 113 locks over the wire.
 114 All locks will be local and not seen by the server
 115 and likewise not seen by other NFS clients.
 116 This removes the need to run the
 117 .Xr rpcbind 8
 118 service and the
 119 .Xr rpc.statd 8
 120 and
 121 .Xr rpc.lockd 8
 122 servers on the client.
 123 Note that this option will only be honored when performing the
 124 initial mount, it will be silently ignored if used while updating
 125 the mount options.
 126 .It Fl N
 127 Do
 128 .Em not
 129 use a reserved socket port number (see below).
 130 .It Fl P
 131 Use a reserved socket port number.
 132 This flag is obsolete, and only retained for compatibility reasons.
 133 Reserved port numbers are used by default now.
 134 (For the rare case where the client has a trusted root account
 135 but untrustworthy users and the network cables are in secure areas this does
 136 help, but for normal desktop clients this does not apply.)
 137 .It Fl R
 138 Set the mount retry count to the specified value.
 139 The default is a retry count of zero, which means to keep retrying
 140 forever.
 141 There is a 60 second delay between each attempt.
 142 .It Fl T
 143 Use TCP transport instead of UDP.
 144 This is recommended for servers that are not on the same LAN cable as
 145 the client.
 146 (NB: This is NOT supported by most
 147 .No non- Ns Bx
 148 servers.)
 149 .It Fl U
 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 Fl a
 155 Set the read-ahead count to the specified value.
 156 This may be in the range of 0 - 4, and determines how many blocks
 157 will be read ahead when a large file is being read sequentially.
 158 Trying a value greater than 1 for this is suggested for
 159 mounts with a large bandwidth * delay product.
 160 .It Fl b
 161 If an initial attempt to contact the server fails, fork off a child to keep
 162 trying the mount in the background.
 163 Useful for
 164 .Xr fstab 5 ,
 165 where the file system mount is not critical to multiuser operation.
 166 .It Fl c
 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 Fl d
 176 Turn off the dynamic retransmit timeout estimator.
 177 This may be useful for UDP mounts that exhibit high retry rates,
 178 since it is possible that the dynamically estimated timeout interval is too
 179 short.
 180 .It Fl g
 181 Set the maximum size of the group list for the credentials to the
 182 specified value.
 183 This should be used for mounts on old servers that cannot handle a
 184 group list size of 16, as specified in RFC 1057.
 185 Try 8, if users in a lot of groups cannot get response from the mount
 186 point.
 187 .It Fl i
 188 Make the mount interruptible, which implies that file system calls that
 189 are delayed due to an unresponsive server will fail with EINTR when a
 190 termination signal is posted for the process.
 191 .It Fl l
 192 Used with NQNFS and NFSV3 to specify that the \fBReaddirPlus\fR RPC should
 193 be used.
 194 This option reduces RPC traffic for cases such as
 195 .Dq "ls -l" ,
 196 but tends to flood the attribute and name caches with prefetched entries.
 197 Try this option and see whether performance improves or degrades.
 198 Probably
 199 most useful for client to server network interconnects with a large bandwidth
 200 times delay product.
 201 .It Fl o
 202 Options are specified with a
 203 .Fl o
 204 flag followed by a comma separated string of options.
 205 See the
 206 .Xr mount 8
 207 man page for possible options and their meanings.
 208 The following NFS specific options are also available:
 209 .Bl -tag -width indent
 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 acregmin Ns = Ns Aq Ar seconds
 214 .It Cm acregmax Ns = Ns Aq Ar seconds
 215 .It Cm acdirmin Ns = Ns Aq Ar seconds
 216 .It Cm acdirmax Ns = Ns Aq Ar seconds
 217 When attributes of files are cached, a timeout calculated to determine
 218 whether a given cache entry has expired.
 219 These four values determine the upper and lower bounds of the timeouts for
 220 .Dq directory
 221 attributes and
 222 .Dq regular
 223 (ie: everything else).
 224 The default values are 3 -> 60 seconds
 225 for regular files, and 30 -> 60 seconds for directories.
 226 The algorithm to calculate the timeout is based on the age of the file.
 227 The older the file,
 228 the longer the cache is considered valid, subject to the limits above.
 229 .It Cm noinet4 , noinet6
 230 Disables
 231 .Dv AF_INET
 232 or
 233 .Dv AF_INET6
 234 connections.
 235 Useful for hosts that have
 236 both an A record and an AAAA record for the same name.
 237 .El
 238 .Pp
 239 .Sy Historic Fl o Sy Options
 240 .Pp
 241 Use of these options is deprecated, they are only mentioned here for
 242 compatibility with historic versions of
 243 .Nm .
 244 .Bl -tag -width ".Cm dumbtimer"
 245 .It Cm bg
 246 Same as
 247 .Fl b .
 248 .It Cm conn
 249 Same as not specifying
 250 .Fl c .
 251 .It Cm dumbtimer
 252 Same as
 253 .Fl d .
 254 .It Cm intr
 255 Same as
 256 .Fl i .
 257 .It Cm lockd
 258 Same as not specifying
 259 .Fl L .
 260 .It Cm nfsv2
 261 Same as
 262 .Fl 2 .
 263 .It Cm nfsv3
 264 Same as
 265 .Fl 3 .
 266 .It Cm rdirplus
 267 Same as
 268 .Fl l .
 269 .It Cm mntudp
 270 Same as
 271 .Fl U .
 272 .It Cm resvport
 273 Same as
 274 .Fl P .
 275 .It Cm soft
 276 Same as
 277 .Fl s .
 278 .It Cm tcp
 279 Same as
 280 .Fl T .
 281 .El
 282 .It Fl r
 283 Set the read data size to the specified value.
 284 It should normally be a power of 2 greater than or equal to 1024.
 285 This should be used for UDP mounts when the
 286 .Dq "fragments dropped due to timeout"
 287 value is getting large while actively using a mount point.
 288 (Use
 289 .Xr netstat 1
 290 with the
 291 .Fl s
 292 option to see what the
 293 .Dq "fragments dropped due to timeout"
 294 value is.)
 295 See the
 296 .Fl w
 297 option as well.
 298 .It Fl s
 299 A soft mount, which implies that file system calls will fail
 300 after
 301 .Ar retrycnt
 302 round trip timeout intervals.
 303 .It Fl t
 304 Set the initial retransmit timeout to the specified value.
 305 May be useful for fine tuning UDP mounts over internetworks
 306 with high packet loss rates or an overloaded server.
 307 Try increasing the interval if
 308 .Xr nfsstat 1
 309 shows high retransmit rates while the file system is active or reducing the
 310 value if there is a low retransmit rate but long response delay observed.
 311 (Normally, the
 312 .Fl d
 313 option should be specified when using this option to manually
 314 tune the timeout
 315 interval.)
 316 .It Fl w
 317 Set the write data size to the specified value.
 318 Ditto the comments w.r.t.\& the
 319 .Fl r
 320 option, but using the
 321 .Dq "fragments dropped due to timeout"
 322 value on the server instead of the client.
 323 Note that both the
 324 .Fl r
 325 and
 326 .Fl w
 327 options should only be used as a last ditch effort at improving performance
 328 when mounting servers that do not support TCP mounts.
 329 .It Fl x
 330 Set the retransmit timeout count for soft mounts to the specified value.
 331 .El
 332 .Sh SEE ALSO
 333 .Xr mount 2 ,
 334 .Xr unmount 2 ,
 335 .Xr fstab 5 ,
 336 .Xr mount 8 ,
 337 .Xr nfsd 8 ,
 338 .Xr nfsiod 8 ,
 339 .Xr showmount 8
 340 .Sh BUGS
 341 Due to the way that Sun RPC is implemented on top of UDP (unreliable datagram)
 342 transport, tuning such mounts is really a black art that can only be expected
 343 to have limited success.
 344 For clients mounting servers that are not on the same
 345 LAN cable or that tend to be overloaded,
 346 TCP transport is strongly recommended,
 347 but unfortunately this is restricted to mostly
 348 .Bx 4.4
 349 servers.