Cisco DHCP Options Guide
Cisco DHCP Options Guide
Cisco DHCP Options Guide
DHCP provides a framework for passing configuration information to hosts on a TCP/IP network. Configuration
parameters and other control information are carried in tagged data items that are stored in the options field
of the DHCP message. The data items themselves are also called options.
This appendix contains DHCP options and BOOTP vendor extensions from RFC 2132, and includes the
validation type for each option, as indicated in Table 10: DHCPv4 Options by Number , on page 22.
This appendix also contains the standard Microsoft client options and several tables displaying the options
sorted by categories.
• Option Descriptions, on page 1
• Option Tables, on page 22
Option Descriptions
The following sections describe the DHCP options in detail:
• RFC 1497 Vendor Extensions, on page 1
• IP Layer Parameters Per Host, on page 3
• IP Layer Parameters Per Interface, on page 4
• Link Layer Parameters Per Interface, on page 5
• TCP Parameters, on page 5
• Application and Service Parameters, on page 5
• DHCPv4 Extension Options, on page 11
• DHCPv6 Options, on page 14
• Microsoft Client Options, on page 13
• Options by Number, on page 22
• Options by Cisco Prime Network Registrar Name, on page 29
• Option Validation Types, on page 39
DHCP Options
1
DHCP Options
DHCP Options
End 255 1 octet End of valid information in the vendor field. Subsequent
octets should be filled with the Pad options.
Subnet Mask 1 4 octets Client subnet mask, as per RFC 950. If both the Subnet
Mask and the Router option are specified in a DHCP
reply, the Subnet Mask option must be first.
Time Offset 2 4 octets Offset of the client subnet, in seconds, from Universal
Time (UT). The offset is expressed as a twos-complement
32-bit integer. A positive offset indicates a location east
of the zero meridian and a negative offset indicates a
location west of the zero meridian.
Router 3 4 octets minimum; List of IP addresses for routers on the client subnet.
multiples of 4 Routers should be in order of preference.
Time Server 4 4 octets minimum; List of RFC 868 compliant time servers available to the
multiples of 4 client. Servers should be in order of preference.
Name Server 5 4 octets minimum; List of IEN 116 name servers available to the client.
Option multiples of 4 Servers should be in order of preference.
Domain Name 6 4 octets minimum; List of Domain Name System (STD 13, RFC 1035) name
Server multiples of 4 servers available to the client. Servers should be in order
of preference.
Log Server 7 4 octets minimum; List of MIT-LCS UDP log servers available to the client.
multiples of 4 Servers should be in order of preference.
Cookie Server 8 4 octets minimum; List of RFC 865-compliant cookie servers available to
multiples of 4 the client. Servers should be in order of preference.
LPR Server 9 4 octets minimum; List of RFC 1179-compliant line printer servers available
multiples of 4 to the client. Servers should be in order of preference.
Impress Server 10 4 octets minimum; List of Imagen Impress servers available to the client.
multiples of 4 Servers should be in order of preference.
Resource Location 11 4 octets minimum; List of RFC 887-compliant resource location servers
Server multiples of 4 available to the client. Servers should be in order of
preference.
Host Name 12 1 octet minimum Name of the client. The name may or may not be qualified
with the local domain name. See RFC 1035 for the
character set restrictions.
Boot File Size 13 2 octets Number of 512-octet blocks in the default boot file.
DHCP Options
2
DHCP Options
IP Layer Parameters Per Host
Merit Dump File 14 1 octet minimum Path name of a file to which the client core image should
be placed in the event the client crashes. The path is
formatted as a character string consisting of characters
from the NVT ASCII character set.
Domain Name 15 1 octet minimum Domain name that the client should use when resolving
hostnames through the Domain Name System.
Root Path 17 1 octet minimum Path name that contains the client root disk. The path is
formatted as a character string consisting of characters
from the NVT ASCII character set.
Extensions Path 18 1 octet minimum Uses a string to specify a file, retrievable through TFTP.
The file contains information that can be interpreted in
the same way as the 64-octet vendor-extension field
within the BOOTP response, with these exceptions: the
length of the file is unconstrained, and all references to
instances of this option in the file are ignored.
IP Forwarding 19 1 octet Specifies whether the client should configure its IP layer
Enable/Disable for packet forwarding. Values: 0=disable; 1=enable
Non-Local Source 20 1 octet Specifies whether the client should configure its IP layer
Routing Enable/Disable to allow forwarding of datagrams with non-local source
routes. Values: 0=disable; 1=enable
Policy Filter 21 8 octets minimum; Policy filters for non-local source routing. The filters
multiples of 8 consist of a list of IP addresses and masks that specify
destination/mask pairs with which to filter incoming
source routes. Any source-routed datagram whose
next-hop address does not match one of the filters should
be discarded by the client.
Maximum Datagram 22 2 octets Maximum size datagram that the client should be
Reassembly Size prepared to reassemble. Value: 576 minimum
Default IP Time-to-live 23 1 octet Default TTL that the client should use on outgoing
datagrams. Values: 1 to 255
DHCP Options
3
DHCP Options
IP Layer Parameters Per Interface
Path MTU Aging 24 4 octets Timeout (in seconds) to use when aging Path MTU
Timeout values (defined in RFC 1191).
Path MTU Plateau Table 25 2 octets minimum; Table of MTU sizes to use when performing Path MTU
multiples of 2 Discovery as defined in RFC 1191. The table is formatted
as a list of 16-bit unsigned integers, ordered from
smallest to largest. Value: 68 minimum
Interface MTU 26 2 octets MTU to use on this interface.The minimum legal value for
the MTU is 68.
All Subnets are Local 27 1 octet Specifies whether or not the client can assume that all subnets
of the IP network to which the client is connected use the
same MTU as the subnet of that network to which the client
is directly connected. Values: 1=all subnets share same MTU;
0=some directly-connected subnets can have smaller MTUs
Perform Mask 29 1 octet Specifies whether or not the client should perform subnet
Discovery mask discovery using ICMP. Values: 0=disable; 1=enable
Mask Supplier 30 1 octet Specifies whether or not the client should respond to subnet
mask requests using ICMP. Values: 0=do not respond;
1=respond
Perform Router 31 1 octet Specifies whether or not the client should solicit routers using
Discovery the Router Discovery mechanism defined in RFC 1256.
Values: 0=disable; 1=enable
Router Solicitation 32 4 octets Address to which the client should transmit router solicitation
Address requests.
Static Route 33 8 octets List of static routes that the client should install in its routing
minimum; cache. If multiple routes to the same destination are specified,
multiples of 8 they are in descending order of priority. The routes consist
of a list of IP address pairs. The first address is the destination
address, and the second address is the router for the
destination. The default route (0.0.0.0) is an illegal destination
for a static route.
DHCP Options
4
DHCP Options
Link Layer Parameters Per Interface
Trailer Encapsulation 34 1 octet Specifies whether or not the client should negotiate the use of trailers
(RFC 893) when using the ARP protocol. Values: 0=do not use; 1=use
ARP Cache Timeout 35 4 octets Timeout in seconds for ARP cache entries.
Ethernet Encapsulation 36 1 octet Specifies whether or not the client should use Ethernet Version 2
(RFC 894) or IEEE 802.3 (RFC 1042) encapsulation if the interface
is an Ethernet. Value: 0=use RFC 894 encapsulation; 1=use RFC 1042
encapsulation
TCP Parameters
The table below lists the options that affect the operation of the TCP layer on a per-interface basis.
TCP Default TTL 37 1 octet Default TTL that the client should use when sending TCP segments.
Value: minimum 1
TCP Keepalive Interval 38 4 octets Interval (in seconds) that the client TCP should wait before sending
a keepalive message on a TCP connection. The time is specified as
a 32-bit unsigned integer. A value of zero indicates that the client
should not generate keepalive messages on connections unless
specifically requested by an application. Value: 32-bit unsigned; 0=do
not generate keepalive messages unless specifically requested.
TCP Keepalive Garbage 39 1 octet Specifies the whether or not the client should send TCP keep-alive
messages with an octet of garbage for compatibility with older
implementations. Values: 0=do not send; 1=send
DHCP Options
5
DHCP Options
DHCP Options
DHCP Options
6
DHCP Options
DHCP Options
DHCP Options
7
DHCP Options
DHCP Options
DHCP Options
8
DHCP Options
DHCP Options
NetBIOS over TCP/IP 44 4 octets minimum; multiples of 4 List of RFC 1001/1002 NBNS
Name Server name servers in order of
preference.
NetBIOS over TCP/IP 45 4 octets minimum; multiples of 4 List of RFC 1001/1002 NBDD
Datagram Distribution servers in order of preference.
Server
DHCP Options
9
DHCP Options
DHCP Options
Simple Mail Transport 69 4 octets minimum; multiples of 4 List of SMTP servers available
Protocol (SMTP) to the client. Servers should be in
Server order of preference.
Post Office Protocol 70 4 octets minimum; multiples of 4 List of POP3 servers available to
(POP3) Server the client. Servers should be in
order of preference.
Default World Wide 72 4 octets minimum; multiples of 4 List of World Wide Web
Web (WWW) Server (WWW) servers available to the
client. Servers should be in order
of preference.
Default Finger Server 73 4 octets minimum; multiples of 4 List of Finger servers available
to the client. Servers should be in
order of preference.
Default Internet Relay 74 4 octets minimum; multiples of 4 List of IRC servers available to
Chat (IRC) Server the client. Servers should be in
order of preference.
DHCP Options
10
DHCP Options
DHCPv4 Extension Options
Option Overload 52 1 octet Indicates that the DHCP sname or file fields are being overloaded
by using them to carry DHCP options. A DHCP server inserts this
option if the returned parameters will exceed the usual space allotted
for options. If this option is present, the client interprets the
specified additional fields after it concludes interpretation of the
standard option fields. Values: 1=file field is used to hold options;
2=sname field is used to hold options; 3=both fields are used to
hold options
DHCP Message 53 1 octet Used to convey the type of DHCP message. The preset value is 1
Type (DHCPDISCOVER). Values: 1=DHCPDISCOVER;
2=DHCPOFFER; 3=DHCPREQUEST; 4=DHCPDECLINE;
5=DHCPACK; 6=DHCPNAK; 7=DHCPRELEASE;
8=DHCPINFORM; 13=LEASEQUERY
Server Identifier 54 4 octets Used in DHCPOFFER and DHCPREQUEST messages, and can
optionally be included in the DHCPACK and DHCPNAK messages.
DHCP servers include this option in the DHCPOFFER in order to
allow the client to distinguish between lease offers. DHCP clients
use the contents of the server identifier field as the destination
address for any DHCP messages unicast to the DHCP server. DHCP
clients also indicate which of several lease offers is being accepted
by including this option in a DHCPREQUEST message. The
identifier is the IP address of the selected server.
Parameter Request 55 1 octet Used by a DHCP client to request values for specified configuration
List minimum parameters. The list of requested parameters is specified as n octets,
where each octet is a valid DHCP option code as defined in this
document. The client can list the options in order of preference.
The DHCP server does not have to return the options in the
requested order, but must try to insert the options in the order that
the client requested.
DHCP Options
11
DHCP Options
DHCP Options
Maximum DHCP 57 2 octets Maximum-length DHCP message that a server is willing to accept.
Message Size The length is specified as an unsigned 16-bit integer. A client can
use the maximum DHCP message size option in DHCPDISCOVER
or DHCPREQUEST messages, but should not use the option in
DHCPDECLINE messages. Value: 576 minimum
Renewal (T1) Time 58 4 octets Time interval from address assignment until the client transitions
Value to RENEWING state. Value: seconds, as 32-bit unsigned integer
Rebinding (T2) 59 4 octets Time interval from address assignment until the client transitions
Time Value to REBINDING state. Value: seconds, as 32-bit unsigned integer
Vendor Class 60 1 octet Used by DHCP clients to optionally identify the vendor type and
Identifier minimum configuration of a DHCP client. The information is a string of n
octets, interpreted by servers. Vendors can choose to define specific
vendor class identifiers to convey particular configuration or other
identification information about a client. For example, the identifier
can encode the client hardware configuration. Servers not equipped
to interpret the class-specific information sent by a client must
ignore it (although it can be reported). Servers that respond should
only use option 43 to return the vendor-specific information to the
client.
Client-Identifier 61 2 octets Used by DHCP clients to specify their unique identifier. DHCP
minimum servers use this value to index their database of address bindings.
This value is expected to be unique for all clients in an
administrative domain.
DHCP servers should treat identifiers as opaque objects. The client
identifier can consist of type-value pairs similar to the htype /chaddr
fields. For instance, it can consist of a hardware type and hardware
address. In this case, the type field should be one of the ARP
hardware types defined in STD2. A hardware type of 0 (zero)
should be used when the value field contains an identifier other
than a hardware address (for example, a fully qualified domain
name).
For correct identification of clients, each client-identifier must be
unique among the client-identifiers used on the subnet to which
the client is attached. Vendors and system administrators are
responsible for choosing client-identifiers that meet this requirement
for uniqueness.
DHCP Options
12
DHCP Options
Microsoft Client Options
TFTP Server name 66 1 octet Identifies a TFTP server when the sname field in the DHCP header
minimum has been used for DHCP options.
Bootfile name 67 1 octet Identifies a bootfile when the file field is the DHCP header that
minimum has been used for DHCP options.
Relay Agent 82 Identifies the DHCP relay agent information (see RFC 3046)
Information
iSNS 83 14 bytes Identifies the Internet Storage Name Service (see RFC 4174)
minimum
BCMCS Controller 88 Variable List of Broadcast and Multicast Service (BCMCS) controller
Domain domains (see RFC 4280)
BCMCS Address 89 4 octets List of IP addresses for the BCMCS controller (see RFC 4280)
minimum
Lease Query Client 91 4 octets Time of the most recent access of the client sending a
Last Transaction DHCPLEASEQUERY (see RFC 4388).
Time
Lease Query 92 4 octets All IP addresses associated with the client specified in a particular
Associated IP minimum DHCPLEASEQUERY message (see RFC 4388).
Addresses
dhcp-lease-time 51 14 days
netbios-node-type 46 Identifies the NetBIOS client type; note that Cisco Prime Network Registrar
displays a warning if it is not present
DHCP Options
13
DHCP Options
DHCPv6 Options
DHCPv6 Options
The table below lists the DHCPv6 options, along with their defined data types. All the option packets include
at least an option length (option-len) and a variable length data field. There can also be additional parameter
settings, as described in the table. Many of these options are described in RFC 3315.
preference 7 A server sends this option to a client to affect what server the client
selects.
AT_INT8
elapsed-time 8 A client sends this option to a server to indicate how long the client
has been trying to complete a message exchange.
AT_SHORT
DHCP Options
14
DHCP Options
DHCP Options
server-unicast 12 The server sends this option to a client to indicate that the client can
unicast messages to the server.
AT_IP6ADDR
user-class 15 Clients use this option to identify the type or category of user or
applications it represents. A zero type count value field followed
AT_TYPECNT
by user data (as a blob).
vendor-class 16 Clients use this option to identify the vendor that manufactured the
hardware on which they are running.
AT_VENDOR_CLASS
interface-id 18 Relay agents use this option to identify the interface on which the
client message is received.
AT_BLOB
reconfigure-accept 20 Clients use this option to announce to the server whether the client
is willing to accept Reconfigure messages.
AT_ZEROSIZE
sip-servers-name 21 Domain names of the SIP outbound proxy servers for the client.
See RFC 3319.
AT_DNSNAME
sip-servers-address 22 IPv6 addresses of the SIP outbound proxy servers for the client.
AT_IP6ADDR
DHCP Options
15
DHCP Options
DHCP Options
info-refresh-time 32 Sets an upper bound for how long a client should wait before
refreshing DHCPv6 information (see RFC 4242).
AT_TIME
bcmcs-server-a 34 List of IPv6 addresses for the Broadcast and Multicast Service
(BCMCS) controller (see RFC 4280).
AT_IP6ADDR
remote-id 37 Relay agents that terminate switched or permanent circuits can add
this option to identify remote hosts (see RFC 4649).
AT_BLOB
DHCP Options
16
DHCP Options
DHCP Options
ero 43 Relay agent Echo Request option to inform the server of the list of
relay agent options to echo back.
AT_SHORT
DHCP Options
17
DHCP Options
DHCP Options
access-domain 57 Defines the domain name associated with the access network. This
option contains a single domain name and, as such, must contain
AT_DNSNAME
precisely one root label.
sip-ua-cs-domains 58 Defines the list of domain names in the Session Initiation Protocol
(SIP) User Agent Configuration Service Domains.
AT_DNSNAME
bootfile-param 60 Sent by the server to the client. It consists of multiple UTF-8 (see
RFC3629) strings for specifying parameters for the boot file.
AT_TYPECNT
client-arch-type 61 Provides parity with the Client System Architecture Type option
(option 93) defined for DHCPv4.
AT_SHORT
nii 62 Provides parity with the Client Network Interface Identifier option
(option 94) defined for DHCPv4.
AT_BLOB
DHCP Options
18
DHCP Options
DHCP Options
aftr-name 64 Defines a fully qualified domain name of the AFTR tunnel endpoint.
AT_DNSNAME
mip6-haa 72 Used by DHCP servers and relay agents to specify the home agent
IP address.
AT_IP6ADDR
krb-principal-name 75 Sent by the client to the DHCPv6 server, which uses it to select a
specific set of configuration parameters, either for a client or for a
AT_BLOB
Kerberos application server.
krb-realm-name 76 Specifies to a DHCPv6 server which realm the client wants to access.
AT_NSTRING
krb-default-realm-name 77 Specifies a default realm name for the Kerberos system (clients and
Kerberos application servers).
AT_NSTRING
DHCP Options
19
DHCP Options
DHCP Options
link-address 80 Indicates to the server the link on which the client is located.
AT_IP6ADDR
addrsel 84 Provides the policy table and some other configuration parameters.
AT_BLOB
dhcpv4_msg 87 Carries a DHCPv4 message that is sent by the client or the server.
Such messages exclude any IP or UDP headers.
AT_BLOB
dhcp4_o_dhcp6_server 88 Carries a list of DHCP 4o6 servers' IPv6 addresses that the client
should contact to obtain IPv4 configuration.
AT_IP6ADDR
s46-rule 89 Conveys the Basic Mapping Rule (BMR) and Forwarding Mapping
Rule (FMR).
AT_BLOB
s46-v4v6bind 92 Specifies the full or shared IPv4 address of the CE. The IPv6 prefix
field is used by the CE to identify the correct prefix to use for the
AT_BLOB
tunnel source.
DHCP Options
20
DHCP Options
DHCP Options
s46-cont-mape 94 Specifies the container used to group all rules and optional port
parameters for a specified domain (Softwire46 MAP-E domain).
AT_CONTAINER6
s46-cont-mapt 95 Specifies the container used to group all rules and optional port
parameters for a specified domain (Softwire46 MAP-T domain).
AT_CONTAINER6
s46-cont-lw 96 Specifies the container used to group all rules and optional port
parameters for a specified domain (Softwire46 Lightweight 4over6
AT_CONTAINER6
domain).
4rd 97 Indicates the DHCPv6 option for 4rd (IPv4 Residual Deployment).
AT_CONTAINER6
lq-base-time 100 Current time the message was created to be sent by the DHCPv6
server to the requestor of the Active or Bulk Leasequery if the
AT_INT
requestor asked for the same in an Active or Bulk Leasequery
request (RFC 7653).
lq-start-time 101 Specifies a query start time to the DHCPv6 server (RFC 7653).
AT_INT
lq-end-time 102 Specifies a query end time to the DHCPv6 server (RFC 7653).
AT_INT
captive-portal 103 Informs the client that it is behind a captive portal and provides the
URI to access an authentication page (RFC 7710).
AT_NSTRING
ani-att 105 Used for exchanging the type of access technology the client uses
to attach to the network (RFC 7839).
AT_BLOB
ani-network-name 106 Name of the access network to which the mobile node is attached
(RFC 7839).
AT_NSTRING
DHCP Options
21
DHCP Options
Option Tables
ani-ap-name 107 Name of the access point (physical device name) to which the mobile
node is attached (RFC 7839).
AT_NSTRING
ani-ap-bssid 108 48-bit Basic SSSID (BSSID) of the access point to which the mobile
node is attached (RFC 7839).
AT_BLOB
ipv6-address-andsf 143 Allows the mobile node (MN) to locate an ANDSF server (RFC
7839).
AT_IP6ADDR
Option Tables
The following tables display the DHCP options in various ways. They show the options sorted numerically,
by Cisco Prime Network Registrar name, and by category.
DHCP options have a prescribed format and allowed values for their option parameters. Table 10: DHCPv4
Options by Number , on page 22 lists each DHCP option and parameter type (in the Validation column). The
parameter formats and allowed values come from the DHCP and Internet RFCs. All the DHCP options appear,
but clients control only some, and the CLI only others.
Options by Number
The table below shows the DHCPv4 options sorted by option number, and includes the validation type. (See
Table 12: Validation Types , on page 39 for details on the option validation types found in the Validation
column.) A 0+ in the Comments column means a repeat count of zero or more occurrences, 1+ means one or
more occurrences, 2n means multiple occurrences in multiples of 2. Comments also indicate whether the
option includes suboptions, and, if so, how many.
Tip For the syntax for adding more complex option data values for suboptions, see Adding Complex Values for
Suboptions.
DHCP Options
22
DHCP Options
DHCP Options
DHCP Options
23
DHCP Options
DHCP Options
DHCP Options
24
DHCP Options
DHCP Options
DHCP Options
25
DHCP Options
DHCP Options
93 pxe-client-arch AT_SHORT
DHCP Options
26
DHCP Options
DHCP Options
95 ldap-url AT_NSTRING
98 user-auth AT_NSTRING
DHCP Options
27
DHCP Options
DHCP Options
DHCP Options
28
DHCP Options
Options by Cisco Prime Network Registrar Name
DHCP Options
29
DHCP Options
DHCP Options
authentication 90 Authentication --
DHCP Options
30
DHCP Options
DHCP Options
DHCP Options
31
DHCP Options
DHCP Options
DHCP Options
32
DHCP Options
DHCP Options
DHCP Options
33
DHCP Options
DHCP Options
DHCP Options
34
DHCP Options
DHCP Options
DHCP Options
35
DHCP Options
DHCP Options
pad 0 Pad --
DHCP Options
36
DHCP Options
DHCP Options
relay-id 53 Relay ID
DHCP Options
37
DHCP Options
DHCP Options
DHCP Options
38
DHCP Options
Option Validation Types
AT_BOOL Boolean—boolean
DHCP Options
39
DHCP Options
DHCP Options
DHCP Options
40
DHCP Options
DHCP Options
AT_TYPECNT Type requiring two child definition: size of the type field, and type of
data—counted-type:
For the DHCPv4 dhcp-user-class-id option (77), the repeating pattern is:
For the DHCPv6 user-class option (15), the repeating pattern is:
AT_ZEROSIZE 32 bits of zero size (no longer used for PAD and END)
Note AT_TIME takes the value entered in seconds, by default. For example, if you enter 60, it is taken as 60 seconds
and if you enter 60s/60m/2h, it is taken as 60 seconds/60 minutes/2 hours and displayed as 60s/60m/2h.
DHCP Options
41
DHCP Options
DHCP Options
DHCP Options
42