Move /var/svc/log to /var/log/svc
[unleashed/lotheac.git] / share / man / man4 / dhcp_inittab.4
blob5cbad07e66e6ffe4e0923837552ef7a00f956711
1 '\" te
2 .\" Copyright (C) 2009, Sun Microsystems, Inc. All Rights Reserved
3 .\" Copyright (c) 2016, Chris Fraire <cfraire@me.com>.
4 .\" 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.
5 .\"  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
6 .\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
7 .TH DHCP_INITTAB 4 "Oct 31, 2016"
8 .SH NAME
9 dhcp_inittab \- information repository for DHCP options
10 .SH DESCRIPTION
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"
127 Data entries are written one per line and have seven fields; each entry
128 provides information for one option. Each field is separated by a comma, except
129 for the first and second, which are separated by whitespace (as defined in
130 \fBisspace\fR(3C)). An entry cannot be continued onto another line. Blank lines
131 and those whose first non-whitespace character is '#' are ignored.
134 The fields, in order, are:
135 .RS +4
137 .ie t \(bu
138 .el o
139 Mnemonic Identifier
141 The Mnemonic Identifier is a user-friendly alias for the option number; it is
142 not case sensitive. This field must be per-category unique and should be unique
143 across all categories. The option names in the \fBSTANDARD\fR, \fBSITE\fR, and
144 \fBVENDOR\fR spaces should not overlap, or the behavior will be undefined. See
145 \fBMnemonic Identifiers for Options\fR section of this man page for
146 descriptions of the option names.
148 .RS +4
150 .ie t \(bu
151 .el o
152 Category (scope)
154 The Category field is one of \fBSTANDARD\fR, \fBSITE\fR, \fBVENDOR\fR,
155 \fBFIELD\fR, or \fBINTERNAL\fR and identifies the scope in which the option
156 falls. \fBSITE\fR is not used in \fBinittab6\fR.
158 .RS +4
160 .ie t \(bu
161 .el o
162 Option Number
164 The Option Number is the number of this option when it is in a \fBDHCP\fR
165 packet. This field should be per-category unique and the \fBSTANDARD\fR and
166 \fBSITE\fR fields should not have overlapping code fields or the behavior is
167 undefined.
169 .RS +4
171 .ie t \(bu
172 .el o
173 Data Type
175 Data Type is one of the following values, which are not case sensitive:
179 .ne 2
181 \fB\fBAscii\fR\fR
183 .RS 13n
184 A printable character string
188 .ne 2
190 \fBBool\fR
192 .RS 13n
193 Has no value. Scope limited to category limited to \fBINTERNAL\fR. Presence of
194 an option of this type within a Solaris configuration file represents
195 \fBTRUE\fR, absence represents \fBFALSE\fR.
199 .ne 2
201 \fB\fBOctet\fR\fR
203 .RS 13n
204 An array of bytes
208 .ne 2
210 \fB\fBUnumber8\fR\fR
212 .RS 13n
213 An 8-bit unsigned integer
217 .ne 2
219 \fB\fBSnumber8\fR\fR
221 .RS 13n
222 An 8-bit signed integer
226 .ne 2
228 \fB\fBUnumber16\fR\fR
230 .RS 13n
231 A 16-bit unsigned integer
235 .ne 2
237 \fB\fBSnumber16\fR\fR
239 .RS 13n
240 A 16-bit signed integer
244 .ne 2
246 \fB\fBUnumber24\fR\fR
248 .RS 13n
249 A 24-bit unsigned integer
253 .ne 2
255 \fB\fBUnumber32\fR\fR
257 .RS 13n
258 A 32-bit unsigned integer
262 .ne 2
264 \fB\fBSnumber32\fR\fR
266 .RS 13n
267 A 32-bit signed integer
271 .ne 2
273 \fB\fBUnumber64\fR\fR
275 .RS 13n
276 A 64-bit unsigned integer
280 .ne 2
282 \fB\fBSnumber64\fR\fR
284 .RS 13n
285 A 64-bit signed integer
289 .ne 2
291 \fB\fBIp\fR\fR
293 .RS 13n
294 An \fBIPv4\fR address
298 .ne 2
300 \fB\fBIpv6\fR\fR
302 .RS 13n
303 An \fBIPv6\fR address
307 .ne 2
309 \fB\fBDuid\fR\fR
311 .RS 13n
312 An RFC 3315 Unique Identifier
316 .ne 2
318 \fB\fBDomain\fR\fR
320 .RS 13n
321 An RFC 1035-encoded domain name
326 The data type field describes an indivisible unit of the option payload, using
327 one of the values listed above.
329 .RS +4
331 .ie t \(bu
332 .el o
333 Granularity
335 The Granularity field describes how many indivisible units in the option
336 payload make up a whole value or item for this option. The value must be
337 greater than zero (\fB0\fR) for any data type other than Bool, in which case it
338 must be zero (\fB0\fR).
340 .RS +4
342 .ie t \(bu
343 .el o
344 Maximum Number Of Items
346 This value specifies the maximum items of  Granularity which  are permissible
347 in a definition using this symbol. For example, there can only  be  one  IP
348 address specified for a subnet mask, so the  Maximum number of            items
349 in this case is one (\fB1\fR).  A   Maximum  value  of zero (\fB0\fR) means
350 that a variable number of items is permitted.
352 .RS +4
354 .ie t \(bu
355 .el o
356 Visibility
358 The Visibility field specifies which \fBDHCP\fR-related programs make use of
359 this information, and should always be defined as \fBsdmi\fR for newly added
360 options.
362 .SS "Mnemonic Identifiers for IPv4 Options"
364 The following table maps the mnemonic identifiers used in Solaris DHCP to
365 \fIRFC 2132\fR options:
370 c c c
371 l l l .
372 \fISymbol\fR    \fICode\fR      \fIDescription\fR
374 \fBSubnet\fR    \fB1\fR T{
375 Subnet Mask, dotted Internet address (IP).
377 \fBUTCoffst\fR  \fB2\fR T{
378 Coordinated Universal time offset (seconds) [deprecated].
380 \fBRouter\fR    \fB3\fR List of Routers, IP.
381 \fBTimeserv\fR  \fB4\fR List of RFC-868 servers, IP.
382 \fBIEN116ns\fR  \fB5\fR List of IEN 116 name servers, IP.
383 \fBDNSserv\fR   \fB6\fR List of DNS name servers, IP.
384 \fBLogserv\fR   \fB7\fR List of MIT-LCS UDP log servers, IP.
385 \fBCookie\fR    \fB8\fR List of RFC-865 cookie servers, IP.
386 \fBLprserv\fR   \fB9\fR T{
387 List of RFC-1179 line printer servers, IP.
389 \fBImpress\fR   \fB10\fR        List of Imagen Impress servers, IP.
390 \fBResource\fR  \fB11\fR        T{
391 List of RFC-887 resource location servers, IP.
393 \fBHostname\fR  \fB12\fR        T{
394 Client's hostname, value from hosts database.
396 \fBBootsize\fR  \fB13\fR        T{
397 Number of 512 octet blocks in boot image, NUMBER.
399 \fBDumpfile\fR  \fB14\fR        T{
400 Path where core image should be dumped, ASCII.
402 \fBDNSdmain\fR  \fB15\fR        DNS domain name, ASCII.
403 \fBSwapserv\fR  \fB16\fR        Client's swap server, IP.
404 \fBRootpath\fR  \fB17\fR        Client's Root path, ASCII.
405 \fBExtendP\fR   \fB18\fR        Extensions path, ASCII.
406 \fBIpFwdF\fR    \fB19\fR        IP Forwarding Enable/Disable, NUMBER.
407 \fBNLrouteF\fR  \fB20\fR        Non-local Source Routing, NUMBER.
408 \fBPFilter\fR   \fB21\fR        Policy Filter, IP.
409 \fBMaxIpSiz\fR  \fB22\fR        T{
410 Maximum datagram Reassembly Size, NUMBER.
412 \fBIpTTL\fR     \fB23\fR        T{
413 Default IP Time to Live, (1=<x<=255), NUMBER.
415 \fBPathTO\fR    \fB24\fR        RFC-1191 Path MTU Aging Timeout, NUMBER.
416 \fBPathTbl\fR   \fB25\fR        RFC-1191 Path MTU Plateau Table, NUMBER.
417 \fBMTU\fR       \fB26\fR        Interface MTU, x>=68, NUMBER.
418 \fBSameMtuF\fR  \fB27\fR        All Subnets are Local, NUMBER.
419 \fBBroadcst\fR  \fB28\fR        Broadcast Address, IP.
420 \fBMaskDscF\fR  \fB29\fR        Perform Mask Discovery, NUMBER.
421 \fBMaskSupF\fR  \fB30\fR        Mask Supplier, NUMBER.
422 \fBRDiscvyF\fR  \fB31\fR        Perform Router Discovery, NUMBER.
423 \fBRSolictS\fR  \fB32\fR        Router Solicitation Address, IP.
424 \fBStaticRt\fR  \fB33\fR        T{
425 Static Route, Double IP (network router).
427 \fBTrailerF\fR  \fB34\fR        Trailer Encapsulation, NUMBER.
428 \fBArpTimeO\fR  \fB35\fR        ARP Cache Time out, NUMBER.
429 \fBEthEncap\fR  \fB36\fR        Ethernet Encapsulation, NUMBER.
430 \fBTcpTTL\fR    \fB37\fR        TCP Default Time to Live, NUMBER.
431 \fBTcpKaInt\fR  \fB38\fR        TCP Keepalive Interval, NUMBER.
432 \fBTcpKaGbF\fR  \fB39\fR        TCP Keepalive Garbage, NUMBER.
433 \fBNISdmain\fR  \fB40\fR        NIS Domain name, ASCII.
434 \fBNISservs\fR  \fB41\fR        List of NIS servers, IP.
435 \fBNTPservs\fR  \fB42\fR        List of NTP servers, IP.
436 \fBNetBNms\fR   \fB44\fR        List of NetBIOS Name servers, IP.
437 \fBNetBDsts\fR  \fB45\fR        T{
438 List of NetBIOS Distribution servers, IP.
440 \fBNetBNdT\fR   \fB46\fR        T{
441 NetBIOS Node type (1=B-node, 2=P, 4=M, 8=H).
443 \fBNetBScop\fR  \fB47\fR        NetBIOS scope, ASCII.
444 \fBXFontSrv\fR  \fB48\fR        List of X Window Font servers, IP.
445 \fBXDispMgr\fR  \fB49\fR        List of X Window Display managers, IP.
446 \fBLeaseTim\fR  \fB51\fR        Lease Time Policy, (-1 = PERM), NUMBER.
447 \fBMessage\fR   \fB56\fR        T{
448 Message to be displayed on client, ASCII.
450 \fBT1Time\fR    \fB58\fR        Renewal (T1) time, NUMBER.
451 \fBT2Time\fR    \fB59\fR        Rebinding (T2) time, NUMBER.
452 \fBNW_dmain\fR  \fB62\fR        NetWare/IP Domain Name, ASCII.
453 \fBNWIPOpts\fR  \fB63\fR        T{
454 NetWare/IP Options, OCTET (unknown type).
456 \fBNIS+dom\fR   \fB64\fR        NIS+ Domain name, ASCII.
457 \fBNIS+serv\fR  \fB65\fR        NIS+ servers, IP.
458 \fBTFTPsrvN\fR  \fB66\fR        TFTP server hostname, ASCII.
459 \fBOptBootF\fR  \fB67\fR        Optional Bootfile path, ASCII.
460 \fBMblIPAgt\fR  \fB68\fR        Mobile IP Home Agent, IP.
461 \fBSMTPserv\fR  \fB69\fR        T{
462 Simple Mail Transport Protocol Server, IP.
464 \fBPOP3serv\fR  \fB70\fR        Post Office Protocol (POP3) Server, IP.
465 \fBNNTPserv\fR  \fB71\fR        T{
466 Network News Transport Proto. (NNTP) Server, IP.
468 \fBWWWservs\fR  \fB72\fR        Default WorldWideWeb Server, IP.
469 \fBFingersv\fR  \fB73\fR        Default Finger Server, IP.
470 \fBIRCservs\fR  \fB74\fR        Internet Relay Chat Server, IP.
471 \fBSTservs\fR   \fB75\fR        StreetTalk Server, IP.
472 \fBSTDAservs\fR \fB76\fR        StreetTalk Directory Assist. Server, IP.
473 \fBUserClas\fR  \fB77\fR        User class information, ASCII.
474 \fBSLP_DA\fR    \fB78\fR        Directory agent, OCTET.
475 \fBSLP_SS\fR    \fB79\fR        Service scope, OCTET.
476 \fBClientFQDN\fR        \fB81\fR        Fully Qualified Domain Name, OCTET.
477 \fBAgentOpt\fR  \fB82\fR        Agent circuit ID, OCTET.
478 \fBFQDN\fR      \fB89\fR        Fully Qualified Domain Name, OCTET.
479 \fBPXEarch\fR   \fB93\fR        Client system architecture, NUMBER.
480 \fBBootFile\fR  \fBN/A\fR       File to Boot, ASCII.
481 \fBBootPath\fR  \fBN/A\fR       T{
482 Boot path prefix to apply to client's requested boot file, ASCII.
484 \fBBootSrvA\fR  \fBN/A\fR       Boot Server, IP.
485 \fBBootSrvN\fR  \fBN/A\fR       Boot Server Hostname, ASCII.
486 \fBEchoVC\fR    \fBN/A\fR       T{
487 Echo Vendor Class Identifier Flag, (Present=\fBTRUE\fR)
489 \fBLeaseNeg\fR  \fBN/A\fR       Lease is Negotiable Flag, (Present=\fBTRUE\fR)
492 .SS "Mnemonic Identifiers for IPv6 Options"
494 The following table maps the mnemonic identifiers used in Solaris DHCP to RFC
495 3315, 3319, 3646, 3898, 4075, and 4280 options:
500 c c c
501 l l l .
502 \fISymbol\fR    \fICode\fR      \fIDescription\fR
504 \fBClientID\fR  \fB1\fR Unique identifier for client, DUID
505 \fBServerID\fR  \fB2\fR Unique identifier for server, DUID
506 \fBPreference\fR        \fB7\fR Server preference, NUMBER
507 \fBUnicast\fR   \fB12\fR        Unicast server address, IPV6
508 \fBUserClass\fR \fB15\fR        User classes for client, OCTET
509 \fBVendorClass\fR       \fB16\fR        Vendor client hardware items, OCTET
510 \fBSIPNames\fR  \fB21\fR        SIP proxy server name list, DOMAIN
511 \fBSIPAddresses\fR      \fB22\fR        T{
512 SIP proxy server addresses in preference order, IPV6
514 \fBDNSAddresses\fR      \fB23\fR        T{
515 DNS server addresses in preference order, IPV6
517 \fBDNSSearch\fR \fB24\fR        DNS search list, DOMAIN
518 \fBNISServers\fR        \fB27\fR        T{
519 NIS server addresses in preference order, IPV6
521 \fBNIS+Servers\fR       \fB28\fR        T{
522 NIS+ server addresses in preference order, IPV6
524 \fBNISDomain\fR \fB29\fR        NIS domain name, DOMAIN
525 \fBNIS+Domain\fR        \fB30\fR        NIS+ domain name, DOMAIN
526 \fBSNTPServers\fR       \fB31\fR        IPV6
527 \fBInfoRefresh\fR       \fB32\fR        UNUMBER32
528 \fBBCMCDomain\fR        \fB33\fR        T{
529 Broadcast/multicast control server name list, DOMAIN
531 \fBBCMCAddresses\fR     \fB34\fR        T{
532 Broadcast/multicast control server addresses, IPV6
536 .SH EXAMPLES
538 \fBExample 1 \fRAltering the DHCP \fBinittab\fR File
541 In general, the \fBDHCP\fR \fBinittab\fR file should only be altered to add
542 \fBSITE\fR options. If other options are added, they will not be automatically
543 carried forward when the system is upgraded. For instance:
546 .in +2
548 ipPairs    SITE, 132, IP, 2, 0, sdmi
550 .in -2
554 describes an option named \fBipPairs\fR, that is in the \fBSITE\fR  category.
555 That is, it is defined by each individual site, and is  option code 132, which
556 is of type \fBIP\fR Address, consisting  of a potentially infinite number of
557 pairs of \fBIP\fR addresses.
559 .SH FILES
560 .in +2
561 \fB/etc/dhcp/inittab\fR
562 .in -2
564 .in +2
565 \fB/etc/dhcp/inittabv6\fR
566 .in -2
567 .SH ATTRIBUTES
569 See \fBattributes\fR(5)  for descriptions of the following attributes:
574 box;
575 c | c
576 l | l .
577 ATTRIBUTE TYPE  ATTRIBUTE VALUE
579 Interface Stability     Committed
582 .SH SEE ALSO
584 \fBdhcpinfo\fR(1), \fBdhcpagent\fR(8), \fBisspace\fR(3C), \fBdhcptab\fR(4),
585 \fBattributes\fR(5), \fBdhcp\fR(5), \fBdhcp_modules\fR(5)
588 \fISystem Administration Guide: IP Services\fR
591 Alexander, S., and R. Droms. \fIRFC 2132, DHCP Options and BOOTP Vendor
592 Extensions\fR. Network Working Group. March 1997.
595 Droms, R. \fI RFC 2131, Dynamic Host Configuration Protocol\fR. Network Working
596 Group. March 1997.
599 Droms, R. \fIRFC 3315, Dynamic Host Configuration Protocol for IPv6
600 (DHCPv6)\fR. Cisco Systems. July 2003.
603 Schulzrinne, H., and B. Volz. \fIRFC 3319, Dynamic Host Configuration Protocol
604 (DHCPv6) Options for Session Initiation Protocol (SIP) Servers\fR. Columbia
605 University and Ericsson. July 2003.
608 Droms, R. \fIRFC 3646, DNS Configuration options for Dynamic Host Configuration
609 Protocol for IPv6 (DHCPv6)\fR. Cisco Systems. December 2003.
612 Kalusivalingam, V. \fIRFC 3898, Network Information Service (NIS) Configuration
613 Options for Dynamic Host Configuration Protocol for IPv6 (DHCPv6)\fR. Cisco
614 Systems. October 2004.
617 Chowdhury, K., P. Yegani, and L. Madour. \fIRFC 4280, Dynamic Host
618 Configuration Protocol (DHCP) Options for Broadcast and Multicast Control
619 Servers\fR. Starent Networks, Cisco Systems, and Ericsson. November 2005.
622 Mockapetris, P.V. \fIRFC 1035, Domain names - implementation and
623 specification\fR. ISI. November 1987.