1 DHCP_INITTAB(4) File Formats and Configurations DHCP_INITTAB(4) 2 3 4 5 NAME 6 dhcp_inittab - information repository for DHCP options 7 8 DESCRIPTION 9 The /etc/dhcp/inittab and the /etc/dhcp/inittab6 files contain 10 information about the Dynamic Host Configuration Protocol (DHCP) 11 options, which are network configuration parameters passed from DHCP 12 servers to DHCP clients when a client machine uses DHCP. Since many 13 DHCP-related commands must parse and understand these DHCP options, 14 this file serves as a central location where information about these 15 options may be obtained. 16 17 18 The DHCP inittab and inittab6 files provide three general pieces of 19 information: 20 21 o A mnemonic alias, or symbol name, for each option number. 22 For instance, option 12 is aliased to the name Hostname. 23 This is useful for DHCP-related programs that require human 24 interaction, such as dhcpinfo(1). 25 26 o Information about the syntax for each option. This includes 27 information such as the type of the value, for example, 28 whether it is a 16-bit integer or an IP address. 29 30 o The policy for what options are visible to which 31 DHCP-related programs. 32 33 34 If you make any changes to the /etc/dhcp/inittab file, note that only 35 additions of or changes to SITE options are preserved during upgrade. 36 For /etc/dhcp/inittab6, no options are preserved during upgrade. 37 38 39 The VENDOR options defined here are intended for use by the Solaris 40 DHCP client and DHCP management tools. The SUNW vendor space is owned 41 by Sun, and changes are likely during upgrade. If you need to configure 42 the Solaris DHCP server to support the vendor options of a different 43 client, see dhcptab(4) for details. 44 45 46 Each DHCP option belongs to a certain category, which roughly defines 47 the scope of the option; for instance, an option may only be understood 48 by certain hosts within a given site, or it may be globally understood 49 by all DHCP clients and servers. The following categories are defined; 50 the category names are not case-sensitive: 51 52 STANDARD 53 All client and server DHCP implementations agree on the 54 semantics. These are administered by the Internet Assigned 55 Numbers Authority (IANA). These options are numbered from 1 56 to 127 for IPv4 DHCP, and 1 to 65535 for DHCPv6. 57 58 59 SITE 60 Within a specific site, all client and server 61 implementations agree on the semantics. However, at another 62 site the type and meaning of the option may be quite 63 different. These options are numbered from 128 to 254 for 64 IPv4 DHCP. DHCPv6 does not support site options. 65 66 67 VENDOR 68 Each vendor may define 254 options (65536 for DHCPv6) 69 unique to that vendor. The vendor is identified within a 70 DHCP packet by the "Vendor Class" option, number 60 (number 71 17 for DHCPv6). An option with a specific numeric 72 identifier belonging to one vendor will, in general, have a 73 type and semantics different from that of a different 74 vendor. Vendor options are "super-encapsulated" into the 75 vendor field number 43, as defined in RFC 2132 for IPv4 76 DHCP, and number 17 as defined in RFC 3315 for DHCPv6. The 77 /etc/dhcp/inittab file contains only Sun vendor options. 78 Define non-Sun vendor options in the dhcptab file. 79 80 81 FIELD 82 This category allows the fixed fields within a DHCP packet 83 to be aliased to a mnemonic name for use with dhcpinfo(1). 84 85 86 INTERNAL 87 This category is internal to the Solaris DHCP 88 implementation and will not be further defined. 89 90 91 DHCP inittab and inittab6 Format 92 Data entries are written one per line and have seven fields; each entry 93 provides information for one option. Each field is separated by a 94 comma, except for the first and second, which are separated by 95 whitespace (as defined in isspace(3C)). An entry cannot be continued 96 onto another line. Blank lines and those whose first non-whitespace 97 character is '#' are ignored. 98 99 100 The fields, in order, are: 101 102 o Mnemonic Identifier 103 104 The Mnemonic Identifier is a user-friendly alias for the 105 option number; it is not case sensitive. This field must be 106 per-category unique and should be unique across all 107 categories. The option names in the STANDARD, SITE, and 108 VENDOR spaces should not overlap, or the behavior will be 109 undefined. See Mnemonic Identifiers for Options section of 110 this man page for descriptions of the option names. 111 112 o Category (scope) 113 114 The Category field is one of STANDARD, SITE, VENDOR, FIELD, 115 or INTERNAL and identifies the scope in which the option 116 falls. SITE is not used in inittab6. 117 118 o Option Number 119 120 The Option Number is the number of this option when it is in 121 a DHCP packet. This field should be per-category unique and 122 the STANDARD and SITE fields should not have overlapping 123 code fields or the behavior is undefined. 124 125 o Data Type 126 127 Data Type is one of the following values, which are not case 128 sensitive: 129 130 131 Ascii 132 A printable character string 133 134 135 Bool 136 Has no value. Scope limited to category limited 137 to INTERNAL. Presence of an option of this type 138 within a Solaris configuration file represents 139 TRUE, absence represents FALSE. 140 141 142 Octet 143 An array of bytes 144 145 146 Unumber8 147 An 8-bit unsigned integer 148 149 150 Snumber8 151 An 8-bit signed integer 152 153 154 Unumber16 155 A 16-bit unsigned integer 156 157 158 Snumber16 159 A 16-bit signed integer 160 161 162 Unumber24 163 A 24-bit unsigned integer 164 165 166 Unumber32 167 A 32-bit unsigned integer 168 169 170 Snumber32 171 A 32-bit signed integer 172 173 174 Unumber64 175 A 64-bit unsigned integer 176 177 178 Snumber64 179 A 64-bit signed integer 180 181 182 Ip 183 An IPv4 address 184 185 186 Ipv6 187 An IPv6 address 188 189 190 Duid 191 An RFC 3315 Unique Identifier 192 193 194 Domain 195 An RFC 1035-encoded domain name 196 197 198 The data type field describes an indivisible unit of the option 199 payload, using one of the values listed above. 200 201 o Granularity 202 203 The Granularity field describes how many indivisible units 204 in the option payload make up a whole value or item for this 205 option. The value must be greater than zero (0) for any data 206 type other than Bool, in which case it must be zero (0). 207 208 o Maximum Number Of Items 209 210 This value specifies the maximum items of Granularity which 211 are permissible in a definition using this symbol. For 212 example, there can only be one IP address specified for a 213 subnet mask, so the Maximum number of items in 214 this case is one (1). A Maximum value of zero (0) means 215 that a variable number of items is permitted. 216 217 o Visibility 218 219 The Visibility field specifies which DHCP-related programs 220 make use of this information, and should always be defined 221 as sdmi for newly added options. 222 223 Mnemonic Identifiers for IPv4 Options 224 The following table maps the mnemonic identifiers used in Solaris DHCP 225 to RFC 2132 options: 226 227 228 229 230 Symbol Code Description 231 -------------------------------------------------------------------------------------- 232 Subnet 1 Subnet Mask, dotted Internet address (IP). 233 UTCoffst 2 Coordinated Universal time offset (seconds) [deprecated]. 234 Router 3 List of Routers, IP. 235 Timeserv 4 List of RFC-868 servers, IP. 236 IEN116ns 5 List of IEN 116 name servers, IP. 237 DNSserv 6 List of DNS name servers, IP. 238 Logserv 7 List of MIT-LCS UDP log servers, IP. 239 Cookie 8 List of RFC-865 cookie servers, IP. 240 Lprserv 9 List of RFC-1179 line printer servers, IP. 241 Impress 10 List of Imagen Impress servers, IP. 242 Resource 11 List of RFC-887 resource location servers, IP. 243 Hostname 12 Client's hostname, value from hosts database. 244 Bootsize 13 Number of 512 octet blocks in boot image, NUMBER. 245 Dumpfile 14 Path where core image should be dumped, ASCII. 246 DNSdmain 15 DNS domain name, ASCII. 247 Swapserv 16 Client's swap server, IP. 248 Rootpath 17 Client's Root path, ASCII. 249 ExtendP 18 Extensions path, ASCII. 250 IpFwdF 19 IP Forwarding Enable/Disable, NUMBER. 251 NLrouteF 20 Non-local Source Routing, NUMBER. 252 PFilter 21 Policy Filter, IP. 253 MaxIpSiz 22 Maximum datagram Reassembly Size, NUMBER. 254 IpTTL 23 Default IP Time to Live, (1=<x<=255), NUMBER. 255 PathTO 24 RFC-1191 Path MTU Aging Timeout, NUMBER. 256 PathTbl 25 RFC-1191 Path MTU Plateau Table, NUMBER. 257 MTU 26 Interface MTU, x>=68, NUMBER. 258 SameMtuF 27 All Subnets are Local, NUMBER. 259 Broadcst 28 Broadcast Address, IP. 260 MaskDscF 29 Perform Mask Discovery, NUMBER. 261 MaskSupF 30 Mask Supplier, NUMBER. 262 RDiscvyF 31 Perform Router Discovery, NUMBER. 263 RSolictS 32 Router Solicitation Address, IP. 264 StaticRt 33 Static Route, Double IP (network router). 265 TrailerF 34 Trailer Encapsulation, NUMBER. 266 ArpTimeO 35 ARP Cache Time out, NUMBER. 267 EthEncap 36 Ethernet Encapsulation, NUMBER. 268 TcpTTL 37 TCP Default Time to Live, NUMBER. 269 TcpKaInt 38 TCP Keepalive Interval, NUMBER. 270 TcpKaGbF 39 TCP Keepalive Garbage, NUMBER. 271 NISdmain 40 NIS Domain name, ASCII. 272 NISservs 41 List of NIS servers, IP. 273 NTPservs 42 List of NTP servers, IP. 274 NetBNms 44 List of NetBIOS Name servers, IP. 275 NetBDsts 45 List of NetBIOS Distribution servers, IP. 276 NetBNdT 46 NetBIOS Node type (1=B-node, 2=P, 4=M, 8=H). 277 NetBScop 47 NetBIOS scope, ASCII. 278 XFontSrv 48 List of X Window Font servers, IP. 279 XDispMgr 49 List of X Window Display managers, IP. 280 LeaseTim 51 Lease Time Policy, (-1 = PERM), NUMBER. 281 Message 56 Message to be displayed on client, ASCII. 282 T1Time 58 Renewal (T1) time, NUMBER. 283 T2Time 59 Rebinding (T2) time, NUMBER. 284 NW_dmain 62 NetWare/IP Domain Name, ASCII. 285 NWIPOpts 63 NetWare/IP Options, OCTET (unknown type). 286 NIS+dom 64 NIS+ Domain name, ASCII. 287 NIS+serv 65 NIS+ servers, IP. 288 TFTPsrvN 66 TFTP server hostname, ASCII. 289 OptBootF 67 Optional Bootfile path, ASCII. 290 MblIPAgt 68 Mobile IP Home Agent, IP. 291 SMTPserv 69 Simple Mail Transport Protocol Server, IP. 292 POP3serv 70 Post Office Protocol (POP3) Server, IP. 293 NNTPserv 71 Network News Transport Proto. (NNTP) Server, IP. 294 WWWservs 72 Default WorldWideWeb Server, IP. 295 Fingersv 73 Default Finger Server, IP. 296 IRCservs 74 Internet Relay Chat Server, IP. 297 STservs 75 StreetTalk Server, IP. 298 STDAservs 76 StreetTalk Directory Assist. Server, IP. 299 UserClas 77 User class information, ASCII. 300 SLP_DA 78 Directory agent, OCTET. 301 SLP_SS 79 Service scope, OCTET. 302 ClientFQDN 81 Fully Qualified Domain Name, OCTET. 303 AgentOpt 82 Agent circuit ID, OCTET. 304 FQDN 89 Fully Qualified Domain Name, OCTET. 305 PXEarch 93 Client system architecture, NUMBER. 306 BootFile N/A File to Boot, ASCII. 307 BootPath N/A Boot path prefix to apply to client's requested boot file, ASCII. 308 BootSrvA N/A Boot Server, IP. 309 BootSrvN N/A Boot Server Hostname, ASCII. 310 EchoVC N/A Echo Vendor Class Identifier Flag, (Present=TRUE) 311 LeaseNeg N/A Lease is Negotiable Flag, (Present=TRUE) 312 313 314 Mnemonic Identifiers for IPv6 Options 315 The following table maps the mnemonic identifiers used in Solaris DHCP 316 to RFC 3315, 3319, 3646, 3898, 4075, and 4280 options: 317 318 319 320 321 Symbol Code Description 322 ---------------------------------------------------------------------------- 323 ClientID 1 Unique identifier for client, DUID 324 ServerID 2 Unique identifier for server, DUID 325 Preference 7 Server preference, NUMBER 326 Unicast 12 Unicast server address, IPV6 327 UserClass 15 User classes for client, OCTET 328 VendorClass 16 Vendor client hardware items, OCTET 329 SIPNames 21 SIP proxy server name list, DOMAIN 330 SIPAddresses 22 SIP proxy server addresses in preference order, IPV6 331 DNSAddresses 23 DNS server addresses in preference order, IPV6 332 DNSSearch 24 DNS search list, DOMAIN 333 NISServers 27 NIS server addresses in preference order, IPV6 334 NIS+Servers 28 NIS+ server addresses in preference order, IPV6 335 NISDomain 29 NIS domain name, DOMAIN 336 NIS+Domain 30 NIS+ domain name, DOMAIN 337 SNTPServers 31 IPV6 338 InfoRefresh 32 UNUMBER32 339 BCMCDomain 33 Broadcast/multicast control server name list, DOMAIN 340 BCMCAddresses 34 Broadcast/multicast control server addresses, IPV6 341 342 343 EXAMPLES 344 Example 1 Altering the DHCP inittab File 345 346 347 In general, the DHCP inittab file should only be altered to add SITE 348 options. If other options are added, they will not be automatically 349 carried forward when the system is upgraded. For instance: 350 351 352 ipPairs SITE, 132, IP, 2, 0, sdmi 353 354 355 356 describes an option named ipPairs, that is in the SITE category. That 357 is, it is defined by each individual site, and is option code 132, 358 which is of type IP Address, consisting of a potentially infinite 359 number of pairs of IP addresses. 360 361 362 FILES 363 /etc/dhcp/inittab 364 /etc/dhcp/inittabv6 365 366 ATTRIBUTES 367 See attributes(5) for descriptions of the following attributes: 368 369 370 371 372 +--------------------+-----------------+ 373 | ATTRIBUTE TYPE | ATTRIBUTE VALUE | 374 +--------------------+-----------------+ 375 |Interface Stability | Committed | 376 +--------------------+-----------------+ 377 378 SEE ALSO 379 dhcpinfo(1),dhcpagent(1M), isspace(3C), dhcptab(4), attributes(5), 380 dhcp(5), dhcp_modules(5) 381 382 383 System Administration Guide: IP Services 384 385 386 Alexander, S., and R. Droms. RFC 2132, DHCP Options and BOOTP Vendor 387 Extensions. Network Working Group. March 1997. 388 389 390 Droms, R. RFC 2131, Dynamic Host Configuration Protocol. Network 391 Working Group. March 1997. 392 393 394 Droms, R. RFC 3315, Dynamic Host Configuration Protocol for IPv6 395 (DHCPv6). Cisco Systems. July 2003. 396 397 398 Schulzrinne, H., and B. Volz. RFC 3319, Dynamic Host Configuration 399 Protocol (DHCPv6) Options for Session Initiation Protocol (SIP) 400 Servers. Columbia University and Ericsson. July 2003. 401 402 403 Droms, R. RFC 3646, DNS Configuration options for Dynamic Host 404 Configuration Protocol for IPv6 (DHCPv6). Cisco Systems. December 2003. 405 406 407 Kalusivalingam, V. RFC 3898, Network Information Service (NIS) 408 Configuration Options for Dynamic Host Configuration Protocol for IPv6 409 (DHCPv6). Cisco Systems. October 2004. 410 411 412 Chowdhury, K., P. Yegani, and L. Madour. RFC 4280, Dynamic Host 413 Configuration Protocol (DHCP) Options for Broadcast and Multicast 414 Control Servers. Starent Networks, Cisco Systems, and Ericsson. 415 November 2005. 416 417 418 Mockapetris, P.V. RFC 1035, Domain names - implementation and 419 specification. ISI. November 1987. 420 421 422 423 October 31, 2016 DHCP_INITTAB(4)