Skip to content

Service OSPF Feature

This feature enables OSPF routing protocol within service VPN segments, allowing the device to exchange routing information with service-side devices.

Diagram

Diagram

Classes

sdwan

Name	Type	Constraint	Mandatory	Default Value
feature_profiles	Class	feature_profiles	No

feature_profiles (sdwan)

Name	Type	Constraint	Mandatory	Default Value
service_profiles	List	service_profiles	No

service_profiles (sdwan.feature_profiles)

Name	Type	Constraint	Mandatory	Default Value
ospf_features	List	ospf_features	No

ospf_features (sdwan.feature_profiles.service_profiles)

Name	Type	Constraint	Mandatory	Default Value
name	String	Regex: `^[^&<>! "]{1,128}$`	Yes
description	String		No
areas	List	areas	No
default_originate	Boolean	`true`, `false`	No
default_originate_always	Boolean	`true`, `false`	No
default_originate_always_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,128}$`	No
default_originate_metric	Integer	min: `0`, max: `16777214`	No
default_originate_metric_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,128}$`	No
default_originate_metric_type	Choice	`type1`, `type2`	No
default_originate_metric_type_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,128}$`	No
distance_external	Integer	min: `1`, max: `255`	No
distance_external_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,128}$`	No
distance_inter_area	Integer	min: `1`, max: `255`	No
distance_inter_area_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,128}$`	No
distance_intra_area	Integer	min: `1`, max: `255`	No
distance_intra_area_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,128}$`	No
redistributes	List	redistributes	No
reference_bandwidth	Integer	min: `1`, max: `4294967`	No
reference_bandwidth_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,128}$`	No
rfc1583_compatibility	Boolean	`true`, `false`	No
rfc1583_compatibility_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,128}$`	No
route_policy	String	Regex: `^[^<! ]{1,128}$`	No
router_id	IP		No
router_id_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,128}$`	No
router_lsa_advertisement_time	Integer	min: `5`, max: `86400`	No
router_lsa_advertisement_type	Choice	`administrative`, `on-startup`	No
spf_calculation_delay	Integer	min: `0`, max: `600000`	No
spf_calculation_delay_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,128}$`	No
spf_initial_hold_time	Integer	min: `0`, max: `600000`	No
spf_initial_hold_time_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,128}$`	No
spf_maximum_hold_time	Integer	min: `0`, max: `600000`	No
spf_maximum_hold_time_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,128}$`	No

ospf_features (sdwan.feature_profiles.service_profiles)

Name	Type	Constraint	Mandatory	Default Value
name	String	Regex: `^[^&<>! "]{1,128}$`	Yes
description	String		No
areas	List	areas	No
default_originate	Boolean	`true`, `false`	No
default_originate_always	Boolean	`true`, `false`	No
default_originate_always_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
default_originate_metric	Integer	min: `0`, max: `16777214`	No
default_originate_metric_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
default_originate_metric_type	Choice	`type1`, `type2`	No
default_originate_metric_type_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
distance_external	Integer	min: `1`, max: `255`	No
distance_external_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
distance_inter_area	Integer	min: `1`, max: `255`	No
distance_inter_area_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
distance_intra_area	Integer	min: `1`, max: `255`	No
distance_intra_area_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
redistributes	List	redistributes	No
reference_bandwidth	Integer	min: `1`, max: `4294967`	No
reference_bandwidth_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
rfc1583_compatibility	Boolean	`true`, `false`	No
rfc1583_compatibility_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
route_policy	String	Regex: `^[^<! ]{1,128}$`	No
router_id	IP		No
router_id_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
router_lsa_advertisement_time	Integer	min: `5`, max: `86400`	No
router_lsa_advertisement_type	Choice	`administrative`, `on-startup`	No
spf_calculation_delay	Integer	min: `0`, max: `600000`	No
spf_calculation_delay_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
spf_initial_hold_time	Integer	min: `0`, max: `600000`	No
spf_initial_hold_time_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
spf_maximum_hold_time	Integer	min: `0`, max: `600000`	No
spf_maximum_hold_time_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No

areas (sdwan.feature_profiles.service_profiles.ospf_features)

Name	Type	Constraint	Mandatory	Default Value
number	Integer	min: `0`, max: `4294967295`	No
number_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,128}$`	No
interfaces	List	interfaces	No
no_summary	Boolean	`true`, `false`	No
no_summary_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,128}$`	No
ranges	List	ranges	No
type	Choice	`stub`, `nssa`	No

areas (sdwan.feature_profiles.service_profiles.ospf_features)

Name	Type	Constraint	Mandatory	Default Value
number	Integer	min: `0`, max: `4294967295`	No
number_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
interfaces	List	interfaces	No
no_summary	Boolean	`true`, `false`	No
no_summary_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
ranges	List	ranges	No
type	Choice	`stub`, `nssa`	No

redistributes (sdwan.feature_profiles.service_profiles.ospf_features)

Name	Type	Constraint	Mandatory	Default Value
protocol	Choice	`bgp`, `connected`, `eigrp`, `nat`, `omp`, `static`	No
protocol_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,128}$`	No
dia	Boolean	`true`, `false`	No
dia_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,128}$`	No
translate_rib_metric	Boolean	`true`, `false`	No
translate_rib_metric_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,128}$`	No
route_policy	String	Regex: `^[^<! ]{1,128}$`	No

redistributes (sdwan.feature_profiles.service_profiles.ospf_features)

Name	Type	Constraint	Mandatory	Default Value
protocol	Choice	`bgp`, `connected`, `eigrp`, `nat`, `omp`, `static`	No
protocol_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
dia	Boolean	`true`, `false`	No
dia_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
translate_rib_metric	Boolean	`true`, `false`	No
translate_rib_metric_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
route_policy	String	Regex: `^[^<! ]{1,128}$`	No

interfaces (sdwan.feature_profiles.service_profiles.ospf_features.areas)

Name	Type	Constraint	Mandatory	Default Value
name	String	Regex: (ATM\|ATM-ACR\|AppGigabitEthernet\|AppNav-Compress\|AppNav-UnCompress\|Async\|BD-VIF\|BDI\|CEM\|CEM-ACR\|Cellular\|Dialer\|Embedded-Service-Engine\|Ethernet\|Ethernet-Internal\|FastEthernet\|FiftyGigabitEthernet\|FiveGigabitEthernet\|FortyGigabitEthernet\|FourHundredGigE\|GMPLS\|GigabitEthernet\|Group-Async\|HundredGigE\|L2LISP\|LISP\|Loopback\|MFR\|Multilink\|Port-channel\|SM\|Serial\|Service-Engine\|TenGigabitEthernet\|Tunnel\|TwentyFiveGigE\|TwentyFiveGigabitEthernet\|TwoGigabitEthernet\|TwoHundredGigE\|Vif\|Virtual-PPP\|Virtual-Template\|VirtualPortGroup\|Vlan\|Wlan-GigabitEthernet\|gre\|ipsec\|nat64\|nat66\|ntp\|nve\|ospfv3\|overlay\|pseudowire\|ucse\|vasileft\|vasiright\|vmi)([0-9](. ?[1-9][0-9])*\|[0-9/]+\|[0-9]+/[0-9]+/[0-9]+:[0-9]+\|[0-9]+/[0-9]+/[0-9]+\|[0-9]+/[0-9]+\|[0-9]+)	No
name_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,128}$`	No
authentication_message_digest_key	String	min: `1`, max: `127`	No
authentication_message_digest_key_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,128}$`	No
authentication_message_digest_key_id	Integer	min: `1`, max: `255`	No
authentication_message_digest_key_id_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,128}$`	No
authentication_type	Choice	`message-digest`	No
authentication_type_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,128}$`	No
cost	Integer	min: `1`, max: `65535`	No
cost_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,128}$`	No
hello_interval	Integer	min: `1`, max: `65535`	No
hello_interval_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,128}$`	No
dead_interval	Integer	min: `1`, max: `65535`	No
dead_interval_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,128}$`	No
designated_router_priority	Integer	min: `0`, max: `255`	No
designated_router_priority_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,128}$`	No
lsa_retransmit_interval	Integer	min: `1`, max: `65535`	No
lsa_retransmit_interval_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,128}$`	No
network_type	Choice	`broadcast`, `non-broadcast`, `point-to-multipoint`, `point-to-point`	No
network_type_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,128}$`	No
passive	Boolean	`true`, `false`	No
passive_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,128}$`	No

interfaces (sdwan.feature_profiles.service_profiles.ospf_features.areas)

Name	Type	Constraint	Mandatory	Default Value
name	String	Regex: (ATM\|ATM-ACR\|AppGigabitEthernet\|AppNav-Compress\|AppNav-UnCompress\|Async\|BD-VIF\|BDI\|CEM\|CEM-ACR\|Cellular\|Dialer\|Embedded-Service-Engine\|Ethernet\|Ethernet-Internal\|FastEthernet\|FiftyGigabitEthernet\|FiveGigabitEthernet\|FortyGigabitEthernet\|FourHundredGigE\|GMPLS\|GigabitEthernet\|Group-Async\|HundredGigE\|L2LISP\|LISP\|Loopback\|MFR\|Multilink\|Port-channel\|SM\|Serial\|Service-Engine\|TenGigabitEthernet\|Tunnel\|TwentyFiveGigE\|TwentyFiveGigabitEthernet\|TwoGigabitEthernet\|TwoHundredGigE\|Vif\|Virtual-PPP\|Virtual-Template\|VirtualPortGroup\|Vlan\|Wlan-GigabitEthernet\|nat64\|nat66\|ntp\|nve\|ospfv3\|overlay\|pseudowire\|ucse\|vasileft\|vasiright\|vmi)([0-9](. ?[1-9][0-9])*\|[0-9/]+\|[0-9]+/[0-9]+/[0-9]+:[0-9]+\|[0-9]+/[0-9]+/[0-9]+\|[0-9]+/[0-9]+\|[0-9]+)	No
name_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,128}$`	No
authentication_message_digest_key	String	min: `1`, max: `127`	No
authentication_message_digest_key_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,128}$`	No
authentication_message_digest_key_id	Integer	min: `1`, max: `255`	No
authentication_message_digest_key_id_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,128}$`	No
authentication_type	Choice	`message-digest`	No
authentication_type_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,128}$`	No
cost	Integer	min: `1`, max: `65535`	No
cost_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,128}$`	No
hello_interval	Integer	min: `1`, max: `65535`	No
hello_interval_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,128}$`	No
dead_interval	Integer	min: `1`, max: `65535`	No
dead_interval_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,128}$`	No
designated_router_priority	Integer	min: `0`, max: `255`	No
designated_router_priority_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,128}$`	No
lsa_retransmit_interval	Integer	min: `1`, max: `65535`	No
lsa_retransmit_interval_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,128}$`	No
network_type	Choice	`broadcast`, `non-broadcast`, `point-to-multipoint`, `point-to-point`	No
network_type_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,128}$`	No
passive	Boolean	`true`, `false`	No
passive_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,128}$`	No

interfaces (sdwan.feature_profiles.service_profiles.ospf_features.areas)

Name	Type	Constraint	Mandatory	Default Value
name	String	Regex: ^(ATM\|ATM-ACR\|AppGigabitEthernet\|AppNav-Compress\|AppNav-UnCompress\|Async\|BD-VIF\|BDI\|CEM\|CEM-ACR\|Cellular\|Dialer\|Embedded-Service-Engine\|Ethernet\|Ethernet-Internal\|FastEthernet\|FiftyGigabitEthernet\|FiveGigabitEthernet\|FortyGigabitEthernet\|FourHundredGigE\|GMPLS\|GigabitEthernet\|Group-Async\|HundredGigE\|L2LISP\|LISP\|Loopback\|MFR\|Multilink\|Port-channel\|SM\|Serial\|Service-Engine\|TenGigabitEthernet\|Tunnel\|TwentyFiveGigE\|TwentyFiveGigabitEthernet\|TwoGigabitEthernet\|TwoHundredGigE\|Vif\|Virtual-PPP\|Virtual-Template\|VirtualPortGroup\|Vlan\|Wlan-GigabitEthernet\|nat64\|nat66\|ntp\|nve\|ospfv3\|overlay\|pseudowire\|ucse\|vasileft\|vasiright\|vmi)([0-9](. ?[1-9][0-9])*\|[0-9/]+\|[0-9]+/[0-9]+/[0-9]+:[0-9]+\|[0-9]+/[0-9]+/[0-9]+\|[0-9]+/[0-9]+\|[0-9]+)$	No
name_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
authentication_message_digest_key	String	min: `1`, max: `127`	No
authentication_message_digest_key_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
authentication_message_digest_key_id	Integer	min: `1`, max: `255`	No
authentication_message_digest_key_id_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
authentication_type	Choice	`message-digest`	No
authentication_type_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
cost	Integer	min: `1`, max: `65535`	No
cost_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
hello_interval	Integer	min: `1`, max: `65535`	No
hello_interval_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
dead_interval	Integer	min: `1`, max: `65535`	No
dead_interval_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
designated_router_priority	Integer	min: `0`, max: `255`	No
designated_router_priority_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
lsa_retransmit_interval	Integer	min: `1`, max: `65535`	No
lsa_retransmit_interval_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
network_type	Choice	`broadcast`, `non-broadcast`, `point-to-multipoint`, `point-to-point`	No
network_type_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
passive	Boolean	`true`, `false`	No
passive_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No

ranges (sdwan.feature_profiles.service_profiles.ospf_features.areas)

Name	Type	Constraint	Mandatory	Default Value
cost	Integer	min: `0`, max: `16777214`	No
network_address	IP		No
network_address_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,128}$`	No
no_advertise	Boolean	`true`, `false`	No
no_advertise_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,128}$`	No
subnet_mask	Choice	`255.255.255.255`, `255.255.255.254`, `255.255.255.252`, `255.255.255.248`, `255.255.255.240`, `255.255.255.224`, `255.255.255.192`, `255.255.255.128`, `255.255.255.0`, `255.255.254.0`, `255.255.252.0`, `255.255.248.0`, `255.255.240.0`, `255.255.224.0`, `255.255.192.0`, `255.255.128.0`, `255.255.0.0`, `255.254.0.0`, `255.252.0.0`, `255.248.0.0`, `255.240.0.0`, `255.224.0.0`, `255.192.0.0`, `255.128.0.0`, `255.0.0.0`, `254.0.0.0`, `252.0.0.0`, `248.0.0.0`, `240.0.0.0`, `224.0.0.0`, `192.0.0.0`, `128.0.0.0`, `0.0.0.0`	No
subnet_mask_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,128}$`	No

ranges (sdwan.feature_profiles.service_profiles.ospf_features.areas)

Name	Type	Constraint	Mandatory	Default Value
cost	Integer	min: `0`, max: `16777214`	No
network_address	IP		No
network_address_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,128}$`	No
no_advertise	Boolean	`true`, `false`	No
no_advertise_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,128}$`	No
subnet_mask	Choice	`255.255.255.255`, `255.255.255.254`, `255.255.255.252`, `255.255.255.248`, `255.255.255.240`, `255.255.255.224`, `255.255.255.192`, `255.255.255.128`, `255.255.255.0`, `255.255.254.0`, `255.255.252.0`, `255.255.248.0`, `255.255.240.0`, `255.255.224.0`, `255.255.192.0`, `255.255.128.0`, `255.255.0.0`, `255.254.0.0`, `255.252.0.0`, `255.240.0.0`, `255.224.0.0`, `255.192.0.0`, `255.128.0.0`, `255.0.0.0`, `254.0.0.0`, `252.0.0.0`, `248.0.0.0`, `240.0.0.0`, `224.0.0.0`, `192.0.0.0`, `128.0.0.0`, `0.0.0.0`	No
subnet_mask_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,128}$`	No

ranges (sdwan.feature_profiles.service_profiles.ospf_features.areas)

Name	Type	Constraint	Mandatory	Default Value
cost	Integer	min: `0`, max: `16777214`	No
network_address	IP		No
network_address_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
no_advertise	Boolean	`true`, `false`	No
no_advertise_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No
subnet_mask	Choice	`255.255.255.255`, `255.255.255.254`, `255.255.255.252`, `255.255.255.248`, `255.255.255.240`, `255.255.255.224`, `255.255.255.192`, `255.255.255.128`, `255.255.255.0`, `255.255.254.0`, `255.255.252.0`, `255.255.248.0`, `255.255.240.0`, `255.255.224.0`, `255.255.192.0`, `255.255.128.0`, `255.255.0.0`, `255.254.0.0`, `255.252.0.0`, `255.240.0.0`, `255.224.0.0`, `255.192.0.0`, `255.128.0.0`, `255.0.0.0`, `254.0.0.0`, `252.0.0.0`, `248.0.0.0`, `240.0.0.0`, `224.0.0.0`, `192.0.0.0`, `128.0.0.0`, `0.0.0.0`	No
subnet_mask_variable	String	Regex: `^[./\[\]a-zA-Z0-9_-]{1,64}$`	No

Examples

Example-1: The example below demonstrates how to configure a service OSPF feature with router ID as variable, area 0 with single interface (interface name is variable and cost is 10) and route redistribution of connected routes into OSPF.

sdwan:
  feature_profiles:
    service_profiles:
      - name: service1
        ospf_features:
          - name: service_ospf_1
            router_id_variable: service_ospf_router_id
            areas:
              - number: 0
                interfaces:
                  - name_variable: service_ospf_interface
                    cost: 10
            redistributes:
              - protocol: connected