Skip to content
Network as Code

OSPF Feature Template

Configure the OSPF Routing parameters for a IOS-XE WAN Edge. This feature tempalte is referenced under a VPN feature template in the cEdge Device Template. OSPF routing allows the WAN Edge to make intelligent routing decision.

Diagram

Diagram

Classes

edge_feature_templates (sdwan)

NameTypeConstraintMandatoryDefault Value
ospf_templatesList[ospf_templates]No

ospf_templates (sdwan.edge_feature_templates)

NameTypeConstraintMandatoryDefault Value
nameStringRegex: ^[^<>!&" ]{1,128}$Yes
descriptionStringYes
device_typesListChoice[ASR-1001-HX, ASR-1001-X, ASR-1002-HX, ASR-1002-X, ASR-1006-X, C1101-4P, C1101-4PLTEP, C1101-4PLTEPW, C1109-2PLTEGB, C1109-2PLTEUS, C1109-2PLTEVZ, C1109-4PLTE2P, C1109-4PLTE2PW, C1111-4P, C1111-4PLTEEA, C1111-4PLTELA, C1111-4PW, C1111-8P, C1111-8PLTEEA, C1111-8PLTEEAW, C1111-8PLTELA, C1111-8PLTELAW, C1111-8PW, C1111X-8P, C1112-8P, C1112-8PLTEEA, C1112-8PLTEEAWE, C1112-8PWE, C1113-8P, C1113-8PLTEEA, C1113-8PLTEEAW, C1113-8PLTELA, C1113-8PLTELAWZ, C1113-8PLTEW, C1113-8PM, C1113-8PMLTEEA, C1113-8PMWE, C1113-8PW, C1116-4P, C1116-4PLTEEA, C1116-4PLTEEAWE, C1116-4PWE, C1117-4P, C1117-4PLTEEA, C1117-4PLTEEAW, C1117-4PLTELA, C1117-4PLTELAWZ, C1117-4PM, C1117-4PMLTEEA, C1117-4PMLTEEAWE, C1117-4PMWE, C1117-4PW, C1118-8P, C1121-4P, C1121-4PLTEP, C1121-8P, C1121-8PLTEP, C1121-8PLTEPW, C1121X-8P, C1121X-8PLTEP, C1121X-8PLTEPW, C1126-8PLTEP, C1126X-8PLTEP, C1127-8PLTEP, C1127-8PMLTEP, C1127X-8PLTEP, C1127X-8PMLTEP, C1128-8PLTEP, C1131-8PLTEPW, C1131-8PW, C1131X-8PLTEPW, C1131X-8PW, C1161-8P, C1161-8PLTEP, C1161X-8P, C1161X-8PLTEP, C8000V, C8200-1N-4T, C8200L-1N-4T, C8300-1N1S-4T2X, C8300-1N1S-6T, C8300-2N2S-4T2X, C8300-2N2S-6T, C8500-12X, C8500-12X4QC, C8500-20X6C, C8500L-8S4X, IR-1101, IR-1821, IR-1831, IR-1833, IR-1835, IR-8140H, IR-8140H-P, IR-8340, ISR-4221, ISR-4221X, ISR-4321, ISR-4331, ISR-4351, ISR-4431, ISR-4451-X, ISR-4461, ISR1100-4G-XE, ISR1100-4GLTEGB-XE, ISR1100-4GLTENA-XE, ISR1100-6G-XE, ISR1100X-4G-XE, ISR1100X-6G-XE]No
areasList[areas]No
auto_cost_reference_bandwidthIntegermin: 1, max: 4294967No
auto_cost_reference_bandwidth_variableStringRegex: ^[^"~$&+,]255$`No
compatible_rfc1583Booleantrue, falseNo
compatible_rfc1583_variableStringRegex: ^[^"~$&+,]255$`No
default_information_originateBooleantrue, falseNo
default_information_originate_alwaysBooleantrue, falseNo
default_information_originate_always_variableStringRegex: ^[^"~$&+,]255$`No
default_information_originate_metricIntegermin: 0, max: 16777214No
default_information_originate_metric_variableStringRegex: ^[^"~$&+,]255$`No
default_information_originate_metric_typeChoicetype1, type2No
default_information_originate_metric_type_variableStringRegex: ^[^"~$&+,]255$`No
distance_inter_areaIntegermin: 1, max: 255No
distance_inter_area_variableStringRegex: ^[^"~$&+,]255$`No
distance_intra_areaIntegermin: 1, max: 255No
distance_intra_area_variableStringRegex: ^[^"~$&+,]255$`No
distance_externalIntegermin: 1, max: 255No
distance_external_variableStringRegex: ^[^"~$&+,]255$`No
max_metric_router_lsasList[max_metric_router_lsas]No
redistributesList[redistributes]No
route_policyStringNo
route_policy_variableStringRegex: ^[^"~$&+,]255$`No
router_idIPNo
router_id_variableStringRegex: ^[^"~$&+,]255$`No
timers_spf_delayIntegermin: 1, max: 600000No
timers_spf_delay_variableStringRegex: ^[^"~$&+,]255$`No
timers_spf_initial_holdIntegermin: 1, max: 600000No
timers_spf_initial_hold_variableStringRegex: ^[^"~$&+,]255$`No
timers_spf_max_holdIntegermin: 1, max: 600000No
timers_spf_max_hold_variableStringRegex: ^[^"~$&+,]255$`No

areas (sdwan.edge_feature_templates.ospf_templates)

NameTypeConstraintMandatoryDefault Value
area_numberIntegermin: 0, max: 4294967295No
area_number_variableStringRegex: ^[^"~$&+,]255$`No
area_typeChoicestub, nssaNo
interfacesList[interfaces]No
no_summaryBooleantrue, falseNo
no_summary_variableStringRegex: ^[^"~$&+,]255$`No
optionalBooleantrue, falseNo
rangesList[ranges]No

max_metric_router_lsas (sdwan.edge_feature_templates.ospf_templates)

NameTypeConstraintMandatoryDefault Value
timeIntegermin: 5, max: 86400No
time_variableStringRegex: ^[^"~$&+,]255$`No
typeChoiceadministrative, on-startupYes

redistributes (sdwan.edge_feature_templates.ospf_templates)

NameTypeConstraintMandatoryDefault Value
nat_diaBooleantrue, falseNo
nat_dia_variableStringRegex: ^[^"~$&+,]255$`No
optionalBooleantrue, falseNo
protocolChoicebgp, connected, eigrp, nat, omp, staticNo
protocol_variableStringRegex: ^[^"~$&+,]255$`No
route_policyStringNo
route_policy_variableStringRegex: ^[^"~$&+,]255$`No

interfaces (sdwan.edge_feature_templates.ospf_templates.areas)

NameTypeConstraintMandatoryDefault Value
authentication_message_digest_keyStringmin: 1, max: 31No
authentication_message_digest_key_variableStringRegex: ^[^"~$&+,]255$`No
authentication_message_digest_key_idIntegermin: 1, max: 255No
authentication_message_digest_key_id_variableStringRegex: ^[^"~$&+,]255$`No
authentication_typeChoicesimple, message-digest, nullNo
authentication_type_variableStringRegex: ^[^"~$&+,]255$`No
costIntegermin: 1, max: 65535No
cost_variableStringRegex: ^[^"~$&+,]255$`No
dead_intervalIntegermin: 1, max: 65535No
dead_interval_variableStringRegex: ^[^"~$&+,]255$`No
hello_intervalIntegermin: 1, max: 65535No
hello_interval_variableStringRegex: ^[^"~$&+,]255$`No
nameStringNo
name_variableStringRegex: ^[^"~$&+,]255$`No
network_typeChoicebroadcast, point-to-point, non-broadcast, point-to-multipointNo
network_type_variableStringRegex: ^[^"~$&+,]255$`No
passive_interfaceBooleantrue, falseNo
passive_interface_variableStringRegex: ^[^"~$&+,]255$`No
priorityIntegermin: 0, max: 255No
priority_variableStringRegex: ^[^"~$&+,]255$`No
retransmit_intervalIntegermin: 1, max: 65535No
retransmit_interval_variableStringRegex: ^[^"~$&+,]255$`No

ranges (sdwan.edge_feature_templates.ospf_templates.areas)

NameTypeConstraintMandatoryDefault Value
addressIPNo
address_variableStringRegex: ^[^"~$&+,]255$`No
costIntegermin: 1, max: 16777214No
cost_variableStringRegex: ^[^"~$&+,]255$`No
no_advertiseBooleantrue, falseNo
no_advertise_variableStringRegex: ^[^"~$&+,]255$`No

Examples

Examples-1: OSPF template with MD5 authentication, with variable for MD5 password, variable for interfaces, variable for route policy and variable for router-id. This template allows OMP routes to be redistributed into OSPF, this is will allow service side devices to learn routes from OMP routes. Enable OSPF MD5 authentication for added security.

sdwan:
  edge_feature_templates:
    ospf_templates:
      - name: FT-CEDGE-OSPF-01
        description: "OSPF base template"
        areas:
          - area_number: 0
            interfaces:
              - authentication_message_digest_key_variable: ospf_area0_if_md5_key
                authentication_message_digest_key_id: 1
                authentication_type: message-digest
                name_variable: ospf_area0_if_name
                passive_interface: false
        default_information_originate: true
        redistributes:
          - protocol: omp
            route_policy_variable: ospf_redistribute_omp_route_policy
        router_id_variable: ospf_router_id

Examples-2: OSPF template with MD5 authentication, with variable for MD5 password, variable for interfaces, variable for route policy and variable for router-id. This template allows OMP routes to be redistributed into OSPF, this will allow service side devices to learn routes from static routes defined on the WAN Edge. Enable OSPF MD5 authentication for added security. OSPF timers have added to tweak the failover and convergence times.

sdwan:
  edge_feature_templates:
    ospf_templates:
      - name: XXX_Service-InternalVPN-OSPF_v001
        description: Service Side Internal VPN OSPF Template
        device_types:
          - C8000V
          - ISR-4331
        areas:
          - area_number_variable: VPNx_ospf_area_number_var
            interfaces:
              - authentication_message_digest_key: password
                authentication_message_digest_key_id: 1
                authentication_type: message-digest
                cost: 1
                dead_interval: 20
                hello_interval: 5
                name_variable: VPNx_ospf_interface_var
        default_information_originate_metric: 100
        default_information_originate_metric_type: type1
        router_id_variable: VPNx_router_ospf_id_var
        redistributes:
          - protocol: static