usr.sbin/nfsd/nfsd.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 .\" 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 .\"     @(#)nfsd.8      8.4 (Berkeley) 3/29/95
  29 .\" $FreeBSD$
  30 .\"
  31 .Dd April 25, 2015
  32 .Dt NFSD 8
  33 .Os
  34 .Sh NAME
  35 .Nm nfsd
  36 .Nd remote
  37 .Tn NFS
  38 server
  39 .Sh SYNOPSIS
  40 .Nm
  41 .Op Fl ardute
  42 .Op Fl n Ar num_servers
  43 .Op Fl h Ar bindip
  44 .Op Fl Fl maxthreads Ar max_threads
  45 .Op Fl Fl minthreads Ar min_threads
  46 .Sh DESCRIPTION
  47 The
  48 .Nm
  49 utility runs on a server machine to service
  50 .Tn NFS
  51 requests from client machines.
  52 At least one
  53 .Nm
  54 must be running for a machine to operate as a server.
  55 .Pp
  56 Unless otherwise specified, eight servers per CPU for
  57 .Tn UDP
  58 transport are started.
  59 .Pp
  60 The following options are available:
  61 .Bl -tag -width Ds
  62 .It Fl r
  63 Register the
  64 .Tn NFS
  65 service with
  66 .Xr rpcbind 8
  67 without creating any servers.
  68 This option can be used along with the
  69 .Fl u
  70 or
  71 .Fl t
  72 options to re-register NFS if the rpcbind server is restarted.
  73 .It Fl d
  74 Unregister the
  75 .Tn NFS
  76 service with
  77 .Xr rpcbind 8
  78 without creating any servers.
  79 .It Fl n Ar threads
  80 Specifies how many servers to create.  This option is equivalent to specifying
  81 .Fl Fl maxthreads
  82 and
  83 .Fl Fl minthreads
  84 with their respective arguments to
  85 .Ar threads .
  86 .It Fl Fl maxthreads Ar threads
  87 Specifies the maximum servers that will be kept around to service requests.
  88 .It Fl Fl minthreads Ar threads
  89 Specifies the minimum servers that will be kept around to service requests.
  90 .It Fl h Ar bindip
  91 Specifies which IP address or hostname to bind to on the local host.
  92 This option is recommended when a host has multiple interfaces.
  93 Multiple
  94 .Fl h
  95 options may be specified.
  96 .It Fl a
  97 Specifies that nfsd should bind to the wildcard IP address.
  98 This is the default if no
  99 .Fl h
 100 options are given.
 101 It may also be specified in addition to any
 102 .Fl h
 103 options given.
 104 Note that NFS/UDP does not operate properly when
 105 bound to the wildcard IP address whether you use -a or do not use -h.
 106 .It Fl t
 107 Serve
 108 .Tn TCP NFS
 109 clients.
 110 .It Fl u
 111 Serve
 112 .Tn UDP NFS
 113 clients.
 114 .It Fl e
 115 Ignored; included for backward compatibility.
 116 .El
 117 .Pp
 118 For example,
 119 .Dq Li "nfsd -u -t -n 6"
 120 serves
 121 .Tn UDP
 122 and
 123 .Tn TCP
 124 transports using six daemons.
 125 .Pp
 126 A server should run enough daemons to handle
 127 the maximum level of concurrency from its clients,
 128 typically four to six.
 129 .Pp
 130 The
 131 .Nm
 132 utility listens for service requests at the port indicated in the
 133 .Tn NFS
 134 server specification; see
 135 .%T "Network File System Protocol Specification" ,
 136 RFC1094,
 137 .%T "NFS: Network File System Version 3 Protocol Specification" ,
 138 RFC1813 and
 139 .%T "Network File System (NFS) Version 4 Protocol" ,
 140 RFC3530.
 141 .Pp
 142 If
 143 .Nm
 144 detects that
 145 .Tn NFS
 146 is not loaded in the running kernel, it will attempt
 147 to load a loadable kernel module containing
 148 .Tn NFS
 149 support using
 150 .Xr kldload 2 .
 151 If this fails, or no
 152 .Tn NFS
 153 KLD is available,
 154 .Nm
 155 will exit with an error.
 156 .Pp
 157 If
 158 .Nm
 159 is to be run on a host with multiple interfaces or interface aliases, use
 160 of the
 161 .Fl h
 162 option is recommended.
 163 If you do not use the option NFS may not respond to
 164 UDP packets from the same IP address they were sent to.
 165 Use of this option
 166 is also recommended when securing NFS exports on a firewalling machine such
 167 that the NFS sockets can only be accessed by the inside interface.
 168 The
 169 .Nm ipfw
 170 utility
 171 would then be used to block nfs-related packets that come in on the outside
 172 interface.
 173 .Pp
 174 If the server has stopped servicing clients and has generated a console message
 175 like
 176 .Dq Li "nfsd server cache flooded..." ,
 177 the value for vfs.nfsd.tcphighwater needs to be increased.
 178 This should allow the server to again handle requests without a reboot.
 179 Also, you may want to consider decreasing the value for
 180 vfs.nfsd.tcpcachetimeo to several minutes (in seconds) instead of 12 hours
 181 when this occurs.
 182 .Pp
 183 Unfortunately making vfs.nfsd.tcphighwater too large can result in the mbuf
 184 limit being reached, as indicated by a console message
 185 like
 186 .Dq Li "kern.ipc.nmbufs limit reached" .
 187 If you cannot find values of the above
 188 .Nm sysctl
 189 values that work, you can disable the DRC cache for TCP by setting
 190 vfs.nfsd.cachetcp to 0.
 191 .Pp
 192 The
 193 .Nm
 194 utility has to be terminated with
 195 .Dv SIGUSR1
 196 and cannot be killed with
 197 .Dv SIGTERM
 198 or
 199 .Dv SIGQUIT .
 200 The
 201 .Nm
 202 utility needs to ignore these signals in order to stay alive as long
 203 as possible during a shutdown, otherwise loopback mounts will
 204 not be able to unmount.
 205 If you have to kill
 206 .Nm
 207 just do a
 208 .Dq Li "kill -USR1 <PID of master nfsd>"
 209 .Sh EXIT STATUS
 210 .Ex -std
 211 .Sh SEE ALSO
 212 .Xr nfsstat 1 ,
 213 .Xr kldload 2 ,
 214 .Xr nfssvc 2 ,
 215 .Xr nfsv4 4 ,
 216 .Xr exports 5 ,
 217 .Xr stablerestart 5 ,
 218 .Xr gssd 8 ,
 219 .Xr ipfw 8 ,
 220 .Xr mountd 8 ,
 221 .Xr nfsiod 8 ,
 222 .Xr nfsrevoke 8 ,
 223 .Xr nfsuserd 8 ,
 224 .Xr rpcbind 8
 225 .Sh HISTORY
 226 The
 227 .Nm
 228 utility first appeared in
 229 .Bx 4.4 .
 230 .Sh BUGS
 231 If
 232 .Nm
 233 is started when
 234 .Xr gssd 8
 235 is not running, it will service AUTH_SYS requests only. To fix the problem
 236 you must kill
 237 .Nm
 238 and then restart it, after the
 239 .Xr gssd 8
 240 is running.