usr.sbin/mountd/mountd.8

   1 .\" Copyright (c) 1989, 1991, 1993
   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. 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 .\"     @(#)mountd.8    8.4 (Berkeley) 4/28/95
  29 .\" $FreeBSD$
  30 .\"
  31 .Dd October 11, 2020
  32 .Dt MOUNTD 8
  33 .Os
  34 .Sh NAME
  35 .Nm mountd
  36 .Nd service remote
  37 .Tn NFS
  38 mount requests
  39 .Sh SYNOPSIS
  40 .Nm
  41 .Op Fl 2delnRrS
  42 .Op Fl h Ar bindip
  43 .Op Fl p Ar port
  44 .Op Ar exportsfile ...
  45 .Sh DESCRIPTION
  46 The
  47 .Nm
  48 utility is the server for
  49 .Tn NFS
  50 mount requests from other client machines.
  51 It listens for service requests at the port indicated in the
  52 .Tn NFS
  53 server specification; see
  54 .%T "Network File System Protocol Specification" ,
  55 RFC1094, Appendix A and
  56 .%T "NFS: Network File System Version 3 Protocol Specification" ,
  57 RFC1813, Appendix I.
  58 .Pp
  59 The following options are available:
  60 .Bl -tag -width indent
  61 .It Fl 2
  62 Allow the administrator to force clients to use only the
  63 version 2
  64 .Tn NFS
  65 protocol to mount file systems from this server.
  66 .It Fl d
  67 Output debugging information.
  68 .Nm
  69 will not detach from the controlling terminal and will print
  70 debugging messages to stderr.
  71 .It Fl e
  72 Ignored; included for backward compatibility.
  73 .It Fl h Ar bindip
  74 Specify specific IP addresses to bind to for TCP and UDP requests.
  75 This option may be specified multiple times.
  76 If no
  77 .Fl h
  78 option is specified,
  79 .Nm
  80 will bind to
  81 .Dv INADDR_ANY .
  82 Note that when specifying IP addresses with
  83 .Fl h ,
  84 .Nm
  85 will automatically add
  86 .Li 127.0.0.1
  87 and if IPv6 is enabled,
  88 .Li ::1
  89 to the list.
  90 .It Fl l
  91 Cause all succeeded
  92 .Nm
  93 requests to be logged.
  94 .It Fl n
  95 Allow non-root mount requests to be served.
  96 This should only be specified if there are clients such as PC's,
  97 that require it.
  98 It will automatically clear the vfs.nfsd.nfs_privport sysctl flag, which
  99 controls if the kernel will accept NFS requests from reserved ports only.
 100 .It Fl p Ar port
 101 Force
 102 .Nm
 103 to bind to the specified port, for both
 104 .Dv AF_INET
 105 and
 106 .Dv AF_INET6
 107 address families.
 108 This is typically done to ensure that the port which
 109 .Nm
 110 binds to is a known quantity which can be used in firewall rulesets.
 111 If
 112 .Nm
 113 cannot bind to this port, an appropriate error will be recorded in
 114 the system log, and the daemon will then exit.
 115 .It Fl R
 116 Do not support the Mount protocol and do not register with
 117 .Xr rpcbind 8 .
 118 This can be done for NFSv4 only servers, since the Mount protocol is not
 119 used by NFSv4.
 120 Useful for NFSv4 only servers that do not wish to run
 121 .Xr rpcbind 8 .
 122 .Xr showmount 8
 123 will not work, however since NFSv4 mounts are not shown by
 124 .Xr showmount 8 ,
 125 this should not be an issue for an NFSv4 only server.
 126 .It Fl r
 127 Allow mount RPCs requests for regular files to be served.
 128 Although this seems to violate the mount protocol specification,
 129 some diskless workstations do mount requests for
 130 their swapfiles and expect them to be regular files.
 131 Since a regular file cannot be specified in
 132 .Pa /etc/exports ,
 133 the entire file system in which the swapfiles resides
 134 will have to be exported with the
 135 .Fl alldirs
 136 flag.
 137 .It Ar exportsfile
 138 Specify an alternate location
 139 for the exports file.
 140 More than one exports file can be specified.
 141 .It Fl S
 142 Tell mountd to suspend/resume execution of the nfsd threads whenever
 143 the exports list is being reloaded.
 144 This avoids intermittent access
 145 errors for clients that do NFS RPCs while the exports are being
 146 reloaded, but introduces a delay in RPC response while the reload
 147 is in progress.
 148 If
 149 .Nm
 150 crashes while an exports load is in progress,
 151 .Nm
 152 must be restarted to get the nfsd threads running again, if this
 153 option is used.
 154 .El
 155 .Pp
 156 When
 157 .Nm
 158 is started,
 159 it loads the export host addresses and options into the kernel
 160 using the
 161 .Xr mount 2
 162 system call.
 163 After changing the exports file,
 164 a hangup signal should be sent to the
 165 .Nm
 166 daemon
 167 to get it to reload the export information.
 168 After sending the SIGHUP
 169 (kill \-s HUP `cat /var/run/mountd.pid`),
 170 check the syslog output to see if
 171 .Nm
 172 logged any parsing
 173 errors in the exports file.
 174 .Pp
 175 If
 176 .Nm
 177 detects that the running kernel does not include
 178 .Tn NFS
 179 support, it will attempt to load a loadable kernel module containing
 180 .Tn NFS
 181 code, using
 182 .Xr kldload 2 .
 183 If this fails, or no
 184 .Tn NFS
 185 KLD was available,
 186 .Nm
 187 exits with an error.
 188 .Sh FILES
 189 .Bl -tag -width /var/run/mountd.pid -compact
 190 .It Pa /etc/exports
 191 the list of exported file systems
 192 .It Pa /var/run/mountd.pid
 193 the pid of the currently running mountd
 194 .It Pa /var/db/mountdtab
 195 the current list of remote mounted file systems
 196 .El
 197 .Sh SEE ALSO
 198 .Xr nfsstat 1 ,
 199 .Xr kldload 2 ,
 200 .Xr nfsv4 4 ,
 201 .Xr exports 5 ,
 202 .Xr nfsd 8 ,
 203 .Xr rpcbind 8 ,
 204 .Xr showmount 8
 205 .Sh HISTORY
 206 The
 207 .Nm
 208 utility first appeared in
 209 .Bx 4.4 .