.\" Copyright (c) 1992, 1993, 1994, 1995 .\" The Regents of the University of California. All rights reserved. .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" 3. Neither the name of the University nor the names of its contributors .\" may be used to endorse or promote products derived from this software .\" without specific prior written permission. .\" .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" .\" @(#)mount_nfs.8 8.3 (Berkeley) 3/29/95 .\" .\" $FreeBSD: src/sbin/mount_nfs/mount_nfs.8,v 1.18.2.10 2003/05/13 14:45:40 trhodes Exp $ .\"" .Dd September 13, 2016 .Dt MOUNT_NFS 8 .Os .Sh NAME .Nm mount_nfs .Nd mount nfs file systems .Sh SYNOPSIS .Nm .Op Fl 23NPTUbcdils .Op Fl D Ar deadthresh .Op Fl I Ar readdirsize .Op Fl R Ar retrycnt .Op Fl a Ar maxreadahead .Op Fl g Ar maxgroups .Op Fl o Ar options .Op Fl r Ar readsize .Op Fl t Ar timeout .Op Fl w Ar writesize .Op Fl x Ar retrans .Ar rhost : Ns Ar path node .Sh DESCRIPTION The .Nm command calls the .Xr mount 2 system call to prepare and graft a remote nfs file system .Pq Ar rhost : Ns Ar path on to the file system tree at the point .Ar node . This command is normally executed by .Xr mount 8 . It implements the mount protocol as described in RFC 1094, Appendix A and .%T "NFS: Network File System Version 3 Protocol Specification" , Appendix I. .Pp By default, .Nm keeps retrying until the mount succeeds. This behaviour is intended for filesystems listed in .Xr fstab 5 that are critical to the boot process. For non-critical filesystems, the .Fl b and .Fl R flags provide mechanisms to prevent the boot process from hanging if the server is unavailable. .Pp If the server becomes unresponsive while an NFS filesystem is mounted, any new or outstanding file operations on that filesystem will hang uninterruptibly until the server comes back. To modify this default behaviour, see the .Fl i and .Fl s flags. .Pp The options are: .Bl -tag -width indent .It Fl 2 Use the NFS Version 2 protocol (the default is to try version 3 first then version 2). Note that NFS version 2 has a file size limit of 2 gigabytes. .It Fl 3 Use the NFS Version 3 protocol. .It Fl D Used to set the .Dq "dead server threshold" to the specified number of round trip timeout intervals. After a .Dq "dead server threshold" of retransmit timeouts, cached data for the unresponsive server is assumed to still be valid. Values may be set in the range of 1 - 9, with 9 referring to an .Dq "infinite dead threshold" (i.e. never assume cached data still valid). This option is not generally recommended and is really an experimental feature. .It Fl I Set the readdir read size to the specified value. The value should normally be a multiple of DIRBLKSIZ that is \(<= the read size for the mount. .It Fl N Do .Em not use a reserved socket port number (see below). .It Fl P Use a reserved socket port number. This flag is obsolete, and only retained for compatibility reasons. Reserved port numbers are used by default now. (For the rare case where the client has a trusted root account but untrustworthy users and the network cables are in secure areas this does help, but for normal desktop clients this does not apply.) .It Fl R Set the mount retry count to the specified value. The default is a retry count of zero, which means to keep retrying forever. There is a 60 second delay between each attempt. .It Fl T Use TCP transport instead of UDP. This is recommended for servers that are not on the same LAN cable as the client. This is the default. .It Fl U Use UDP transport instead of TCP. This is not recommended due to the ease of which .Dx clients can blow out available socket buffer space on the server, not to mention the impossibility of accurately calculating the proper retry interval due to disk I/O backlogs on the server. If you want to use the option anyway it is recommended that the server reserve upwards of 2 MBytes of socket buffer space to hold the received UDP packets. .It Fl a Set the read-ahead count to the specified value. This may be in the range of 0 - 32, and determines how many blocks will be read ahead when a large file is being read sequentially. Trying a value greater than 1 for this is suggested for mounts with a large bandwidth * delay product. .It Fl b If an initial attempt to contact the server fails, fork off a child to keep trying the mount in the background. Useful for .Xr fstab 5 , where the filesystem mount is not critical to multiuser operation. .It Fl c For UDP mount points, do not do a .Xr connect 2 . This must be used if the server does not reply to requests from the standard NFS port number 2049 or replies to requests using a different IP address (which can occur if the server is multi-homed). Setting the .Va vfs.nfs.nfs_ip_paranoia sysctl to 0 will make this option the default. .It Fl d Turn off the dynamic retransmit timeout estimator. This may be useful for UDP mounts that exhibit high retry rates, since it is possible that the dynamically estimated timeout interval is too short. .It Fl g Set the maximum size of the group list for the credentials to the specified value. This should be used for mounts on old servers that cannot handle a group list size of 16, as specified in RFC 1057. Try 8, if users in a lot of groups cannot get response from the mount point. .It Fl i Make the mount interruptible, which implies that file system calls that are delayed due to an unresponsive server will fail with .Er EINTR when a termination signal is posted for the process. .It Fl l Used with NFSV3 to specify that the .Em ReaddirPlus RPC should be used. This option reduces RPC traffic for cases such as .Dq "ls -l" , but tends to flood the attribute and name caches with prefetched entries. Try this option and see whether performance improves or degrades. Probably most useful for client to server network interconnects with a large bandwidth times delay product. This is the default. .It Fl o Options are specified with a .Fl o flag followed by a comma separated string of options. See the .Xr mount 8 man page for possible options and their meanings. The following NFS specific option is also available: .Bl -tag -width indent .It Cm port Ns = Use specified port number for NFS requests. The default is to query the portmapper for the NFS port. .It Cm acregmin Ns = .It Cm acregmax Ns = .It Cm acdirmin Ns = .It Cm acdirmax Ns = When attributes of files are cached, a timeout calculated to determine whether a given cache entry has expired. These four values determine the upper and lower bounds of the timeouts for ``directory'' attributes and ``regular'' (i.e.: everything else). The default values are 3 -> 60 seconds for regular files, and 30 -> 60 seconds for directories. The algorithm to calculate the timeout is based on the age of the file. The older the file, the longer the cache is considered valid, subject to the limits above. .It Cm bg Same as .Fl b . .It Cm cache Set .Cm cache .Xr chflags 2 flag on mount point (recursive, does not cross mounts). NFS does not support .Xr chflags 2 , this is alternate method to set flag. .Cm cache flag is used by .Xr swapcache 8 . .It Cm conn Same as not specifying .Fl c . .It Cm dumbtimer Same as .Fl d . .It Cm intr Same as .Fl i . .It Cm nfsv2 Same as .Fl 2 . .It Cm nfsv3 Same as .Fl 3 . .It Cm rdirplus Same as .Fl l . .It Cm mntudp Same as .Fl U (obsolete). .It Cm resvport Same as .Fl P . .It Cm soft Same as .Fl s . .It Cm tcp Same as .Fl T . .It Cm udp Same as .Fl U . .It Cm retrycnt Same as .Fl R . .El .It Fl r Set the read data size to the specified value. It should normally be a power of 2 greater than or equal to 1024. This should be used for UDP mounts when the .Dq "fragments dropped due to timeout" value is getting large while actively using a mount point. (Use .Xr netstat 1 with the .Fl s option to see what the .Dq "fragments dropped due to timeout" value is.) See the .Fl w option as well. .It Fl s A soft mount, which implies that file system calls will fail after .Em Retry round trip timeout intervals. .It Fl t Set the initial retransmit timeout to the specified value. May be useful for fine tuning UDP mounts over internetworks with high packet loss rates or an overloaded server. Try increasing the interval if .Xr nfsstat 1 shows high retransmit rates while the file system is active or reducing the value if there is a low retransmit rate but long response delay observed. (Normally, the .Fl d option should be specified when using this option to manually tune the timeout interval.) .It Fl w Set the write data size to the specified value. Ditto the comments w.r.t.\& the .Fl r option, but using the .Dq "fragments dropped due to timeout" value on the server instead of the client. Note that both the .Fl r and .Fl w options should only be used as a last ditch effort at improving performance when mounting servers that do not support TCP mounts. .It Fl x Set the retransmit timeout count for soft mounts to the specified value. .El .Sh SEE ALSO .Xr netstat 1 , .Xr nfsstat 1 , .Xr mount 2 , .Xr unmount 2 , .Xr fstab 5 , .Xr mount 8 , .Xr nfsd 8 , .Xr showmount 8 , .Xr swapcache 8 .Sh HISTORY A version of the .Nm utility appeared in .Bx 4.4 . .Sh BUGS Due to the way that Sun RPC is implemented on top of UDP (unreliable datagram) transport, tuning such mounts is really a black art that can only be expected to have limited success. For clients mounting servers that are not on the same LAN cable or that tend to be overloaded, TCP transport is strongly recommended, but unfortunately this is restricted to mostly .Bx 4.4 servers. .Pp NFS does not support .Xr chflags 2 .