Service DHCP Server Feature
Configure DHCP Server feature.
Diagram
Classes
service_profiles (sdwan.feature_profiles)
| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| dhcp_servers | List | [dhcp_servers] | No |
dhcp_servers (sdwan.feature_profiles.service_profiles)
| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| name | String | Regex: ^[^&<>! "]{1,128}$ | Yes | |
| description | String | No | ||
| pool_network_address | IP | No | ||
| pool_network_address_variable | String | Regex: ^[./\[\]a-zA-Z0-9_-]{1,64}$ | No | |
| pool_subnet_mask | Choice | 255.255.255.255, 255.255.255.254, 255.255.255.252, 255.255.255.248, 255.255.255.240, 255.255.255.224, 255.255.255.192, 255.255.255.128, 255.255.255.0, 255.255.254.0, 255.255.252.0, 255.255.248.0, 255.255.240.0, 255.255.224.0, 255.255.192.0, 255.255.128.0, 255.255.0.0, 255.254.0.0, 255.252.0.0, 255.240.0.0, 255.224.0.0, 255.192.0.0, 255.128.0.0, 255.0.0.0, 254.0.0.0, 252.0.0.0, 248.0.0.0, 240.0.0.0, 224.0.0.0, 192.0.0.0, 128.0.0.0, 0.0.0.0 | No | |
| pool_subnet_mask_variable | String | Regex: ^[./\[\]a-zA-Z0-9_-]{1,64}$ | No | |
| default_gateway | IP | No | ||
| default_gateway_variable | String | Regex: ^[./\[\]a-zA-Z0-9_-]{1,64}$ | No | |
| dns_servers | List | IP | No | |
| dns_servers_variable | String | Regex: ^[./\[\]a-zA-Z0-9_-]{1,64}$ | No | |
| domain_name | String | min: 1, max: 32 | No | |
| domain_name_variable | String | Regex: ^[./\[\]a-zA-Z0-9_-]{1,64}$ | No | |
| exclude_addresses | List | String[Regex: ^((25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])(-((25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9]))?$] | No | |
| exclude_addresses_variable | String | Regex: ^[./\[\]a-zA-Z0-9_-]{1,64}$ | No | |
| interface_mtu | Integer | min: 68, max: 65535 | No | |
| interface_mtu_variable | String | Regex: ^[./\[\]a-zA-Z0-9_-]{1,64}$ | No | |
| lease_time | Integer | min: 10, max: 31536000 | No | |
| lease_time_variable | String | Regex: ^[./\[\]a-zA-Z0-9_-]{1,64}$ | No | |
| options | List | [options] | No | |
| static_leases | List | [static_leases] | No | |
| tftp_servers | List | IP | No | |
| tftp_servers_variable | String | Regex: ^[./\[\]a-zA-Z0-9_-]{1,64}$ | No |
options (sdwan.feature_profiles.service_profiles.dhcp_servers)
| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| code | Integer | min: 1, max: 254 | No | |
| code_variable | String | Regex: ^[./\[\]a-zA-Z0-9_-]{1,64}$ | No | |
| ascii | String | No | ||
| ascii_variable | String | Regex: ^[./\[\]a-zA-Z0-9_-]{1,64}$ | No | |
| hex | String | Regex: ^([0-9A-Fa-f]{2})+$ | No | |
| hex_variable | String | Regex: ^[./\[\]a-zA-Z0-9_-]{1,64}$ | No | |
| ip_addresses | List | IP | No | |
| ip_addresses_variable | String | Regex: ^[./\[\]a-zA-Z0-9_-]{1,64}$ | No |
static_leases (sdwan.feature_profiles.service_profiles.dhcp_servers)
| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| ip_address | IP | No | ||
| ip_address_variable | String | Regex: ^[./\[\]a-zA-Z0-9_-]{1,64}$ | No | |
| mac_address | String | Regex: ^(([a-fA-F\d]{2}:){5}[a-fA-F\d]{2})$ | No | |
| mac_address_variable | String | Regex: ^[./\[\]a-zA-Z0-9_-]{1,64}$ | No |
Examples
Example-1: DHCP Server Configuration for Guest Wi-Fi and Employee LAN Segments
A retail organization operates a branch office where network administrators need to assign IP addresses dynamically to two separate LAN segments: one for employees and another for guest Wi-Fi users. Each segment operates on a different VPN (VPN 20 for employees and VPN 30 for guests). The employee LAN requires IP reservation for specific devices such as printers and POS systems, while the guest Wi-Fi segment demands basic DHCP settings with a strict exclusion of specific IP ranges for security. The DHCP configuration ensures clients in both segments automatically receive network settings like IP address, gateway, DNS, and domain information. Additionally, custom DHCP options are included for specialized services used in the guest segment.
This YAML configuration defines two DHCP server profiles under feature_profiles → service_profiles to serve different VPN segments in an SD-WAN deployment. The first profile, DHCP-EMPLOYEE-LAN, configures a DHCP server for VPN 20 with a /24 subnet, setting default gateway, DNS servers, and reserving IPs for critical employee devices like printers and POS terminals. The second profile, DHCP-GUEST-WIFI, defines a DHCP server for VPN 30 using a /25 subnet, with a limited lease time to restrict guest usage and explicit exclusion of sensitive IP addresses for security. Additionally, custom DHCP options are added using code and hex to support specific guest service requirements. This configuration ensures robust, segmented, and automated IP management across the enterprise LAN.
sdwan: feature_profiles: service_profiles: - name: DHCP-EMPLOYEE-LAN description: DHCP Server for Employee LAN on VPN 20 dhcp_servers: - name: DHCP-Employee description: Employee LAN DHCP on VPN 20 pool_network_address_variable: vpn20_dhcp_pool pool_subnet_mask: "255.255.255.0" default_gateway_variable: vpn20_gateway dns_servers: - 8.8.8.8 - 1.1.1.1 domain_name: "corp.local" lease_time: 86400 exclude_addresses: - 192.168.20.1 - 192.168.20.200-192.168.20.210 static_leases: - mac_address_variable: printer_mac ip_address_variable: printer_ip - mac_address_variable: pos_mac ip_address_variable: pos_ip
- name: DHCP-GUEST-WIFI description: DHCP Server for Guest Wi-Fi on VPN 30 dhcp_servers: - name: DHCP-Guest description: Guest Wi-Fi DHCP on VPN 30 pool_network_address_variable: vpn30_dhcp_pool pool_subnet_mask: "255.255.255.128" default_gateway_variable: vpn30_gateway dns_servers: - 9.9.9.9 - 4.2.2.2 domain_name: "guest.local" lease_time: 3600 exclude_addresses: - 192.168.30.1-192.168.30.10 options: - code: 60 hex: "0102030405"Example-2: Edge LAN profile basic DHCP Server
The example below illustrates how to configure DHCP server feature within a service profile. It defines the address pool, setting the network address and subnet mask, as well as default gateway and DNS server addresses, providing essential network settings to connected devices. Additionally, it includes exclusion of specific addresses from the DHCP pool.
sdwan: feature_profiles: service_profiles: - name: DHCP-SERVRER-LAN-10 description: Edge LAN profile basic DHCP Server dhcp_servers: - name: DHCP-Server-1 description: LAN DHCP Server VPN 10 pool_network_address_variable: vpn10_dhcp_address_pool pool_subnet_mask: "255.255.255.0" default_gateway_variable: vpn10_dhcp_default_gateway dns_servers: - 1.1.1.1 - 9.9.9.9 domain_name: "test.com" lease_time: 60000 exclude_addresses_variable: vpn10_dhcp_exclude_addresses_lanExample-3: Edge LAN profile basic DHCP Server - domain name, lease time
The example below illustrates how to configure DHCP server feature within a service profile. The configuration specifies an address pool, subnet mask, default gateway, and DNS servers, ensuring devices receive necessary network configurations. Additionally, it includes settings for domain name, lease time, exclusion of certain addresses, and static leases for specific devices, along with custom DHCP options.
sdwan: feature_profiles: service_profiles: - name: DHCP-SERVRER-LAN-11 description: Edge LAN profile basic DHCP Server dhcp_servers: - name: DHCP-Server-2 description: LAN DHCP Server VPN 11 pool_network_address_variable: vpn11_dhcp_address_pool pool_subnet_mask: "255.255.255.128" default_gateway_variable: vpn11_dhcp_default_gateway dns_servers: - 1.1.1.1 - 9.9.9.9 domain_name: "test.com" lease_time: 60000 exclude_addresses: - 10.10.10.100 - 10.10.10.1-10.10.10.5 static_leases: - mac_address_variable: vpn11_static_lease_mac1 ip_address_variable: vpn11_static_lease_ip1 options: - code: 43 hex: "f305ac10011802"