Routing Configuration Guide, Cisco Catalyst SD-WAN Releases 17.x

PDF

Configure OMP

Updated: February 6, 2026

Overview

Follow these procedures to implement OMP routing on your devices.


Configure OMP using a configuration group

Before you begin

On the Configuration > Configuration Groups page, choose SD-WAN as the solution type.

Procedure

1.

From the Cisco SD-WAN Manager menu, choose Configuration > Configuration Groups.

2.

Create and configure a OMP feature in a System profile.

  1. Configure these fields for Basic Configuration section.

    Table 1. Basic Configuration

    Field

    Description

    Graceful Restart Enable

    Enable graceful restart. By default, the graceful restart for OMP is enabled.

    Paths Advertised Per Prefix

    Specify the maximum number of equal-cost routes to advertise per prefix. A advertises routes to Cisco Catalyst SD-WAN Controllers, and the controllers redistribute the learned routes, advertising each route-TLOC tuple. A can have up to four TLOCs, and by default advertises each route-TLOC tuple to the Cisco Catalyst SD-WAN Controller. If a local site has two s, a Cisco Catalyst SD-WAN 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

    BGP AS Path Auto-Translation

    Enables automatic translation of the BGP as path length into the OMP preference value for BGP-learned routes. When this option is enabled, routes with shorter BGP aspaths are assigned a higher OMP preference. Specifically, the OMP preference for a BGP-learned route starts at 255 and is decremented by 1 for each AS in the BGP aspath. As a result, routes with fewer AS hops receive a higher preference within OMP route selection.

    ECMP Limit

    Specify the maximum number of OMP paths received from the Cisco Catalyst SD-WAN Controller that can be installed in the local route table of the Cisco IOS XE Catalyst SD-WAN device. By default, a installs a maximum of four unique OMP paths into its route table.

    Range: 1 through 16

    Default: 4

    Advertisement Interval (In Second)

    Specify the time between OMP update packets.

    Range: 0 through 65535 seconds

    Default: 1 second

    We recommend you to configure 5 seconds on edge devices and 20 seconds on vSmart.

    Hold Time(In Second)

    Specify how long to wait before closing the OMP connection to a peer. If the peer doesn’t receive three consecutive keepalive messages within the hold time, the OMP connection to the peer is closed.

    Range: 0 through 65535 seconds

    Defaults, by Cisco Catalyst SD-WAN Control Components release:

    • 20.18.x and later: 300 seconds

    • 20.16.x: 5400 seconds

    • 20.12.1 to 20.15.x: 300 seconds

    • Before 20.12.1: 60 seconds

    Defaults, by Cisco IOS XE Catalyst SD-WAN release:

    • 17.18.1 and later: 300 seconds

    • 17.16.x: 5400 seconds

    EOR Timer(In Second)

    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 weren’t 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)

    Overlay AS

    Specify a BGP AS number that OMP advertises to the BGP neighbors of the router.

    Shutdown

    Enable this option to disable OMP and disable the Cisco Catalyst SD-WAN overlay network. OMP is enabled by default.

    OMP Admin Distance Ipv4

    To advertise a route over OMP, configure the OMP administrative distance for the IPv4 address lower than the leaked route administrative distance.

    OMP Admin Distance Ipv6

    To advertise a route over OMP, configure the OMP administrative distance for the IPv6 address lower than the leaked route administrative distance.

  2. Configure Timers.

    Table 2. Timers

    Field

    Description

    Graceful Restart(In Second)

    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)

  3. Configure these fields for Advertise section.

    Table 3. Advertise

    Field

    Description

    Advertise Ipv4 BGP

    Enable this option to advertise BGP routes to OMP. By default, BGP routes are not advertised to OMP.

    Advertise Ipv4 OSPF

    Enable this option to advertise external OSPF routes to OMP. By default, external OSPF routes are not advertised to OMP.

    Advertise Ipv4 OSPF v3

    Enable this option to advertise external OSPFv3 routes to OMP. By default, external OSPFv3 routes are not advertised to OMP.

    Advertise Ipv4 Connected

    Enable this option to advertise connected routes to OMP. By default, connected routes are not advertised to OMP.

    Advertise Ipv4 Static

    Enable this option to advertise static routes to OMP. By default static routes are not advertised to OMP.

    Advertise Ipv4 LISP

    Enable this option to advertise LISP routes to OMP. By default, LISP routes are not advertised to OMP.

    Advertise Ipv4 ISIS

    Enable this option to advertise IS-IS routes to OMP. By default, IS-IS routes are not advertised to OMP.

    Advertise Ipv4 EIGRP

    Enable this option to advertise EIGRP routes to OMP. By default, EIGRP routes are not advertised to OMP.

    Advertise Ipv6 BGP

    Enable this option to advertise BGP routes to OMP. By default, BGP routes are not advertised to OMP.

    Advertise Ipv6 OSPF

    Enable this option to advertise external OSPF routes to OMP. By default, external OSPF routes are not advertised to OMP.

    Advertise Ipv6 Connected

    Enable this option to advertise connected routes to OMP. By default, connected routes are not advertised to OMP.

    Advertise Ipv6 Static

    Enable this option to advertise static routes to OMP. By default static routes are not advertised to OMP.

    Advertise Ipv6 LISP

    Enable this option to advertise LISP routes to OMP. By default, LISP routes are not advertised to OMP.

    Advertise Ipv6 ISIS

    Enable this option to advertise IS-IS routes to OMP. By default, IS-IS routes are not advertised to OMP.

    Advertise Ipv6 EIGRP

    Enable this option to advertise EIGRP routes to OMP. By default, EIGRP routes are not advertised to OMP.

  4. Configure these fields for Best Path.

    Table 4. Best Path

    Field

    Description

    Treat Hierarchical and Direct Paths Equally

    (Minimum supported release: Cisco IOS XE Catalyst SD-WAN Release 17.13.1a)

    In a Multi-Region Fabric scenario, if using secondary regions, enable this option to enable packets to use all available paths rather than only direct paths.

    By default, when a direct path is available to reach a destination, the overlay management protocol (OMP) enables only the direct path to the routing forwarding layer because the direct path uses fewer hops. This logic is part of route optimization. The result is that the forwarding layer, which includes application-aware routing policy, can only use the direct path.

    Treat Hierarchical and Direct Paths Equally disables this comparison of the number of hops so that traffic can use either the direct secondary-region path (fewer hops) or the primary-region path (more hops). When you disable the comparison of the number of hops, OMP applies equal-cost multi-path routing (ECMP) to all routes, and packets can use all available paths.

    Transport Gateway Path Behavior

    (Minimum supported release: Cisco IOS XE Catalyst SD-WAN Release 17.13.1a)

    Choose one of the following:

    • Prefer Transport Gateway Path: For devices that can connect through a transport gateway, use only the transport gateway paths, even if other paths are available.

    • Do ECMP Between Direct and Transport Gateway Paths: For devices that can connect through a transport gateway and through direct paths, apply ECMP to all available paths.

    Site Type

    (Minimum supported release: Cisco IOS XE Catalyst SD-WAN Release 17.13.1a)

    If you configure a value for Transport Gateway Path Behavior, this field appears. Optionally, choose one or more site types to apply the transport gateway path behavior only to those site types.

What to do next

Also see Deploy a configuration group.


Configure OMP using templates

Use the OMP template to configure OMP parameters for all Cisco IOS XE Catalyst SD-WAN devices, and for Cisco Catalyst SD-WAN Controllers.

OMP is enabled by default on all Cisco IOS XE Catalyst SD-WAN devices, SD-WAN Manager NMSs, and Cisco Catalyst SD-WAN Controllers. You do not need to explicitly enable OMP. OMP must be operational for the Cisco SD-WAN overlay network to function. If you disable it, the overlay network also gets disabled.

Route advertisements in OMP are done either by applying the configuration at the global level or at the specific VRF level. For more information about route advertisements in OMP, see OMP Advertisements.

Cisco IOS XE Catalyst SD-WAN device use VRFs in place of VPNs. However, the steps desciebed in this section are still applicable for configuring Cisco IOS XE Catalyst SD-WAN devices through SD-WAN Manager. When you complete the configuration, the system automatically maps the VPN configurations to VRF configurations.

Procedure

1.

From the Cisco SD-WAN Manager menu, choose Configuration > Templates.

2.

Click Device Templates.

Note

In Cisco vManage Release 20.7.x and earlier, Device Templates is titled Device.

3.

Click Create Template.

4.

From the Create Template drop-down list, choose From Feature Template.

5.

From the Device Model drop-down list, choose the type of device for which you’re creating the template.

6.

To create a custom template for OMP, choose 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 an operation or the plus sign (+) to display more fields.

7.

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.

8.

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 list to the left of the parameter field and select one of these:

Parameter scope

Scope description

Device Specific (indicated by a host icon)

Use a device-specific value for the parameter. For device-specific parameters, you can’t enter a value in the feature template. You enter the value when you attach a Cisco SD-WAN 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 Cisco SD-WAN device to a device template.

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.

What to do next

See Configure OMP options.


Configure OMP options

Procedure

1.

To configure basic OMP options, click Basic Configuration and configure these parameters. All parameters are optional.

Table 1. Basic OMP options

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

Specify a BGP AS number that OMP 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 to 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. A Cisco IOS XE Catalyst SD-WAN device can have up to eight TLOCs, and by default advertises each route-TLOC tuple to the Cisco Catalyst SD-WAN Controller. If a local site has two Cisco IOS XE Catalyst SD-WAN devices, a Cisco Catalyst SD-WAN 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(s) are advertised.

Range: 1 to 16

Default: 4

ECMP Limit

Specify the maximum number of OMP paths received from the Cisco Catalyst SD-WAN Controller that can be installed in the Cisco IOS XE Catalyst SD-WAN device local route table. By default, a Cisco IOS XE Catalyst SD-WAN device installs a maximum of four unique OMP paths into its route table.

Range: 1 to 16

Default: 4

Send Backup Paths (on Cisco Catalyst SD-WAN Controllers only)

Click On to have OMP advertise backup routes to Cisco IOS XE Catalyst SD-WAN device. 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 chosen to enable to the Cisco SD-WAN overlay network. Click Yes to disable OMP and disable the Cisco SD-WAN overlay network. OMP is enabled by default.

Discard Rejected (on Cisco Catalyst SD-WAN Controllers only)

Click Yes to have OMP discard routes that have been rejected on the basis of policy. By default, rejected routes aren’t discarded.

2.

Click Save.

3.

To configure OMP timers, click Timers and configure these parameters:

Table 2. OMP Timers

Parameter name

Description

Advertisement Interval

Specify the time between OMP Update packets.

Range: 0 to 65535 seconds

Default: 1 second

We recommend you to configure 5 seconds on edge devices and 20 seconds on vSmart.

Hold Time

Specify how long to wait before closing the OMP connection to a peer. If the peer doesn’t receive three consecutive keepalive messages within the hold time, the OMP connection to the peer is closed.

Range: 0 to 65535 seconds

Defaults, by Cisco Catalyst SD-WAN Control Components release:

  • 20.18.x and later: 300 seconds

  • 20.16.x: 5400 seconds

  • 20.12.1 to 20.15.x: 300 seconds

  • Before 20.12.1: 60 seconds

Defaults, by Cisco IOS XE Catalyst SD-WAN release:

  • 17.18.1 and later: 300 seconds

  • 17.16.x: 5400 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 weren’t refreshed after the OMP session came back up are considered to be stale and are deleted from the route table.

Range: 1 to 3600 seconds (1 hour)

Default: 300 seconds (5 minutes)

4.

Click Save.

5.

To advertise routes learned locally by the Cisco IOS XE Catalyst SD-WAN device to OMP, click Advertise and configure these parameters:

Route advertisements in OMP are done either by applying the configuration at the global level or at the specific VRF level.

Table 3. OMP Advertisements

Parameter name

Description

Advertise

Click On or Off to enable or disable the Cisco IOS XE Catalyst SD-WAN device 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.

  • Connected: Click Off to disable advertising connected routes to OMP. By default, connected routes are 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 aren’t 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.

6.

Click Save.


Configure OMP using the CLI commands

Follow these procedures to configure OMP using CLI commands.


Configure OMP graceful restart using CLI commands

OMP graceful restart is enabled on all Cisco IOS XE Catalyst SD-WAN devices and Cisco Catalyst SD-WAN Controllers. OMP graceful restart timer tells the OMP peer how long to retain the cached advertised routes. When this timer expires, the cached routes are considered to be no longer valid, and the OMP peer flushes them from its route table. The default timer is 43,200 seconds (12 hours), and the timer range is 1 through 604,800 seconds (7 days). You can modify this default timer value using CLI commands.

OMP must be operational for Cisco SD-WAN overlay network to function. If you disable it, you disable the overlay network. OMP support in Cisco SD-WAN includes:

  • IPv6 service routes

  • IPv4 and IPv6 protocols, which are both turned on by default

  • OMP route advertisements to BGP, EIGRP, OSPF, connected routes, static routes, and so on

The graceful restart timer is set up independently on each OMP peer that is, Cisco IOS XE Catalyst SD-WAN device and Cisco Catalyst SD-WAN Controller. Consider a Cisco Catalyst SD-WAN Controller that uses a graceful restart time of 300 seconds, or 5 minutes, and a Cisco IOS XE Catalyst SD-WAN device that is configured with a timer of 600 seconds (10 minutes). Here, the SD-WAN Controller retains the OMP routes learned from that device for 10 minutes—the graceful restart timer value that is configured on the device and that the device has sent to the SD-WAN Controller during the setup of the OMP session. The SD-WAN device retains the routes it learns from the SD-WAN Controller for 5 minutes, which is the default graceful restart time value that is used on the SD-WAN Controller and that the controller sent to the device, also during the setup of the OMP session.

While the SD-WAN Controller is down and a SD-WAN device is using cached OMP information, if you reboot the device, it loses its cached information; hence, it will not be able to forward data traffic until it establishes a control plane connection to the SD-WAN Controller.

Procedure

1.

To modify the default timer value, enter the global configuration mode:

Example:

Device# config-transaction
Device(config)# sdwan
2.

Enter the timers graceful-restart-timer command and specify the time in seconds.

Example:

Device(config-omp)# timers graceful-restart-timer <seconds>
3.

To disable OMP graceful restart, use this command:

Example:

Device(config-omp)# no graceful-restart

Configure OMP route advertisement using CLI commands

Enable protocol route advertisements to OMP for all VRFs on a Cisco IOS XE Catalyst SD-WAN device.

A Cisco IOS XE Catalyst SD-WAN device advertises connected routes, static routes, OSPF inter-area, OSPF intra-area routes, OSPFv3 IPv6 intra-area routes, and OSPF IPv6 inter-area routes to OMP for Cisco Catalyst SD-WAN Controller, that is responsible for the device's domain. You can use the advertise command to have the device advertise these routes to OMP, consequently to SD-WAN Controller.

Note

Configuration of route advertisements in OMP can be done either by applying the configuration at the global level or at the specific VRF level.

Procedure

1.

To enable protocol route advertisements for OMP protocol for all VRFs, add the configuration at the global level.

Example:

Device(config)# sdwan 
Device(config-sdwan)# omp 
Device(config-omp)# address-family ipv4 
Device(config-ipv4)# advertise bgp 
2.

To enable protocol route advertisements for a few VRFs, remove the global-level configuration using no advertise bgp command.

Example:

Device(config)# sdwan 
Device(config-sdwan)# omp 
Device(config-omp)# address-family ipv4 
Device(config-ipv4)# no advertise bgp
3.

Then, add a per-VRF-level configuration:

Example:

  
Device(config-ipv4)# address-family ipv4 vrf 2  
Device(config-vrf-2)# advertise bgp 
Device(config-vrf-2)# address-family ipv4 vrf 4 
Device(config-vrf-4)# advertise bgp 
Device(config-vrf-4)# commit 
Note

To disable certain protocol route advertisements for all or for a few VRFs, ensure that the configuration is present neither at the global level nor at the VRF level.

4.

Next, configure the routes the device advertises to OMP for all VRFs configured on the device:

Example:

config-transaction
 sdwan
  omp
   address-family ipv4
    advertise ospf external
    advertise bgp
    advertise eigrp
    advertise connected
    advertise static
    exit
  address-family ipv6
   advertise ospf external
   advertise bgp
   advertise eigrp
   advertise connected
   advertise static
   exit

For OSPF, the route type can be external. The bgp , connected , ospf , and static options advertise all learned or configured routes of that type to OMP. To advertise a specific route instead of advertising all routes for a protocol, use the network option, and specify the prefix of the route to advertise.

5.

To configure the routes that the device advertises to OMP for a specific VRF on the device, use these command:

Example:

config-transaction
 sdwan
  omp
   address-family ipv4 vrf 1
    advertise aggregate prefix 10.0.0.0/8
    advertise ospf external
    advertise bgp
    advertise eigrp
    advertise connected
    advertise static
    exit
  address-family ipv6 vrf 1
   advertise aggregate 2001:DB8::/32   
   advertise ospf external
   advertise bgp
   advertise eigrp
   advertise connected
   advertise static
   exit
6.

For individual VRFs, routes from the specified prefix can be aggregated after advertising them into OMP using the advertise protocol config command. By default, the aggregated prefixes and all individual prefixes are advertised. To advertise only the aggregated prefix, include the aggregate-only option:

Example:

config-transaction
 sdwan
  omp
   address-family ipv4 vrf 1
    advertise aggregate 10.0.0.0/8 aggregate-only
    exit
Note

Route advertisements in OMP are done either by applying configuration at the global level or to specific VRFs. The specific VRF configuration doesn’t override global-VRF configuration in OMP.


Configure BGP AS Path propagation into OMP using CLI commands

You can enable Cisco IOS XE Catalyst SD-WAN device to advertise BGP AS path information into OMP, ensuring that devices in the service-side network can receive and utilize this information for loop prevention. Propagating BGP AS path information helps to prevent BGP routing loops by allowing routers to identify and avoid routes that contain their own AS number in the path. It also provides greater visibility into the routing path.

When you configure BGP to propagate AS path information, the device sends AS path information to devices that are behind the Cisco IOS XE Catalyst SD-WAN devices (in the service-side network) that are running BGP, and it receives AS path information from these routers. If you’re redistributing BGP routes into OMP, the AS path information is included in the advertised BGP routes. If you configure BGP AS path propagation on some but not all devices in the overlay network, the devices on which it’s not configured receive the AS path information but they don’t forward it to the BGP routers in their local service-side network.

Procedure

1.

Enter the global configuration mode and add the BGP address-family configuration for the relevant VRF.

Example:

config-transaction
 router bgp 200
 address-family ipv4 vrf 11
  neighbor 10.20.1.0 remote-as 200
  propagate-aspath
  exit

When BGP advertises routes into OMP, it advertises each prefix's metric. BGP can also advertise the prefix's AS path.

2.

In networks that have both overlay and underlay connectivity—for example, when devices are interconnected by both a Cisco SD-WAN overlay network and an MPLS underlay network—you can assign as AS number to OMP itself. For devices running BGP, this overlay AS number is included in the AS path of BGP route updates. To configure the overlay AS:

Example:

config-transaction
 sdwan
  omp
   overlay-as 55
   exit

You can specify the AS number in 2-byte ASDOT notation (1–65535) or in 4-byte ASDOT notation (1.0 through 65535.65535). As a best practice, we recommended you to configure the overlay AS number as a unique AS number within both the overlay and the underlay networks.

If you configure the same overlay AS number on multiple devices in the overlay network, all these devices are considered to be part of the same AS, and as a result, they don’t forward any routes that contain the overlay AS number. This mechanism is an additional technique for preventing BGP routing loops in the network.


Configure the number of advertised routes using CLI commands

You can control and configure the number of route–TLOC tuples that Cisco IOS XE Catalyst SD-WAN devices and Cisco Catalyst SD-WAN Controllers advertise, enabling you to optimize route advertisement and path selection based on your network requirements. You can execute the commands using CLI Add-on template.

A Cisco IOS XE Catalyst SD-WAN device device can have up to eight WAN interfaces, and each WAN interface has a different TLOC. (A WAN interface is any interface in VPN 0 (or transport VRF) that is configured as a tunnel interface. Both physical and loopback interfaces can be configured to be tunnel interfaces.) This means that each router can have up to eight TLOCs. The device advertises each route–TLOC tuple to the Cisco Catalyst SD-WAN Controller.

The SD-WAN Controller redistributes the routes it learns from Cisco IOS XE Catalyst SD-WAN devices, advertising each route–TLOC tuple. If, for example, a local site has two devices, an SD-WAN Controller could potentially learn eight route–TLOC tuples for the same route. By default, SD-WAN devices and SD-WAN Controllers advertises up to four equal-cost route–TLOC tuples for the same route.

You can configure devices to advertise from 1 to 16 route–TLOC tuples for the same route.

Procedure

Execute this command:

Example:

Device(config-omp)# send-path-limit <path-limit>
Device(config-omp)# send-path-limit 14

From Cisco Catalyst SD-WAN Control Components Release 20.8.x, you can configure an SD-WAN Controller operating in a Hierarchical SD-WAN environment to advertise from 1 to 32 route-TLOC tuples to edge devices for the same route.

From Cisco Catalyst SD-WAN Control Components Release 20.9.x, you can configure an SD-WAN Controller in any Cisco SD-WAN environment to advertise from 1 to 32 route-TLOC tuples to edge devices for the same route.

If the configured limit is lower than the number of route–TLOC tuples, the SD-WAN device or SD-WAN Controller advertises only the best routes.


Configure the number of installed OMP paths using CLI commands

Cisco IOS XE Catalyst SD-WAN devices install OMP paths received from the SD-WAN Controller into their local route table. By default, Cisco IOS XE Catalyst SD-WAN devices installs a maximum of four unique OMP paths into its route table. You can modify this number using the CLI add-on template.

Procedure

Execute the ecmp-limit command:

Example:

Device(config-omp)# ecmp-limit <number-of-paths>
Device(config-omp)# ecmp-limit 2

The maximum number of OMP paths installed can range from 1 through 16.


Configure the OMP hold time using CLI commands

You can modify the OMP hold time interval using CLI commands.

The OMP hold time determines how long to wait before closing the OMP connection to a peer. If the peer doesn’t receive three consecutive keepalive messages within the hold time, the OMP connection to the peer is closed.

The hold time must be at least two times the hello tolerance interval set on the WAN tunnel interface in transport VRF. To configure the hello tolerance interface, use the hello-tolerance command.

We recommend that you configure OMP hold time to 300 seconds. The range is 0 to 65,535 seconds.

Procedure

To modify the OMP hold time interval, use the timers holdtime command:

Example:

Device(config-omp)# timers holdtime <seconds>
Device(config-omp)# timers holdtime 300

Defaults, by Cisco Catalyst SD-WAN Control Components release:

  • 20.18.x and later: 300 seconds

  • 20.16.x: 5400 seconds

  • 20.12.1 to 20.15.x: 300 seconds

  • Before 20.12.1: 60 seconds

Defaults, by Cisco IOS XE Catalyst SD-WAN release:

  • 17.18.1 and later: 300 seconds

  • 17.16.x: 5400 seconds

Note

The keepalive timer is one-third the hold time and isn’t configurable.

Note

If the local device and the peer have different hold time intervals, the higher value is used.

If you set the hold time to 0, the keepalive and hold timers on the local device and the peer are set to 0.


Configure the OMP advertisement interval and end-of-RIB timer using CLI commands

By default, OMP sends Update packets once per second. You can modify the interval using a CLI command.

After an OMP session goes down and then comes back up, an end-of-RIB (EOR) marker is sent after 300 seconds (5 minutes). After this maker is sent, any routes that weren’t refreshed after the OMP session came back up are considered to be stale and are deleted from the route table. You can also modify the EOR timer using a CLI command.

Procedure

1.

To modify the interval, use the timers advertisement-interval command:

Example:

Device(config-omp)# timers advertisement-interval <interval>
Device(config-omp)# timers advertisement-interval 5000

The interval can be in the range 0 to 65535 seconds.

2.

To modify the EOR timer, use the timers eor-timer command.

Example:

Device(config-omp)# timers eor-timer<eor-timer>
Device(config-omp)# timers eor-timer 300

The time can be in the range 1 through 3600 seconds (1 hour).