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 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)mount_nfs.8 8.3 (Berkeley) 3/29/95
  33 .\"
  34 .\" $FreeBSD: src/sbin/mount_nfs/mount_nfs.8,v 1.18.2.10 2003/05/13 14:45:40 trhodes Exp $
  35 .\" $DragonFly: src/sbin/mount_nfs/mount_nfs.8,v 1.5 2006/03/27 16:18:13 dillon Exp $
  36 .\""
  37 .Dd March 29, 1995
  38 .Dt MOUNT_NFS 8
  39 .Os
  40 .Sh NAME
  41 .Nm mount_nfs
  42 .Nd mount nfs file systems
  43 .Sh SYNOPSIS
  44 .Nm
  45 .Op Fl 23KNPTUbcdils
  46 .Op Fl D Ar deadthresh
  47 .Op Fl I Ar readdirsize
  48 .Op Fl R Ar retrycnt
  49 .Op Fl a Ar maxreadahead
  50 .Op Fl g Ar maxgroups
  51 .Op Fl m Ar realm
  52 .Op Fl o Ar options
  53 .Op Fl r Ar readsize
  54 .Op Fl t Ar timeout
  55 .Op Fl w Ar writesize
  56 .Op Fl x Ar retrans
  57 .Ar rhost : Ns Ar path node
  58 .Sh DESCRIPTION
  59 The
  60 .Nm
  61 command
  62 calls the
  63 .Xr mount 2
  64 system call to prepare and graft a remote nfs file system
  65 .Pq Ar rhost : Ns Ar path
  66 on to the file system tree at the point
  67 .Ar node .
  68 This command is normally executed by
  69 .Xr mount 8 .
  70 It implements the mount protocol as described in RFC 1094, Appendix A and
  71 .%T "NFS: Network File System Version 3 Protocol Specification" ,
  72 Appendix I.
  73 .Pp
  74 By default,
  75 .Nm
  76 keeps retrying until the mount succeeds.
  77 This behaviour is intended for filesystems listed in
  78 .Xr fstab 5
  79 that are critical to the boot process.
  80 For non-critical filesystems, the
  81 .Fl b
  82 and
  83 .Fl R
  84 flags provide mechanisms to prevent the boot process from hanging
  85 if the server is unavailable.
  86 .Pp
  87 If the server becomes unresponsive while an NFS filesystem is
  88 mounted, any new or outstanding file operations on that filesystem
  89 will hang uninterruptibly until the server comes back.
  90 To modify this default behaviour, see the
  91 .Fl i
  92 and
  93 .Fl s
  94 flags.
  95 .Pp
  96 The options are:
  97 .Bl -tag -width indent
  98 .It Fl 2
  99 Use the NFS Version 2 protocol (the default is to try version 3 first
 100 then version 2).  Note that NFS version 2 has a file size limit of 2
 101 gigabytes.
 102 .It Fl 3
 103 Use the NFS Version 3 protocol.
 104 .It Fl D
 105 Used to set the
 106 .Dq "dead server threshold"
 107 to the specified number of round trip timeout intervals.
 108 After a
 109 .Dq "dead server threshold"
 110 of retransmit timeouts,
 111 cached data for the unresponsive server is assumed to still be valid.
 112 Values may be set in the range of 1 - 9, with 9 referring to an
 113 .Dq "infinite dead threshold"
 114 (i.e. never assume cached data still valid).
 115 This option is not generally recommended and is really an experimental
 116 feature.
 117 .It Fl I
 118 Set the readdir read size to the specified value.
 119 The value should normally
 120 be a multiple of DIRBLKSIZ that is \(<= the read size for the mount.
 121 .It Fl K
 122 Pass Kerberos authenticators to the server for client-to-server
 123 user-credential mapping.
 124 This requires that the kernel be built with the NFSKERB option.
 125 The use of this option will prevent the kernel from compiling
 126 unless calls to the appropriate Kerberos encryption routines
 127 are provided in the NFS source.
 128 (Refer to the INTERNET-DRAFT titled
 129 .%T "Authentication Mechanisms for ONC RPC" ,
 130 for more information.)
 131 .It Fl N
 132 Do
 133 .Em not
 134 use a reserved socket port number (see below).
 135 .It Fl P
 136 Use a reserved socket port number.
 137 This flag is obsolete, and only retained for compatibility reasons.
 138 Reserved port numbers are used by default now.
 139 (For the rare case where the client has a trusted root account
 140 but untrustworthy users and the network cables are in secure areas this does
 141 help, but for normal desktop clients this does not apply.)
 142 .It Fl R
 143 Set the mount retry count to the specified value.
 144 The default is a retry count of zero, which means to keep retrying
 145 forever.
 146 There is a 60 second delay between each attempt.
 147 .It Fl T
 148 Use TCP transport instead of UDP.
 149 This is recommended for servers that are not on the same LAN cable as
 150 the client.
 151 (NB: This is NOT supported by most
 152 .No non- Ns Bx
 153 servers.)
 154 .It Fl U
 155 Force the mount protocol to use UDP transport, even for TCP NFS mounts.
 156 (Necessary for some old
 157 .Bx
 158 servers.)
 159 .It Fl a
 160 Set the read-ahead count to the specified value.
 161 This may be in the range of 0 - 4, and determines how many blocks
 162 will be read ahead when a large file is being read sequentially.
 163 Trying a value greater than 1 for this is suggested for
 164 mounts with a large bandwidth * delay product.
 165 .It Fl b
 166 If an initial attempt to contact the server fails, fork off a child to keep
 167 trying the mount in the background.
 168 Useful for
 169 .Xr fstab 5 ,
 170 where the filesystem mount is not critical to multiuser operation.
 171 .It Fl c
 172 For UDP mount points, do not do a
 173 .Xr connect 2 .
 174 This must be used if the server does not reply to requests from the standard
 175 NFS port number 2049 or replies to requests using a different IP address
 176 (which can occur if the server is multi-homed).
 177 Setting the
 178 .Va vfs.nfs.nfs_ip_paranoia
 179 sysctl to 0 will make this option the default.
 180 .It Fl d
 181 Turn off the dynamic retransmit timeout estimator.
 182 This may be useful for UDP mounts that exhibit high retry rates,
 183 since it is possible that the dynamically estimated timeout interval is too
 184 short.
 185 .It Fl g
 186 Set the maximum size of the group list for the credentials to the
 187 specified value.
 188 This should be used for mounts on old servers that cannot handle a
 189 group list size of 16, as specified in RFC 1057.
 190 Try 8, if users in a lot of groups cannot get response from the mount
 191 point.
 192 .It Fl i
 193 Make the mount interruptible, which implies that file system calls that
 194 are delayed due to an unresponsive server will fail with
 195 .Er EINTR
 196 when a
 197 termination signal is posted for the process.
 198 .It Fl l
 199 Used with NFSV3 to specify that the \fBReaddirPlus\fR RPC should
 200 be used.
 201 This option reduces RPC traffic for cases such as
 202 .Dq "ls -l" ,
 203 but tends to flood the attribute and name caches with prefetched entries.
 204 Try this option and see whether performance improves or degrades.
 205 Probably
 206 most useful for client to server network interconnects with a large bandwidth
 207 times delay product.
 208 .It Fl m
 209 Set the Kerberos realm to the string argument.
 210 Used with the
 211 .Fl K
 212 option for mounts to other realms.
 213 .It Fl o
 214 Options are specified with a
 215 .Fl o
 216 flag followed by a comma separated string of options.
 217 See the
 218 .Xr mount 8
 219 man page for possible options and their meanings.
 220 The following NFS specific option is also available:
 221 .Bl -tag -width indent
 222 .It port=<port_number>
 223 Use specified port number for NFS requests.
 224 The default is to query the portmapper for the NFS port.
 225 .It acregmin=<seconds>
 226 .It acregmax=<seconds>
 227 .It acdirmin=<seconds>
 228 .It acdirmax=<seconds>
 229 When attributes of files are cached, a timeout calculated to determine
 230 whether a given cache entry has expired.  These four values determine the
 231 upper and lower bounds of the timeouts for ``directory'' attributes and
 232 ``regular'' (ie: everything else).  The default values are 3 -> 60 seconds
 233 for regular files, and 30 -> 60 seconds for directories.  The algorithm to
 234 calculate the timeout is based on the age of the file.  The older the file,
 235 the longer the cache is considered valid, subject to the limits above.
 236 .El
 237 .Pp
 238 .Bl -tag -width "dumbtimerXX"
 239 \fBHistoric \&-o options\fR
 240 .Pp
 241 Use of these options is deprecated, they are only mentioned here for
 242 compatibility with historic versions of
 243 .Nm .
 244 .It bg
 245 Same as
 246 .Fl b .
 247 .It conn
 248 Same as not specifying
 249 .Fl c .
 250 .It dumbtimer
 251 Same as
 252 .Fl d .
 253 .It intr
 254 Same as
 255 .Fl i .
 256 .It kerb
 257 Same as
 258 .Fl K .
 259 .It nfsv2
 260 Same as
 261 .Fl 2 .
 262 .It nfsv3
 263 Same as
 264 .Fl 3 .
 265 .It rdirplus
 266 Same as
 267 .Fl l .
 268 .It mntudp
 269 Same as
 270 .Fl U .
 271 .It resvport
 272 Same as
 273 .Fl P .
 274 .It soft
 275 Same as
 276 .Fl s .
 277 .It tcp
 278 Same as
 279 .Fl T .
 280 .El
 281 .It Fl r
 282 Set the read data size to the specified value.
 283 It should normally be a power of 2 greater than or equal to 1024.
 284 This should be used for UDP mounts when the
 285 .Dq "fragments dropped due to timeout"
 286 value is getting large while actively using a mount point.
 287 (Use
 288 .Xr netstat 1
 289 with the
 290 .Fl s
 291 option to see what the
 292 .Dq "fragments dropped due to timeout"
 293 value is.)
 294 See the
 295 .Fl w
 296 option as well.
 297 .It Fl s
 298 A soft mount, which implies that file system calls will fail
 299 after \fBRetry\fR round trip timeout intervals.
 300 .It Fl t
 301 Set the initial retransmit timeout to the specified value.
 302 May be useful for fine tuning UDP mounts over internetworks
 303 with high packet loss rates or an overloaded server.
 304 Try increasing the interval if
 305 .Xr nfsstat 1
 306 shows high retransmit rates while the file system is active or reducing the
 307 value if there is a low retransmit rate but long response delay observed.
 308 (Normally, the -d option should be specified when using this option to manually
 309 tune the timeout
 310 interval.)
 311 .It Fl w
 312 Set the write data size to the specified value.
 313 Ditto the comments w.r.t. the
 314 .Fl r
 315 option, but using the
 316 .Dq "fragments dropped due to timeout"
 317 value on the server instead of the client.
 318 Note that both the
 319 .Fl r
 320 and
 321 .Fl w
 322 options should only be used as a last ditch effort at improving performance
 323 when mounting servers that do not support TCP mounts.
 324 .It Fl x
 325 Set the retransmit timeout count for soft mounts to the specified value.
 326 .El
 327 .Sh SEE ALSO
 328 .Xr mount 2 ,
 329 .Xr unmount 2 ,
 330 .Xr fstab 5 ,
 331 .Xr mount 8 ,
 332 .Xr nfsd 8 ,
 333 .Xr nfsiod 8 ,
 334 .Xr showmount 8
 335 .Sh BUGS
 336 Due to the way that Sun RPC is implemented on top of UDP (unreliable datagram)
 337 transport, tuning such mounts is really a black art that can only be expected
 338 to have limited success.
 339 For clients mounting servers that are not on the same
 340 LAN cable or that tend to be overloaded,
 341 TCP transport is strongly recommended,
 342 but unfortunately this is restricted to mostly
 343 .Bx 4.4
 344 servers.