bfa7c04a88af2dc259d48b5a93518398e028f545
[dragonfly.git] / sbin / dhclient / dhcp-options.5
1 .\"     $OpenBSD: dhcp-options.5,v 1.8 2007/05/31 19:19:43 jmc Exp $
2 .\"     $DragonFly: src/sbin/dhclient/dhcp-options.5,v 1.1 2008/08/30 16:07:58 hasso Exp $
3 .\"
4 .\" Copyright (c) 1995, 1996, 1997, 1998 The Internet Software Consortium.
5 .\" All rights reserved.
6 .\"
7 .\" Redistribution and use in source and binary forms, with or without
8 .\" modification, are permitted provided that the following conditions
9 .\" are met:
10 .\"
11 .\" 1. Redistributions of source code must retain the above copyright
12 .\"    notice, this list of conditions and the following disclaimer.
13 .\" 2. Redistributions in binary form must reproduce the above copyright
14 .\"    notice, this list of conditions and the following disclaimer in the
15 .\"    documentation and/or other materials provided with the distribution.
16 .\" 3. Neither the name of The Internet Software Consortium nor the names
17 .\"    of its contributors may be used to endorse or promote products derived
18 .\"    from this software without specific prior written permission.
19 .\"
20 .\" THIS SOFTWARE IS PROVIDED BY THE INTERNET SOFTWARE CONSORTIUM AND
21 .\" CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
22 .\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
23 .\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
24 .\" DISCLAIMED.  IN NO EVENT SHALL THE INTERNET SOFTWARE CONSORTIUM OR
25 .\" CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26 .\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27 .\" LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
28 .\" USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
29 .\" ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
30 .\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
31 .\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 .\" SUCH DAMAGE.
33 .\"
34 .\" This software has been written for the Internet Software Consortium
35 .\" by Ted Lemon <mellon@fugue.com> in cooperation with Vixie
36 .\" Enterprises.  To learn more about the Internet Software Consortium,
37 .\" see ``http://www.isc.org/isc''.  To learn more about Vixie
38 .\" Enterprises, see ``http://www.vix.com''.
39 .\"
40 .Dd $Mdocdate$
41 .Dt DHCP-OPTIONS 5
42 .Os
43 .Sh NAME
44 .Nm dhcp-options
45 .Nd Dynamic Host Configuration Protocol options
46 .Sh DESCRIPTION
47 The Dynamic Host Configuration protocol allows the client to receive
48 .Ic options
49 from the DHCP server describing the network configuration and various
50 services that are available on the network.
51 When configuring
52 .Xr dhcpd 8
53 or
54 .Xr dhclient 8 ,
55 options must often be declared.
56 The syntax for declaring options, and the names and formats of the options
57 that can be declared, are documented here.
58 .Sh REFERENCE: OPTION STATEMENTS
59 DHCP
60 .Ic option
61 statements always start with the
62 .Ic option
63 keyword, followed by an option name, followed by option data.
64 The option names and data formats are described below.
65 It is not necessary to exhaustively specify all DHCP options \-
66 only those options which are needed by clients must be specified.
67 .Pp
68 Option data comes in a variety of formats, as defined below:
69 .Pp
70 The
71 .Ar ip-address
72 data type can be entered either as an explicit IP address
73 (e.g., 239.254.197.10) or as a domain name (e.g., haagen.isc.org).
74 A domain name must resolve to a single IP address.
75 .Pp
76 The
77 .Ar int32
78 data type specifies a signed 32-bit integer.
79 The
80 .Ar uint32
81 data type specifies an unsigned 32-bit integer.
82 The
83 .Ar int16
84 and
85 .Ar uint16
86 data types specify signed and unsigned 16-bit integers.
87 The
88 .Ar int8
89 and
90 .Ar uint8
91 data types specify signed and unsigned 8-bit integers.
92 Unsigned 8-bit integers are also sometimes referred to as octets.
93 .Pp
94 The
95 .Ar string
96 data type specifies an
97 .Tn NVT
98 .Pq Network Virtual Terminal
99 .Tn ASCII
100 string, which must be enclosed in double quotes \- for example,
101 to specify a domain-name option, the syntax would be
102 .Pp
103 .Dl option domain-name \&"isc.org\&";
104 .Pp
105 The
106 .Ar flag
107 data type specifies a boolean value.
108 Booleans can be either true or false
109 (or on or off, if that makes more sense to you).
110 .Pp
111 The
112 .Ar data-string
113 data type specifies either an
114 .Tn NVT ASCII
115 string enclosed in double quotes, or a series of octets specified in
116 hexadecimal, separated by colons.
117 For example:
118 .Pp
119 .Dl option dhcp-client-identifier \&"CLIENT-FOO\&";
120 or
121 .Dl option dhcp-client-identifier 43:4c:49:45:54:2d:46:4f:4f;
122 .Pp
123 The documentation for the various options mentioned below is taken
124 from the IETF draft document on DHCP options, RFC 2132.
125 Options which are not listed by name may be defined by the name
126 .Pf option\- Ns Ar nnn ,
127 where
128 .Ar nnn
129 is the decimal number of the option code.
130 These options may be followed either by a string, enclosed in quotes, or by
131 a series of octets, expressed as two-digit hexadecimal numbers separated
132 by colons.
133 For example:
134 .Bd -literal -offset indent
135 option option-133 "my-option-133-text";
136 option option-129 1:54:c9:2b:47;
137 .Ed
138 .Pp
139 Because
140 .Xr dhcpd 8
141 does not know the format of these undefined option codes,
142 no checking is done to ensure the correctness of the entered data.
143 .Pp
144 The standard options are:
145 .Ss RFC 1497 Vendor Extensions
146 .Bl -tag -width Ds
147 .It Ic option subnet-mask Ar ip-address ;
148 The
149 .Ic subnet-mask
150 option specifies the client's subnet mask as per RFC 950.
151 If no subnet-mask option is provided anywhere in scope, as a last resort
152 .Xr dhcpd 8
153 will use the subnet mask from the subnet declaration for the network on
154 which an address is being assigned.
155 However,
156 .Em any
157 subnet-mask option declaration that is in scope for the address being
158 assigned will override the subnet mask specified in the subnet declaration.
159 .It Ic option time-offset Ar int32 ;
160 The
161 .Ic time-offset
162 option specifies the offset of the client's subnet in seconds from
163 Coordinated Universal Time (UTC).
164 .It Xo
165 .Ic option routers Ar ip-address
166 .Oo , Ar ip-address ... Oc ;
167 .Xc
168 The
169 .Ic routers
170 option specifies a list of IP addresses for routers on the client's subnet.
171 Routers should be listed in order of preference.
172 .It Xo
173 .Ic option time-servers Ar ip-address
174 .Oo , Ar ip-address ... Oc ;
175 .Xc
176 The
177 .Ic time-server
178 option specifies a list of RFC 868 time servers available to the client.
179 Servers should be listed in order of preference.
180 .It Xo
181 .Ic option ien116-name-servers Ar ip-address
182 .Oo , Ar ip-address ... Oc ;
183 .Xc
184 The
185 .Ic ien116-name-servers
186 option specifies a list of IEN 116 name servers available to the client.
187 Servers should be listed in order of preference.
188 .It Xo
189 .Ic option domain-name-servers Ar ip-address
190 .Oo , Ar ip-address ... Oc ;
191 .Xc
192 The
193 .Ic domain-name-servers
194 option specifies a list of Domain Name System (STD 13, RFC 1035) name servers
195 available to the client.
196 Servers should be listed in order of preference.
197 .It Xo
198 .Ic option log-servers Ar ip-address
199 .Oo , Ar ip-address ... Oc ;
200 .Xc
201 The
202 .Ic log-servers
203 option specifies a list of MIT-LCS UDP log servers available to the client.
204 Servers should be listed in order of preference.
205 .It Xo
206 .Ic option cookie-servers Ar ip-address
207 .Oo , Ar ip-address ... Oc ;
208 .Xc
209 The
210 .Ic cookie-servers
211 option specifies a list of RFC 865 cookie servers available to the client.
212 Servers should be listed in order of preference.
213 .It Xo
214 .Ic option lpr-servers Ar ip-address
215 .Oo , Ar ip-address ... Oc ;
216 .Xc
217 The
218 .Ic lpr-servers
219 option specifies a list of RFC 1179 line printer servers available to the
220 client.
221 Servers should be listed in order of preference.
222 .It Xo
223 .Ic option impress-servers Ar ip-address
224 .Oo , Ar ip-address ... Oc ;
225 .Xc
226 The
227 .Ic impress-servers
228 option specifies a list of Imagen Impress servers available to the client.
229 Servers should be listed in order of preference.
230 .It Xo
231 .Ic option resource-location-servers Ar ip-address
232 .Oo , Ar ip-address ... Oc ;
233 .Xc
234 This option specifies a list of RFC 887 Resource Location servers available
235 to the client.
236 Servers should be listed in order of preference.
237 .It Ic option host-name Ar string ;
238 This option specifies the name of the client.
239 The name may or may not be qualified with the local domain name
240 (it is preferable to use the
241 .Ic domain-name
242 option to specify the domain name).
243 See RFC 1035 for character set restrictions.
244 .It Ic option boot-size Ar uint16 ;
245 This option specifies the length in 512-octet blocks of the default
246 boot image for the client.
247 .It Ic option merit-dump Ar string ;
248 This option specifies the pathname of a file to which the client's
249 core image should be dumped in the event the client crashes.
250 The path is formatted as a character string consisting of characters from
251 the
252 .Tn NVT ASCII
253 character set.
254 .It Ic option domain-name Ar string ;
255 This option specifies the domain name that the client should use when
256 resolving hostnames via the Domain Name System.
257 .It Ic option swap-server Ar ip-address ;
258 This specifies the IP address of the client's swap server.
259 .It Ic option root-path Ar string ;
260 This option specifies the pathname that contains the client's root disk.
261 The path is formatted as a character string consisting of characters from
262 the
263 .Tn NVT ASCII
264 character set.
265 .El
266 .Ss IP Layer Parameters per Host
267 .Bl -tag -width Ds
268 .It Ic option ip-forwarding Ar flag ;
269 This option specifies whether the client should configure its IP layer
270 for packet forwarding.
271 A value of 0 means disable IP forwarding, and a value of 1 means enable
272 IP forwarding.
273 .It Ic option non-local-source-routing Ar flag ;
274 This option specifies whether the client should configure its IP
275 layer to allow forwarding of datagrams with non-local source routes
276 (see Section 3.3.5 of [4] for a discussion of this topic).
277 A value of 0 means disallow forwarding of such datagrams, and a value of 1
278 means allow forwarding.
279 .It Xo
280 .Ic option policy-filter Ar ip-address ip-address
281 .Oo , Ar ip-address ip-address ... Oc ;
282 .Xc
283 This option specifies policy filters for non-local source routing.
284 The filters consist of a list of IP addresses and masks which specify
285 destination/mask pairs with which to filter incoming source routes.
286 .Pp
287 Any source-routed datagram whose next-hop address does not match one
288 of the filters should be discarded by the client.
289 .Pp
290 See STD 3 (RFC 1122) for further information.
291 .It Ic option max-dgram-reassembly Ar uint16 ;
292 This option specifies the maximum size datagram that the client should be
293 prepared to reassemble.
294 The minimum legal value is 576.
295 .It Ic option default-ip-ttl Ar uint8 ;
296 This option specifies the default time-to-live that the client should
297 use on outgoing datagrams.
298 .It Ic option path-mtu-aging-timeout Ar uint32 ;
299 This option specifies the timeout (in seconds) to use when aging Path
300 MTU values discovered by the mechanism defined in RFC 1191.
301 .It Xo
302 .Ic option path-mtu-plateau-table Ar uint16
303 .Oo , Ar uint16 ... Oc ;
304 .Xc
305 This option specifies a table of MTU sizes to use when performing
306 Path MTU Discovery as defined in RFC 1191.
307 The table is formatted as a list of 16-bit unsigned integers,
308 ordered from smallest to largest.
309 The minimum MTU value cannot be smaller than 68.
310 .El
311 .Ss IP Layer Parameters per Interface
312 .Bl -tag -width Ds
313 .It Ic option interface-mtu Ar uint16 ;
314 This option specifies the MTU to use on this interface.
315 The minimum legal value for the MTU is 68.
316 .It Ic option all-subnets-local Ar flag ;
317 This option specifies whether or not the client may assume that all subnets
318 of the IP network to which the client is connected use the same MTU as the
319 subnet of that network to which the client is directly connected.
320 A value of 1 indicates that all subnets share the same MTU.
321 A value of 0 means that the client should assume that some subnets of the
322 directly connected network may have smaller MTUs.
323 .It Ic option broadcast-address Ar ip-address ;
324 This option specifies the broadcast address in use on the client's subnet.
325 Legal values for broadcast addresses are specified in section 3.2.1.3 of
326 STD 3 (RFC 1122).
327 .It Ic option perform-mask-discovery Ar flag ;
328 This option specifies whether or not the client should perform subnet mask
329 discovery using ICMP.
330 A value of 0 indicates that the client should not perform mask discovery.
331 A value of 1 means that the client should perform mask discovery.
332 .It Ic option mask-supplier Ar flag ;
333 This option specifies whether or not the client should respond to subnet mask
334 requests using ICMP.
335 A value of 0 indicates that the client should not respond.
336 A value of 1 means that the client should respond.
337 .It Ic option router-discovery Ar flag ;
338 This option specifies whether or not the client should solicit routers using
339 the Router Discovery mechanism defined in RFC 1256.
340 A value of 0 indicates that the client should not perform router discovery.
341 A value of 1 means that the client should perform router discovery.
342 .It Ic option router-solicitation-address Ar ip-address ;
343 This option specifies the address to which the client should transmit
344 router solicitation requests.
345 .It Xo
346 .Ic option static-routes Ar ip-address ip-address
347 .Oo , Ar ip-address ip-address ... Oc ;
348 .Xc
349 This option specifies a list of static routes that the client should
350 install in its routing cache.
351 If multiple routes to the same destination are specified, they are listed
352 in descending order of priority.
353 .Pp
354 The routes consist of a list of IP address pairs.
355 The first address is the destination address,
356 and the second address is the router for the destination.
357 .Pp
358 The default route (0.0.0.0) is an illegal destination for a static route.
359 To specify the default route, use the
360 .Ic routers
361 option.
362 .El
363 .Ss Link Layer Parameters per Interface
364 .Bl -tag -width Ds
365 .It Ic option trailer-encapsulation Ar flag ;
366 This option specifies whether or not the client should negotiate the
367 use of trailers (RFC 893 [14]) when using the ARP protocol.
368 A value of 0 indicates that the client should not attempt to use trailers.
369 A value of 1 means that the client should attempt to use trailers.
370 .It Ic option arp-cache-timeout Ar uint32 ;
371 This option specifies the timeout in seconds for ARP cache entries.
372 .It Ic option ieee802-3-encapsulation Ar flag ;
373 This option specifies whether or not the client should use Ethernet
374 Version 2 (RFC 894) or IEEE 802.3 (RFC 1042) encapsulation if the
375 interface is an Ethernet.
376 A value of 0 indicates that the client should use RFC 894 encapsulation.
377 A value of 1 means that the client should use RFC 1042 encapsulation.
378 .El
379 .Ss TCP Parameters
380 .Bl -tag -width Ds
381 .It Ic option default-tcp-ttl Ar uint8 ;
382 This option specifies the default TTL that the client should use when
383 sending TCP segments.
384 The minimum value is 1.
385 .It Ic option tcp-keepalive-interval Ar uint32 ;
386 This option specifies the interval (in seconds) that the client TCP
387 should wait before sending a keepalive message on a TCP connection.
388 The time is specified as a 32-bit unsigned integer.
389 A value of zero indicates that the client should not generate keepalive
390 messages on connections unless specifically requested by an application.
391 .It Ic option tcp-keepalive-garbage Ar flag ;
392 This option specifies whether or not the client should send TCP keepalive
393 messages with an octet of garbage for compatibility with older implementations.
394 A value of 0 indicates that a garbage octet should not be sent.
395 A value of 1 indicates that a garbage octet should be sent.
396 .El
397 .Ss Application and Service Parameters
398 .Bl -tag -width Ds
399 .It Ic option nis-domain Ar string ;
400 This option specifies the name of the client's NIS (Sun Network Information
401 Services) domain.
402 The domain is formatted as a character string consisting of characters
403 from the
404 .Tn NVT ASCII
405 character set.
406 .It Xo
407 .Ic option nis-servers Ar ip-address
408 .Oo , Ar ip-address ... Oc ;
409 .Xc
410 This option specifies a list of IP addresses indicating NIS servers
411 available to the client.
412 Servers should be listed in order of preference.
413 .It Xo
414 .Ic option ntp-servers Ar ip-address
415 .Oo , Ar ip-address ... Oc ;
416 .Xc
417 This option specifies a list of IP addresses indicating NTP (RFC 1305)
418 servers available to the client.
419 Servers should be listed in order of preference.
420 .It Xo
421 .Ic option netbios-name-servers Ar ip-address
422 .Oo , Ar ip-address ... Oc ;
423 .Xc
424 The NetBIOS name server (NBNS) option specifies a list of RFC 1001/1002
425 NBNS name servers listed in order of preference.
426 NetBIOS Name Service is currently more commonly referred to as WINS.
427 WINS servers can be specified using the
428 .Ic netbios-name-servers
429 option.
430 .It Xo
431 .Ic option netbios-dd-server Ar ip-address
432 .Oo , Ar ip-address ... Oc ;
433 .Xc
434 The NetBIOS datagram distribution server (NBDD) option specifies a
435 list of RFC 1001/1002 NBDD servers listed in order of preference.
436 .It Ic option netbios-node-type Ar uint8 ;
437 The NetBIOS node type option allows NetBIOS over TCP/IP clients which
438 are configurable to be configured as described in RFC 1001/1002.
439 The value is specified as a single octet which identifies the client type.
440 .Pp
441 Possible node types are:
442 .Bl -tag -width Ds
443 .It 1
444 B-node: Broadcast - no WINS
445 .It 2
446 P-node: Peer - WINS only
447 .It 4
448 M-node: Mixed - broadcast, then WINS
449 .It 8
450 H-node: Hybrid - WINS, then broadcast
451 .El
452 .It Ic option netbios-scope Ar string ;
453 The NetBIOS scope option specifies the NetBIOS over TCP/IP scope
454 parameter for the client as specified in RFC 1001/1002.
455 See RFC 1001, RFC 1002, and RFC 1035 for character-set restrictions.
456 .It Xo
457 .Ic option font-servers Ar ip-address
458 .Oo , Ar ip-address ... Oc ;
459 .Xc
460 This option specifies a list of X Window System Font servers available
461 to the client.
462 Servers should be listed in order of preference.
463 .It Xo
464 .Ic option x-display-manager Ar ip-address
465 .Oo , Ar ip-address ... Oc ;
466 .Xc
467 This option specifies a list of systems that are running the X Window
468 System Display Manager and are available to the client.
469 Addresses should be listed in order of preference.
470 .It Ic option dhcp-client-identifier Ar data-string ;
471 This option can be used to specify a DHCP client identifier in a
472 host declaration, so that
473 .Xr dhcpd 8
474 can find the host record by matching against the client identifier.
475 .It Ic option nisplus-domain Ar string ;
476 This option specifies the name of the client's NIS+ domain.
477 The domain is formatted as a character string consisting of characters
478 from the
479 .Tn NVT ASCII
480 character set.
481 .It Xo
482 .Ic option nisplus-servers Ar ip-address
483 .Oo , Ar ip-address ... Oc ;
484 .Xc
485 This option specifies a list of IP addresses indicating NIS+ servers
486 available to the client.
487 Servers should be listed in order of preference.
488 .It Ic option tftp-server-name Ar string ;
489 This option is used to identify a TFTP server and, if supported by the
490 client, should have the same effect as the
491 .Ic server-name
492 declaration.
493 BOOTP clients are unlikely to support this option.
494 Some DHCP clients will support it, and others actually require it.
495 .It Ic option bootfile-name Ar string ;
496 This option is used to identify a bootstrap file.
497 If supported by the client, it should have the same effect as the
498 .Ic filename
499 declaration.
500 BOOTP clients are unlikely to support this option.
501 Some DHCP clients will support it, and others actually require it.
502 .It Xo
503 .Ic option mobile-ip-home-agent Ar ip-address
504 .Oo , Ar ip-address ... Oc ;
505 .Xc
506 This option specifies a list of IP addresses indicating mobile IP
507 home agents available to the client.
508 Agents should be listed in order of preference, although normally there
509 will be only one such agent.
510 .It Xo
511 .Ic option smtp-server Ar ip-address
512 .Oo , Ar ip-address ... Oc ;
513 .Xc
514 The
515 .Ic smtp-server
516 option specifies a list of SMTP servers available to the client.
517 Servers should be listed in order of preference.
518 .It Xo
519 .Ic option pop-server Ar ip-address
520 .Oo , Ar ip-address ... Oc ;
521 .Xc
522 The
523 .Ic pop-server
524 option specifies a list of POP3 servers available to the client.
525 Servers should be listed in order of preference.
526 .It Xo
527 .Ic option nntp-server Ar ip-address
528 .Oo , Ar ip-address ... Oc ;
529 .Xc
530 The
531 .Ic nntp-server
532 option specifies a list of NNTP servers available to the client.
533 Servers should be listed in order of preference.
534 .It Xo
535 .Ic option www-server Ar ip-address
536 .Oo , Ar ip-address ... Oc ;
537 .Xc
538 The
539 .Ic www-server
540 option specifies a list of WWW servers available to the client.
541 Servers should be listed in order of preference.
542 .It Xo
543 .Ic option finger-server Ar ip-address
544 .Oo , Ar ip-address ... Oc ;
545 .Xc
546 The
547 .Ic finger-server
548 option specifies a list of
549 .Xr finger 1
550 servers available to the client.
551 Servers should be listed in order of preference.
552 .It Xo
553 .Ic option irc-server Ar ip-address
554 .Oo , Ar ip-address ... Oc ;
555 .Xc
556 The
557 .Ic irc-server
558 option specifies a list of IRC servers available to the client.
559 Servers should be listed in order of preference.
560 .It Xo
561 .Ic option streettalk-server Ar ip-address
562 .Oo , Ar ip-address ... Oc ;
563 .Xc
564 The
565 .Ic streettalk-server
566 option specifies a list of StreetTalk servers available to the client.
567 Servers should be listed in order of preference.
568 .It Xo
569 .Ic option streettalk-directory-assistance-server Ar ip-address
570 .Oo , Ar ip-address ... Oc ;
571 .Xc
572 The StreetTalk Directory Assistance (STDA) server option specifies a
573 list of STDA servers available to the client.
574 Servers should be listed in order of preference.
575 .El
576 .Sh SEE ALSO
577 .Xr dhclient.conf 5 ,
578 .Xr dhcpd.conf 5 ,
579 .Xr dhcpd.leases 5 ,
580 .Xr dhclient 8 ,
581 .Xr dhcpd 8
582 .Pp
583 RFC 2131, RFC 2132.
584 .Sh AUTHORS
585 .An -nosplit
586 .Xr dhcpd 8
587 was written by
588 .An Ted Lemon Aq mellon@vix.com
589 under a contract with Vixie Labs.
590 .Pp
591 The current implementation was reworked by
592 .An Henning Brauer Aq henning@openbsd.org .