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 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 Not all NFS servers support this method, especially older ones,
 147 caution should be observed in these cases.
 148 .It Fl U
 149 Force the mount protocol to use UDP transport, even for TCP NFS mounts.
 150 (Necessary for some old
 151 .Bx
 152 servers.)
 153 .It Fl a
 154 Set the read-ahead count to the specified value.
 155 This may be in the range of 0 - 4, and determines how many blocks
 156 will be read ahead when a large file is being read sequentially.
 157 Trying a value greater than 1 for this is suggested for
 158 mounts with a large bandwidth * delay product.
 159 .It Fl b
 160 If an initial attempt to contact the server fails, fork off a child to keep
 161 trying the mount in the background.
 162 Useful for
 163 .Xr fstab 5 ,
 164 where the file system mount is not critical to multiuser operation.
 165 .It Fl c
 166 For UDP mount points, do not do a
 167 .Xr connect 2 .
 168 This must be used if the server does not reply to requests from the standard
 169 NFS port number 2049 or replies to requests using a different IP address
 170 (which can occur if the server is multi-homed).
 171 Setting the
 172 .Va vfs.nfs.nfs_ip_paranoia
 173 sysctl to 0 will make this option the default.
 174 .It Fl d
 175 Turn off the dynamic retransmit timeout estimator.
 176 This may be useful for UDP mounts that exhibit high retry rates,
 177 since it is possible that the dynamically estimated timeout interval is too
 178 short.
 179 .It Fl g
 180 Set the maximum size of the group list for the credentials to the
 181 specified value.
 182 This should be used for mounts on old servers that cannot handle a
 183 group list size of 16, as specified in RFC 1057.
 184 Try 8, if users in a lot of groups cannot get response from the mount
 185 point.
 186 .It Fl i
 187 Make the mount interruptible, which implies that file system calls that
 188 are delayed due to an unresponsive server will fail with EINTR when a
 189 termination signal is posted for the process.
 190 .It Fl l
 191 Used with NQNFS and NFSV3 to specify that the \fBReaddirPlus\fR RPC should
 192 be used.
 193 This option reduces RPC traffic for cases such as
 194 .Dq "ls -l" ,
 195 but tends to flood the attribute and name caches with prefetched entries.
 196 Try this option and see whether performance improves or degrades.
 197 Probably
 198 most useful for client to server network interconnects with a large bandwidth
 199 times delay product.
 200 .It Fl o
 201 Options are specified with a
 202 .Fl o
 203 flag followed by a comma separated string of options.
 204 See the
 205 .Xr mount 8
 206 man page for possible options and their meanings.
 207 The following NFS specific options are also available:
 208 .Bl -tag -width indent
 209 .It Cm port Ns = Ns Aq Ar port_number
 210 Use specified port number for NFS requests.
 211 The default is to query the portmapper for the NFS port.
 212 .It Cm acregmin Ns = Ns Aq Ar seconds
 213 .It Cm acregmax Ns = Ns Aq Ar seconds
 214 .It Cm acdirmin Ns = Ns Aq Ar seconds
 215 .It Cm acdirmax Ns = Ns Aq Ar seconds
 216 When attributes of files are cached, a timeout calculated to determine
 217 whether a given cache entry has expired.
 218 These four values determine the upper and lower bounds of the timeouts for
 219 .Dq directory
 220 attributes and
 221 .Dq regular
 222 (ie: everything else).
 223 The default values are 3 -> 60 seconds
 224 for regular files, and 30 -> 60 seconds for directories.
 225 The algorithm to calculate the timeout is based on the age of the file.
 226 The older the file,
 227 the longer the cache is considered valid, subject to the limits above.
 228 .It Cm noinet4 , noinet6
 229 Disables
 230 .Dv AF_INET
 231 or
 232 .Dv AF_INET6
 233 connections.
 234 Useful for hosts that have
 235 both an A record and an AAAA record for the same name.
 236 .El
 237 .Pp
 238 .Sy Historic Fl o Sy Options
 239 .Pp
 240 Use of these options is deprecated, they are only mentioned here for
 241 compatibility with historic versions of
 242 .Nm .
 243 .Bl -tag -width ".Cm dumbtimer"
 244 .It Cm bg
 245 Same as
 246 .Fl b .
 247 .It Cm conn
 248 Same as not specifying
 249 .Fl c .
 250 .It Cm dumbtimer
 251 Same as
 252 .Fl d .
 253 .It Cm intr
 254 Same as
 255 .Fl i .
 256 .It Cm lockd
 257 Same as not specifying
 258 .Fl L .
 259 .It Cm nfsv2
 260 Same as
 261 .Fl 2 .
 262 .It Cm nfsv3
 263 Same as
 264 .Fl 3 .
 265 .It Cm rdirplus
 266 Same as
 267 .Fl l .
 268 .It Cm mntudp
 269 Same as
 270 .Fl U .
 271 .It Cm resvport
 272 Same as
 273 .Fl P .
 274 .It Cm soft
 275 Same as
 276 .Fl s .
 277 .It Cm 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
 300 .Ar retrycnt
 301 round trip timeout intervals.
 302 .It Fl t
 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 .Fl d
 312 option should be specified when using this option to manually
 313 tune the timeout
 314 interval.)
 315 .It Fl w
 316 Set the write data size to the specified value.
 317 Ditto the comments w.r.t.\& the
 318 .Fl r
 319 option, but using the
 320 .Dq "fragments dropped due to timeout"
 321 value on the server instead of the client.
 322 Note that both the
 323 .Fl r
 324 and
 325 .Fl w
 326 options should only be used as a last ditch effort at improving performance
 327 when mounting servers that do not support TCP mounts.
 328 .It Fl x
 329 Set the retransmit timeout count for soft mounts to the specified value.
 330 .El
 331 .Sh SEE ALSO
 332 .Xr mount 2 ,
 333 .Xr unmount 2 ,
 334 .Xr fstab 5 ,
 335 .Xr mount 8 ,
 336 .Xr nfsd 8 ,
 337 .Xr nfsiod 8 ,
 338 .Xr showmount 8