Skip to content
Network as Code

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

Section titled “Diagram”
Diagram

Classes

Section titled “Classes”

service_profiles (sdwan.feature_profiles)

Section titled “service_profiles (sdwan.feature_profiles)”
NameTypeConstraintMandatoryDefault Value
ospf_featuresList[ospf_features]No

ospf_features (sdwan.feature_profiles.service_profiles)

Section titled “ospf_features (sdwan.feature_profiles.service_profiles)”
NameTypeConstraintMandatoryDefault Value
nameStringRegex: ^[^&<>! "]{1,128}$Yes
descriptionStringNo
areasList[areas]No
default_originateBooleantrue, falseNo
default_originate_alwaysBooleantrue, falseNo
default_originate_always_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
default_originate_metricIntegermin: 0, max: 16777214No
default_originate_metric_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
default_originate_metric_typeChoicetype1, type2No
default_originate_metric_type_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
distance_externalIntegermin: 1, max: 255No
distance_external_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
distance_inter_areaIntegermin: 1, max: 255No
distance_inter_area_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
distance_intra_areaIntegermin: 1, max: 255No
distance_intra_area_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
redistributesList[redistributes]No
reference_bandwidthIntegermin: 1, max: 4294967No
reference_bandwidth_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
rfc1583_compatibilityBooleantrue, falseNo
rfc1583_compatibility_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
route_policyStringRegex: ^[^<! ]{1,128}$No
router_idIPNo
router_id_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
router_lsa_advertisement_timeIntegermin: 5, max: 86400No
router_lsa_advertisement_typeChoiceadministrative, on-startupNo
spf_calculation_delayIntegermin: 0, max: 600000No
spf_calculation_delay_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
spf_initial_hold_timeIntegermin: 0, max: 600000No
spf_initial_hold_time_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
spf_maximum_hold_timeIntegermin: 0, max: 600000No
spf_maximum_hold_time_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No

areas (sdwan.feature_profiles.service_profiles.ospf_features)

Section titled “areas (sdwan.feature_profiles.service_profiles.ospf_features)”
NameTypeConstraintMandatoryDefault Value
numberIntegermin: 0, max: 4294967295No
number_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
interfacesList[interfaces]No
no_summaryBooleantrue, falseNo
no_summary_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
rangesList[ranges]No
typeChoicestub, nssaNo

redistributes (sdwan.feature_profiles.service_profiles.ospf_features)

Section titled “redistributes (sdwan.feature_profiles.service_profiles.ospf_features)”
NameTypeConstraintMandatoryDefault Value
protocolChoicebgp, connected, eigrp, nat, omp, staticNo
protocol_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
diaBooleantrue, falseNo
dia_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
translate_rib_metricBooleantrue, falseNo
translate_rib_metric_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
route_policyStringRegex: ^[^<! ]{1,128}$No

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

Section titled “interfaces (sdwan.feature_profiles.service_profiles.ospf_features.areas)”
NameTypeConstraintMandatoryDefault Value
nameStringRegex: ^(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_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
authentication_message_digest_keyStringmin: 1, max: 127No
authentication_message_digest_key_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
authentication_message_digest_key_idIntegermin: 1, max: 255No
authentication_message_digest_key_id_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
authentication_typeChoicemessage-digestNo
authentication_type_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
costIntegermin: 1, max: 65535No
cost_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
hello_intervalIntegermin: 1, max: 65535No
hello_interval_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
dead_intervalIntegermin: 1, max: 65535No
dead_interval_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
designated_router_priorityIntegermin: 0, max: 255No
designated_router_priority_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
lsa_retransmit_intervalIntegermin: 1, max: 65535No
lsa_retransmit_interval_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
network_typeChoicebroadcast, non-broadcast, point-to-multipoint, point-to-pointNo
network_type_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
passiveBooleantrue, falseNo
passive_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No

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

Section titled “ranges (sdwan.feature_profiles.service_profiles.ospf_features.areas)”
NameTypeConstraintMandatoryDefault Value
costIntegermin: 0, max: 16777214No
network_addressIPNo
network_address_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
no_advertiseBooleantrue, falseNo
no_advertise_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
subnet_maskChoice255.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.0No
subnet_mask_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No

Examples

Section titled “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