DHCP Server Feature Template

Configure DHCP server characteristics, such as address pool, lease time, static leases, domain name, default gateway, DNS servers, and TFTP servers.

Diagram

Classes

edge_feature_templates (sdwan)

Name	Type	Constraint	Mandatory	Default Value
dhcp_server_templates	List	`[dhcp_server_templates]`	No

dhcp_server_templates (sdwan.edge_feature_templates)

Name	Type	Constraint	Mandatory
name	String	Regex: `^[^<>!&" ]{1,128}$`	Yes
description	String		Yes
device_types	List	Choice[`ASR-1001-HX`, `ASR-1001-X`, `ASR-1002-HX`, `ASR-1002-X`, `ASR-1006-X`, `C1101-4P`, `C1101-4PLTEP`, `C1101-4PLTEPW`, `C1109-2PLTEGB`, `C1109-2PLTEUS`, `C1109-2PLTEVZ`, `C1109-4PLTE2P`, `C1109-4PLTE2PW`, `C1111-4P`, `C1111-4PLTEEA`, `C1111-4PLTELA`, `C1111-4PW`, `C1111-8P`, `C1111-8PLTEEA`, `C1111-8PLTEEAW`, `C1111-8PLTELA`, `C1111-8PLTELAW`, `C1111-8PW`, `C1111X-8P`, `C1112-8P`, `C1112-8PLTEEA`, `C1112-8PLTEEAWE`, `C1112-8PWE`, `C1113-8P`, `C1113-8PLTEEA`, `C1113-8PLTEEAW`, `C1113-8PLTELA`, `C1113-8PLTELAWZ`, `C1113-8PLTEW`, `C1113-8PM`, `C1113-8PMLTEEA`, `C1113-8PMWE`, `C1113-8PW`, `C1116-4P`, `C1116-4PLTEEA`, `C1116-4PLTEEAWE`, `C1116-4PWE`, `C1117-4P`, `C1117-4PLTEEA`, `C1117-4PLTEEAW`, `C1117-4PLTELA`, `C1117-4PLTELAWZ`, `C1117-4PM`, `C1117-4PMLTEEA`, `C1117-4PMLTEEAWE`, `C1117-4PMWE`, `C1117-4PW`, `C1118-8P`, `C1121-4P`, `C1121-4PLTEP`, `C1121-8P`, `C1121-8PLTEP`, `C1121-8PLTEPW`, `C1121X-8P`, `C1121X-8PLTEP`, `C1121X-8PLTEPW`, `C1126-8PLTEP`, `C1126X-8PLTEP`, `C1127-8PLTEP`, `C1127-8PMLTEP`, `C1127X-8PLTEP`, `C1127X-8PMLTEP`, `C1128-8PLTEP`, `C1131-8PLTEPW`, `C1131-8PW`, `C1131X-8PLTEPW`, `C1131X-8PW`, `C1161-8P`, `C1161-8PLTEP`, `C1161X-8P`, `C1161X-8PLTEP`, `C8000V`, `C8200-1N-4T`, `C8200L-1N-4T`, `C8300-1N1S-4T2X`, `C8300-1N1S-6T`, `C8300-2N2S-4T2X`, `C8300-2N2S-6T`, `C8500-12X`, `C8500-12X4QC`, `C8500-20X6C`, `C8500L-8S4X`, `IR-1101`, `IR-1821`, `IR-1831`, `IR-1833`, `IR-1835`, `IR-8140H`, `IR-8140H-P`, `IR-8340`, `ISR-4221`, `ISR-4221X`, `ISR-4321`, `ISR-4331`, `ISR-4351`, `ISR-4431`, `ISR-4451-X`, `ISR-4461`, `ISR1100-4G-XE`, `ISR1100-4GLTEGB-XE`, `ISR1100-4GLTENA-XE`, `ISR1100-6G-XE`, `ISR1100X-4G-XE`, `ISR1100X-6G-XE`]	No
address_pool	IP		No
address_pool_variable	String	Regex: `^[^"~`$&+,]255$`	No
default_gateway	IP		No
default_gateway_variable	String	Regex: `^[^"~`$&+,]255$`	No
dns_servers	List	IP	No
dns_servers_variable	String	Regex: `^[^"~`$&+,]255$`	No
domain_name	String		No
domain_name_variable	String	Regex: `^[^"~`$&+,]255$`	No
exclude_addresses	List	IP	No
exclude_addresses_variable	String	Regex: `^[^"~`$&+,]255$`	No
exclude_addresses_ranges	List	`[exclude_addresses_ranges]`	No
interface_mtu	Integer	min: `68`, max: `65535`	No
interface_mtu_variable	String	Regex: `^[^"~`$&+,]255$`	No
lease_time	Integer	min: `10`, max: `31536000`	No
lease_time_variable	String	Regex: `^[^"~`$&+,]255$`	No
options	List	`[options]`	No
static_leases	List	`[static_leases]`	No
tftp_servers	List	IP	No
tftp_servers_variable	String	Regex: `^[^"~`$&+,]255$`	No

exclude_addresses_ranges (sdwan.edge_feature_templates.dhcp_server_templates)

Name	Type	Constraint	Mandatory	Default Value
from	IP		Yes
to	IP		Yes

options (sdwan.edge_feature_templates.dhcp_server_templates)

Name	Type	Constraint	Mandatory
option_code	Integer	min: `1`, max: `254`	No
option_code_variable	String	Regex: `^[^"~`$&+,]255$`	No
ascii	String		No
ascii_variable	String	Regex: `^[^"~`$&+,]255$`	No
hex	String		No
hex_variable	String	Regex: `^[^"~`$&+,]255$`	No
ip_addresses	List	IP	No
ip_addresses_variable	String	Regex: `^[^"~`$&+,]255$`	No

static_leases (sdwan.edge_feature_templates.dhcp_server_templates)

Name	Type	Constraint	Mandatory
ip_address	IP		No
ip_address_variable	String	Regex: `^[^"~`$&+,]255$`	No
mac_address	String	Regex: `^(([a-fA-F\d]{2}:){5}[a-fA-F\d]{2})$`	No
mac_address_variable	String	Regex: `^[^"~`$&+,]255$`	No
hostname	String	min: `1`, max: `32`	No
hostname_variable	String	Regex: `^[^"~`$&+,]255$`	No
optional	Boolean	`true`, `false`	No

Examples

Example-1: The example below illustrates how to configure DHCP server feature template. It defines the address pool, default gateway and DNS server addresses, providing essential network settings to connected devices. Additionally, it includes exclusion of specific addresses from the DHCP pool, configures lease time, and optionally sets up static address leases with specific IP and MAC addresses.

sdwan:
  edge_feature_templates:
    dhcp_server_templates:
      - name: FT-EDGE-VPN11-DHCP-LAN-V01
        description: Guest VPN DHCP Server
        address_pool_variable: vpn11_ipv4_lan_dhcp_address_pool
        exclude_addresses_variable: vpn11_ipv4_lan_dhcp_exclude_addresses
        lease_time: 3600
        static_leases:
          - ip_address_variable: vpn11_ipv4_lan_dhcp_static_addresses
            mac_address_variable: vpn11_ipv4_lan_dhcp_static_mac
            optional: true
        default_gateway_variable: vpn11_ipv4_lan_dhcp_default_gateway
        dns_servers_variable: vpn11_ipv4_lan_dhcp_dns_servers