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 January 1, 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 arduteo
  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 The new NFS server that includes NFSv4 support is now the default, so this
 116 option is now a no-op and should be considered deprecated.
 117 .It Fl o
 118 Forces the use of the old NFS server that does not include NFSv4 support
 119 in it.
 120 .El
 121 .Pp
 122 For example,
 123 .Dq Li "nfsd -u -t -n 6"
 124 serves
 125 .Tn UDP
 126 and
 127 .Tn TCP
 128 transports using six daemons.
 129 .Pp
 130 A server should run enough daemons to handle
 131 the maximum level of concurrency from its clients,
 132 typically four to six.
 133 .Pp
 134 The
 135 .Nm
 136 utility listens for service requests at the port indicated in the
 137 .Tn NFS
 138 server specification; see
 139 .%T "Network File System Protocol Specification" ,
 140 RFC1094,
 141 .%T "NFS: Network File System Version 3 Protocol Specification" ,
 142 RFC1813 and
 143 .%T "Network File System (NFS) Version 4 Protocol" ,
 144 RFC3530.
 145 .Pp
 146 If
 147 .Nm
 148 detects that
 149 .Tn NFS
 150 is not loaded in the running kernel, it will attempt
 151 to load a loadable kernel module containing
 152 .Tn NFS
 153 support using
 154 .Xr kldload 2 .
 155 If this fails, or no
 156 .Tn NFS
 157 KLD is available,
 158 .Nm
 159 will exit with an error.
 160 .Pp
 161 If
 162 .Nm
 163 is to be run on a host with multiple interfaces or interface aliases, use
 164 of the
 165 .Fl h
 166 option is recommended.
 167 If you do not use the option NFS may not respond to
 168 UDP packets from the same IP address they were sent to.
 169 Use of this option
 170 is also recommended when securing NFS exports on a firewalling machine such
 171 that the NFS sockets can only be accessed by the inside interface.
 172 The
 173 .Nm ipfw
 174 utility
 175 would then be used to block nfs-related packets that come in on the outside
 176 interface.
 177 .Pp
 178 If the server has stopped servicing clients and has generated a console message
 179 like
 180 .Dq Li "nfsd server cache flooded..." ,
 181 the value for vfs.nfsd.tcphighwater needs to be increased.
 182 This should allow the server to again handle requests without a reboot.
 183 Also, you may want to consider decreasing the value for
 184 vfs.nfsd.tcpcachetimeo to several minutes (in seconds) instead of 12 hours
 185 when this occurs.
 186 .Pp
 187 Unfortunately making vfs.nfsd.tcphighwater too large can result in the mbuf
 188 limit being reached, as indicated by a console message
 189 like
 190 .Dq Li "kern.ipc.nmbufs limit reached" .
 191 If you cannot find values of the above
 192 .Nm sysctl
 193 values that work, you can disable the DRC cache for TCP by setting
 194 vfs.nfsd.cachetcp to 0.
 195 .Pp
 196 The
 197 .Nm
 198 utility has to be terminated with
 199 .Dv SIGUSR1
 200 and cannot be killed with
 201 .Dv SIGTERM
 202 or
 203 .Dv SIGQUIT .
 204 The
 205 .Nm
 206 utility needs to ignore these signals in order to stay alive as long
 207 as possible during a shutdown, otherwise loopback mounts will
 208 not be able to unmount.
 209 If you have to kill
 210 .Nm
 211 just do a
 212 .Dq Li "kill -USR1 <PID of master nfsd>"
 213 .Sh EXIT STATUS
 214 .Ex -std
 215 .Sh SEE ALSO
 216 .Xr nfsstat 1 ,
 217 .Xr kldload 2 ,
 218 .Xr nfssvc 2 ,
 219 .Xr nfsv4 4 ,
 220 .Xr exports 5 ,
 221 .Xr stablerestart 5 ,
 222 .Xr gssd 8 ,
 223 .Xr ipfw 8 ,
 224 .Xr mountd 8 ,
 225 .Xr nfsiod 8 ,
 226 .Xr nfsrevoke 8 ,
 227 .Xr nfsuserd 8 ,
 228 .Xr rpcbind 8
 229 .Sh HISTORY
 230 The
 231 .Nm
 232 utility first appeared in
 233 .Bx 4.4 .
 234 .Sh BUGS
 235 If
 236 .Nm
 237 is started when
 238 .Xr gssd 8
 239 is not running, it will service AUTH_SYS requests only. To fix the problem
 240 you must kill
 241 .Nm
 242 and then restart it, after the
 243 .Xr gssd 8
 244 is running.