]>
Commit | Line | Data |
---|---|---|
08fe7cdb TL |
1 | .\" dhcpd.8 |
2 | .\" | |
88cd8aca | 3 | .\" Copyright (c) 2004-2006 by Internet Systems Consortium, Inc. ("ISC") |
98311e4b | 4 | .\" Copyright (c) 1996-2003 by Internet Software Consortium |
08fe7cdb | 5 | .\" |
98311e4b DH |
6 | .\" Permission to use, copy, modify, and distribute this software for any |
7 | .\" purpose with or without fee is hereby granted, provided that the above | |
8 | .\" copyright notice and this permission notice appear in all copies. | |
08fe7cdb | 9 | .\" |
98311e4b DH |
10 | .\" THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES |
11 | .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF | |
12 | .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR | |
13 | .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES | |
14 | .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN | |
15 | .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT | |
16 | .\" OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. | |
08fe7cdb | 17 | .\" |
98311e4b DH |
18 | .\" Internet Systems Consortium, Inc. |
19 | .\" 950 Charter Street | |
20 | .\" Redwood City, CA 94063 | |
21 | .\" <info@isc.org> | |
22 | .\" http://www.isc.org/ | |
23 | .\" | |
24 | .\" This software has been written for Internet Systems Consortium | |
69c620f2 | 25 | .\" by Ted Lemon in cooperation with Vixie Enterprises and Nominum, Inc. |
98311e4b | 26 | .\" To learn more about Internet Systems Consortium, see |
69c620f2 TL |
27 | .\" ``http://www.isc.org/''. To learn more about Vixie Enterprises, |
28 | .\" see ``http://www.vix.com''. To learn more about Nominum, Inc., see | |
29 | .\" ``http://www.nominum.com''. | |
f49473ba | 30 | .\" |
98bd7ca0 | 31 | .\" $Id: dhcpd.8,v 1.26 2007/05/08 23:05:22 dhankins Exp $ |
f49473ba | 32 | .\" |
ee0cda4d TL |
33 | .TH dhcpd 8 |
34 | .SH NAME | |
5e6b52dc | 35 | dhcpd - Dynamic Host Configuration Protocol Server |
ee0cda4d TL |
36 | .SH SYNOPSIS |
37 | .B dhcpd | |
38 | [ | |
39 | .B -p | |
40 | .I port | |
41 | ] | |
d27562c7 TL |
42 | [ |
43 | .B -f | |
44 | ] | |
45 | [ | |
5e6b52dc TL |
46 | .B -d |
47 | ] | |
48 | [ | |
6edb572b TL |
49 | .B -q |
50 | ] | |
51 | [ | |
897065dc TL |
52 | .B -t |
53 | | | |
54 | .B -T | |
55 | ] | |
56 | [ | |
98bd7ca0 DH |
57 | .B -4 |
58 | | | |
59 | .B -6 | |
60 | ] | |
61 | [ | |
e2ac5814 TL |
62 | .B -cf |
63 | .I config-file | |
64 | ] | |
65 | [ | |
66 | .B -lf | |
67 | .I lease-file | |
68 | ] | |
69 | [ | |
88cd8aca DH |
70 | .B -pf |
71 | .I pid-file | |
72 | ] | |
73 | [ | |
51fe0cce TL |
74 | .B -tf |
75 | .I trace-output-file | |
76 | ] | |
77 | [ | |
78 | .B -play | |
79 | .I trace-playback-file | |
80 | ] | |
81 | [ | |
d27562c7 TL |
82 | .I if0 |
83 | [ | |
84 | .I ...ifN | |
85 | ] | |
86 | ] | |
ee0cda4d | 87 | .SH DESCRIPTION |
98311e4b | 88 | The Internet Systems Consortium DHCP Server, dhcpd, implements the |
5e6b52dc TL |
89 | Dynamic Host Configuration Protocol (DHCP) and the Internet Bootstrap |
90 | Protocol (BOOTP). DHCP allows hosts on a TCP/IP network to request | |
91 | and be assigned IP addresses, and also to discover information about | |
92 | the network to which they are attached. BOOTP provides similar | |
93 | functionality, with certain restrictions. | |
f21a7b4a TL |
94 | .SH CONTRIBUTIONS |
95 | .PP | |
46a65180 TL |
96 | This software is free software. At various times its development has |
97 | been underwritten by various organizations, including the ISC and | |
98 | Vixie Enterprises. The development of 3.0 has been funded almost | |
99 | entirely by Nominum, Inc. | |
100 | .PP | |
101 | At this point development is being shepherded by Ted Lemon, and hosted | |
102 | by the ISC, but the future of this project depends on you. If you | |
103 | have features you want, please consider implementing them. | |
ee0cda4d TL |
104 | .SH OPERATION |
105 | .PP | |
08fe7cdb TL |
106 | The DHCP protocol allows a host which is unknown to the network |
107 | administrator to be automatically assigned a new IP address out of a | |
108 | pool of IP addresses for its network. In order for this to work, the | |
109 | network administrator allocates address pools in each subnet and | |
ee0cda4d TL |
110 | enters them into the dhcpd.conf(5) file. |
111 | .PP | |
08fe7cdb | 112 | On startup, dhcpd reads the |
ee0cda4d | 113 | .IR dhcpd.conf |
5e6b52dc TL |
114 | file and stores a list of available addresses on each subnet in |
115 | memory. When a client requests an address using the DHCP protocol, | |
116 | dhcpd allocates an address for it. Each client is assigned a lease, | |
117 | which expires after an amount of time chosen by the administrator (by | |
118 | default, one day). Before leases expire, the clients to which leases | |
119 | are assigned are expected to renew them in order to continue to use | |
120 | the addresses. Once a lease has expired, the client to which that | |
121 | lease was assigned is no longer permitted to use the leased IP | |
122 | address. | |
ee0cda4d | 123 | .PP |
08fe7cdb | 124 | In order to keep track of leases across system reboots and server |
ee0cda4d TL |
125 | restarts, dhcpd keeps a list of leases it has assigned in the |
126 | dhcpd.leases(5) file. Before dhcpd grants a lease to a host, it | |
127 | records the lease in this file and makes sure that the contents of the | |
128 | file are flushed to disk. This ensures that even in the event of a | |
129 | system crash, dhcpd will not forget about a lease that it has | |
130 | assigned. On startup, after reading the dhcpd.conf file, dhcpd | |
131 | reads the dhcpd.leases file to refresh its memory about what leases | |
132 | have been assigned. | |
133 | .PP | |
134 | New leases are appended to the end of the dhcpd.leases | |
08fe7cdb | 135 | file. In order to prevent the file from becoming arbitrarily large, |
ee0cda4d TL |
136 | from time to time dhcpd creates a new dhcpd.leases file from its |
137 | in-core lease database. Once this file has been written to disk, the | |
138 | old file is renamed | |
139 | .IR dhcpd.leases~ , | |
140 | and the new file is renamed dhcpd.leases. If the system crashes in | |
141 | the middle of this process, whichever dhcpd.leases file remains will | |
142 | contain all the lease information, so there is no need for a special | |
143 | crash recovery process. | |
144 | .PP | |
5e6b52dc TL |
145 | BOOTP support is also provided by this server. Unlike DHCP, the BOOTP |
146 | protocol does not provide a protocol for recovering | |
147 | dynamically-assigned addresses once they are no longer needed. It is | |
148 | still possible to dynamically assign addresses to BOOTP clients, but | |
149 | some administrative process for reclaiming addresses is required. By | |
150 | default, leases are granted to BOOTP clients in perpetuity, although | |
151 | the network administrator may set an earlier cutoff date or a shorter | |
152 | lease length for BOOTP leases if that makes sense. | |
153 | .PP | |
154 | BOOTP clients may also be served in the old standard way, which is to | |
155 | simply provide a declaration in the dhcpd.conf file for each | |
156 | BOOTP client, permanently assigning an address to each client. | |
ee0cda4d TL |
157 | .PP |
158 | Whenever changes are made to the dhcpd.conf file, dhcpd must be | |
159 | restarted. To restart dhcpd, send a SIGTERM (signal 15) to the | |
160 | process ID contained in | |
5e6b52dc TL |
161 | .IR RUNDIR/dhcpd.pid , |
162 | and then re-invoke dhcpd. Because the DHCP server database is not as | |
163 | lightweight as a BOOTP database, dhcpd does not automatically restart | |
164 | itself when it sees a change to the dhcpd.conf file. | |
4e19a6df TL |
165 | .PP |
166 | Note: We get a lot of complaints about this. We realize that it would | |
167 | be nice if one could send a SIGHUP to the server and have it reload | |
168 | the database. This is not technically impossible, but it would | |
169 | require a great deal of work, our resources are extremely limited, and | |
170 | they can be better spent elsewhere. So please don't complain about | |
171 | this on the mailing list unless you're prepared to fund a project to | |
172 | implement this feature, or prepared to do it yourself. | |
d27562c7 TL |
173 | .SH COMMAND LINE |
174 | .PP | |
5e6b52dc TL |
175 | The names of the network interfaces on which dhcpd should listen for |
176 | broadcasts may be specified on the command line. This should be done | |
177 | on systems where dhcpd is unable to identify non-broadcast interfaces, | |
178 | but should not be required on other systems. If no interface names | |
179 | are specified on the command line dhcpd will identify all network | |
98311e4b | 180 | interfaces which are up, eliminating non-broadcast interfaces if |
5e6b52dc | 181 | possible, and listen for DHCP broadcasts on each interface. |
d27562c7 | 182 | .PP |
98bd7ca0 DH |
183 | The server either operates as a DHCPv6 server or a DHCP server, but |
184 | not both at the same time. To run as a DHCPv6 server, use the | |
185 | .B -6 | |
186 | flag. To run as a DHCP server, use the | |
187 | .B -4 | |
188 | flag. If neither is used, the default is to run as a DHCPv6 server. | |
189 | .PP | |
5e6b52dc TL |
190 | If dhcpd should listen on a port other than the standard (port 67), |
191 | the | |
d27562c7 | 192 | .B -p |
5e6b52dc TL |
193 | flag may used. It should be followed by the udp port number on which |
194 | dhcpd should listen. This is mostly useful for debugging purposes. | |
d27562c7 | 195 | .PP |
5e6b52dc TL |
196 | To run dhcpd as a foreground process, rather than allowing it to run |
197 | as a daemon in the background, the | |
d27562c7 | 198 | .B -f |
5e6b52dc TL |
199 | flag should be specified. This is useful when running dhcpd under a |
200 | debugger, or when running it out of inittab on System V systems. | |
201 | .PP | |
202 | To have dhcpd log to the standard error descriptor, specify the | |
203 | .B -d | |
204 | flag. This can be useful for debugging, and also at sites where a | |
205 | complete log of all dhcp activity must be kept but syslogd is not | |
206 | reliable or otherwise cannot be used. Normally, dhcpd will log all | |
207 | output using the syslog(3) function with the log facility set to | |
71b0f2ce DH |
208 | LOG_DAEMON. Note that -d implies -f (the daemon will not fork |
209 | itself into the background). | |
e2ac5814 TL |
210 | .PP |
211 | Dhcpd can be made to use an alternate configuration file with the | |
212 | .B -cf | |
88cd8aca | 213 | flag, an alternate lease file with the |
e2ac5814 | 214 | .B -lf |
88cd8aca DH |
215 | flag, or an alternate pid file with the |
216 | .B -pf | |
e2ac5814 TL |
217 | flag. Because of the importance of using the same lease database at |
218 | all times when running dhcpd in production, these options should be | |
219 | used \fBonly\fR for testing lease files or database files in a | |
220 | non-production environment. | |
6edb572b TL |
221 | .PP |
222 | When starting dhcpd up from a system startup script (e.g., /etc/rc), | |
223 | it may not be desirable to print out the entire copyright message on | |
224 | startup. To avoid printing this message, the | |
225 | .B -q | |
226 | flag may be specified. | |
897065dc TL |
227 | .PP |
228 | The DHCP server reads two files on startup: a configuration file, and | |
229 | a lease database. If the | |
230 | .B -t | |
231 | flag is specified, the server will simply test the configuration file | |
232 | for correct syntax, but will not attempt to perform any network | |
233 | operations. This can be used to test the a new configuration file | |
234 | automatically before installing it. | |
235 | .PP | |
236 | The | |
237 | .B -T | |
238 | flag can be used to test the lease database file in a similar way. | |
51fe0cce TL |
239 | .PP |
240 | The \fB-tf\fR and \fB-play\fR options allow you to specify a file into | |
241 | which the entire startup state of the server and all the transactions | |
242 | it processes are either logged or played back from. This can be | |
243 | useful in submitting bug reports - if you are getting a core dump | |
244 | every so often, you can start the server with the \fB-tf\fR option and | |
245 | then, when the server dumps core, the trace file will contain all the | |
246 | transactions that led up to it dumping core, so that the problem can | |
247 | be easily debugged with \fB-play\fR. | |
248 | .PP | |
249 | The \fB-play\fR option must be specified with an alternate lease file, | |
250 | using the \fB-lf\fR switch, so that the DHCP server doesn't wipe out | |
251 | your existing lease file with its test data. The DHCP server will | |
252 | refuse to operate in playback mode unless you specify an alternate | |
253 | lease file. | |
ee0cda4d | 254 | .SH CONFIGURATION |
98311e4b | 255 | The syntax of the dhcpd.conf(5) file is discussed separately. This |
ee0cda4d | 256 | section should be used as an overview of the configuration process, |
ba7ed239 | 257 | and the dhcpd.conf(5) documentation should be consulted for detailed |
ee0cda4d TL |
258 | reference information. |
259 | .PP | |
260 | .SH Subnets | |
261 | dhcpd needs to know the subnet numbers and netmasks of all subnets for | |
262 | which it will be providing service. In addition, in order to | |
263 | dynamically allocate addresses, it must be assigned one or more ranges | |
264 | of addresses on each subnet which it can in turn assign to client | |
265 | hosts as they boot. Thus, a very simple configuration providing DHCP | |
08fe7cdb TL |
266 | support might look like this: |
267 | .nf | |
268 | .sp 1 | |
5e6b52dc | 269 | subnet 239.252.197.0 netmask 255.255.255.0 { |
08fe7cdb | 270 | range 239.252.197.10 239.252.197.250; |
98311e4b | 271 | } |
08fe7cdb | 272 | .fi |
ee0cda4d | 273 | .PP |
08fe7cdb TL |
274 | Multiple address ranges may be specified like this: |
275 | .nf | |
276 | .sp 1 | |
5e6b52dc TL |
277 | subnet 239.252.197.0 netmask 255.255.255.0 { |
278 | range 239.252.197.10 239.252.197.107; | |
08fe7cdb | 279 | range 239.252.197.113 239.252.197.250; |
5e6b52dc | 280 | } |
08fe7cdb | 281 | .fi |
ee0cda4d | 282 | .PP |
08fe7cdb TL |
283 | If a subnet will only be provided with BOOTP service and no dynamic |
284 | address assignment, the range clause can be left out entirely, but the | |
285 | subnet statement must appear. | |
ee0cda4d TL |
286 | .PP |
287 | .SH Lease Lengths | |
08fe7cdb TL |
288 | DHCP leases can be assigned almost any length from zero seconds to |
289 | infinity. What lease length makes sense for any given subnet, or for | |
290 | any given installation, will vary depending on the kinds of hosts | |
291 | being served. | |
ee0cda4d | 292 | .PP |
08fe7cdb TL |
293 | For example, in an office environment where systems are added from |
294 | time to time and removed from time to time, but move relatively | |
295 | infrequently, it might make sense to allow lease times of a month of | |
296 | more. In a final test environment on a manufacturing floor, it may | |
297 | make more sense to assign a maximum lease length of 30 minutes - | |
298 | enough time to go through a simple test procedure on a network | |
299 | appliance before packaging it up for delivery. | |
ee0cda4d | 300 | .PP |
08fe7cdb TL |
301 | It is possible to specify two lease lengths: the default length that |
302 | will be assigned if a client doesn't ask for any particular lease | |
303 | length, and a maximum lease length. These are specified as clauses | |
304 | to the subnet command: | |
305 | .nf | |
306 | .sp 1 | |
5e6b52dc TL |
307 | subnet 239.252.197.0 netmask 255.255.255.0 { |
308 | range 239.252.197.10 239.252.197.107; | |
309 | default-lease-time 600; | |
08fe7cdb | 310 | max-lease-time 7200; |
98311e4b | 311 | } |
08fe7cdb | 312 | .fi |
ee0cda4d | 313 | .PP |
08fe7cdb TL |
314 | This particular subnet declaration specifies a default lease time of |
315 | 600 seconds (ten minutes), and a maximum lease time of 7200 seconds | |
316 | (two hours). Other common values would be 86400 (one day), 604800 | |
317 | (one week) and 2592000 (30 days). | |
ee0cda4d | 318 | .PP |
08fe7cdb TL |
319 | Each subnet need not have the same lease\(emin the case of an office |
320 | environment and a manufacturing environment served by the same DHCP | |
321 | server, it might make sense to have widely disparate values for | |
322 | default and maximum lease times on each subnet. | |
ee0cda4d TL |
323 | .SH BOOTP Support |
324 | Each BOOTP client must be explicitly declared in the dhcpd.conf | |
08fe7cdb TL |
325 | file. A very basic client declaration will specify the client |
326 | network interface's hardware address and the IP address to assign to | |
327 | that client. If the client needs to be able to load a boot file from | |
328 | the server, that file's name must be specified. A simple bootp | |
329 | client declaration might look like this: | |
330 | .nf | |
331 | .sp 1 | |
fc5aedc9 TL |
332 | host haagen { |
333 | hardware ethernet 08:00:2b:4c:59:23; | |
5e6b52dc | 334 | fixed-address 239.252.197.9; |
08fe7cdb | 335 | filename "/tftpboot/haagen.boot"; |
5e6b52dc | 336 | } |
08fe7cdb | 337 | .fi |
ee0cda4d | 338 | .SH Options |
08fe7cdb TL |
339 | DHCP (and also BOOTP with Vendor Extensions) provide a mechanism |
340 | whereby the server can provide the client with information about how | |
341 | to configure its network interface (e.g., subnet mask), and also how | |
342 | the client can access various network services (e.g., DNS, IP routers, | |
343 | and so on). | |
ee0cda4d | 344 | .PP |
08fe7cdb TL |
345 | These options can be specified on a per-subnet basis, and, for BOOTP |
346 | clients, also on a per-client basis. In the event that a BOOTP | |
347 | client declaration specifies options that are also specified in its | |
348 | subnet declaration, the options specified in the client declaration | |
98311e4b | 349 | take precedence. A reasonably complete DHCP configuration might |
08fe7cdb TL |
350 | look something like this: |
351 | .nf | |
352 | .sp 1 | |
5e6b52dc TL |
353 | subnet 239.252.197.0 netmask 255.255.255.0 { |
354 | range 239.252.197.10 239.252.197.250; | |
355 | default-lease-time 600 max-lease-time 7200; | |
356 | option subnet-mask 255.255.255.0; | |
357 | option broadcast-address 239.252.197.255; | |
358 | option routers 239.252.197.1; | |
359 | option domain-name-servers 239.252.197.2, 239.252.197.3; | |
08fe7cdb | 360 | option domain-name "isc.org"; |
5e6b52dc | 361 | } |
08fe7cdb | 362 | .fi |
ee0cda4d | 363 | .PP |
08fe7cdb TL |
364 | A bootp host on that subnet that needs to be in a different domain and |
365 | use a different name server might be declared as follows: | |
366 | .nf | |
367 | .sp 1 | |
ba7ed239 TL |
368 | host haagen { |
369 | hardware ethernet 08:00:2b:4c:59:23; | |
5e6b52dc TL |
370 | fixed-address 239.252.197.9; |
371 | filename "/tftpboot/haagen.boot"; | |
372 | option domain-name-servers 192.5.5.1; | |
08fe7cdb | 373 | option domain-name "vix.com"; |
5e6b52dc | 374 | } |
08fe7cdb | 375 | .fi |
ee0cda4d | 376 | .PP |
5e6b52dc TL |
377 | A more complete description of the dhcpd.conf file syntax is provided |
378 | in dhcpd.conf(5). | |
90e0ef94 TL |
379 | .SH OMAPI |
380 | The DHCP server provides the capability to modify some of its | |
381 | configuration while it is running, without stopping it, modifying its | |
382 | database files, and restarting it. This capability is currently | |
383 | provided using OMAPI - an API for manipulating remote objects. OMAPI | |
384 | clients connect to the server using TCP/IP, authenticate, and can then | |
385 | examine the server's current status and make changes to it. | |
386 | .PP | |
387 | Rather than implementing the underlying OMAPI protocol directly, user | |
388 | programs should use the dhcpctl API or OMAPI itself. Dhcpctl is a | |
389 | wrapper that handles some of the housekeeping chores that OMAPI does | |
390 | not do automatically. Dhcpctl and OMAPI are documented in \fBdhcpctl(3)\fR | |
391 | and \fBomapi(3)\fR. | |
392 | .PP | |
393 | OMAPI exports objects, which can then be examined and modified. The | |
394 | DHCP server exports the following objects: lease, host, | |
395 | failover-state and group. Each object has a number of methods that | |
396 | are provided: lookup, create, and destroy. In addition, it is | |
397 | possible to look at attributes that are stored on objects, and in some | |
398 | cases to modify those attributes. | |
399 | .SH THE LEASE OBJECT | |
400 | Leases can't currently be created or destroyed, but they can be looked | |
401 | up to examine and modify their state. | |
402 | .PP | |
403 | Leases have the following attributes: | |
404 | .PP | |
405 | .B state \fIinteger\fR lookup, examine | |
406 | .RS 0.5i | |
407 | .nf | |
408 | 1 = free | |
409 | 2 = active | |
410 | 3 = expired | |
411 | 4 = released | |
412 | 5 = abandoned | |
413 | 6 = reset | |
414 | 7 = backup | |
415 | 8 = reserved | |
416 | 9 = bootp | |
417 | .fi | |
418 | .RE | |
419 | .PP | |
420 | .B ip-address \fIdata\fR lookup, examine | |
421 | .RS 0.5i | |
422 | The IP address of the lease. | |
423 | .RE | |
424 | .PP | |
425 | .B dhcp-client-identifier \fIdata\fR lookup, examine, update | |
426 | .RS 0.5i | |
427 | The | |
428 | client identifier that the client used when it acquired the lease. | |
429 | Not all clients send client identifiers, so this may be empty. | |
430 | .RE | |
431 | .PP | |
432 | .B client-hostname \fIdata\fR examine, update | |
433 | .RS 0.5i | |
434 | The value the client sent in the host-name option. | |
435 | .RE | |
436 | .PP | |
437 | .B host \fIhandle\fR examine | |
438 | .RS 0.5i | |
439 | the host declaration associated with this lease, if any. | |
440 | .RE | |
441 | .PP | |
442 | .B subnet \fIhandle\fR examine | |
443 | .RS 0.5i | |
444 | the subnet object associated with this lease (the subnet object is not | |
445 | currently supported). | |
446 | .RE | |
447 | .PP | |
448 | .B pool \fIhandle\fR examine | |
449 | .RS 0.5i | |
c759db75 | 450 | the pool object associated with this lease (the pool object is not |
90e0ef94 TL |
451 | currently supported). |
452 | .RE | |
453 | .PP | |
454 | .B billing-class \fIhandle\fR examine | |
455 | .RS 0.5i | |
456 | the handle to the class to which this lease is currently billed, if | |
457 | any (the class object is not currently supported). | |
458 | .RE | |
459 | .PP | |
460 | .B hardware-address \fIdata\fR examine, update | |
461 | .RS 0.5i | |
462 | the hardware address (chaddr) field sent by the client when it | |
463 | acquired its lease. | |
464 | .RE | |
465 | .PP | |
466 | .B hardware-type \fIinteger\fR examine, update | |
467 | .RS 0.5i | |
468 | the type of the network interface that the client reported when it | |
469 | acquired its lease. | |
470 | .RE | |
471 | .PP | |
472 | .B ends \fItime\fR examine | |
473 | .RS 0.5i | |
474 | the time when the lease's current state ends, as understood by the | |
475 | client. | |
476 | .RE | |
477 | .PP | |
478 | .B tstp \fItime\fR examine | |
479 | .RS 0.5i | |
480 | the time when the lease's current state ends, as understood by the | |
481 | server. | |
482 | .RE | |
483 | .B tsfp \fItime\fR examine | |
484 | .RS 0.5i | |
88cd8aca DH |
485 | the adjusted time when the lease's current state ends, as understood by |
486 | the failover peer (if there is no failover peer, this value is | |
487 | undefined). Generally this value is only adjusted for expired, released, | |
488 | or reset leases while the server is operating in partner-down state, and | |
489 | otherwise is simply the value supplied by the peer. | |
490 | .RE | |
491 | .B atsfp \fItime\fR examine | |
492 | .RS 0.5i | |
493 | the actual tsfp value sent from the peer. This value is forgotten when a | |
c759db75 | 494 | lease binding state change is made, to facilitate retransmission logic. |
90e0ef94 TL |
495 | .RE |
496 | .PP | |
497 | .B cltt \fItime\fR examine | |
498 | .RS 0.5i | |
499 | The time of the last transaction with the client on this lease. | |
500 | .RE | |
501 | .SH THE HOST OBJECT | |
502 | Hosts can be created, destroyed, looked up, examined and modified. | |
503 | If a host declaration is created or deleted using OMAPI, that | |
504 | information will be recorded in the dhcpd.leases file. It is | |
505 | permissible to delete host declarations that are declared in the | |
506 | dhcpd.conf file. | |
507 | .PP | |
508 | Hosts have the following attributes: | |
509 | .PP | |
510 | .B name \fIdata\fR lookup, examine, modify | |
511 | .RS 0.5i | |
512 | the name of the host declaration. This name must be unique among all | |
513 | host declarations. | |
514 | .RE | |
515 | .PP | |
516 | .B group \fIhandle\fR examine, modify | |
517 | .RS 0.5i | |
518 | the named group associated with the host declaration, if there is one. | |
519 | .RE | |
520 | .PP | |
521 | .B hardware-address \fIdata\fR lookup, examine, modify | |
522 | .RS 0.5i | |
523 | the link-layer address that will be used to match the client, if any. | |
524 | Only valid if hardware-type is also present. | |
525 | .RE | |
526 | .PP | |
527 | .B hardware-type \fIinteger\fR lookup, examine, modify | |
528 | .RS 0.5i | |
529 | the type of the network interface that will be used to match the | |
530 | client, if any. Only valid if hardware-address is also present. | |
531 | .RE | |
532 | .PP | |
533 | .B dhcp-client-identifier \fIdata\fR lookup, examine, modify | |
534 | .RS 0.5i | |
535 | the dhcp-client-identifier option that will be used to match the | |
536 | client, if any. | |
537 | .RE | |
538 | .PP | |
539 | .B ip-address \fIdata\fR examine, modify | |
540 | .RS 0.5i | |
541 | a fixed IP address which is reserved for a DHCP client that matches | |
542 | this host declaration. The IP address will only be assigned to the | |
543 | client if it is valid for the network segment to which the client is | |
544 | connected. | |
545 | .RE | |
546 | .PP | |
547 | .B statements \fIdata\fR modify | |
548 | .RS 0.5i | |
549 | a list of statements in the format of the dhcpd.conf file that will be | |
550 | executed whenever a message from the client is being processed. | |
551 | .RE | |
552 | .PP | |
553 | .B known \fIinteger\fR examine, modify | |
554 | .RS 0.5i | |
555 | if nonzero, indicates that a client matching this host declaration | |
556 | will be treated as \fIknown\fR in pool permit lists. If zero, the | |
557 | client will not be treated as known. | |
558 | .RE | |
559 | .SH THE GROUP OBJECT | |
560 | Named groups can be created, destroyed, looked up, examined and | |
561 | modified. If a group declaration is created or deleted using OMAPI, | |
562 | that information will be recorded in the dhcpd.leases file. It is | |
563 | permissible to delete group declarations that are declared in the | |
564 | dhcpd.conf file. | |
565 | .PP | |
566 | Named groups currently can only be associated with | |
567 | hosts - this allows one set of statements to be efficiently attached | |
568 | to more than one host declaration. | |
569 | .PP | |
570 | Groups have the following attributes: | |
571 | .PP | |
572 | .B name \fIdata\fR | |
573 | .RS 0.5i | |
574 | the name of the group. All groups that are created using OMAPI must | |
575 | have names, and the names must be unique among all groups. | |
576 | .RE | |
577 | .PP | |
578 | .B statements \fIdata\fR | |
579 | .RS 0.5i | |
580 | a list of statements in the format of the dhcpd.conf file that will be | |
581 | executed whenever a message from a client whose host declaration | |
582 | references this group is processed. | |
583 | .RE | |
d758ad8c TL |
584 | .SH THE CONTROL OBJECT |
585 | The control object allows you to shut the server down. If the server | |
586 | is doing failover with another peer, it will make a clean transition | |
587 | into the shutdown state and notify its peer, so that the peer can go | |
588 | into partner down, and then record the "recover" state in the lease | |
589 | file so that when the server is restarted, it will automatically | |
590 | resynchronize with its peer. | |
591 | .PP | |
592 | On shutdown the server will also attempt to cleanly shut down all | |
593 | OMAPI connections. If these connections do not go down cleanly after | |
c759db75 | 594 | five seconds, they are shut down preemptively. It can take as much |
d758ad8c TL |
595 | as 25 seconds from the beginning of the shutdown process to the time |
596 | that the server actually exits. | |
597 | .PP | |
598 | To shut the server down, open its control object and set the state | |
599 | attribute to 2. | |
0db87765 TL |
600 | .SH THE FAILOVER-STATE OBJECT |
601 | The failover-state object is the object that tracks the state of the | |
602 | failover protocol as it is being managed for a given failover peer. | |
603 | The failover object has the following attributes (please see | |
604 | .B dhcpd.conf (5) | |
605 | for explanations about what these attributes mean): | |
606 | .PP | |
607 | .B name \fIdata\fR examine | |
608 | .RS 0.5i | |
609 | Indicates the name of the failover peer relationship, as described in | |
610 | the server's \fBdhcpd.conf\fR file. | |
611 | .RE | |
612 | .PP | |
613 | .B partner-address \fIdata\fR examine | |
614 | .RS 0.5i | |
615 | Indicates the failover partner's IP address. | |
616 | .RE | |
617 | .PP | |
618 | .B local-address \fIdata\fR examine | |
619 | .RS 0.5i | |
620 | Indicates the IP address that is being used by the DHCP server for | |
621 | this failover pair. | |
622 | .RE | |
623 | .PP | |
624 | .B partner-port \fIdata\fR examine | |
625 | .RS 0.5i | |
626 | Indicates the TCP port on which the failover partner is listening for | |
627 | failover protocol connections. | |
628 | .RE | |
629 | .PP | |
630 | .B local-port \fIdata\fR examine | |
631 | .RS 0.5i | |
632 | Indicates the TCP port on which the DHCP server is listening for | |
633 | failover protocol connections for this failover pair. | |
634 | .RE | |
635 | .PP | |
636 | .B max-outstanding-updates \fIinteger\fR examine | |
637 | .RS 0.5i | |
638 | Indicates the number of updates that can be outstanding and | |
639 | unacknowledged at any given time, in this failover relationship. | |
640 | .RE | |
641 | .PP | |
642 | .B mclt \fIinteger\fR examine | |
643 | .RS 0.5i | |
644 | Indicates the maximum client lead time in this failover relationship. | |
645 | .RE | |
646 | .PP | |
647 | .B load-balance-max-secs \fIinteger\fR examine | |
648 | .RS 0.5i | |
649 | Indicates the maximum value for the secs field in a client request | |
650 | before load balancing is bypassed. | |
651 | .RE | |
652 | .PP | |
653 | .B load-balance-hba \fIdata\fR examine | |
654 | .RS 0.5i | |
655 | Indicates the load balancing hash bucket array for this failover | |
656 | relationship. | |
657 | .RE | |
658 | .PP | |
659 | .B local-state \fIinteger\fR examine, modify | |
660 | .RS 0.5i | |
661 | Indicates the present state of the DHCP server in this failover | |
662 | relationship. Possible values for state are: | |
663 | .RE | |
664 | .RS 1i | |
665 | .PP | |
666 | .nf | |
667 | 1 - partner down | |
668 | 2 - normal | |
669 | 3 - communications interrupted | |
670 | 4 - resolution interrupted | |
671 | 5 - potential conflict | |
672 | 6 - recover | |
673 | 7 - recover done | |
674 | 8 - shutdown | |
675 | 9 - paused | |
676 | 10 - startup | |
677 | 11 - recover wait | |
678 | .fi | |
679 | .RE | |
680 | .PP | |
681 | .RS 0.5i | |
682 | In general it is not a good idea to make changes to this state. | |
683 | However, in the case that the failover partner is known to be down, it | |
684 | can be useful to set the DHCP server's failover state to partner | |
685 | down. At this point the DHCP server will take over service of the | |
686 | failover partner's leases as soon as possible, and will give out | |
687 | normal leases, not leases that are restricted by MCLT. If you do put | |
688 | the DHCP server into the partner-down when the other DHCP server is | |
689 | not in the partner-down state, but is not reachable, IP address | |
690 | assignment conflicts are possible, even likely. Once a server has | |
691 | been put into partner-down mode, its failover partner must not be | |
692 | brought back online until communication is possible between the two | |
693 | servers. | |
694 | .RE | |
695 | .PP | |
696 | .B partner-state \fIinteger\fR examine | |
697 | .RS 0.5i | |
698 | Indicates the present state of the failover partner. | |
699 | .RE | |
700 | .PP | |
701 | .B local-stos \fIinteger\fR examine | |
702 | .RS 0.5i | |
703 | Indicates the time at which the DHCP server entered its present state | |
704 | in this failover relationship. | |
705 | .RE | |
706 | .PP | |
707 | .B partner-stos \fIinteger\fR examine | |
708 | .RS 0.5i | |
709 | Indicates the time at which the failover partner entered its present state. | |
710 | .RE | |
711 | .PP | |
712 | .B hierarchy \fIinteger\fR examine | |
713 | .RS 0.5i | |
714 | Indicates whether the DHCP server is primary (0) or secondary (1) in | |
715 | this failover relationship. | |
716 | .RE | |
717 | .PP | |
718 | .B last-packet-sent \fIinteger\fR examine | |
719 | .RS 0.5i | |
720 | Indicates the time at which the most recent failover packet was sent | |
721 | by this DHCP server to its failover partner. | |
722 | .RE | |
723 | .PP | |
724 | .B last-timestamp-received \fIinteger\fR examine | |
725 | .RS 0.5i | |
726 | Indicates the timestamp that was on the failover message most recently | |
727 | received from the failover partner. | |
728 | .RE | |
729 | .PP | |
730 | .B skew \fIinteger\fR examine | |
731 | .RS 0.5i | |
732 | Indicates the skew between the failover partner's clock and this DHCP | |
733 | server's clock | |
734 | .RE | |
735 | .PP | |
736 | .B max-response-delay \fIinteger\fR examine | |
737 | .RS 0.5i | |
738 | Indicates the time in seconds after which, if no message is received | |
739 | from the failover partner, the partner is assumed to be out of | |
740 | communication. | |
741 | .RE | |
742 | .PP | |
743 | .B cur-unacked-updates \fIinteger\fR examine | |
744 | .RS 0.5i | |
745 | Indicates the number of update messages that have been received from | |
746 | the failover partner but not yet processed. | |
747 | .RE | |
ee0cda4d TL |
748 | .SH FILES |
749 | .B ETCDIR/dhcpd.conf, DBDIR/dhcpd.leases, RUNDIR/dhcpd.pid, | |
750 | .B DBDIR/dhcpd.leases~. | |
751 | .SH SEE ALSO | |
66b01364 | 752 | dhclient(8), dhcrelay(8), dhcpd.conf(5), dhcpd.leases(5) |
ee0cda4d TL |
753 | .SH AUTHOR |
754 | .B dhcpd(8) | |
90e0ef94 | 755 | was originally written by Ted Lemon under a contract with Vixie Labs. |
98311e4b | 756 | Funding for this project was provided by Internet Systems |
90e0ef94 | 757 | Consortium. Version 3 of the DHCP server was funded by Nominum, Inc. |
98311e4b DH |
758 | Information about Internet Systems Consortium is available at |
759 | .B http://www.isc.org/\fR. | |
760 | Information about Nominum can be found at \fBhttp://www.nominum.com/\fR. |