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


Use the OMP template to configure OMP parameters for all vEdge Cloud and vEdge router devices, and for vSmart controllers.

The Viptela Overlay Management Protocol (OMP) establishes and maintains the Viptela control plane.

OMP is enabled by default on all vEdge routers, vManage NMSs, and vSmart controllers, so there is no need to explicitly configure or enable OMP. OMP must be operational for the Viptela overlay network to function. If you disable it, you disable the overlay network.

Navigate to the Template Screen and Name the Template

  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. To create a custom template for OMP, select the Factory_Default_OMP_Template and click Create Template. The OMP template form is displayed. The top of the form contains fields for naming the template, and the bottom contains fields for defining OMP parameters. You may need to click a tab or the plus sign (+) to display additional fields.
  6. In the Template Name field, enter a name for the template. The name can be up to 128 characters and can contain only alphanumeric characters.
  7. In the Template Description field, enter a description of the template. The description can be up to 2048 characters and can contain only alphanumeric characters.

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.

Configure Basic OMP Options

To configure basic OMP options, select the Basic Configuration tab and configure the following parameters. All parameters are optional.

Parameter Name Description
Graceful Restart for OMP Ensure that Yes is selected to enable graceful restart. By default, graceful restart for OMP is enabled.
Overlay AS Number (on vEdge routers only) Specify a BGP AS number that OMOP advertises to the router's BGP neighbors.
Graceful Restart Timer

Specify how often the OMP information cache is flushed and refreshed. A timer value of 0 disables OMP graceful restart.
Range: 0 through 604800 seconds (168 hours, or 7 days)
Default: 43200 seconds (12 hours)

Number of Paths Advertised per Prefix

Specify the maximum number of equal-cost routes to advertise per prefix. vEdge routers advertise routes to vSmart controllers, and the controllers redistributes the learned routes, advertising each route-TLOC tuple. A vEdge router can have up to four TLOCs, and by default advertises each route-TLOC tuple to the vSmart controller. If a local site has two vEdge routers, a vSmart controller could potentially learn eight route-TLOC tuples for the same route. If the configured limit is lower than the number of route-TLOC tuples, the best route or routes are advertised.
Range: 1 through 16
Default: 4

ECMP Limit (on vEdge routers only)

Specify the maximum number of OMP paths received from the vSmart controller that can be installed in the vEdge router's local route table. By default, a vEdge router installs a maximum of four unique OMP paths into its route table.
Range: 1 through 32
Default: 4

Send Backup Paths (on vSmart Controllers only) Click On to have OMP advertise backup routes to vEdge routers. By default, OMP advertises only the best route or routes. If you configure to send backup paths, OMP also advertises the first non-best route in addition to the best route or routes.
Shutdown Ensure that No is selected, to enable to Viptela overlay network. Click Yes to disable OMP and disable the Viptela overlay network. OMP is enabled by default.
Discard rejected (on vSmart controllers only) Click Yes to have OMP discard routes that have been rejected on the basis of policy. By default, rejected routes are not discarded.

To save the feature template, click Save.

CLI equivalent:

  discard-rejected (on vSmart controllers only)
  ecmp-limit number (on vEdge routers only)
  overlay-as as-number (on vEdge routers only)
  send-backup-paths (on vSmart controllers only)
  send-path-limit number
  [no] shutdown

Configure OMP Timers

To configure OMP timers, select the Timers tab and configure the following parameters:

Parameter Name Description
Advertisement Interval

Specify the time between OMP Update packets.

Range: 0 through 65535 seconds
Default: 1 second

Hold Time

Specify how long to wait before closing the OMP connection to a peer. If the peer does not receive three consecutive keepalive messages within the hold time, the OMP connection to the peer is closed.
Range: 0 through 65535 seconds
Default: 60 seconds

EOR Timer Specify how long to wait after an OMP session has gone down and then come back up to send an end-of-RIB (EOR) marker. After this marker is sent, any routes that were not refreshed after the OMP session came back up are considered to be stale and are deleted from the route table.
Range: 1 through 3600 seconds (1 hour)
Default: 300 seconds (5 minutes)

To save the feature template, click Save.

CLI equivalent:

    advertisement-interval seconds
    graceful-restart-timer seconds
    holdtime seconds

Configure OMP Advertisements

To advertise routes learned locally by the vEdge router to OMP, select the Advertise tab and configure the following parameters:

Parameter Name Description
Advertise (on vEdge routers only)

Click On or Off to enable or disable the vEdge router advertising to OMP the routes that it learns locally:

  • BGP—Click On to advertise BGP routes to OMP. By default, BGP routes are not advertised to OMP.
  • OSPF—​Click On and click On again in the External field that appears to advertise external OSPF routes to OMP. OSPF inter-area and intra-area routes are always advertised to OMP. By default, external OSPF routes are not advertised to OMP.
  • Connected—Click Off to disable advertising connected routes to OMP. By default, connected routes are advertised to OMP.
  • Static—Click Off to disable advertising static routes to OMP. By default static routes are advertised to OMP.

To configure per-VPN route advertisements to OMP, use the VPN feature template.

To save the feature template, click Save.

CLI equivalent:

  advertise (bgp | connected | ospf | static) (on vEdge routers only)

Release Information

Introduced in vManage NMS in Release 15.2.
In Release 17.1, add Overlay AS Number field.

  • Was this article helpful?