Add the DragonFly cvs id and perform general cleanups on cvs/rcs/sccs ids. Most
[dragonfly.git] / contrib / isc-dhcp / client / dhclient.conf.5
1 .\"     dhclient.conf.5
2 .\"
3 .\" Copyright (c) 1996-2002 Internet Software Consortium.
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 .\"
8 .\" 1. Redistributions of source code must retain the above copyright
9 .\"    notice, this list of conditions and the following disclaimer.
10 .\" 2. Redistributions in binary form must reproduce the above copyright
11 .\"    notice, this list of conditions and the following disclaimer in the
12 .\"    documentation and/or other materials provided with the distribution.
13 .\" 3. Neither the name of The Internet Software Consortium nor the names
14 .\"    of its contributors may be used to endorse or promote products derived
15 .\"    from this software without specific prior written permission.
16 .\"
30 .\"
31 .\" This software has been written for the Internet Software Consortium
32 .\" by Ted Lemon in cooperation with Vixie Enterprises and Nominum, Inc.
33 .\" To learn more about the Internet Software Consortium, see
34 .\" ``''.  To learn more about Vixie Enterprises,
35 .\" see ``''.   To learn more about Nominum, Inc., see
36 .\" ``''.
37 .\"
38 .\" $Id: dhclient.conf.5,v 2002/11/17 02:25:43 dhankins Exp $
39 .\" $FreeBSD: src/contrib/isc-dhcp/client/dhclient.conf.5,v 2003/03/02 16:42:38 murray Exp $
40 .\" $DragonFly: src/contrib/isc-dhcp/client/Attic/dhclient.conf.5,v 1.2 2003/06/17 04:24:02 dillon Exp $
41 .\"
42 .TH dhclient.conf 5
44 dhclient.conf - DHCP client configuration file
46 The dhclient.conf file contains configuration information for
47 .IR dhclient,
48 the Internet Software Consortium DHCP Client.
49 .PP
50 The dhclient.conf file is a free-form ASCII text file.   It is parsed by
51 the recursive-descent parser built into dhclient.   The file may contain
52 extra tabs and newlines for formatting purposes.  Keywords in the file
53 are case-insensitive.   Comments may be placed anywhere within the
54 file (except within quotes).   Comments begin with the # character and
55 end at the end of the line.
56 .PP
57 The dhclient.conf file can be used to configure the behaviour of the
58 client in a wide variety of ways: protocol timing, information
59 requested from the server, information required of the server,
60 defaults to use if the server does not provide certain information,
61 values with which to override information provided by the server, or
62 values to prepend or append to information provided by the server.
63 The configuration file can also be preinitialized with addresses to
64 use on networks that don't have DHCP servers.
66 The timing behaviour of the client need not be configured by the user.
67 If no timing configuration is provided by the user, a fairly
68 reasonable timing behaviour will be used by default - one which
69 results in fairly timely updates without placing an inordinate load on
70 the server.
71 .PP
72 The following statements can be used to adjust the timing behaviour of
73 the DHCP client if required, however:
74 .PP
75 .I The
76 .B timeout
77 .I statement
78 .PP
79 .B timeout
80 .I time
81 .B ;
82 .PP
83 The
84 .I timeout
85 statement determines the amount of time that must pass between the
86 time that the client begins to try to determine its address and the
87 time that it decides that it's not going to be able to contact a
88 server.   By default, this timeout is sixty seconds.   After the
89 timeout has passed, if there are any static leases defined in the
90 configuration file, or any leases remaining in the lease database that
91 have not yet expired, the client will loop through these leases
92 attempting to validate them, and if it finds one that appears to be
93 valid, it will use that lease's address.   If there are no valid
94 static leases or unexpired leases in the lease database, the client
95 will restart the protocol after the defined retry interval.
96 .PP
97 .I The
98 .B retry
99 .I statement
100 .PP
101  \fBretry \fItime\fR\fB;\fR
102 .PP
103 The
104 .I retry
105 statement determines the time that must pass after the client has
106 determined that there is no DHCP server present before it tries again
107 to contact a DHCP server.   By default, this is five minutes.
108 .PP
109 .I The
110 .B select-timeout
111 .I statement
112 .PP
113  \fBselect-timeout \fItime\fR\fB;\fR
114 .PP
115 It is possible (some might say desirable) for there to be more than
116 one DHCP server serving any given network.   In this case, it is
117 possible that a client may be sent more than one offer in response to
118 its initial lease discovery message.   It may be that one of these
119 offers is preferable to the other (e.g., one offer may have the
120 address the client previously used, and the other may not).
121 .PP
122 The
123 .I select-timeout
124 is the time after the client sends its first lease discovery request
125 at which it stops waiting for offers from servers, assuming that it
126 has received at least one such offer.   If no offers have been
127 received by the time the
128 .I select-timeout
129 has expired, the client will accept the first offer that arrives.
130 .PP
131 By default, the select-timeout is zero seconds - that is, the client
132 will take the first offer it sees.
133 .PP
134 .I The
135 .B reboot
136 .I statement
137 .PP
138  \fBreboot \fItime\fR\fB;\fR
139 .PP
140 When the client is restarted, it first tries to reacquire the last
141 address it had.   This is called the INIT-REBOOT state.   If it is
142 still attached to the same network it was attached to when it last
143 ran, this is the quickest way to get started.   The
144 .I reboot
145 statement sets the time that must elapse after the client first tries
146 to reacquire its old address before it gives up and tries to discover
147 a new address.   By default, the reboot timeout is ten seconds.
148 .PP
149 .I The
150 .B backoff-cutoff
151 .I statement
152 .PP
153  \fBbackoff-cutoff \fItime\fR\fB;\fR
154 .PP
155 The client uses an exponential backoff algorithm with some randomness,
156 so that if many clients try to configure themselves at the same time,
157 they will not make their requests in lockstep.   The
158 .I backoff-cutoff
159 statement determines the maximum amount of time that the client is
160 allowed to back off.   It defaults to two minutes.
161 .PP
162 .I The
163 .B initial-interval
164 .I statement
165 .PP
166  \fBinitial-interval \fItime\fR\fB;\fR
167 .PP
168 The
169 .I initial-interval
170 statement sets the amount of time between the first attempt to reach a
171 server and the second attempt to reach a server.  Each time a message
172 is sent, the interval between messages is incremented by twice the
173 current interval multiplied by a random number between zero and one.
174 If it is greater than the backoff-cutoff amount, it is set to that
175 amount.  It defaults to ten seconds.
177 The DHCP protocol allows the client to request that the server send it
178 specific information, and not send it other information that it is not
179 prepared to accept.   The protocol also allows the client to reject
180 offers from servers if they don't contain information the client
181 needs, or if the information provided is not satisfactory.
182 .PP
183 There is a variety of data contained in offers that DHCP servers send
184 to DHCP clients.  The data that can be specifically requested is what
185 are called \fIDHCP Options\fR.  DHCP Options are defined in
186  \fBdhcp-options(5)\fR.
187 .PP
188 .I The
189 .B request
190 .I statement
191 .PP
192  \fBrequest [ \fIoption\fR ] [\fB,\fI ... \fIoption\fR ]\fB;\fR
193 .PP
194 The request statement causes the client to request that any server
195 responding to the client send the client its values for the specified
196 options.   Only the option names should be specified in the request
197 statement - not option parameters.   By default, the DHCP server
198 requests the subnet-mask, broadcast-address, time-offset, routers,
199 domain-name, domain-name-servers and host-name options. 
200 .PP
201 In some cases, it may be desirable to send no parameter request list
202 at all.   To do this, simply write the request statement but specify
203 no parameters:
204 .PP
205 .nf
206         request;
207 .fi
208 .PP
209 .I The
210 .B require
211 .I statement
212 .PP
213  \fBrequire [ \fIoption\fR ] [\fB,\fI ... \fIoption ]\fB;\fR
214 .PP
215 The require statement lists options that must be sent in order for an
216 offer to be accepted.   Offers that do not contain all the listed
217 options will be ignored.
218 .PP
219 .I The
220 .B send
221 .I statement
222 .PP
223  \fBsend { [ \fIoption declaration\fR ]
224 [\fB,\fI ... \fIoption declaration\fR ]\fB}\fR
225 .PP
226 The send statement causes the client to send the specified options to
227 the server with the specified values.  These are full option
228 declarations as described in \fBdhcp-options(5)\fR.  Options that are
229 always sent in the DHCP protocol should not be specified here, except
230 that the client can specify a \fBrequested-lease-time\fR option other
231 than the default requested lease time, which is two hours.  The other
232 obvious use for this statement is to send information to the server
233 that will allow it to differentiate between this client and other
234 clients or kinds of clients.
236 The client now has some very limited support for doing DNS updates
237 when a lease is acquired.   This is prototypical, and probably doesn't
238 do what you want.   It also only works if you happen to have control
239 over your DNS server, which isn't very likely.
240 .PP
241 To make it work, you have to declare a key and zone as in the DHCP
242 server (see \fBdhcpd.conf\fR(5) for details).   You also need to
243 configure the fqdn option on the client, as follows:
244 .PP
245 .nf
246   send fqdn.fqdn "";
247   send fqdn.encoded on;
248   send fqdn.server-update off;
249 .fi
250 .PP
251 The \fIfqdn.fqdn\fR option \fBMUST\fR be a fully-qualified domain
252 name.   You \fBMUST\fR define a zone statement for the zone to be
253 updated.   The \fIfqdn.encoded\fR option may need to be set to
254 \fIon\fR or \fIoff\fR, depending on the DHCP server you are using.
255 .PP
256 .I The
257 .B do-forward-updates
258 .I statement
259 .PP
260  \fBdo-forward-updates [ \fIflag\fR ] \fB;\fR
261 .PP
262 If you want to do DNS updates in the DHCP client
263 script (see \fBdhclient-script(8)\fR) rather than having the
264 DHCP client do the update directly (for example, if you want to
265 use SIG(0) authentication, which is not supported directly by the
266 DHCP client, you can instruct the client not to do the update using
267 the \fBdo-forward-updates\fR statement.   \fIFlag\fR should be \fBtrue\fR
268 if you want the DHCP client to do the update, and \fBfalse\fR if
269 you don't want the DHCP client to do the update.   By default, the DHCP
270 client will do the DNS update.
272 In some cases, a client may receive option data from the server which
273 is not really appropriate for that client, or may not receive
274 information that it needs, and for which a useful default value
275 exists.   It may also receive information which is useful, but which
276 needs to be supplemented with local information.   To handle these
277 needs, several option modifiers are available.
278 .PP
279 .I The
280 .B default
281 .I statement
282 .PP
283  \fBdefault [ \fIoption declaration\fR ] \fB;\fR
284 .PP
285 If for some option the client should use the value supplied by
286 the server, but needs to use some default value if no value was supplied
287 by the server, these values can be defined in the
288 .B default
289 statement.
290 .PP
291 .I The
292 .B supersede
293 .I statement
294 .PP
295  \fBsupersede [ \fIoption declaration\fR ] \fB;\fR
296 .PP
297 If for some option the client should always use a locally-configured
298 value or values rather than whatever is supplied by the server, these
299 values can be defined in the 
300 .B supersede
301 statement.
302 .PP
303 .I The
304 .B prepend
305 .I statement
306 .PP
307  \fBprepend [ \fIoption declaration\fR ] \fB;\fR
308 .PP
309 If for some set of options the client should use a value you
310 supply, and then use the values supplied by
311 the server, if any, these values can be defined in the
312 .B prepend
313 statement.   The
314 .B prepend
315 statement can only be used for options which
316 allow more than one value to be given.   This restriction is not
317 enforced - if you ignore it, the behaviour will be unpredictable.
318 .PP
319 .I The
320 .B append
321 .I statement
322 .PP
323  \fBappend [ \fIoption declaration\fR ] \fB;\fR
324 .PP
325 If for some set of options the client should first use the values
326 supplied by the server, if any, and then use values you supply, these
327 values can be defined in the
328 .B append
329 statement.   The
330 .B append
331 statement can only be used for options which
332 allow more than one value to be given.   This restriction is not
333 enforced - if you ignore it, the behaviour will be unpredictable.
335 .PP
336 .I The
337 .B lease
338 .I declaration
339 .PP
340  \fBlease {\fR \fIlease-declaration\fR [ ... \fIlease-declaration ] \fB}\fR
341 .PP
342 The DHCP client may decide after some period of time (see \fBPROTOCOL
343 TIMING\fR) that it is not going to succeed in contacting a
344 server.   At that time, it consults its own database of old leases and
345 tests each one that has not yet timed out by pinging the listed router
346 for that lease to see if that lease could work.   It is possible to
347 define one or more \fIfixed\fR leases in the client configuration file
348 for networks where there is no DHCP or BOOTP service, so that the
349 client can still automatically configure its address.   This is done
350 with the
351 .B lease
352 statement.
353 .PP
354 NOTE: the lease statement is also used in the dhclient.leases file in
355 order to record leases that have been received from DHCP servers.
356 Some of the syntax for leases as described below is only needed in the
357 dhclient.leases file.   Such syntax is documented here for
358 completeness.
359 .PP
360 A lease statement consists of the lease keyword, followed by a left
361 curly brace, followed by one or more lease declaration statements,
362 followed by a right curly brace.   The following lease declarations
363 are possible:
364 .PP
365  \fBbootp;\fR
366 .PP
367 The
368 .B bootp
369 statement is used to indicate that the lease was acquired using the
370 BOOTP protocol rather than the DHCP protocol.   It is never necessary
371 to specify this in the client configuration file.   The client uses
372 this syntax in its lease database file.
373 .PP
374  \fBinterface\fR \fB"\fR\fIstring\fR\fB";\fR
375 .PP
376 The
377 .B interface
378 lease statement is used to indicate the interface on which the lease
379 is valid.   If set, this lease will only be tried on a particular
380 interface.   When the client receives a lease from a server, it always
381 records the interface number on which it received that lease.
382 If predefined leases are specified in the dhclient.conf file, the
383 interface should also be specified, although this is not required.
384 .PP
385  \fBfixed-address\fR \fIip-address\fR\fB;\fR
386 .PP
387 The
388 .B fixed-address
389 statement is used to set the ip address of a particular lease.   This
390 is required for all lease statements.   The IP address must be
391 specified as a dotted quad (e.g.,
392 .PP
393  \fBfilename "\fR\fIstring\fR\fB";\fR
394 .PP
395 The
396 .B filename
397 statement specifies the name of the boot filename to use.   This is
398 not used by the standard client configuration script, but is included
399 for completeness.
400 .PP
401  \fBserver-name "\fR\fIstring\fR\fB";\fR
402 .PP
403 The
404 .B server-name
405 statement specifies the name of the boot server name to use.   This is
406 also not used by the standard client configuration script.
407 .PP
408  \fBoption\fR \fIoption-declaration\fR\fB;\fR
409 .PP
410 The
411 .B option
412 statement is used to specify the value of an option supplied by the
413 server, or, in the case of predefined leases declared in
414 dhclient.conf, the value that the user wishes the client configuration
415 script to use if the predefined lease is used.
416 .PP
417  \fBscript "\fIscript-name\fB";\fR
418 .PP
419 The
420 .B script
421 statement is used to specify the pathname of the dhcp client
422 configuration script.  This script is used by the dhcp client to set
423 each interface's initial configuration prior to requesting an address,
424 to test the address once it has been offered, and to set the
425 interface's final configuration once a lease has been acquired.   If
426 no lease is acquired, the script is used to test predefined leases, if
427 any, and also called once if no valid lease can be identified.   For
428 more information, see
429 .B dhclient-script(8).
430 .PP
431  \fBvendor option space "\fIname\fB";\fR
432 .PP
433 The
434 .B vendor option space
435 statement is used to specify which option space should be used for
436 decoding the vendor-encapsulate-options option if one is received.
437 The \fIdhcp-vendor-identifier\fR can be used to request a specific
438 class of vendor options from the server.   See
439 .B dhcp-options(5)
440 for details.
441 .PP
442  \fBmedium "\fImedia setup\fB";\fR
443 .PP
444 The
445 .B medium
446 statement can be used on systems where network interfaces cannot
447 automatically determine the type of network to which they are
448 connected.  The media setup string is a system-dependent parameter
449 which is passed to the dhcp client configuration script when
450 initializing the interface.  On Unix and Unix-like systems, the
451 argument is passed on the ifconfig command line when configuring te
452 interface.
453 .PP
454 The dhcp client automatically declares this parameter if it uses a
455 media type (see the
456 .B media
457 statement) when configuring the interface in order to obtain a lease.
458 This statement should be used in predefined leases only if the network
459 interface requires media type configuration.
460 .PP
461  \fBrenew\fR \fIdate\fB;\fR
462 .PP
463  \fBrebind\fR \fIdate\fB;\fR
464 .PP
465  \fBexpire\fR \fIdate\fB;\fR
466 .PP
467 The \fBrenew\fR statement defines the time at which the dhcp client
468 should begin trying to contact its server to renew a lease that it is
469 using.   The \fBrebind\fR statement defines the time at which the dhcp
470 client should begin to try to contact \fIany\fR dhcp server in order
471 to renew its lease.   The \fBexpire\fR statement defines the time at
472 which the dhcp client must stop using a lease if it has not been able
473 to contact a server in order to renew it.
474 .PP
475 These declarations are automatically set in leases acquired by the
476 DHCP client, but must also be configured in predefined leases - a
477 predefined lease whose expiry time has passed will not be used by the
478 DHCP client.
479 .PP
480 Dates are specified as follows:
481 .PP
482  \fI<weekday> <year>\fB/\fI<month>\fB/\fI<day>
483 <hour>\fB:\fI<minute>\fB:\fI<second>\fR
484 .PP
485 The weekday is present to make it easy for a human to tell when a
486 lease expires - it's specified as a number from zero to six, with zero
487 being Sunday.  When declaring a predefined lease, it can always be
488 specified as zero.  The year is specified with the century, so it
489 should generally be four digits except for really long leases.  The
490 month is specified as a number starting with 1 for January.  The day
491 of the month is likewise specified starting with 1.  The hour is a
492 number between 0 and 23, the minute a number between 0 and 59, and the
493 second also a number between 0 and 59.
495  \fBalias { \fI declarations ... \fB}\fR
496 .PP
497 Some DHCP clients running TCP/IP roaming protocols may require that in
498 addition to the lease they may acquire via DHCP, their interface also
499 be configured with a predefined IP alias so that they can have a
500 permanent IP address even while roaming.   The Internet Software
501 Consortium DHCP client doesn't support roaming with fixed addresses
502 directly, but in order to facilitate such experimentation, the dhcp
503 client can be set up to configure an IP alias using the
504 .B alias
505 declaration.
506 .PP
507 The alias declaration resembles a lease declaration, except that
508 options other than the subnet-mask option are ignored by the standard
509 client configuration script, and expiry times are ignored.  A typical
510 alias declaration includes an interface declaration, a fixed-address
511 declaration for the IP alias address, and a subnet-mask option
512 declaration.   A medium statement should never be included in an alias
513 declaration.
515  \fBreject \fIip-address\fB;\fR
516 .PP
517 The
518 .B reject
519 statement causes the DHCP client to reject offers from
520 servers who use the specified address as a server identifier.   This
521 can be used to avoid being configured by rogue or misconfigured dhcp
522 servers, although it should be a last resort - better to track down
523 the bad DHCP server and fix it.
524 .PP
525  \fBinterface "\fIname\fB" { \fIdeclarations ... \fB }
526 .PP
527 A client with more than one network interface may require different
528 behaviour depending on which interface is being configured.   All
529 timing parameters and declarations other than lease and alias
530 declarations can be enclosed in an interface declaration, and those
531 parameters will then be used only for the interface that matches the
532 specified name.   Interfaces for which there is no interface
533 declaration will use the parameters declared outside of any interface
534 declaration, or the default settings.
535 .PP
536  \fBpseudo "\fIname\fR" "\fIreal-name\fB" { \fIdeclarations ... \fB }
537 .PP
538 Under some circumstances it can be useful to declare a pseudo-interface 
539 and have the DHCP client acquire a configuration for that interface.
540 Each interface that the DHCP client is supporting normally has a DHCP
541 client state machine running on it to acquire and maintain its lease.
542 A pseudo-interface is just another state machine running on the
543 interface named \fIreal-name\fR, with its own lease and its own
544 state.   If you use this feature, you must provide a client identifier
545 for both the pseudo-interface and the actual interface, and the two
546 identifiers must be different.   You must also provide a separate
547 client script for the pseudo-interface to do what you want with the IP
548 address.   For example:
549 .PP
550 .nf
551         interface "ep0" {
552                 send dhcp-client-identifier "my-client-ep0";
553         }
554         pseudo "secondary" "ep0" {
555                 send dhcp-client-identifier "my-client-ep0-secondary";
556                 script "/etc/dhclient-secondary";
557         }
558 .fi
559 .PP
560 The client script for the pseudo-interface should not configure the
561 interface up or down - essentially, all it needs to handle are the
562 states where a lease has been acquired or renewed, and the states
563 where a lease has expired.   See \fBdhclient-script(8)\fR for more
564 information.
565 .PP
566  \fBmedia "\fImedia setup\fB"\fI [ \fB, "\fImedia setup\fB", \fI... ]\fB;\fR
567 .PP
568 The
569 .B media
570 statement defines one or more media configuration parameters which may
571 be tried while attempting to acquire an IP address.   The dhcp client
572 will cycle through each media setup string on the list, configuring
573 the interface using that setup and attempting to boot, and then trying
574 the next one.   This can be used for network interfaces which aren't
575 capable of sensing the media type unaided - whichever media type
576 succeeds in getting a request to the server and hearing the reply is
577 probably right (no guarantees).
578 .PP
579 The media setup is only used for the initial phase of address
580 acquisition (the DHCPDISCOVER and DHCPOFFER packets).   Once an
581 address has been acquired, the dhcp client will record it in its lease
582 database and will record the media type used to acquire the address.
583 Whenever the client tries to renew the lease, it will use that same
584 media type.   The lease must expire before the client will go back to
585 cycling through media types.
587 The following configuration file is used on a laptop running NetBSD
588 1.3.   The laptop has an IP alias of, and has one
589 interface, ep0 (a 3com 3C589C).   Booting intervals have been
590 shortened somewhat from the default, because the client is known to
591 spend most of its time on networks with little DHCP activity.   The
592 laptop does roam to multiple networks.
594 .nf
596 timeout 60;
597 retry 60;
598 reboot 10;
599 select-timeout 5;
600 initial-interval 2;
601 reject;
603 interface "ep0" {
604     send host-name "";
605     send dhcp-client-identifier 1:0:a0:24:ab:fb:9c;
606     send dhcp-lease-time 3600;
607     supersede domain-name "";
608     prepend domain-name-servers;
609     request subnet-mask, broadcast-address, time-offset, routers,
610             domain-name, domain-name-servers, host-name;
611     require subnet-mask, domain-name-servers;
612     script "CLIENTBINDIR/dhclient-script";
613     media "media 10baseT/UTP", "media 10base2/BNC";
614 }
616 alias {
617   interface "ep0";
618   fixed-address;
619   option subnet-mask;
620 }
621 .fi
622 This is a very complicated dhclient.conf file - in general, yours
623 should be much simpler.   In many cases, it's sufficient to just
624 create an empty dhclient.conf file - the defaults are usually fine.
626 dhcp-options(5), dhclient.leases(5), dhclient(8), RFC2132,
627 RFC2131.
629 .B dhclient(8)
630 was written by Ted Lemon
631 under a contract with Vixie Labs.   Funding
632 for this project was provided by the Internet Software Consortium.
633 Information about the Internet Software Consortium can be found at
634 .B