'\" te .\" Copyright (C) 2009, Sun Microsystems, Inc. All Rights Reserved .\" 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. .\" 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 .\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] .TH dhcp_inittab 4 "31 Aug 2009" "SunOS 5.11" "File Formats" .SH NAME dhcp_inittab \- information repository for DHCP options .SH DESCRIPTION .sp .LP The \fB/etc/dhcp/inittab\fR and the \fB/etc/dhcp/inittab6\fR files contain information about the Dynamic Host Configuration Protocol (\fBDHCP\fR) options, which are network configuration parameters passed from \fBDHCP\fR servers to \fBDHCP\fR clients when a client machine uses \fBDHCP\fR. Since many \fBDHCP\fR-related commands must parse and understand these \fBDHCP\fR options, this file serves as a central location where information about these options may be obtained. .sp .LP The \fBDHCP\fR \fBinittab\fR and \fBinittab6\fR files provide three general pieces of information: .RS +4 .TP .ie t \(bu .el o A mnemonic alias, or symbol name, for each option number. For instance, option 12 is aliased to the name \fBHostname\fR. This is useful for \fBDHCP\fR-related programs that require human interaction, such as \fBdhcpinfo\fR(1). .RE .RS +4 .TP .ie t \(bu .el o Information about the syntax for each option. This includes information such as the type of the value, for example, whether it is a 16-bit integer or an \fBIP\fR address. .RE .RS +4 .TP .ie t \(bu .el o The policy for what options are visible to which \fBDHCP\fR-related programs. .RE .sp .LP If you make any changes to the \fB/etc/dhcp/inittab\fR file, note that only additions of or changes to \fBSITE\fR options are preserved during upgrade. For \fB/etc/dhcp/inittab6\fR, no options are preserved during upgrade. .sp .LP The \fBVENDOR\fR options defined here are intended for use by the Solaris \fBDHCP\fR client and \fBDHCP\fR management tools. The \fBSUNW\fR vendor space is owned by Sun, and changes are likely during upgrade. If you need to configure the Solaris \fBDHCP\fR server to support the vendor options of a different client, see \fBdhcptab\fR(4) for details. .sp .LP Each \fBDHCP\fR option belongs to a certain category, which roughly defines the scope of the option; for instance, an option may only be understood by certain hosts within a given site, or it may be globally understood by all \fBDHCP\fR clients and servers. The following categories are defined; the category names are not case-sensitive: .sp .ne 2 .mk .na \fB\fBSTANDARD\fR\fR .ad .RS 12n .rt All client and server \fBDHCP\fR implementations agree on the semantics. These are administered by the Internet Assigned Numbers Authority (\fBIANA\fR). These options are numbered from \fB1\fR to \fB127\fR for IPv4 DHCP, and \fB1\fR to \fB65535\fR for DHCPv6. .RE .sp .ne 2 .mk .na \fB\fBSITE\fR\fR .ad .RS 12n .rt Within a specific site, all client and server implementations agree on the semantics. However, at another site the type and meaning of the option may be quite different. These options are numbered from \fB128\fR to \fB254\fR for IPv4 DHCP. DHCPv6 does not support site options. .RE .sp .ne 2 .mk .na \fB\fBVENDOR\fR\fR .ad .RS 12n .rt Each vendor may define \fB254\fR options (65536 for DHCPv6) unique to that vendor. The vendor is identified within a \fBDHCP\fR packet by the "Vendor Class" option, number \fB60\fR (number \fB17\fR for DHCPv6). An option with a specific numeric identifier belonging to one vendor will, in general, have a type and semantics different from that of a different vendor. Vendor options are "super-encapsulated" into the vendor field number \fB43\fR, as defined in \fIRFC 2132\fR for IPv4 DHCP, and number \fB17\fR as defined in RFC 3315 for DHCPv6. The \fB/etc/dhcp/inittab\fR file contains only Sun vendor options. Define non-Sun vendor options in the \fBdhcptab\fR file. .RE .sp .ne 2 .mk .na \fB\fBFIELD\fR\fR .ad .RS 12n .rt This category allows the fixed fields within a \fBDHCP\fR packet to be aliased to a mnemonic name for use with \fBdhcpinfo\fR(1). .RE .sp .ne 2 .mk .na \fB\fBINTERNAL\fR\fR .ad .RS 12n .rt This category is internal to the Solaris \fBDHCP\fR implementation and will not be further defined. .RE .SS "DHCP \fBinittab\fR and \fBinittab6\fR Format" .sp .LP Data entries are written one per line and have seven fields; each entry provides information for one option. Each field is separated by a comma, except for the first and second, which are separated by whitespace (as defined in \fBisspace\fR(3C)). An entry cannot be continued onto another line. Blank lines and those whose first non-whitespace character is '#' are ignored. .sp .LP The fields, in order, are: .RS +4 .TP .ie t \(bu .el o Mnemonic Identifier .sp The Mnemonic Identifier is a user-friendly alias for the option number; it is not case sensitive. This field must be per-category unique and should be unique across all categories. The option names in the \fBSTANDARD\fR, \fBSITE\fR, and \fBVENDOR\fR spaces should not overlap, or the behavior will be undefined. See \fBMnemonic Identifiers for Options\fR section of this man page for descriptions of the option names. .RE .RS +4 .TP .ie t \(bu .el o Category (scope) .sp The Category field is one of \fBSTANDARD\fR, \fBSITE\fR, \fBVENDOR\fR, \fBFIELD\fR, or \fBINTERNAL\fR and identifies the scope in which the option falls. \fBSITE\fR is not used in \fBinittab6\fR. .RE .RS +4 .TP .ie t \(bu .el o Option Number .sp The Option Number is the number of this option when it is in a \fBDHCP\fR packet. This field should be per-category unique and the \fBSTANDARD\fR and \fBSITE\fR fields should not have overlapping code fields or the behavior is undefined. .RE .RS +4 .TP .ie t \(bu .el o Data Type .sp Data Type is one of the following values, which are not case sensitive: .RS .sp .ne 2 .mk .na \fB\fBAscii\fR\fR .ad .RS 13n .rt A printable character string .RE .sp .ne 2 .mk .na \fBBool\fR .ad .RS 13n .rt Has no value. Scope limited to category limited to \fBINTERNAL\fR. Presence of an option of this type within a Solaris configuration file represents \fBTRUE\fR, absence represents \fBFALSE\fR. .RE .sp .ne 2 .mk .na \fB\fBOctet\fR\fR .ad .RS 13n .rt An array of bytes .RE .sp .ne 2 .mk .na \fB\fBUnumber8\fR\fR .ad .RS 13n .rt An 8-bit unsigned integer .RE .sp .ne 2 .mk .na \fB\fBSnumber8\fR\fR .ad .RS 13n .rt An 8-bit signed integer .RE .sp .ne 2 .mk .na \fB\fBUnumber16\fR\fR .ad .RS 13n .rt A 16-bit unsigned integer .RE .sp .ne 2 .mk .na \fB\fBSnumber16\fR\fR .ad .RS 13n .rt A 16-bit signed integer .RE .sp .ne 2 .mk .na \fB\fBUnumber24\fR\fR .ad .RS 13n .rt A 24-bit unsigned integer .RE .sp .ne 2 .mk .na \fB\fBUnumber32\fR\fR .ad .RS 13n .rt A 32-bit unsigned integer .RE .sp .ne 2 .mk .na \fB\fBSnumber32\fR\fR .ad .RS 13n .rt A 32-bit signed integer .RE .sp .ne 2 .mk .na \fB\fBUnumber64\fR\fR .ad .RS 13n .rt A 64-bit unsigned integer .RE .sp .ne 2 .mk .na \fB\fBSnumber64\fR\fR .ad .RS 13n .rt A 64-bit signed integer .RE .sp .ne 2 .mk .na \fB\fBIp\fR\fR .ad .RS 13n .rt An \fBIPv4\fR address .RE .sp .ne 2 .mk .na \fB\fBIpv6\fR\fR .ad .RS 13n .rt An \fBIPv6\fR address .RE .sp .ne 2 .mk .na \fB\fBDuid\fR\fR .ad .RS 13n .rt An RFC 3315 Unique Identifier .RE .sp .ne 2 .mk .na \fB\fBDomain\fR\fR .ad .RS 13n .rt An RFC 1035-encoded domain name .RE .RE The data type field describes an indivisible unit of the option payload, using one of the values listed above. .RE .RS +4 .TP .ie t \(bu .el o Granularity .sp The Granularity field describes how many indivisible units in the option payload make up a whole value or item for this option. The value must be greater than zero (\fB0\fR) for any data type other than Bool, in which case it must be zero (\fB0\fR). .RE .RS +4 .TP .ie t \(bu .el o Maximum Number Of Items .sp This value specifies the maximum items of Granularity which are permissible in a definition using this symbol. For example, there can only be one IP address specified for a subnet mask, so the Maximum number of items in this case is one (\fB1\fR). A Maximum value of zero (\fB0\fR) means that a variable number of items is permitted. .RE .RS +4 .TP .ie t \(bu .el o Visibility .sp The Visibility field specifies which \fBDHCP\fR-related programs make use of this information, and should always be defined as \fBsdmi\fR for newly added options. .RE .SS "Mnemonic Identifiers for IPv4 Options" .sp .LP The following table maps the mnemonic identifiers used in Solaris DHCP to \fIRFC 2132\fR options: .sp .sp .TS tab(); cw(1.4i) cw(1.09i) cw(3.02i) lw(1.4i) lw(1.09i) lw(3.02i) . \fISymbol\fR\fICode\fR\fIDescription\fR _ \fBSubnet\fR\fB1\fRT{ Subnet Mask, dotted Internet address (IP). T} \fBUTCoffst\fR\fB2\fRT{ Coordinated Universal time offset (seconds). T} \fBRouter\fR\fB3\fRList of Routers, IP. \fBTimeserv\fR\fB4\fRList of RFC-868 servers, IP. \fBIEN116ns\fR\fB5\fRList of IEN 116 name servers, IP. \fBDNSserv\fR\fB6\fRList of DNS name servers, IP. \fBLogserv\fR\fB7\fRList of MIT-LCS UDP log servers, IP. \fBCookie\fR\fB8\fRList of RFC-865 cookie servers, IP. \fBLprserv\fR\fB9\fRT{ List of RFC-1179 line printer servers, IP. T} \fBImpress\fR\fB10\fRList of Imagen Impress servers, IP. \fBResource\fR\fB11\fRT{ List of RFC-887 resource location servers, IP. T} \fBHostname\fR\fB12\fRT{ Client's hostname, value from hosts database. T} \fBBootsize\fR\fB13\fRT{ Number of 512 octet blocks in boot image, NUMBER. T} \fBDumpfile\fR\fB14\fRT{ Path where core image should be dumped, ASCII. T} \fBDNSdmain\fR\fB15\fRDNS domain name, ASCII. \fBSwapserv\fR\fB16\fRClient's swap server, IP. \fBRootpath\fR\fB17\fRClient's Root path, ASCII. \fBExtendP\fR\fB18\fRExtensions path, ASCII. \fBIpFwdF\fR\fB19\fRIP Forwarding Enable/Disable, NUMBER. \fBNLrouteF\fR\fB20\fRNon-local Source Routing, NUMBER. \fBPFilter\fR\fB21\fRPolicy Filter, IP. \fBMaxIpSiz\fR\fB22\fRT{ Maximum datagram Reassembly Size, NUMBER. T} \fBIpTTL\fR\fB23\fRT{ Default IP Time to Live, (1==68, NUMBER. \fBSameMtuF\fR\fB27\fRAll Subnets are Local, NUMBER. \fBBroadcst\fR\fB28\fRBroadcast Address, IP. \fBMaskDscF\fR\fB29\fRPerform Mask Discovery, NUMBER. \fBMaskSupF\fR\fB30\fRMask Supplier, NUMBER. \fBRDiscvyF\fR\fB31\fRPerform Router Discovery, NUMBER. \fBRSolictS\fR\fB32\fRRouter Solicitation Address, IP. \fBStaticRt\fR\fB33\fRT{ Static Route, Double IP (network router). T} \fBTrailerF\fR\fB34\fRTrailer Encapsulation, NUMBER. \fBArpTimeO\fR\fB35\fRARP Cache Time out, NUMBER. \fBEthEncap\fR\fB36\fREthernet Encapsulation, NUMBER. \fBTcpTTL\fR\fB37\fRTCP Default Time to Live, NUMBER. \fBTcpKaInt\fR\fB38\fRTCP Keepalive Interval, NUMBER. \fBTcpKaGbF\fR\fB39\fRTCP Keepalive Garbage, NUMBER. \fBNISdmain\fR\fB40\fRNIS Domain name, ASCII. \fBNISservs\fR\fB41\fRList of NIS servers, IP. \fBNTPservs\fR\fB42\fRList of NTP servers, IP. \fBNetBNms\fR\fB44\fRList of NetBIOS Name servers, IP. \fBNetBDsts\fR\fB45\fRT{ List of NetBIOS Distribution servers, IP. T} \fBNetBNdT\fR\fB46\fRT{ NetBIOS Node type (1=B-node, 2=P, 4=M, 8=H). T} \fBNetBScop\fR\fB47\fRNetBIOS scope, ASCII. \fBXFontSrv\fR\fB48\fRList of X Window Font servers, IP. \fBXDispMgr\fR\fB49\fRList of X Window Display managers, IP. \fBLeaseTim\fR\fB51\fRLease Time Policy, (-1 = PERM), NUMBER. \fBMessage\fR\fB56\fRT{ Message to be displayed on client, ASCII. T} \fBT1Time\fR\fB58\fRRenewal (T1) time, NUMBER. \fBT2Time\fR\fB59\fRRebinding (T2) time, NUMBER. \fBNW_dmain\fR\fB62\fRNetWare/IP Domain Name, ASCII. \fBNWIPOpts\fR\fB63\fRT{ NetWare/IP Options, OCTET (unknown type). T} \fBNIS+dom\fR\fB64\fRNIS+ Domain name, ASCII. \fBNIS+serv\fR\fB65\fRNIS+ servers, IP. \fBTFTPsrvN\fR\fB66\fRTFTP server hostname, ASCII. \fBOptBootF\fR\fB67\fROptional Bootfile path, ASCII. \fBMblIPAgt\fR\fB68\fRMobile IP Home Agent, IP. \fBSMTPserv\fR\fB69\fRT{ Simple Mail Transport Protocol Server, IP. T} \fBPOP3serv\fR\fB70\fRPost Office Protocol (POP3) Server, IP. \fBNNTPserv\fR\fB71\fRT{ Network News Transport Proto. (NNTP) Server, IP. T} \fBWWWservs\fR\fB72\fRDefault WorldWideWeb Server, IP. \fBFingersv\fR\fB73\fRDefault Finger Server, IP. \fBIRCservs\fR\fB74\fRInternet Relay Chat Server, IP. \fBSTservs\fR\fB75\fRStreetTalk Server, IP. \fBSTDAservs\fR\fB76\fRStreetTalk Directory Assist. Server, IP. \fBUserClas\fR\fB77\fRUser class information, ASCII. \fBSLP_DA\fR\fB78\fRDirectory agent, OCTET. \fBSLP_SS\fR\fB79\fRService scope, OCTET. \fBAgentOpt\fR\fB82\fRAgent circuit ID, OCTET. \fBFQDN\fR\fB89\fRFully Qualified Domain Name, OCTET. \fBPXEarch\fR\fB93\fRClient system architecture, NUMBER. \fBBootFile\fR\fBN/A\fRFile to Boot, ASCII. \fBBootPath\fR\fBN/A\fRT{ Boot path prefix to apply to client's requested boot file, ASCII. T} \fBBootSrvA\fR\fBN/A\fRBoot Server, IP. \fBBootSrvN\fR\fBN/A\fRBoot Server Hostname, ASCII. \fBEchoVC\fR\fBN/A\fRT{ Echo Vendor Class Identifier Flag, (Present=\fBTRUE\fR) T} \fBLeaseNeg\fR\fBN/A\fRLease is Negotiable Flag, (Present=\fBTRUE\fR) .TE .SS "Mnemonic Identifiers for IPv6 Options" .sp .LP The following table maps the mnemonic identifiers used in Solaris DHCP to RFC 3315, 3319, 3646, 3898, 4075, and 4280 options: .sp .sp .TS tab(); cw(1.4i) cw(1.09i) cw(3.02i) lw(1.4i) lw(1.09i) lw(3.02i) . \fISymbol\fR\fICode\fR\fIDescription\fR _ \fBClientID\fR\fB1\fRUnique identifier for client, DUID \fBServerID\fR\fB2\fRUnique identifier for server, DUID \fBPreference\fR\fB7\fRServer preference, NUMBER \fBUnicast\fR\fB12\fRUnicast server address, IPV6 \fBUserClass\fR\fB15\fRUser classes for client, OCTET \fBVendorClass\fR\fB16\fRVendor client hardware items, OCTET \fBSIPNames\fR\fB21\fRSIP proxy server name list, DOMAIN \fBSIPAddresses\fR\fB22\fRT{ SIP proxy server addresses in preference order, IPV6 T} \fBDNSAddresses\fR\fB23\fRT{ DNS server addresses in preference order, IPV6 T} \fBDNSSearch\fR\fB24\fRDNS search list, DOMAIN \fBNISServers\fR\fB27\fRT{ NIS server addresses in preference order, IPV6 T} \fBNIS+Servers\fR\fB28\fRT{ NIS+ server addresses in preference order, IPV6 T} \fBNISDomain\fR\fB29\fRNIS domain name, DOMAIN \fBNIS+Domain\fR\fB30\fRNIS+ domain name, DOMAIN \fBSNTPServers\fR\fB31\fRIPV6 \fBInfoRefresh\fR\fB32\fRUNUMBER32 \fBBCMCDomain\fR\fB33\fRT{ Broadcast/multicast control server name list, DOMAIN T} \fBBCMCAddresses\fR\fB34\fRT{ Broadcast/multicast control server addresses, IPV6 T} .TE .SH EXAMPLES .LP \fBExample 1 \fRAltering the DHCP \fBinittab\fR File .sp .LP In general, the \fBDHCP\fR \fBinittab\fR file should only be altered to add \fBSITE\fR options. If other options are added, they will not be automatically carried forward when the system is upgraded. For instance: .sp .in +2 .nf ipPairs SITE, 132, IP, 2, 0, sdmi .fi .in -2 .sp .LP describes an option named \fBipPairs\fR, that is in the \fBSITE\fR category. That is, it is defined by each individual site, and is option code 132, which is of type \fBIP\fR Address, consisting of a potentially infinite number of pairs of \fBIP\fR addresses. .SH FILES .br .in +2 \fB/etc/dhcp/inittab\fR .in -2 .br .in +2 \fB/etc/dhcp/inittabv6\fR .in -2 .SH ATTRIBUTES .sp .LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp .sp .TS tab() box; cw(2.75i) |cw(2.75i) lw(2.75i) |lw(2.75i) . ATTRIBUTE TYPEATTRIBUTE VALUE _ Interface StabilityCommitted .TE .SH SEE ALSO .sp .LP \fBdhcpinfo\fR(1),\fBdhcpagent\fR(1M), \fBisspace\fR(3C), \fBdhcptab\fR(4), \fBattributes\fR(5), \fBdhcp\fR(5), \fBdhcp_modules\fR(5) .sp .LP \fISystem Administration Guide: IP Services\fR .sp .LP Alexander, S., and R. Droms. \fIRFC 2132, DHCP Options and BOOTP Vendor Extensions\fR. Network Working Group. March 1997. .sp .LP Droms, R. \fI RFC 2131, Dynamic Host Configuration Protocol\fR. Network Working Group. March 1997. .sp .LP Droms, R. \fIRFC 3315, Dynamic Host Configuration Protocol for IPv6 (DHCPv6)\fR. Cisco Systems. July 2003. .sp .LP Schulzrinne, H., and B. Volz. \fIRFC 3319, Dynamic Host Configuration Protocol (DHCPv6) Options for Session Initiation Protocol (SIP) Servers\fR. Columbia University and Ericsson. July 2003. .sp .LP Droms, R. \fIRFC 3646, DNS Configuration options for Dynamic Host Configuration Protocol for IPv6 (DHCPv6)\fR. Cisco Systems. December 2003. .sp .LP Kalusivalingam, V. \fIRFC 3898, Network Information Service (NIS) Configuration Options for Dynamic Host Configuration Protocol for IPv6 (DHCPv6)\fR. Cisco Systems. October 2004. .sp .LP Chowdhury, K., P. Yegani, and L. Madour. \fIRFC 4280, Dynamic Host Configuration Protocol (DHCP) Options for Broadcast and Multicast Control Servers\fR. Starent Networks, Cisco Systems, and Ericsson. November 2005. .sp .LP Mockapetris, P.V. \fIRFC 1035, Domain names - implementation and specification\fR. ISI. November 1987.