Merge commit 'b31ca922c7346747131aed07c0c171ec2f573aac' into merges
[unleashed.git] / share / man / man4 / dhcp_inittab.4
blob3a2e95ba7010589d3bf55363f87f425971d13e13
1 '\" te
2 .\" Copyright (C) 2009, Sun Microsystems, Inc. All Rights Reserved
3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
4 .\"  See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with
5 .\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
6 .TH DHCP_INITTAB 4 "Aug 31, 2009"
7 .SH NAME
8 dhcp_inittab \- information repository for DHCP options
9 .SH DESCRIPTION
10 .sp
11 .LP
12 The \fB/etc/dhcp/inittab\fR and the \fB/etc/dhcp/inittab6\fR files contain
13 information about the Dynamic Host Configuration Protocol (\fBDHCP\fR) options,
14 which are network configuration parameters passed from \fBDHCP\fR servers to
15 \fBDHCP\fR clients when a client machine uses \fBDHCP\fR. Since many
16 \fBDHCP\fR-related commands must parse and understand these \fBDHCP\fR options,
17 this file serves as a central location where information about these options
18 may be obtained.
19 .sp
20 .LP
21 The \fBDHCP\fR \fBinittab\fR and \fBinittab6\fR files provide three general
22 pieces of information:
23 .RS +4
24 .TP
25 .ie t \(bu
26 .el o
27 A mnemonic alias, or symbol name, for each option number. For instance, option
28 12 is aliased to the name \fBHostname\fR. This is useful for \fBDHCP\fR-related
29 programs that require human interaction, such as \fBdhcpinfo\fR(1).
30 .RE
31 .RS +4
32 .TP
33 .ie t \(bu
34 .el o
35 Information about the syntax for each option. This includes information such as
36 the type of the value, for example, whether it is a 16-bit integer or an
37 \fBIP\fR address.
38 .RE
39 .RS +4
40 .TP
41 .ie t \(bu
42 .el o
43 The policy for what options are visible to which \fBDHCP\fR-related programs.
44 .RE
45 .sp
46 .LP
47 If you make any changes to the \fB/etc/dhcp/inittab\fR file, note that only
48 additions of or changes to \fBSITE\fR options are preserved during upgrade. For
49 \fB/etc/dhcp/inittab6\fR, no options are preserved during upgrade.
50 .sp
51 .LP
52 The \fBVENDOR\fR options defined here are intended for use by the Solaris
53 \fBDHCP\fR client and \fBDHCP\fR management tools. The \fBSUNW\fR vendor space
54 is owned by Sun, and changes are likely during upgrade. If you need to
55 configure the Solaris \fBDHCP\fR server to support the vendor options of a
56 different client, see \fBdhcptab\fR(4) for details.
57 .sp
58 .LP
59 Each \fBDHCP\fR option belongs to a certain category, which roughly defines the
60 scope of the option; for instance, an option may only be understood by certain
61 hosts within a given site, or it may be globally understood by all \fBDHCP\fR
62 clients and servers. The following categories are defined; the category names
63 are not case-sensitive:
64 .sp
65 .ne 2
66 .na
67 \fB\fBSTANDARD\fR\fR
68 .ad
69 .RS 12n
70 All client and server \fBDHCP\fR implementations agree on the semantics. These
71 are administered by the Internet Assigned Numbers Authority (\fBIANA\fR). These
72 options are numbered from \fB1\fR to \fB127\fR for IPv4 DHCP, and \fB1\fR to
73 \fB65535\fR for DHCPv6.
74 .RE
76 .sp
77 .ne 2
78 .na
79 \fB\fBSITE\fR\fR
80 .ad
81 .RS 12n
82 Within a specific site, all client and server implementations agree on the
83 semantics. However, at another site the type and meaning of the option may be
84 quite different. These options are numbered from \fB128\fR to \fB254\fR for
85 IPv4 DHCP. DHCPv6 does not support site options.
86 .RE
88 .sp
89 .ne 2
90 .na
91 \fB\fBVENDOR\fR\fR
92 .ad
93 .RS 12n
94 Each vendor may define \fB254\fR options (65536 for DHCPv6) unique to that
95 vendor. The vendor is identified within a \fBDHCP\fR packet by the "Vendor
96 Class" option, number \fB60\fR (number \fB17\fR for DHCPv6). An option with a
97 specific numeric identifier belonging to one vendor will, in general, have a
98 type and semantics different from that of a different vendor. Vendor options
99 are "super-encapsulated" into the vendor field number \fB43\fR, as defined in
100 \fIRFC 2132\fR for IPv4 DHCP, and number \fB17\fR as defined in RFC 3315 for
101 DHCPv6. The \fB/etc/dhcp/inittab\fR file contains only Sun vendor options.
102 Define non-Sun vendor options in the \fBdhcptab\fR file.
106 .ne 2
108 \fB\fBFIELD\fR\fR
110 .RS 12n
111 This category allows the fixed fields within a \fBDHCP\fR packet to be aliased
112 to a mnemonic name for use with \fBdhcpinfo\fR(1).
116 .ne 2
118 \fB\fBINTERNAL\fR\fR
120 .RS 12n
121 This category is internal to the Solaris \fBDHCP\fR implementation and will not
122 be further defined.
125 .SS "DHCP \fBinittab\fR and \fBinittab6\fR Format"
128 Data entries are written one per line and have seven fields; each entry
129 provides information for one option. Each field is separated by a comma, except
130 for the first and second, which are separated by whitespace (as defined in
131 \fBisspace\fR(3C)). An entry cannot be continued onto another line. Blank lines
132 and those whose first non-whitespace character is '#' are ignored.
135 The fields, in order, are:
136 .RS +4
138 .ie t \(bu
139 .el o
140 Mnemonic Identifier
142 The Mnemonic Identifier is a user-friendly alias for the option number; it is
143 not case sensitive. This field must be per-category unique and should be unique
144 across all categories. The option names in the \fBSTANDARD\fR, \fBSITE\fR, and
145 \fBVENDOR\fR spaces should not overlap, or the behavior will be undefined. See
146 \fBMnemonic Identifiers for Options\fR section of this man page for
147 descriptions of the option names.
149 .RS +4
151 .ie t \(bu
152 .el o
153 Category (scope)
155 The Category field is one of \fBSTANDARD\fR, \fBSITE\fR, \fBVENDOR\fR,
156 \fBFIELD\fR, or \fBINTERNAL\fR and identifies the scope in which the option
157 falls. \fBSITE\fR is not used in \fBinittab6\fR.
159 .RS +4
161 .ie t \(bu
162 .el o
163 Option Number
165 The Option Number is the number of this option when it is in a \fBDHCP\fR
166 packet. This field should be per-category unique and the \fBSTANDARD\fR and
167 \fBSITE\fR fields should not have overlapping code fields or the behavior is
168 undefined.
170 .RS +4
172 .ie t \(bu
173 .el o
174 Data Type
176 Data Type is one of the following values, which are not case sensitive:
180 .ne 2
182 \fB\fBAscii\fR\fR
184 .RS 13n
185 A printable character string
189 .ne 2
191 \fBBool\fR
193 .RS 13n
194 Has no value. Scope limited to category limited to \fBINTERNAL\fR. Presence of
195 an option of this type within a Solaris configuration file represents
196 \fBTRUE\fR, absence represents \fBFALSE\fR.
200 .ne 2
202 \fB\fBOctet\fR\fR
204 .RS 13n
205 An array of bytes
209 .ne 2
211 \fB\fBUnumber8\fR\fR
213 .RS 13n
214 An 8-bit unsigned integer
218 .ne 2
220 \fB\fBSnumber8\fR\fR
222 .RS 13n
223 An 8-bit signed integer
227 .ne 2
229 \fB\fBUnumber16\fR\fR
231 .RS 13n
232 A 16-bit unsigned integer
236 .ne 2
238 \fB\fBSnumber16\fR\fR
240 .RS 13n
241 A 16-bit signed integer
245 .ne 2
247 \fB\fBUnumber24\fR\fR
249 .RS 13n
250 A 24-bit unsigned integer
254 .ne 2
256 \fB\fBUnumber32\fR\fR
258 .RS 13n
259 A 32-bit unsigned integer
263 .ne 2
265 \fB\fBSnumber32\fR\fR
267 .RS 13n
268 A 32-bit signed integer
272 .ne 2
274 \fB\fBUnumber64\fR\fR
276 .RS 13n
277 A 64-bit unsigned integer
281 .ne 2
283 \fB\fBSnumber64\fR\fR
285 .RS 13n
286 A 64-bit signed integer
290 .ne 2
292 \fB\fBIp\fR\fR
294 .RS 13n
295 An \fBIPv4\fR address
299 .ne 2
301 \fB\fBIpv6\fR\fR
303 .RS 13n
304 An \fBIPv6\fR address
308 .ne 2
310 \fB\fBDuid\fR\fR
312 .RS 13n
313 An RFC 3315 Unique Identifier
317 .ne 2
319 \fB\fBDomain\fR\fR
321 .RS 13n
322 An RFC 1035-encoded domain name
327 The data type field describes an indivisible unit of the option payload, using
328 one of the values listed above.
330 .RS +4
332 .ie t \(bu
333 .el o
334 Granularity
336 The Granularity field describes how many indivisible units in the option
337 payload make up a whole value or item for this option. The value must be
338 greater than zero (\fB0\fR) for any data type other than Bool, in which case it
339 must be zero (\fB0\fR).
341 .RS +4
343 .ie t \(bu
344 .el o
345 Maximum Number Of Items
347 This value specifies the maximum items of  Granularity which  are permissible
348 in a definition using this symbol. For example, there can only  be  one  IP
349 address specified for a subnet mask, so the  Maximum number of            items
350 in this case is one (\fB1\fR).  A   Maximum  value  of zero (\fB0\fR) means
351 that a variable number of items is permitted.
353 .RS +4
355 .ie t \(bu
356 .el o
357 Visibility
359 The Visibility field specifies which \fBDHCP\fR-related programs make use of
360 this information, and should always be defined as \fBsdmi\fR for newly added
361 options.
363 .SS "Mnemonic Identifiers for IPv4 Options"
366 The following table maps the mnemonic identifiers used in Solaris DHCP to
367 \fIRFC 2132\fR options:
372 c c c
373 l l l .
374 \fISymbol\fR    \fICode\fR      \fIDescription\fR
376 \fBSubnet\fR    \fB1\fR T{
377 Subnet Mask, dotted Internet address (IP).
379 \fBUTCoffst\fR  \fB2\fR T{
380 Coordinated Universal time offset (seconds).
382 \fBRouter\fR    \fB3\fR List of Routers, IP.
383 \fBTimeserv\fR  \fB4\fR List of RFC-868 servers, IP.
384 \fBIEN116ns\fR  \fB5\fR List of IEN 116 name servers, IP.
385 \fBDNSserv\fR   \fB6\fR List of DNS name servers, IP.
386 \fBLogserv\fR   \fB7\fR List of MIT-LCS UDP log servers, IP.
387 \fBCookie\fR    \fB8\fR List of RFC-865 cookie servers, IP.
388 \fBLprserv\fR   \fB9\fR T{
389 List of RFC-1179 line printer servers, IP.
391 \fBImpress\fR   \fB10\fR        List of Imagen Impress servers, IP.
392 \fBResource\fR  \fB11\fR        T{
393 List of RFC-887 resource location servers, IP.
395 \fBHostname\fR  \fB12\fR        T{
396 Client's hostname, value from hosts database.
398 \fBBootsize\fR  \fB13\fR        T{
399 Number of 512 octet blocks in boot image, NUMBER.
401 \fBDumpfile\fR  \fB14\fR        T{
402 Path where core image should be dumped, ASCII.
404 \fBDNSdmain\fR  \fB15\fR        DNS domain name, ASCII.
405 \fBSwapserv\fR  \fB16\fR        Client's swap server, IP.
406 \fBRootpath\fR  \fB17\fR        Client's Root path, ASCII.
407 \fBExtendP\fR   \fB18\fR        Extensions path, ASCII.
408 \fBIpFwdF\fR    \fB19\fR        IP Forwarding Enable/Disable, NUMBER.
409 \fBNLrouteF\fR  \fB20\fR        Non-local Source Routing, NUMBER.
410 \fBPFilter\fR   \fB21\fR        Policy Filter, IP.
411 \fBMaxIpSiz\fR  \fB22\fR        T{
412 Maximum datagram Reassembly Size, NUMBER.
414 \fBIpTTL\fR     \fB23\fR        T{
415 Default IP Time to Live, (1=<x<=255), NUMBER.
417 \fBPathTO\fR    \fB24\fR        RFC-1191 Path MTU Aging Timeout, NUMBER.
418 \fBPathTbl\fR   \fB25\fR        RFC-1191 Path MTU Plateau Table, NUMBER.
419 \fBMTU\fR       \fB26\fR        Interface MTU, x>=68, NUMBER.
420 \fBSameMtuF\fR  \fB27\fR        All Subnets are Local, NUMBER.
421 \fBBroadcst\fR  \fB28\fR        Broadcast Address, IP.
422 \fBMaskDscF\fR  \fB29\fR        Perform Mask Discovery, NUMBER.
423 \fBMaskSupF\fR  \fB30\fR        Mask Supplier, NUMBER.
424 \fBRDiscvyF\fR  \fB31\fR        Perform Router Discovery, NUMBER.
425 \fBRSolictS\fR  \fB32\fR        Router Solicitation Address, IP.
426 \fBStaticRt\fR  \fB33\fR        T{
427 Static Route, Double IP (network router).
429 \fBTrailerF\fR  \fB34\fR        Trailer Encapsulation, NUMBER.
430 \fBArpTimeO\fR  \fB35\fR        ARP Cache Time out, NUMBER.
431 \fBEthEncap\fR  \fB36\fR        Ethernet Encapsulation, NUMBER.
432 \fBTcpTTL\fR    \fB37\fR        TCP Default Time to Live, NUMBER.
433 \fBTcpKaInt\fR  \fB38\fR        TCP Keepalive Interval, NUMBER.
434 \fBTcpKaGbF\fR  \fB39\fR        TCP Keepalive Garbage, NUMBER.
435 \fBNISdmain\fR  \fB40\fR        NIS Domain name, ASCII.
436 \fBNISservs\fR  \fB41\fR        List of NIS servers, IP.
437 \fBNTPservs\fR  \fB42\fR        List of NTP servers, IP.
438 \fBNetBNms\fR   \fB44\fR        List of NetBIOS Name servers, IP.
439 \fBNetBDsts\fR  \fB45\fR        T{
440 List of NetBIOS Distribution servers, IP.
442 \fBNetBNdT\fR   \fB46\fR        T{
443 NetBIOS Node type (1=B-node, 2=P, 4=M, 8=H).
445 \fBNetBScop\fR  \fB47\fR        NetBIOS scope, ASCII.
446 \fBXFontSrv\fR  \fB48\fR        List of X Window Font servers, IP.
447 \fBXDispMgr\fR  \fB49\fR        List of X Window Display managers, IP.
448 \fBLeaseTim\fR  \fB51\fR        Lease Time Policy, (-1 = PERM), NUMBER.
449 \fBMessage\fR   \fB56\fR        T{
450 Message to be displayed on client, ASCII.
452 \fBT1Time\fR    \fB58\fR        Renewal (T1) time, NUMBER.
453 \fBT2Time\fR    \fB59\fR        Rebinding (T2) time, NUMBER.
454 \fBNW_dmain\fR  \fB62\fR        NetWare/IP Domain Name, ASCII.
455 \fBNWIPOpts\fR  \fB63\fR        T{
456 NetWare/IP Options, OCTET (unknown type).
458 \fBNIS+dom\fR   \fB64\fR        NIS+ Domain name, ASCII.
459 \fBNIS+serv\fR  \fB65\fR        NIS+ servers, IP.
460 \fBTFTPsrvN\fR  \fB66\fR        TFTP server hostname, ASCII.
461 \fBOptBootF\fR  \fB67\fR        Optional Bootfile path, ASCII.
462 \fBMblIPAgt\fR  \fB68\fR        Mobile IP Home Agent, IP.
463 \fBSMTPserv\fR  \fB69\fR        T{
464 Simple Mail Transport Protocol Server, IP.
466 \fBPOP3serv\fR  \fB70\fR        Post Office Protocol (POP3) Server, IP.
467 \fBNNTPserv\fR  \fB71\fR        T{
468 Network News Transport Proto. (NNTP) Server, IP.
470 \fBWWWservs\fR  \fB72\fR        Default WorldWideWeb Server, IP.
471 \fBFingersv\fR  \fB73\fR        Default Finger Server, IP.
472 \fBIRCservs\fR  \fB74\fR        Internet Relay Chat Server, IP.
473 \fBSTservs\fR   \fB75\fR        StreetTalk Server, IP.
474 \fBSTDAservs\fR \fB76\fR        StreetTalk Directory Assist. Server, IP.
475 \fBUserClas\fR  \fB77\fR        User class information, ASCII.
476 \fBSLP_DA\fR    \fB78\fR        Directory agent, OCTET.
477 \fBSLP_SS\fR    \fB79\fR        Service scope, OCTET.
478 \fBAgentOpt\fR  \fB82\fR        Agent circuit ID, OCTET.
479 \fBFQDN\fR      \fB89\fR        Fully Qualified Domain Name, OCTET.
480 \fBPXEarch\fR   \fB93\fR        Client system architecture, NUMBER.
481 \fBBootFile\fR  \fBN/A\fR       File to Boot, ASCII.
482 \fBBootPath\fR  \fBN/A\fR       T{
483 Boot path prefix to apply to client's requested boot file, ASCII.
485 \fBBootSrvA\fR  \fBN/A\fR       Boot Server, IP.
486 \fBBootSrvN\fR  \fBN/A\fR       Boot Server Hostname, ASCII.
487 \fBEchoVC\fR    \fBN/A\fR       T{
488 Echo Vendor Class Identifier Flag, (Present=\fBTRUE\fR)
490 \fBLeaseNeg\fR  \fBN/A\fR       Lease is Negotiable Flag, (Present=\fBTRUE\fR)
493 .SS "Mnemonic Identifiers for IPv6 Options"
496 The following table maps the mnemonic identifiers used in Solaris DHCP to RFC
497 3315, 3319, 3646, 3898, 4075, and 4280 options:
502 c c c
503 l l l .
504 \fISymbol\fR    \fICode\fR      \fIDescription\fR
506 \fBClientID\fR  \fB1\fR Unique identifier for client, DUID
507 \fBServerID\fR  \fB2\fR Unique identifier for server, DUID
508 \fBPreference\fR        \fB7\fR Server preference, NUMBER
509 \fBUnicast\fR   \fB12\fR        Unicast server address, IPV6
510 \fBUserClass\fR \fB15\fR        User classes for client, OCTET
511 \fBVendorClass\fR       \fB16\fR        Vendor client hardware items, OCTET
512 \fBSIPNames\fR  \fB21\fR        SIP proxy server name list, DOMAIN
513 \fBSIPAddresses\fR      \fB22\fR        T{
514 SIP proxy server addresses in preference order, IPV6
516 \fBDNSAddresses\fR      \fB23\fR        T{
517 DNS server addresses in preference order, IPV6
519 \fBDNSSearch\fR \fB24\fR        DNS search list, DOMAIN
520 \fBNISServers\fR        \fB27\fR        T{
521 NIS server addresses in preference order, IPV6
523 \fBNIS+Servers\fR       \fB28\fR        T{
524 NIS+ server addresses in preference order, IPV6
526 \fBNISDomain\fR \fB29\fR        NIS domain name, DOMAIN
527 \fBNIS+Domain\fR        \fB30\fR        NIS+ domain name, DOMAIN
528 \fBSNTPServers\fR       \fB31\fR        IPV6
529 \fBInfoRefresh\fR       \fB32\fR        UNUMBER32
530 \fBBCMCDomain\fR        \fB33\fR        T{
531 Broadcast/multicast control server name list, DOMAIN
533 \fBBCMCAddresses\fR     \fB34\fR        T{
534 Broadcast/multicast control server addresses, IPV6
538 .SH EXAMPLES
540 \fBExample 1 \fRAltering the DHCP \fBinittab\fR File
543 In general, the \fBDHCP\fR \fBinittab\fR file should only be altered to add
544 \fBSITE\fR options. If other options are added, they will not be automatically
545 carried forward when the system is upgraded. For instance:
548 .in +2
550 ipPairs    SITE, 132, IP, 2, 0, sdmi
552 .in -2
556 describes an option named \fBipPairs\fR, that is in the \fBSITE\fR  category.
557 That is, it is defined by each individual site, and is  option code 132, which
558 is of type \fBIP\fR Address, consisting  of a potentially infinite number of
559 pairs of \fBIP\fR addresses.
561 .SH FILES
563 .in +2
564 \fB/etc/dhcp/inittab\fR
565 .in -2
567 .in +2
568 \fB/etc/dhcp/inittabv6\fR
569 .in -2
570 .SH ATTRIBUTES
573 See \fBattributes\fR(5)  for descriptions of the following attributes:
578 box;
579 c | c
580 l | l .
581 ATTRIBUTE TYPE  ATTRIBUTE VALUE
583 Interface Stability     Committed
586 .SH SEE ALSO
589 \fBdhcpinfo\fR(1), \fBdhcpagent\fR(8), \fBisspace\fR(3C), \fBdhcptab\fR(4),
590 \fBattributes\fR(5), \fBdhcp\fR(5), \fBdhcp_modules\fR(5)
593 \fISystem Administration Guide: IP Services\fR
596 Alexander, S., and R. Droms. \fIRFC 2132, DHCP Options and BOOTP Vendor
597 Extensions\fR. Network Working Group. March 1997.
600 Droms, R. \fI RFC 2131, Dynamic Host Configuration Protocol\fR. Network Working
601 Group. March 1997.
604 Droms, R. \fIRFC 3315, Dynamic Host Configuration Protocol for IPv6
605 (DHCPv6)\fR. Cisco Systems. July 2003.
608 Schulzrinne, H., and B. Volz. \fIRFC 3319, Dynamic Host Configuration Protocol
609 (DHCPv6) Options for Session Initiation Protocol (SIP) Servers\fR. Columbia
610 University and Ericsson. July 2003.
613 Droms, R. \fIRFC 3646, DNS Configuration options for Dynamic Host Configuration
614 Protocol for IPv6 (DHCPv6)\fR. Cisco Systems. December 2003.
617 Kalusivalingam, V. \fIRFC 3898, Network Information Service (NIS) Configuration
618 Options for Dynamic Host Configuration Protocol for IPv6 (DHCPv6)\fR. Cisco
619 Systems. October 2004.
622 Chowdhury, K., P. Yegani, and L. Madour. \fIRFC 4280, Dynamic Host
623 Configuration Protocol (DHCP) Options for Broadcast and Multicast Control
624 Servers\fR. Starent Networks, Cisco Systems, and Ericsson. November 2005.
627 Mockapetris, P.V. \fIRFC 1035, Domain names - implementation and
628 specification\fR. ISI. November 1987.