Overview
Follow these procedures to implement OMP routing on your devices.
Routing Configuration Guide, Cisco Catalyst SD-WAN Releases 17.x
Updated: February 6, 2026
Follow these procedures to implement OMP routing on your devices.
On the page, choose SD-WAN as the solution type.
| 1. | From the Cisco SD-WAN Manager menu, choose . |
|
| 2. | Create and configure a OMP feature in a System profile. |
Also see Deploy a configuration group.
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.
| 1. | From the Cisco SD-WAN Manager menu, choose . |
|||||||
| 2. | Click Device Templates.
|
|||||||
| 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:
|
| 1. | To configure basic OMP options, click Basic Configuration and configure these parameters. All parameters are optional.
|
|||||||||||||||||||
| 2. | Click Save. |
|||||||||||||||||||
| 3. | To configure OMP timers, click Timers and configure these parameters:
|
|||||||||||||||||||
| 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.
|
|||||||||||||||||||
| 6. | Click Save. |
Follow these procedures to configure OMP 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.
| 1. | To modify the default timer value, enter the global configuration mode: Example:
|
|
| 2. | Enter the timers graceful-restart-timer command and specify the time in seconds. Example:
|
|
| 3. | To disable OMP graceful restart, use this command: Example:
|
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.
Configuration of route advertisements in OMP can be done either by applying the configuration at the global level or at the specific VRF level.
| 1. | To enable protocol route advertisements for OMP protocol for all VRFs, add the configuration at the global level. Example:
|
|
| 2. | To enable protocol route advertisements for a few VRFs, remove the global-level configuration using no advertise bgp command. Example:
|
|
| 3. | Then, add a per-VRF-level configuration: Example:
|
|
| 4. | Next, configure the routes the device advertises to OMP for all VRFs configured on the device: Example:
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:
|
|
| 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:
|
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.
| 1. | Enter the global configuration mode and add the BGP address-family configuration for the relevant VRF. Example:
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:
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. |
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.
Execute this command: Example:
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. |
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.
Execute the ecmp-limit command: Example:
The maximum number of OMP paths installed can range from 1 through 16. |
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.
To modify the OMP hold time interval, use the timers holdtime command: Example:
Defaults, by Cisco Catalyst SD-WAN Control Components release:
Defaults, by Cisco IOS XE Catalyst SD-WAN release:
|
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.
| 1. | To modify the interval, use the timers advertisement-interval command: Example:
The interval can be in the range 0 to 65535 seconds. |
|
| 2. | To modify the EOR timer, use the timers eor-timer command. Example:
The time can be in the range 1 through 3600 seconds (1 hour). |