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