1 .\" Copyright (c) 1992, 1993, 1994, 1995
2 .\" The Regents of the University of California. All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
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. 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.
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
28 .\" @(#)mount_nfs.8 8.3 (Berkeley) 3/29/95
36 .Nd mount NFS file systems
40 .Op Fl a Ar maxreadahead
41 .Op Fl D Ar deadthresh
43 .Op Fl I Ar readdirsize
50 .Ar rhost : Ns Ar path node
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
60 This command is normally executed by
63 it implements the mount protocol as described in RFC 1094, Appendix A and
65 For NFSv4, it uses the NFSv4 protocol as described in RFC 7530, RFC 5661 and
70 keeps retrying until the mount succeeds.
71 This behaviour is intended for file systems listed in
73 that are critical to the boot process.
74 For non-critical file systems, the
78 options provide mechanisms to prevent the boot process from hanging
79 if the server is unavailable.
81 If the server becomes unresponsive while an NFS file system is
82 mounted, any new or outstanding file operations on that file system
83 will hang uninterruptibly until the server comes back.
84 To modify this default behaviour, see the
91 .Bl -tag -width indent
93 Options are specified with a
95 flag followed by a comma separated string of options.
98 man page for possible options and their meanings.
99 The following NFS specific options are also available:
100 .Bl -tag -width indent
101 .It Cm acregmin Ns = Ns Aq Ar seconds
102 .It Cm acregmax Ns = Ns Aq Ar seconds
103 .It Cm acdirmin Ns = Ns Aq Ar seconds
104 .It Cm acdirmax Ns = Ns Aq Ar seconds
105 When attributes of files are cached, a timeout calculated to determine
106 whether a given cache entry has expired.
107 These four values determine the upper and lower bounds of the timeouts for
111 (ie: everything else).
112 The default values are 3 -> 60 seconds
113 for regular files, and 30 -> 60 seconds for directories.
114 The algorithm to calculate the timeout is based on the age of the file.
116 the longer the cache is considered valid, subject to the limits above.
117 .It Cm actimeo Ns = Ns Aq Ar seconds
118 Set four cache timeouts above to specified value.
120 This option can be used along with
122 to specify that all operations should use the host-based initiator
124 This may be used for clients that run system daemons that need to
125 access files on the NFSv4 mounted volume.
127 If an initial attempt to contact the server fails, fork off a child to keep
128 trying the mount in the background.
131 where the file system mount is not critical to multiuser operation.
132 .It Cm deadthresh Ns = Ns Aq Ar value
134 .Dq "dead server threshold"
135 to the specified number of round trip timeout intervals before a
136 .Dq "server not responding"
137 message is displayed.
139 Turn off the dynamic retransmit timeout estimator.
140 This may be useful for UDP mounts that exhibit high retry rates,
141 since it is possible that the dynamically estimated timeout interval is too
144 Same as not specifying
146 .It Cm gssname Ns = Ns Aq Ar service-principal-name
147 This option can be used with the KerberosV security flavors for NFSv4 mounts
149 .Dq "service-principal-name"
150 of a host-based entry in the default
151 keytab file that is used for system operations.
152 It allows the mount to be performed by
154 and avoids problems with
155 cached credentials for the system operations expiring.
157 .Dq "service-prinicpal-name"
158 should be specified without instance or domain and is typically
169 can also be used if the local system's
171 value does not match the host-based principal in the keytab.
173 Same as not specifying
176 Make the mount interruptible, which implies that file system calls that
177 are delayed due to an unresponsive server will fail with EINTR when a
178 termination signal is posted for the process.
179 .It Cm maxgroups Ns = Ns Aq Ar value
180 Set the maximum size of the group list for the credentials to the
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
187 Force the mount protocol to use UDP transport, even for TCP NFS mounts.
188 (Necessary for some old
191 .It Cm nametimeo Ns = Ns Aq Ar value
192 Override the default of NFS_DEFAULT_NAMETIMEO for the timeout (in seconds)
193 for positive name cache entries.
194 If this is set to 0 it disables positive name caching for the mount point.
195 .It Cm negnametimeo Ns = Ns Aq Ar value
196 Override the default of NFS_DEFAULT_NEGNAMETIMEO for the timeout (in seconds)
197 for negative name cache entries.
198 If this is set to 0 it disables negative name caching for the mount point.
200 Use the NFS Version 2 protocol (the default is to try version 3 first
202 Note that NFS version 2 has a file size limit of 2 gigabytes.
204 Use the NFS Version 3 protocol.
206 Use the NFS Version 4 protocol.
207 This option will force the mount to use
209 .It Cm minorversion Ns = Ns Aq Ar value
210 Override the default of 0 for the minor version of the NFS Version 4 protocol.
211 The minor versions other than 0 currently supported are 1 and 2.
212 This option is only meaningful when used with the
216 Make a minor version 1 or 2 of the NFS Version 4 protocol mount use a single
217 OpenOwner for all Opens.
218 This may be useful for a server with a very low limit on OpenOwners, such as
220 This option cannot be used for an NFS Version 4, minor version 0 mount.
221 As such, this option requires the
223 option be specified with a value of 1 for AmazonEFS, because AmazonEFS does
224 not support minor version 2 at this time.
225 It may not work correctly when Delegations are being issued by a server,
226 but note that the AmazonEFS server does not issued delegations at this time.
227 This option is only meaningful when used with the
233 Enable support for parallel NFS (pNFS) for minor version 1 or 2 of the
234 NFS Version 4 protocol.
235 This option is only meaningful when used with the
239 Disable attribute caching.
241 For UDP mount points, do not do a
243 This must be used if the server does not reply to requests from the standard
244 NFS port number 2049 or replies to requests using a different IP address
245 (which can occur if the server is multi-homed).
247 .Va vfs.nfs.nfs_ip_paranoia
248 sysctl to 0 will make this option the default.
250 Normally, NFS clients maintain the close-to-open cache coherency.
251 This works by flushing at close time and checking at open time.
252 Checking at open time is implemented by getting attributes from
253 the server and purging the data cache if they do not match
254 attributes cached by the client.
256 This option disables checking at open time.
257 It may improve performance for read-only mounts,
258 but should only be used if the data on the server changes rarely.
259 Be sure to understand the consequences before enabling this option.
260 .It Cm noinet4 , noinet6
266 Useful for hosts that have
267 both an A record and an AAAA record for the same name.
273 locks over the wire via the NLM protocol for NFSv3 mounts.
274 All locks will be local and not seen by the server
275 and likewise not seen by other NFS clients for NFSv3 mounts.
276 This removes the need to run the
282 servers on the client.
283 Note that this option will only be honored when performing the
284 initial mount, it will be silently ignored if used while updating
286 Also, note that NFSv4 mounts do not use these daemons and handle locks over the
287 wire in the NFSv4 protocol.
288 As such, this option is meaningless for NFSv4 mounts.
290 This mount option allows the NFS client to
291 combine non-contiguous byte ranges being written
292 such that the dirty byte range becomes a superset of the bytes
294 This reduces the number of writes significantly for software
296 The merging of byte ranges is not done if the file has been file
297 locked, since most applications modifying a file from multiple
298 clients will use file locking.
299 As such, this option could result in a corrupted file for the
300 rare case of an application modifying the file from multiple
301 clients concurrently without using file locking.
303 For the RPCSEC_GSS security flavors, such as krb5, krb5i and krb5p,
304 this option sets the name of the host based principal name expected
306 This option overrides the default, which will be ``nfs@<server-fqdn>''
307 and should normally be sufficient.
311 use a reserved socket port number (see below).
312 .It Cm port Ns = Ns Aq Ar port_number
313 Use specified port number for NFS requests.
314 The default is to query the portmapper for the NFS port.
315 .It Cm proto Ns = Ns Aq Ar protocol
316 Specify transport protocol version to use.
319 udp - Use UDP over IPv4
320 tcp - Use TCP over IPv4
321 udp6 - Use UDP over IPv6
322 tcp6 - Use TCP over IPv6
325 Used with NFSV3 to specify that the \fBReaddirPlus\fR RPC should
327 For NFSV4, setting this option has a similar effect, in that it will make
328 the Readdir Operation get more attributes.
329 This option reduces RPC traffic for cases such as
331 but tends to flood the attribute and name caches with prefetched entries.
332 Try this option and see whether performance improves or degrades.
334 most useful for client to server network interconnects with a large bandwidth
336 .It Cm readahead Ns = Ns Aq Ar value
337 Set the read-ahead count to the specified value.
338 This may be in the range of 0 - 4, and determines how many blocks
339 will be read ahead when a large file is being read sequentially.
340 Trying a value greater than 1 for this is suggested for
341 mounts with a large bandwidth * delay product.
342 .It Cm readdirsize Ns = Ns Aq Ar value
343 Set the readdir read size to the specified value.
344 The value should normally
347 that is <= the read size for the mount.
349 Use a reserved socket port number.
350 This flag is obsolete, and only retained for compatibility reasons.
351 Reserved port numbers are used by default now.
352 (For the rare case where the client has a trusted root account
353 but untrustworthy users and the network cables are in secure areas this does
354 help, but for normal desktop clients this does not apply.)
355 .It Cm retrans Ns = Ns Aq Ar value
356 Set the retransmit timeout count for soft mounts to the specified value.
357 .It Cm retrycnt Ns = Ns Aq Ar count
358 Set the mount retry count to the specified value.
359 The default is a retry count of zero, which means to keep retrying
361 There is a 60 second delay between each attempt.
362 .It Cm rsize Ns = Ns Aq Ar value
363 Set the read data size to the specified value.
364 It should normally be a power of 2 greater than or equal to 1024.
365 This should be used for UDP mounts when the
366 .Dq "fragments dropped due to timeout"
367 value is getting large while actively using a mount point.
372 option to see what the
373 .Dq "fragments dropped due to timeout"
375 .It Cm sec Ns = Ns Aq Ar flavor
376 This option specifies what security flavor should be used for the mount.
379 krb5 - Use KerberosV authentication
380 krb5i - Use KerberosV authentication and
381 apply integrity checksums to RPCs
382 krb5p - Use KerberosV authentication and
384 sys - The default AUTH_SYS, which uses a
385 uid + gid list authenticator
388 A soft mount, which implies that file system calls will fail
391 round trip timeout intervals.
394 This is the default option, as it provides for increased reliability on both
395 LAN and WAN configurations compared to UDP.
396 Some old NFS servers do not support this method; UDP mounts may be required
397 for interoperability.
398 .It Cm timeout Ns = Ns Aq Ar value
399 Set the initial retransmit timeout to the specified value,
400 expressed in tenths of a second.
401 May be useful for fine tuning UDP mounts over internetworks
402 with high packet loss rates or an overloaded server.
403 Try increasing the interval if
405 shows high retransmit rates while the file system is active or reducing the
406 value if there is a low retransmit rate but long response delay observed.
409 option should be specified when using this option to manually
412 .It Cm timeo Ns = Ns Aq Ar value
416 This option specifies that the connection to the server must use TLS
418 TLS is only supported for TCP connections and the
420 daemon must be running for an NFS over TCP connection to use TLS.
423 .It Cm vers Ns = Ns Aq Ar vers_number
424 Use the specified version number for NFS requests.
431 .It Cm wcommitsize Ns = Ns Aq Ar value
432 Set the maximum pending write commit size to the specified value.
433 This determines the maximum amount of pending write data that the NFS
434 client is willing to cache for each file.
435 .It Cm wsize Ns = Ns Aq Ar value
436 Set the write data size to the specified value.
437 Ditto the comments w.r.t.\& the
439 option, but using the
440 .Dq "fragments dropped due to timeout"
441 value on the server instead of the client.
446 options should only be used as a last ditch effort at improving performance
447 when mounting servers that do not support TCP mounts.
451 The following command line flags are equivalent to
453 named options and are supported for compatibility with older
455 .Bl -tag -width indent
467 .Fl o Cm readdirsize Ns = Ns Aq Ar value
475 Use a reserved socket port number.
476 This flag is obsolete, and only retained for compatibility reasons.
477 (For the rare case where the client has a trusted root account
478 but untrustworthy users and the network cables are in secure areas this does
479 help, but for normal desktop clients this does not apply.)
482 .Fl o Cm retrycnt Ns = Ns Aq Ar value
491 .Fl o Cm readahead Ns = Ns Aq Ar value
512 .Fl o Cm rsize Ns = Ns Aq Ar value
518 .Fl o Cm retransmit Ns = Ns Aq Ar value
521 .Fl o Cm wsize Ns = Ns Aq Ar value
524 .Fl o Cm retrans Ns = Ns Aq Ar value
529 named options are equivalent to other
531 named options and are supported for compatibility with other
532 operating systems (e.g., Linux, Solaris, and OSX) to ease usage of
535 .Bl -tag -width indent
536 .It Fl o Cm vers Ns = Ns 2
539 .It Fl o Cm vers Ns = Ns 3
542 .It Fl o Cm vers Ns = Ns 4
563 Since nfsv4 performs open/lock operations that have their ordering strictly
564 enforced by the server, the options
568 cannot be safely used.
570 nfsv4 mounts are strongly recommended.