1dhcp_inittab(4)                  File Formats                  dhcp_inittab(4)
2
3
4

NAME

6       dhcp_inittab - information repository for DHCP options
7

DESCRIPTION

9       The /etc/dhcp/inittab and the /etc/dhcp/inittab6 files contain informa‐
10       tion about the Dynamic  Host  Configuration  Protocol  (DHCP)  options,
11       which  are network configuration parameters passed from DHCP servers to
12       DHCP clients when a client machine uses DHCP. Since  many  DHCP-related
13       commands must parse and understand these DHCP options, this file serves
14       as a central location where information  about  these  options  may  be
15       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 DHCP-
31                  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    All client and server DHCP  implementations  agree  on  the
53                   semantics.  These are administered by the Internet Assigned
54                   Numbers Authority (IANA). These options are numbered from 1
55                   to 127 for IPv4 DHCP, and 1 to 65535 for DHCPv6.
56
57
58       SITE        Within  a  specific site, all client and server implementa‐
59                   tions agree on the semantics. However, at another site  the
60                   type  and  meaning  of  the  option may be quite different.
61                   These options are numbered from 128 to 254 for  IPv4  DHCP.
62                   DHCPv6 does not support site options.
63
64
65       VENDOR      Each  vendor  may  define  254  options  (65536 for DHCPv6)
66                   unique to that vendor. The vendor is  identified  within  a
67                   DHCP packet by the "Vendor Class" option, number 60 (number
68                   17 for DHCPv6). An option with a specific  numeric  identi‐
69                   fier  belonging to one vendor will, in general, have a type
70                   and semantics different from that of  a  different  vendor.
71                   Vendor  options  are  "super-encapsulated"  into the vendor
72                   field number 43, as defined in RFC 2132 for IPv4 DHCP,  and
73                   number   17   as  defined  in  RFC  3315  for  DHCPv6.  The
74                   /etc/dhcp/inittab file contains only  Sun  vendor  options.
75                   Define non-Sun vendor options in the dhcptab file.
76
77
78       FIELD       This  category allows the fixed fields within a DHCP packet
79                   to be aliased to a mnemonic name for use with dhcpinfo(1).
80
81
82       INTERNAL    This category is internal to the Solaris  DHCP  implementa‐
83                   tion and will not be further defined.
84
85
86   DHCP inittab and inittab6 Format
87       Data entries are written one per line and have seven fields; each entry
88       provides information for one option.  Each  field  is  separated  by  a
89       comma,  except  for the first and second, which are separated by white‐
90       space (as defined in isspace(3C)). An entry cannot  be  continued  onto
91       another  line. Blank lines and those whose first non-whitespace charac‐
92       ter is '#' are ignored.
93
94
95       The fields, in order, are:
96
97           o      Mnemonic Identifier
98
99                  The Mnemonic Identifier is a  user-friendly  alias  for  the
100                  option  number; it is not case sensitive. This field must be
101                  per-category unique and should be unique  across  all  cate‐
102                  gories.  The  option names in the STANDARD, SITE, and VENDOR
103                  spaces should not overlap, or the  behavior  will  be  unde‐
104                  fined.  See Mnemonic Identifiers for Options section of this
105                  man page for descriptions of the option names.
106
107           o      Category (scope)
108
109                  The Category field is one of STANDARD, SITE, VENDOR,  FIELD,
110                  or  INTERNAL  and  identifies  the scope in which the option
111                  falls. SITE is not used in inittab6.
112
113           o      Option Number
114
115                  The Option Number is the number of this option when it is in
116                  a  DHCP packet. This field should be per-category unique and
117                  the STANDARD and SITE fields  should  not  have  overlapping
118                  code fields or the behavior is undefined.
119
120           o      Data Type
121
122                  Data Type is one of the following values, which are not case
123                  sensitive:
124
125
126                  Ascii        A printable character string
127
128
129                  Bool         Has no value. Scope limited to category limited
130                               to INTERNAL. Presence of an option of this type
131                               within a Solaris configuration file  represents
132                               TRUE, absence represents FALSE.
133
134
135                  Octet        An array of bytes
136
137
138                  Unumber8     An 8-bit unsigned integer
139
140
141                  Snumber8     An 8-bit signed integer
142
143
144                  Unumber16    A 16-bit unsigned integer
145
146
147                  Snumber16    A 16-bit signed integer
148
149
150                  Unumber24    A 24-bit unsigned integer
151
152
153                  Unumber32    A 32-bit unsigned integer
154
155
156                  Snumber32    A 32-bit signed integer
157
158
159                  Unumber64    A 64-bit unsigned integer
160
161
162                  Snumber64    A 64-bit signed integer
163
164
165                  Ip           An IPv4 address
166
167
168                  Ipv6         An IPv6 address
169
170
171                  Duid         An RFC 3315 Unique Identifier
172
173
174                  Domain       An RFC 1035-encoded domain name
175
176
177           The  data  type  field  describes an indivisible unit of the option
178           payload, using one of the values listed above.
179
180           o      Granularity
181
182                  The Granularity field describes how many  indivisible  units
183                  in the option payload make up a whole value or item for this
184                  option. The value must be greater than zero (0) for any data
185                  type other than Bool, in which case it must be zero (0).
186
187           o      Maximum Number Of Items
188
189                  This value specifies the maximum items of  Granularity which
190                  are permissible in a definition using this symbol. For exam‐
191                  ple,  there  can  only  be  one  IP  address specified for a
192                  subnet mask, so the  Maximum number of             items  in
193                  this case is one (1).  A   Maximum  value  of zero (0) means
194                  that a variable number of items is permitted.
195
196           o      Visibility
197
198                  The Visibility field specifies which  DHCP-related  programs
199                  make  use  of this information, and should always be defined
200                  as sdmi for newly added options.
201
202   Mnemonic Identifiers for IPv4 Options
203       The following table maps the mnemonic identifiers used in Solaris  DHCP
204       to RFC 2132 options:
205
206
207
208
209           Symbol          Code                     Description
210       ────────────────────────────────────────────────────────────────────────
211       Subnet           1             Subnet  Mask,  dotted  Internet  address
212                                      (IP).
213       UTCoffst         2             Coordinated Universal time offset  (sec‐
214                                      onds).
215       Router           3             List of Routers, IP.
216       Timeserv         4             List of RFC-868 servers, IP.
217       IEN116ns         5             List of IEN 116 name servers, IP.
218       DNSserv          6             List of DNS name servers, IP.
219       Logserv          7             List of MIT-LCS UDP log servers, IP.
220       Cookie           8             List of RFC-865 cookie servers, IP.
221       Lprserv          9             List  of  RFC-1179 line printer servers,
222                                      IP.
223       Impress          10            List of Imagen Impress servers, IP.
224       Resource         11            List  of   RFC-887   resource   location
225                                      servers, IP.
226       Hostname         12            Client's   hostname,  value  from  hosts
227                                      database.
228       Bootsize         13            Number  of  512  octet  blocks  in  boot
229                                      image, NUMBER.
230       Dumpfile         14            Path  where core image should be dumped,
231                                      ASCII.
232       DNSdmain         15            DNS domain name, ASCII.
233       Swapserv         16            Client's swap server, IP.
234       Rootpath         17            Client's Root path, ASCII.
235       ExtendP          18            Extensions path, ASCII.
236       IpFwdF           19            IP Forwarding Enable/Disable, NUMBER.
237       NLrouteF         20            Non-local Source Routing, NUMBER.
238       PFilter          21            Policy Filter, IP.
239       MaxIpSiz         22            Maximum datagram Reassembly  Size,  NUM‐
240                                      BER.
241       IpTTL            23            Default  IP  Time  to Live, (1=<x<=255),
242                                      NUMBER.
243       PathTO           24            RFC-1191 Path MTU Aging Timeout, NUMBER.
244       PathTbl          25            RFC-1191 Path MTU Plateau Table, NUMBER.
245       MTU              26            Interface MTU, x>=68, NUMBER.
246       SameMtuF         27            All Subnets are Local, NUMBER.
247       Broadcst         28            Broadcast Address, IP.
248       MaskDscF         29            Perform Mask Discovery, NUMBER.
249       MaskSupF         30            Mask Supplier, NUMBER.
250       RDiscvyF         31            Perform Router Discovery, NUMBER.
251       RSolictS         32            Router Solicitation Address, IP.
252       StaticRt         33            Static   Route,   Double   IP   (network
253                                      router).
254       TrailerF         34            Trailer Encapsulation, NUMBER.
255       ArpTimeO         35            ARP Cache Time out, NUMBER.
256       EthEncap         36            Ethernet Encapsulation, NUMBER.
257       TcpTTL           37            TCP Default Time to Live, NUMBER.
258       TcpKaInt         38            TCP Keepalive Interval, NUMBER.
259       TcpKaGbF         39            TCP Keepalive Garbage, NUMBER.
260       NISdmain         40            NIS Domain name, ASCII.
261       NISservs         41            List of NIS servers, IP.
262       NTPservs         42            List of NTP servers, IP.
263       NetBNms          44            List of NetBIOS Name servers, IP.
264       NetBDsts         45            List  of  NetBIOS  Distribution servers,
265                                      IP.
266       NetBNdT          46            NetBIOS Node type (1=B-node,  2=P,  4=M,
267                                      8=H).
268
269       NetBScop         47            NetBIOS scope, ASCII.
270       XFontSrv         48            List of X Window Font servers, IP.
271       XDispMgr         49            List of X Window Display managers, IP.
272       LeaseTim         51            Lease Time Policy, (-1 = PERM), NUMBER.
273       Message          56            Message   to  be  displayed  on  client,
274                                      ASCII.
275       T1Time           58            Renewal (T1) time, NUMBER.
276       T2Time           59            Rebinding (T2) time, NUMBER.
277       NW_dmain         62            NetWare/IP Domain Name, ASCII.
278       NWIPOpts         63            NetWare/IP   Options,   OCTET   (unknown
279                                      type).
280       NIS+dom          64            NIS+ Domain name, ASCII.
281       NIS+serv         65            NIS+ servers, IP.
282       TFTPsrvN         66            TFTP server hostname, ASCII.
283       OptBootF         67            Optional Bootfile path, ASCII.
284       MblIPAgt         68            Mobile IP Home Agent, IP.
285       SMTPserv         69            Simple  Mail  Transport Protocol Server,
286                                      IP.
287       POP3serv         70            Post Office Protocol (POP3) Server, IP.
288       NNTPserv         71            Network  News  Transport  Proto.  (NNTP)
289                                      Server, IP.
290       WWWservs         72            Default WorldWideWeb Server, IP.
291       Fingersv         73            Default Finger Server, IP.
292       IRCservs         74            Internet Relay Chat Server, IP.
293       STservs          75            StreetTalk Server, IP.
294       STDAservs        76            StreetTalk Directory Assist. Server, IP.
295       UserClas         77            User class information, ASCII.
296       SLP_DA           78            Directory agent, OCTET.
297       SLP_SS           79            Service scope, OCTET.
298       AgentOpt         82            Agent circuit ID, OCTET.
299       FQDN             89            Fully Qualified Domain Name, OCTET.
300       PXEarch          93            Client system architecture, NUMBER.
301       BootFile         N/A           File to Boot, ASCII.
302       BootPath         N/A           Boot  path  prefix  to apply to client's
303                                      requested boot file, ASCII.
304       BootSrvA         N/A           Boot Server, IP.
305       BootSrvN         N/A           Boot Server Hostname, ASCII.
306       EchoVC           N/A           Echo  Vendor  Class   Identifier   Flag,
307                                      (Present=TRUE)
308       LeaseNeg         N/A           Lease is Negotiable Flag, (Present=TRUE)
309
310
311   Mnemonic Identifiers for IPv6 Options
312       The  following table maps the mnemonic identifiers used in Solaris DHCP
313       to RFC 3315, 3319, 3646, 3898, 4075, and 4280 options:
314
315
316
317
318           Symbol          Code                   Description
319       ───────────────────────────────────────────────────────────────────
320       ClientID         1             Unique identifier for client, DUID
321       ServerID         2             Unique identifier for server, DUID
322       Preference       7             Server preference, NUMBER
323       Unicast          12            Unicast server address, IPV6
324       UserClass        15            User classes for client, OCTET
325       VendorClass      16            Vendor client hardware items, OCTET
326       SIPNames         21            SIP proxy server name list, DOMAIN
327       SIPAddresses     22            SIP proxy server addresses in pref‐
328                                      erence order, IPV6
329       DNSAddresses     23            DNS  server addresses in preference
330                                      order, IPV6
331       DNSSearch        24            DNS search list, DOMAIN
332       NISServers       27            NIS server addresses in  preference
333                                      order, IPV6
334
335
336       NIS+Servers      28            NIS+ server addresses in preference
337                                      order, IPV6
338       NISDomain        29            NIS domain name, DOMAIN
339       NIS+Domain       30            NIS+ domain name, DOMAIN
340       SNTPServers      31            IPV6
341       InfoRefresh      32            UNUMBER32
342       BCMCDomain       33            Broadcast/multicast control  server
343                                      name list, DOMAIN
344       BCMCAddresses    34            Broadcast/multicast  control server
345                                      addresses, IPV6
346
347

EXAMPLES

349       Example 1 Altering the DHCP inittab File
350
351
352       In general, the DHCP inittab file should only be altered  to  add  SITE
353       options.  If  other  options  are added, they will not be automatically
354       carried forward when the system is upgraded. For instance:
355
356
357         ipPairs    SITE, 132, IP, 2, 0, sdmi
358
359
360
361       describes an option named ipPairs, that is in the SITE  category.  That
362       is,  it  is  defined  by each individual site, and is  option code 132,
363       which is of type IP Address, consisting  of a potentially infinite num‐
364       ber of pairs of IP addresses.
365
366

FILES

368         /etc/dhcp/inittab
369         /etc/dhcp/inittabv6
370

ATTRIBUTES

372       See attributes(5)  for descriptions of the following attributes:
373
374
375
376
377       ┌─────────────────────────────┬─────────────────────────────┐
378       │      ATTRIBUTE TYPE         │      ATTRIBUTE VALUE        │
379       ├─────────────────────────────┼─────────────────────────────┤
380       │Availability                 │SUNWcsr                      │
381       ├─────────────────────────────┼─────────────────────────────┤
382       │Interface Stability          │Committed                    │
383       └─────────────────────────────┴─────────────────────────────┘
384

SEE ALSO

386       dhcpinfo(1),dhcpagent(1M),   isspace(3C),   dhcptab(4),  attributes(5),
387       dhcp(5), dhcp_modules(5)
388
389
390       System Administration Guide: IP Services
391
392
393       Alexander, S., and R. Droms. RFC 2132, DHCP Options  and  BOOTP  Vendor
394       Extensions. Network Working Group. March 1997.
395
396
397       Droms, R.  RFC 2131, Dynamic Host Configuration Protocol. Network Work‐
398       ing Group. March 1997.
399
400
401       Droms, R. RFC  3315,  Dynamic  Host  Configuration  Protocol  for  IPv6
402       (DHCPv6). Cisco Systems. July 2003.
403
404
405       Schulzrinne, H., and B. Volz. RFC 3319, Dynamic Host Configuration Pro‐
406       tocol (DHCPv6) Options for Session Initiation Protocol  (SIP)  Servers.
407       Columbia University and Ericsson. July 2003.
408
409
410       Droms, R. RFC 3646, DNS Configuration options for Dynamic Host Configu‐
411       ration Protocol for IPv6 (DHCPv6). Cisco Systems. December 2003.
412
413
414       Kalusivalingam, V. RFC 3898, Network Information Service (NIS) Configu‐
415       ration  Options  for  Dynamic  Host  Configuration  Protocol  for  IPv6
416       (DHCPv6). Cisco Systems. October 2004.
417
418
419       Chowdhury, K., P. Yegani, and L. Madour. RFC 4280, Dynamic Host Config‐
420       uration  Protocol  (DHCP)  Options  for Broadcast and Multicast Control
421       Servers. Starent Networks, Cisco Systems, and Ericsson. November 2005.
422
423
424       Mockapetris, P.V. RFC 1035, Domain names - implementation and  specifi‐
425       cation. ISI. November 1987.
426
427
428
429SunOS 5.11                        31 Aug 2009                  dhcp_inittab(4)
Impressum