Skip to content

System OMP Feature

OMP template controls number of paths being advertised and installed, which protocols are by default redistributed into OMP, AS overlay number and also various timers: graceful restart, advertisment and hold.

Diagram

Diagram

Classes

system_profiles (sdwan.feature_profiles)

Name	Type	Constraint	Mandatory	Default Value
omp	Class	`[omp]`	No

omp (sdwan.feature_profiles.system_profiles)

Name	Type	Constraint	Mandatory	Default Value
name	String	Regex: `^[^&<>! "]{1,128}$`	No	`omp`
description	String		No
advertise_ipv4_bgp	Boolean	`true`, `false`	No
advertise_ipv4_bgp_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,128}$`	No
advertise_ipv4_connected	Boolean	`true`, `false`	No
advertise_ipv4_connected_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,128}$`	No
advertise_ipv4_eigrp	Boolean	`true`, `false`	No
advertise_ipv4_eigrp_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,128}$`	No
advertise_ipv4_isis	Boolean	`true`, `false`	No
advertise_ipv4_isis_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,128}$`	No
advertise_ipv4_lisp	Boolean	`true`, `false`	No
advertise_ipv4_lisp_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,128}$`	No
advertise_ipv4_ospf	Boolean	`true`, `false`	No
advertise_ipv4_ospf_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,128}$`	No
advertise_ipv4_ospf_v3	Boolean	`true`, `false`	No
advertise_ipv4_ospf_v3_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,128}$`	No
advertise_ipv4_static	Boolean	`true`, `false`	No
advertise_ipv4_static_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,128}$`	No
advertise_ipv6_bgp	Boolean	`true`, `false`	No
advertise_ipv6_bgp_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,128}$`	No
advertise_ipv6_connected	Boolean	`true`, `false`	No
advertise_ipv6_connected_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,128}$`	No
advertise_ipv6_eigrp	Boolean	`true`, `false`	No
advertise_ipv6_eigrp_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,128}$`	No
advertise_ipv6_isis	Boolean	`true`, `false`	No
advertise_ipv6_isis_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,128}$`	No
advertise_ipv6_lisp	Boolean	`true`, `false`	No
advertise_ipv6_lisp_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,128}$`	No
advertise_ipv6_ospf	Boolean	`true`, `false`	No
advertise_ipv6_ospf_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,128}$`	No
advertise_ipv6_static	Boolean	`true`, `false`	No
advertise_ipv6_static_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,128}$`	No
advertisement_interval	Integer	min: `1`, max: `65535`	No
advertisement_interval_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,128}$`	No
aspath_auto_translation	Boolean	`true`, `false`	No
aspath_auto_translation_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,128}$`	No
ecmp_limit	Integer	min: `1`, max: `16`	No
ecmp_limit_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,128}$`	No
eor_timer	Integer	min: `1`, max: `3600`	No
eor_timer_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,128}$`	No
graceful_restart	Boolean	`true`, `false`	No
graceful_restart_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,128}$`	No
graceful_restart_timer	Integer	min: `1`, max: `604800`	No
graceful_restart_timer_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,128}$`	No
holdtime	Integer	min: `3`, max: `65535`	No
holdtime_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,128}$`	No
ignore_region_path_length	Boolean	`true`, `false`	No
ignore_region_path_length_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,128}$`	No
omp_admin_distance_ipv4	Integer	min: `1`, max: `255`	No
omp_admin_distance_ipv4_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,128}$`	No
omp_admin_distance_ipv6	Integer	min: `1`, max: `255`	No
omp_admin_distance_ipv6_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,128}$`	No
overlay_as	Integer	min: `1`, max: `4294967295`	No
overlay_as_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,128}$`	No
send_path_limit	Integer	min: `1`, max: `16`	No
send_path_limit_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,128}$`	No
shutdown	Boolean	`true`, `false`	No
shutdown_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,128}$`	No
site_types	List	Choice[`type-1`, `type-2`, `type-3`, `cloud`, `branch`, `br`, `spoke`]	No
site_types_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,128}$`	No
transport_gateway	Choice	`prefer`, `ecmp-with-direct-path`	No
transport_gateway_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,128}$`	No

Examples

Example-1: This example shows how to configure OMP feature which advertises IPv4 and IPv6 connected and OSPF routes into OMP, setting ECMP limit and send-path-limit to 16, enabling graceful restart and setting a greaceful restart timer.

sdwan:
  feature_profiles:
    system_profiles:
      - name: system1
        description: Basic system profile
        omp:
          name: omp
          description: OMP base template
          advertise_ipv4_connected: true
          advertise_ipv4_ospf: true
          advertise_ipv6_connected: true
          advertise_ipv6_ospf: true
          ecmp_limit: 16
          send_path_limit: 16
          graceful_restart: true
          graceful_restart_timer: 86400

OMP template controls number of paths being advertised and installed, which protocols are by default redistributed into OMP, AS overlay number and also various timers: graceful restart, advertisment and hold.

Diagram

Diagram

Classes

system_profiles (sdwan.feature_profiles)

Name	Type	Constraint	Mandatory	Default Value
omp	Class	`[omp]`	No

omp (sdwan.feature_profiles.system_profiles)

Name	Type	Constraint	Mandatory	Default Value
name	String	Regex: `^[^&<>! "]{1,128}$`	No	`omp`
description	String		No
advertise_ipv4_bgp	Boolean	`true`, `false`	No
advertise_ipv4_bgp_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
advertise_ipv4_connected	Boolean	`true`, `false`	No
advertise_ipv4_connected_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
advertise_ipv4_eigrp	Boolean	`true`, `false`	No
advertise_ipv4_eigrp_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
advertise_ipv4_isis	Boolean	`true`, `false`	No
advertise_ipv4_isis_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
advertise_ipv4_lisp	Boolean	`true`, `false`	No
advertise_ipv4_lisp_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
advertise_ipv4_ospf	Boolean	`true`, `false`	No
advertise_ipv4_ospf_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
advertise_ipv4_ospf_v3	Boolean	`true`, `false`	No
advertise_ipv4_ospf_v3_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
advertise_ipv4_static	Boolean	`true`, `false`	No
advertise_ipv4_static_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
advertise_ipv6_bgp	Boolean	`true`, `false`	No
advertise_ipv6_bgp_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
advertise_ipv6_connected	Boolean	`true`, `false`	No
advertise_ipv6_connected_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
advertise_ipv6_eigrp	Boolean	`true`, `false`	No
advertise_ipv6_eigrp_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
advertise_ipv6_isis	Boolean	`true`, `false`	No
advertise_ipv6_isis_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
advertise_ipv6_lisp	Boolean	`true`, `false`	No
advertise_ipv6_lisp_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
advertise_ipv6_ospf	Boolean	`true`, `false`	No
advertise_ipv6_ospf_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
advertise_ipv6_static	Boolean	`true`, `false`	No
advertise_ipv6_static_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
advertisement_interval	Integer	min: `1`, max: `65535`	No
advertisement_interval_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
ecmp_limit	Integer	min: `1`, max: `16`	No
ecmp_limit_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
eor_timer	Integer	min: `1`, max: `3600`	No
eor_timer_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
graceful_restart	Boolean	`true`, `false`	No
graceful_restart_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
graceful_restart_timer	Integer	min: `1`, max: `604800`	No
graceful_restart_timer_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
holdtime	Integer	min: `3`, max: `65535`	No
holdtime_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
ignore_region_path_length	Boolean	`true`, `false`	No
ignore_region_path_length_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
omp_admin_distance_ipv4	Integer	min: `1`, max: `255`	No
omp_admin_distance_ipv4_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
omp_admin_distance_ipv6	Integer	min: `1`, max: `255`	No
omp_admin_distance_ipv6_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
overlay_as	Integer	min: `1`, max: `4294967295`	No
overlay_as_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
send_path_limit	Integer	min: `1`, max: `16`	No
send_path_limit_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
shutdown	Boolean	`true`, `false`	No
shutdown_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
site_types	List	Choice[`type-1`, `type-2`, `type-3`, `cloud`, `branch`, `br`, `spoke`]	No
site_types_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
transport_gateway	Choice	`prefer`, `ecmp-with-direct-path`	No
transport_gateway_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No

Examples

Example-1: This example shows how to configure OMP feature which advertises IPv4 and IPv6 connected and OSPF routes into OMP, setting ECMP limit and send-path-limit to 16, enabling graceful restart and setting a greaceful restart timer.

sdwan:
  feature_profiles:
    system_profiles:
      - name: system1
        description: Basic system profile
        omp:
          name: omp
          description: OMP base template
          advertise_ipv4_connected: true
          advertise_ipv4_ospf: true
          advertise_ipv6_connected: true
          advertise_ipv6_ospf: true
          ecmp_limit: 16
          send_path_limit: 16
          graceful_restart: true
          graceful_restart_timer: 86400

OMP template controls number of paths being advertised and installed, which protocols are by default redistributed into OMP, AS overlay number and also various timers: graceful restart, advertisment and hold.

Diagram

Diagram

Classes

system_profiles (sdwan.feature_profiles)

Name	Type	Constraint	Mandatory	Default Value
omp	Class	`[omp]`	No

omp (sdwan.feature_profiles.system_profiles)

Name	Type	Constraint	Mandatory	Default Value
name	String	Regex: `^[^&<>! "]{1,128}$`	No	`omp`
description	String		No
advertise_ipv4_bgp	Boolean	`true`, `false`	No
advertise_ipv4_bgp_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
advertise_ipv4_connected	Boolean	`true`, `false`	No
advertise_ipv4_connected_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
advertise_ipv4_eigrp	Boolean	`true`, `false`	No
advertise_ipv4_eigrp_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
advertise_ipv4_isis	Boolean	`true`, `false`	No
advertise_ipv4_isis_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
advertise_ipv4_lisp	Boolean	`true`, `false`	No
advertise_ipv4_lisp_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
advertise_ipv4_ospf	Boolean	`true`, `false`	No
advertise_ipv4_ospf_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
advertise_ipv4_ospf_v3	Boolean	`true`, `false`	No
advertise_ipv4_ospf_v3_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
advertise_ipv4_static	Boolean	`true`, `false`	No
advertise_ipv4_static_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
advertise_ipv6_bgp	Boolean	`true`, `false`	No
advertise_ipv6_bgp_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
advertise_ipv6_connected	Boolean	`true`, `false`	No
advertise_ipv6_connected_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
advertise_ipv6_eigrp	Boolean	`true`, `false`	No
advertise_ipv6_eigrp_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
advertise_ipv6_isis	Boolean	`true`, `false`	No
advertise_ipv6_isis_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
advertise_ipv6_lisp	Boolean	`true`, `false`	No
advertise_ipv6_lisp_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
advertise_ipv6_ospf	Boolean	`true`, `false`	No
advertise_ipv6_ospf_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
advertise_ipv6_static	Boolean	`true`, `false`	No
advertise_ipv6_static_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
advertisement_interval	Integer	min: `1`, max: `65535`	No
advertisement_interval_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
ecmp_limit	Integer	min: `1`, max: `16`	No
ecmp_limit_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
eor_timer	Integer	min: `1`, max: `3600`	No
eor_timer_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
graceful_restart	Boolean	`true`, `false`	No
graceful_restart_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
graceful_restart_timer	Integer	min: `1`, max: `604800`	No
graceful_restart_timer_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
holdtime	Integer	min: `3`, max: `65535`	No
holdtime_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
ignore_region_path_length	Boolean	`true`, `false`	No
ignore_region_path_length_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
omp_admin_distance_ipv4	Integer	min: `1`, max: `255`	No
omp_admin_distance_ipv4_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
omp_admin_distance_ipv6	Integer	min: `1`, max: `255`	No
omp_admin_distance_ipv6_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
overlay_as	Integer	min: `1`, max: `4294967295`	No
overlay_as_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
send_path_limit	Integer	min: `1`, max: `16`	No
send_path_limit_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
shutdown	Boolean	`true`, `false`	No
shutdown_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
site_types	List	Choice[`type-1`, `type-2`, `type-3`, `cloud`, `branch`, `br`, `spoke`]	No
site_types_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
transport_gateway	Choice	`prefer`, `ecmp-with-direct-path`	No
transport_gateway_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No

Examples

Example-1: Basic OMP configuration is shown in example below. We want OMP only to advertise by default static and connected routes. Rest should be controlled by VPN template. Edges are allowed to advertise 16 paths and install 16 ECMP paths. Graceful restart is enabled with restart timer set to one day.

sdwan:
  feature_profiles:
    system_profiles:
      - name: system1
        description: Basic system profile
        omp_templates:
          - name: FT-EDGE-OMP-01
            description: OMP base template
            ipv4_advertise_protocols:
              - ospf
              - connected
            ipv6_advertise_protocols:
              - ospf
              - connected
            ecmp_limit: 16
            send_path_limit: 16
            graceful_restart: true
            graceful_restart_timer: 86400