IPv6 DHCP Pool

IPv6 DHCP pools configure DHCPv6 server pools that provide IPv6 address allocation, prefix delegation, DNS servers, domain names, and other DHCPv6 options to clients. Pools can delegate prefixes from local pools or assign specific prefixes directly, and support vendor-specific options for advanced configuration.

Diagram

Classes

iosxe

Name	Type	Constraint	Mandatory	Default Value
devices	List	devices	No
device_groups	List	device_groups	No
global	Class	global	No

devices (iosxe)

Name	Type	Constraint	Mandatory	Default Value
configuration	Class	configuration	No

device_groups (iosxe)

Name	Type	Constraint	Mandatory	Default Value
configuration	Class	configuration	No

global (iosxe)

Name	Type	Constraint	Mandatory	Default Value
configuration	Class	configuration	No

configuration (iosxe.devices)

Name	Type	Constraint	Mandatory	Default Value
ipv6_dhcp_pools	List	ipv6_dhcp_pools	No

ipv6_dhcp_pools (iosxe.devices.configuration)

Name	Type	Constraint	Mandatory	Default Value
name	String	Regex: ^[^\s]*$	Yes
vrf	String		No
address_prefixes	List	address_prefixes	No
prefix_delegation_pool_name	String		No
prefix_delegation_pool_valid_lifetime	Any	Integer[min: 0, max: 4294967295] or Choice[infinite] or String[Regex: ^.*[\$\%]\{.*$]	No
prefix_delegation_pool_preferred_lifetime	Any	Integer[min: 0, max: 4294967295] or Choice[infinite] or String[Regex: ^.*[\$\%]\{.*$]	No
prefix_delegation_prefixes	List	prefix_delegation_prefixes	No
dns_servers	List	String	No
domain_names	List	String	No
bootfile_url	String		No
sntp_addresses	List	IP	No
link_addresses	List	link_addresses	No
option_include_all	Boolean	true, false	No
vendor_specifics	List	vendor_specifics	No
import_dns_server	Boolean	true, false	No
import_domain_name	Boolean	true, false	No
information_refresh_days	Integer	min: 0, max: 365	No
information_refresh_hours	Integer	min: 0, max: 23	No
information_refresh_minutes	Integer	min: 0, max: 59	No
information_refresh_infinite	Boolean	true, false	No

address_prefixes (iosxe.devices.configuration.ipv6_dhcp_pools)

Name	Type	Constraint	Mandatory	Default Value
address	IP		Yes
valid_lifetime	Any	Integer[min: 5, max: 4294967295] or Choice[infinite] or String[Regex: ^.*[\$\%]\{.*$]	No
preferred_lifetime	Any	Integer[min: 5, max: 4294967295] or Choice[infinite] or String[Regex: ^.*[\$\%]\{.*$]	No

prefix_delegation_prefixes (iosxe.devices.configuration.ipv6_dhcp_pools)

Name	Type	Constraint	Mandatory	Default Value
prefix	IP		Yes
hex_string	String	Regex: ^[0-9a-fA-F]*$	No
iaid	String	Regex: ^[0-9a-fA-F]*$	No
valid_lifetime	Any	Integer[min: 0, max: 4294967295] or Choice[infinite] or String[Regex: ^.*[\$\%]\{.*$]	No
preferred_lifetime	Any	Integer[min: 0, max: 4294967295] or Choice[infinite] or String[Regex: ^.*[\$\%]\{.*$]	No

link_addresses (iosxe.devices.configuration.ipv6_dhcp_pools)

Name	Type	Constraint	Mandatory	Default Value
address	IP		Yes

vendor_specifics (iosxe.devices.configuration.ipv6_dhcp_pools)

Name	Type	Constraint	Mandatory	Default Value
enterprise_id	Integer	min: 1, max: 4294967295	Yes
suboptions	List	suboptions	No

suboptions (iosxe.devices.configuration.ipv6_dhcp_pools.vendor_specifics)

Name	Type	Constraint	Mandatory	Default Value
number	Integer	min: 1, max: 65535	Yes
address	String		No
ascii	String		No
hex	String	Regex: ^[0-9a-fA-F]*$	No

Examples

iosxe:
  devices:
    - name: Device1
      configuration:
        ipv6_dhcp_pools:
          - name: DHCPv6-PD
            prefix_delegation_pool_name: DHCPv6-PD
            prefix_delegation_pool_valid_lifetime: 2592000
            prefix_delegation_pool_preferred_lifetime: 604800
            dns_servers:
              - "2001:4860:4860::8888"
              - "2001:4860:4860::4444"
            domain_names:
              - example.com
            sntp_addresses:
              - "2001:db8::123"
            bootfile_url: "tftp://[2001:db8::1]/boot.cfg"
            option_include_all: true
            link_addresses:
              - address: "2001:db8:10::/64"
            vendor_specifics:
              - enterprise_id: 9
                suboptions:
                  - number: 1
                    address: "2001:db8::1"
                  - number: 2
                    ascii: "router1.example.com"
                  - number: 3
                    hex: "0A0B0C0D"
          - name: ADDRESS-POOL
            address_prefixes:
              - address: "2001:db8:1::/64"
                valid_lifetime: 2592000
                preferred_lifetime: 604800
            dns_servers:
              - "2001:4860:4860::8888"
            information_refresh_days: 1
            information_refresh_hours: 12
            information_refresh_minutes: 30
          - name: VRF-POOL
            vrf: CUSTOMER-A
            prefix_delegation_prefixes:
              - prefix: "2001:db8:a::/48"
                hex_string: "00030001AABBCCDDEEFF"
                iaid: "00000001"
                valid_lifetime: 2592000
                preferred_lifetime: 604800
          - name: IMPORT-POOL
            import_dns_server: true
            import_domain_name: true
          - name: INFINITE-POOL
            information_refresh_infinite: true