Skip to main content
Cisco SD-WAN
Product Documentation
Viptela Documentation

DHCP Server

Use the DHCP-Server template for all vEdge Cloud and vEdge router devices.

You enable DHCP server functionality on a vEdge router interface so it can assign IP addresses to hosts in the service-side network.

To configure a vEdge router to act as a DHCP server using vManage templates:

  1. Create a DHCP-Server feature template to configure DHCP server parameters, as described in this article.
  2. Create one or more interface feature templates, as described in the VPN-Interface-Ethernet and the VPN-Interface-PPP-Ethernet help topics.
  3. Create a VPN feature template to configure VPN parameters. See the VPN help topic.

To configure a vEdge router interface to be a DHCP helper, so that it forwards broadcast DHCP requests that it receives from DHCP servers, in the DHCP Helper field of the applicable interfaces template, enter the addresses of the DHCP servers.​

Navigate to the Template Screen

  1. In vManage NMS, select the Configuration ► Templates screen.
  2. In the Device tab, click Create Template.
  3. From the Create Template drop-down, select From Feature Template.
  4. From the Device Model drop-down, select the type of device for which you are creating the template.
  5. Click the Service VPN tab located directly beneath the Description field, or scroll to the Service VPN section.
  6. Click the Service VPN drop-down.
  7. Under Additional VPN Templates, located to the right of the screen, click VPN Interface.
  8. From the Sub-Templates drop-down, select DHCP Server.
  9. From the DHCP Server drop-down, click Create Template. The DHCP-Server template form is displayed. The top of the form contains fields for naming the template, and the bottom contains fields for defining DHCP Server parameters.

When you first open a feature template, for each parameter that has a default value, the scope is set to Default (indicated by a check mark), and the default setting or value is shown. To change the default or to enter a value, click the scope drop-down to the left of the parameter field and select one of the following:

Parameter Scope

Scope Description

Device Specific (indicated by a host icon)

Use a device-specific value for the parameter. For device-specific parameters, you cannot enter a value in the feature template. You enter the value when you attach a Viptela device to a device template.

When you click Device Specific, the Enter Key box opens. This box displays a key, which is a unique string that identifies the parameter in a CSV file that you create. This file is an Excel spreadsheet that contains one column for each key. The header row contains the key names (one key per column), and each row after that corresponds to a device and defines the values of the keys for that device. You upload the CSV file when you attach a Viptela device to a device template. For more information, see Create a Template Variables Spreadsheet.

To change the default key, type a new string and move the cursor out of the Enter Key box.

Examples of device-specific parameters are system IP address, hostname, GPS location, and site ID.

Global (indicated by a globe icon)

Enter a value for the parameter, and apply that value to all devices.

Examples of parameters that you might apply globally to a group of devices are DNS server, syslog server, and interface MTUs.

Minimum DHCP Server Configuration

The following parameters are can be configured to specify DHCP server functionality. At a minimum, you must configure the address pool.

Step Parameter Name Description
 1. Template Name Enter template name. It can be up to 128 characters and can contain only alphanumeric characters.
 2. Description (Template) Enter description of the template. It can be up to 2048 characters and can contain only alphanumeric characters.
 3. Address pool Enter the IPv4 prefix range, in the format prefix/length, for the pool of addresses in the service-side network for which the vEdge router interface acts as DHCP server.
 4. Exclude Addresses (optional) Enter one or more IP addresses to exclude from the DHCP address pool. To specify multiple individual addresses, list them separated by a comma (for example,,, To specify a range of addresses, separate them with a hyphen (for example,
 5. Maximum Leases (optional)

Specify the number of IP addresses that can be assigned on this interface.
Range: 0 through 4294967295

 6. Lease Time (optional)

Specify how long a DHCP-assigned IP address is valid.
Range: 0 through 4294967295 seconds

 7. Offer Time (optional)

Specify how long the IP address offered to a DHCP client is reserved for that client. By default, an offered IP address is reserved indefinitely, until the DHCP server runs out of addresses. At that point, the address is offered to another client.
Range: 0 through 4294967295 seconds
Default: 600 seconds

 8. Administrative State (optional) Select Up to enable or Down to disable the DHCP functionality on the interface. By default, DHCP server functionality is disabled on a vEdge router interface.
 9. Interface MTU (optional)

Specify the maximum MTU size of packets on the interface.
Range: 68 to 65535 bytes

10. Domain Name (optional) Specify the domain name that the DHCP client uses to resolve hostnames.
11. Default Gateway (optional) Enter the IP address of a default gateway in the service-side network.
12. DNS Servers (optional) Enter one or more IP address for a DNS server in the service-side network. Separate multiple entries with a comma. You can specify up to eight addresses.
13. TFTP Servers Enter the IP address of a TFTP server in the service-side network. You can specify one or two addresses. If two, separate them with a comma.
14. Save Click Save to save the feature template.

CLI equivalent:

vpn vpn-id
  interface geslot/port
      address-pool prefix/length
      admin-state (down | up)
      exclude ip-address
      lease-time seconds
      max-leases number
      offer-time minutes
        default-gateway ip-address
        dns-servers ip-address
        domain-name domain-name
        interface-mtu mtu
        tftp-servers ip-address

Configure Static Leases

To configure a static lease to assign a static IP address to a client device on the service-side network, click the plus sign (+):

Parameter Name Description
MAC Address Enter the MAC address of the client to which the static IP address is being assigned.
IP Address Enter the static IP address to assign to the client.
Hostname Enter the hostname of the client device.

To remove a static lease, click the trash icon to the right of the entry.

CLI equivalent:

vpn vpn-id
  interface geslot/port
      static-lease mac-address ip ip-address host-name hostname

Release Information

Introduced in vManage NMS in Release 15.2.

  • Was this article helpful?