1 .\" Copyright (c) 1988, 1989, 1991 Carnegie Mellon University
3 .\" $FreeBSD: src/libexec/bootpd/bootpd.8,v 1.10.2.5 2001/07/22 12:07:21 dd Exp $
10 .Nd Internet Boot Protocol server/gateway
17 .Op Fl c Ar chdir-path
30 implements an Internet Bootstrap Protocol (BOOTP) server as defined in
31 RFC951, RFC1532, and RFC1533.
33 implements a simple BOOTP gateway which can be used to forward
34 requests and responses between clients on one subnet and a
37 on another subnet. While either
41 will forward BOOTREPLY packets, only
43 will forward BOOTREQUEST packets.
45 One host on each network segment is normally configured to run either
51 by including one of the following lines in the file
54 .Dl bootps dgram udp wait root /usr/libexec/bootpd bootpd /etc/bootptab
55 .Dl bootps dgram udp wait root /usr/libexec/bootpgw bootpgw server
57 This mode of operation is referred to as "inetd mode" and causes
61 to be started only when a boot request arrives. If it does not
62 receive another packet within fifteen minutes of the last one
63 it received, it will exit to conserve system resources. The
65 option controls this timeout (see OPTIONS).
67 It is also possible to run
71 in "standalone mode" (without
73 by simply invoking it from a shell like any other regular command.
74 Standalone mode is particularly useful when
76 is used with a large configuration database, where the start up
77 delay might otherwise prevent timely response to client requests.
78 (Automatic start up in standalone mode can be done by invoking
83 Standalone mode is less useful for
86 has very little start up delay because
87 it does not read a configuration file.
89 Either program automatically detects whether it was invoked from inetd
90 or from a shell and automatically selects the appropriate mode.
95 option may be used to force standalone or inetd mode respectively
98 The following options are available:
99 .Bl -tag -width indent
103 value (in minutes) that a
107 process will wait for a BOOTP packet before exiting.
108 If no packets are received for
110 minutes, then the program will exit.
111 A timeout value of zero means "run forever".
112 In standalone mode, this option is forced to zero.
113 .It Fl d Ar debug-level
116 variable that controls the amount of debugging messages generated.
121 4 will set the debugging level to 4.
122 For compatibility with older versions of
124 omitting the numeric parameter (i.e. just
126 will simply increment the debug level by one.
127 .It Fl c Ar chdir-path
128 Set the current directory used by
130 while checking the existence and size of client boot files. This is
131 useful when client boot files are specified as relative pathnames, and
133 needs to use the same current directory as the TFTP server
136 This option is not recognized by
139 Force inetd mode. This option is obsolete, but remains for
140 compatibility with older versions of
143 Force standalone mode. This option is obsolete, but remains for
144 compatibility with older versions of
147 Specify the name of the configuration file from which
149 loads its database of known clients and client options
153 Specify the name of the file that
155 will dump its internal database into when it receives a
158 only). This option is only recognized if
160 was compiled with the -DDEBUG flag.
162 Specify the name of a BOOTP server to which
164 will forward all BOOTREQUEST packets it receives
173 operate similarly in that both listen for any packets sent to the
175 port, and both simply forward any BOOTREPLY packets.
176 They differ in their handling of BOOTREQUEST packets.
180 is started, it determines the address of a BOOTP server
181 whose name is provided as a command line parameter. When
183 receives a BOOTREQUEST packet, it sets the "gateway address"
184 and "hop count" fields in the packet and forwards the packet
185 to the BOOTP server at the address determined earlier.
186 Requests are forwarded only if they indicate that
187 the client has been waiting for at least three seconds.
191 is started it reads a configuration file, (normally
193 that initializes the internal database of known clients and client
194 options. This internal database is reloaded
195 from the configuration file when
197 receives a hangup signal (SIGHUP) or when it discovers that the
198 configuration file has changed.
202 receives a BOOTREQUEST packet, it
203 .\" checks the modification time of the
204 .\" configuration file and reloads the database if necessary. Then it
205 looks for a database entry matching the client request.
206 If the client is known,
208 composes a BOOTREPLY packet using the database entry found above,
209 and sends the reply to the client (possibly using a gateway).
210 If the client is unknown, the request is discarded
211 (with a notice if debug > 0).
215 is compiled with the -DDEBUG option, receipt of a SIGUSR1 signal causes
216 it to dump its internal database to the file
218 or the dumpfile specified as a command line parameter.
220 During initialization, both programs
221 determine the UDP port numbers to be used by calling
224 .Pa /etc/services ) .
225 Two service names (and port numbers) are used:
227 .Dl bootps BOOTP Server listening port
228 .Dl bootpc BOOTP Client destination port
230 If the port numbers cannot be determined using
232 then the values default to bootps=67 and bootpc=68.
234 .Bl -tag -width /tmp/bootpd.dump -compact
236 Database file read by
238 .It Pa /tmp/bootpd.dump
239 Debugging dump file created by
242 Internet service numbers.
244 Current directory typically used by the TFTP server and
248 Individual host entries must not exceed 1024 characters.
250 This distribution is currently maintained by
251 .An Walter L. Wimer Aq walt+@cmu.edu .
253 The original BOOTP server was created by
255 at Stanford University in January 1986.
257 The current version of
259 is primarily the work of
261 .An Drew D. Perkins ,
263 .An Walter L. Wimer ,
264 at Carnegie Mellon University.
266 Enhancements and bug-fixes have been contributed by:
268 (in alphabetical order)
271 .An Danny Backx Aq db@sunbim.be
272 .An John Brezak Aq brezak@ch.hp.com
273 .An Frank da Cruz Aq fdc@cc.columbia.edu
274 .An David R. Linn Aq drl@vuse.vanderbilt.edu
275 .An Jim McKim Aq mckim@lerc.nasa.gov
276 .An Gordon W. Ross Aq gwr@mc.com
277 .An Jason Zions Aq jazz@hal.com .
283 DARPA Internet Request For Comments:
284 .Bl -tag -width RFC1533 -compact
288 Clarifications and Extensions for the Bootstrap Protocol
290 DHCP Options and BOOTP Vendor Extensions