xref: /freebsd/usr.sbin/nfsd/nfsd.8 (revision 6f9c8e5b074419423648ffb89b83fd2f257e90b7)
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 23, 2011
32.Dt NFSD 8
33.Os
34.Sh NAME
35.Nm nfsd
36.Nd remote
37.Tn NFS
38server
39.Sh SYNOPSIS
40.Nm
41.Op Fl arduteo
42.Op Fl n Ar num_servers
43.Op Fl h Ar bindip
44.Sh DESCRIPTION
45The
46.Nm
47utility runs on a server machine to service
48.Tn NFS
49requests from client machines.
50At least one
51.Nm
52must be running for a machine to operate as a server.
53.Pp
54Unless otherwise specified, four servers for
55.Tn UDP
56transport are started.
57.Pp
58The following options are available:
59.Bl -tag -width Ds
60.It Fl r
61Register the
62.Tn NFS
63service with
64.Xr rpcbind 8
65without creating any servers.
66This option can be used along with the
67.Fl u
68or
69.Fl t
70options to re-register NFS if the rpcbind server is restarted.
71.It Fl d
72Unregister the
73.Tn NFS
74service with
75.Xr rpcbind 8
76without creating any servers.
77.It Fl n
78Specifies how many servers to create.
79.It Fl h Ar bindip
80Specifies which IP address or hostname to bind to on the local host.
81This option is recommended when a host has multiple interfaces.
82Multiple
83.Fl h
84options may be specified.
85.It Fl a
86Specifies that nfsd should bind to the wildcard IP address.
87This is the default if no
88.Fl h
89options are given.
90It may also be specified in addition to any
91.Fl h
92options given.
93Note that NFS/UDP does not operate properly when
94bound to the wildcard IP address whether you use -a or do not use -h.
95.It Fl t
96Serve
97.Tn TCP NFS
98clients.
99.It Fl u
100Serve
101.Tn UDP NFS
102clients.
103.It Fl e
104The new NFS server that includes NFSv4 support is now the default, so this
105option is now a no-op and should be considered deprecated.
106.It Fl o
107Forces the use of the old NFS server that does not include NFSv4 support
108in it.
109.El
110.Pp
111For example,
112.Dq Li "nfsd -u -t -n 6"
113serves
114.Tn UDP
115and
116.Tn TCP
117transports using six daemons.
118.Pp
119A server should run enough daemons to handle
120the maximum level of concurrency from its clients,
121typically four to six.
122.Pp
123The
124.Nm
125utility listens for service requests at the port indicated in the
126.Tn NFS
127server specification; see
128.%T "Network File System Protocol Specification" ,
129RFC1094,
130.%T "NFS: Network File System Version 3 Protocol Specification" ,
131RFC1813 and
132.%T "Network File System (NFS) Version 4 Protocol" ,
133RFC3530.
134.Pp
135If
136.Nm
137detects that
138.Tn NFS
139is not loaded in the running kernel, it will attempt
140to load a loadable kernel module containing
141.Tn NFS
142support using
143.Xr kldload 2 .
144If this fails, or no
145.Tn NFS
146KLD is available,
147.Nm
148will exit with an error.
149.Pp
150If
151.Nm
152is to be run on a host with multiple interfaces or interface aliases, use
153of the
154.Fl h
155option is recommended.
156If you do not use the option NFS may not respond to
157UDP packets from the same IP address they were sent to.
158Use of this option
159is also recommended when securing NFS exports on a firewalling machine such
160that the NFS sockets can only be accessed by the inside interface.
161The
162.Nm ipfw
163utility
164would then be used to block nfs-related packets that come in on the outside
165interface.
166.Pp
167The
168.Nm
169utility has to be terminated with
170.Dv SIGUSR1
171and cannot be killed with
172.Dv SIGTERM
173or
174.Dv SIGQUIT .
175The
176.Nm
177utility needs to ignore these signals in order to stay alive as long
178as possible during a shutdown, otherwise loopback mounts will
179not be able to unmount.
180If you have to kill
181.Nm
182just do a
183.Dq Li "kill -USR1 <PID of master nfsd>"
184.Sh EXIT STATUS
185.Ex -std
186.Sh SEE ALSO
187.Xr nfsstat 1 ,
188.Xr kldload 2 ,
189.Xr nfssvc 2 ,
190.Xr nfsv4 4 ,
191.Xr exports 5 ,
192.Xr stablerestart 5 ,
193.Xr gssd 8 ,
194.Xr ipfw 8 ,
195.Xr mountd 8 ,
196.Xr nfsiod 8 ,
197.Xr nfsrevoke 8 ,
198.Xr nfsuserd 8 ,
199.Xr rpcbind 8
200.Sh HISTORY
201The
202.Nm
203utility first appeared in
204.Bx 4.4 .
205.Sh BUGS
206If
207.Nm
208is started when
209.Xr gssd 8
210is not running, it will service AUTH_SYS requests only. To fix the problem
211you must kill
212.Nm
213and then restart it, after the
214.Xr gssd 8
215is running.
216