OSPF is a link-state interior gateway protocol that uses Dijkstra’s algorithm to calculate the shortest path. It supports areas, VRFs, segment routing, fast reroute, flexible algorithms, and various redistribution options for multi-protocol environments.
Name Type Constraint Mandatory Default Value ospf_processes List [ospf_processes]No
Name Type Constraint Mandatory Default Value id String Yes mpls_traffic_eng_router_id IP No mpls_traffic_eng_router_id_interface String No mpls_traffic_eng_multicast_intact Boolean true, falseNo mpls_traffic_eng_autoroute_exclude_route_policy String No mpls_traffic_eng_igp_intact Boolean true, falseNo mpls_traffic_eng_ldp_sync_update Boolean true, falseNo mpls_ldp_sync Choice enableNo mpls_ldp_sync_igp_shortcuts Choice enableNo mpls_ldp_auto_config Boolean true, falseNo cost Integer min: 1, max: 65535 No cost_fallback Class [cost_fallback]No hello_interval Integer min: 1, max: 65535 No dead_interval Integer min: 1, max: 65535 No priority Integer min: 0, max: 255 No retransmit_interval Integer min: 1, max: 65535 No transmit_delay Integer min: 1, max: 65535 No flood_reduction Choice enable, disableNo demand_circuit Choice enable, disableNo mtu_ignore Choice enable, disableNo database_filter_all_out Choice enable, disableNo passive Choice enable, disableNo log_adjacency_changes Choice detail, disableNo router_id IP No redistribute_connected Boolean true, falseNo redistribute_connected_tag Integer min: 0, max: 4294967295 No redistribute_connected_metric_type Integer min: 1, max: 2 No redistribute_connected_route_policy String No redistribute_connected_metric Integer min: 1, max: 16777214 No redistribute_connected_metric_use_rib_metric Boolean true, falseNo redistribute_connected_lsa_type_summary Boolean true, falseNo redistribute_connected_nssa_only Boolean true, falseNo redistribute_static Boolean true, falseNo redistribute_static_tag Integer min: 0, max: 4294967295 No redistribute_static_metric_type Integer min: 1, max: 2 No redistribute_static_route_policy String No redistribute_static_metric Integer min: 1, max: 16777214 No redistribute_static_metric_use_rib_metric Boolean true, falseNo redistribute_static_lsa_type_summary Boolean true, falseNo redistribute_static_nssa_only Boolean true, falseNo redistribute_bgp List [redistribute_bgp]No redistribute_isis List [redistribute_isis]No redistribute_ospf List [redistribute_ospf]No distribute_list_in_acl String No distribute_list_in_route_policy String No distribute_list_out_acl String No distribute_list_out_connected_acl String No distribute_list_out_static_acl String No distribute_list_out_bgp_asn Any String or Integer[min: 1, max: 4294967295] or String[Regex: ^.*[\$\%]\{.*$] No distribute_list_out_bgp_acl String No distribute_list_out_ospf_process String No distribute_list_out_ospf_acl String No packet_size Integer min: 576, max: 10000 No bfd_fast_detect Choice enable, strict-modeNo bfd_minimum_interval Integer min: 3, max: 30000 No bfd_multiplier Integer min: 2, max: 50 No security_ttl Choice enableNo security_ttl_hops Integer min: 1, max: 254 No prefix_suppression Choice enableNo default_information_originate Boolean true, falseNo default_information_originate_always Boolean true, falseNo default_information_originate_metric Integer min: 1, max: 16777214 No default_information_originate_metric_type Integer min: 1, max: 2 No default_information_originate_route_policy String No default_metric Integer min: 1, max: 16777214 No distance_sources List [distance_sources]No distance_ospf_intra_area Integer min: 1, max: 255 No distance_ospf_inter_area Integer min: 1, max: 255 No distance_ospf_external Integer min: 1, max: 255 No auto_cost_reference_bandwidth Integer min: 1, max: 2147483647 No auto_cost_disable Boolean true, falseNo ignore_lsa_mospf Boolean true, falseNo capability_opaque_disable Boolean true, falseNo capability_lls_disable Boolean true, falseNo capability_type7_prefer Boolean true, falseNo max_metric Class [max_metric]No max_lsa Integer min: 1, max: 4294967294 No max_lsa_threshold Integer min: 1, max: 100 No max_lsa_warning_only Boolean true, falseNo max_lsa_ignore_time Integer min: 1, max: 17895697 No max_lsa_ignore_count Integer min: 1, max: 4294967294 No max_lsa_reset_time Integer min: 2, max: 35791394 No timers Class [timers]No nsf_interval Integer min: 90, max: 3600 No nsf_lifetime Integer min: 90, max: 1800 No nsf_flush_delay_time Integer min: 1, max: 3600 No nsf_cisco Boolean true, falseNo nsf_cisco_enforce_global Boolean true, falseNo nsf_ietf Boolean true, falseNo nsf_ietf_strict_lsa_checking Boolean true, falseNo nsf_ietf_helper_disable Boolean true, falseNo address_family_ipv4_unicast Boolean true, falseNo maximum_interfaces Integer min: 1, max: 4294967295 No maximum_paths Integer min: 1, max: 64 No maximum_redistributed_prefixes Integer min: 1, max: 4294967295 No maximum_redistributed_prefixes_threshold Integer min: 1, max: 100 No maximum_redistributed_prefixes_warning_only Boolean true, falseNo queue_limit_high Integer min: 1000, max: 30000 No queue_limit_medium Integer min: 1000, max: 30000 No queue_limit_low Integer min: 1000, max: 30000 No queue_dispatch_incoming Integer min: 30, max: 3000 No queue_dispatch_rate_limited_lsa Integer min: 30, max: 3000 No queue_dispatch_flush_lsa Integer min: 30, max: 3000 No queue_dispatch_spf_lsa_limit Integer min: 30, max: 3000 No summary_prefixes List [summary_prefixes]No spf_prefix_priority_route_policy String No fast_reroute_per_prefix Class [fast_reroute_per_prefix]No fast_reroute_per_link Class [fast_reroute_per_link]No fast_reroute_disable Boolean true, falseNo loopback_stub_network Choice enable, disableNo link_down_fast_detect Boolean true, falseNo weight Integer min: 1, max: 16777214 No delay_normalize_interval Integer min: 1, max: 16777215 No delay_normalize_offset Integer min: 0, max: 16777215 No microloop_avoidance Choice enable, protected, segment-routingNo microloop_avoidance_rib_update_delay Integer min: 1, max: 600000 No segment_routing Class [segment_routing]No affinity_maps List [affinity_maps]No flex_algos List [flex_algos]No authentication Class [authentication]No network Choice broadcast, non-broadcast, point-to-point, point-to-multipointNo external_out Choice enable, disableNo summary_in Choice enable, disableNo adjacency_stagger_disable Boolean true, falseNo adjacency_stagger_initial_neighbors Integer min: 1, max: 65535 No adjacency_stagger_simultaneous_neighbors Integer min: 1, max: 65535 No snmp_context String No snmp_trap_rate_limit_min Integer min: 2, max: 60 No snmp_trap_rate_limit_max Integer min: 0, max: 300 No monitor_convergence Boolean true, falseNo monitor_convergence_prefix_list String No monitor_convergence_track_summary_routes Boolean true, falseNo monitor_convergence_track_external_routes Boolean true, falseNo monitor_convergence_track_ip_frr Boolean true, falseNo ucmp Boolean true, falseNo ucmp_variance Integer min: 101, max: 10000 No ucmp_prefix_list String No ucmp_exclude_interfaces List [ucmp_exclude_interfaces]No ucmp_delay_interval Integer min: 1, max: 5000 No srlg_admin_weight Integer min: 0, max: 65535 No srlg_names List [srlg_names]No max_external_lsa Integer min: 1, max: 4294967294 No max_external_lsa_threshold Integer min: 1, max: 100 No max_external_lsa_suppress_neighbor Boolean true, falseNo max_external_lsa_warning_only Boolean true, falseNo exchange_timer Integer min: 1, max: 35791394 No exchange_timer_hold_time Integer min: 1, max: 35791394 No exchange_timer_recovery_count Integer min: 1, max: 4294967294 No distribute_link_state Boolean true, falseNo distribute_link_state_instance_id Integer min: 0, max: 4294967295 No distribute_link_state_throttle Integer min: 1, max: 3600 No distribute_link_state_excl_external Boolean true, falseNo distribute_link_state_allow_prefix_route_policy String No distribute_link_state_follow_on Integer min: 1, max: 3600 No nsr Choice enable, disableNo protocol_shutdown Choice enable, host-mode, on-reloadNo vrfs List [vrfs]No areas List [areas]No
Name Type Constraint Mandatory Default Value anomaly_delay Class [anomaly_delay]No
Name Type Constraint Mandatory Default Value asn Any String or Integer[min: 1, max: 4294967295] or String[Regex: ^.*[\$\%]\{.*$] Yes tag Integer min: 0, max: 4294967295 No metric_type Integer min: 1, max: 2 No route_policy String No preserve_med Boolean true, falseNo metric Integer min: 1, max: 16777214 No metric_use_rib_metric Boolean true, falseNo lsa_type_summary Boolean true, falseNo nssa_only Boolean true, falseNo
Name Type Constraint Mandatory Default Value process String Yes level_1 Boolean true, falseNo level_2 Boolean true, falseNo level_1_2 Boolean true, falseNo tag Integer min: 0, max: 4294967295 No metric_type Integer min: 1, max: 2 No route_policy String No metric Integer min: 1, max: 16777214 No metric_use_rib_metric Boolean true, falseNo lsa_type_summary Boolean true, falseNo nssa_only Boolean true, falseNo
Name Type Constraint Mandatory Default Value process String Yes tag Integer min: 0, max: 4294967295 No metric_type Integer min: 1, max: 2 No route_policy String No match_internal Boolean true, falseNo match_external Boolean true, falseNo match_external_one Boolean true, falseNo match_external_two Boolean true, falseNo match_nssa_external Boolean true, falseNo match_nssa_external_one Boolean true, falseNo match_nssa_external_two Boolean true, falseNo metric Integer min: 1, max: 16777214 No metric_use_rib_metric Boolean true, falseNo lsa_type_summary Boolean true, falseNo nssa_only Boolean true, falseNo
Name Type Constraint Mandatory Default Value address IP Yes wildcard String Yes distance Integer min: 1, max: 255 Yes acl String No
Name Type Constraint Mandatory Default Value router_lsa Class [router_lsa]No
Name Type Constraint Mandatory Default Value throttle Class [throttle]No lsa Class [lsa]No pacing Class [pacing]No graceful_shutdown Class [graceful_shutdown]No
Name Type Constraint Mandatory Default Value address IP Yes mask Any IP or Integer[min: 0, max: 32] or String[Regex: ^.*[\$\%]\{.*$] Yes not_advertise Boolean true, falseNo tag Integer min: 0, max: 4294967295 No
Name Type Constraint Mandatory Default Value enable Boolean true, falseNo priority_limit Choice critical, high, mediumNo load_sharing_disable Boolean true, falseNo srlg_protection_weighted_global Boolean true, falseNo use_candidate_only Choice enable, disableNo remote_lfa_tunnel_mpls_ldp Boolean true, falseNo remote_lfa_disable Boolean true, falseNo remote_lfa_maximum_cost Integer min: 1, max: 4294967295 No ti_lfa Choice enable, disableNo tiebreaker Class [tiebreaker]No exclude_interfaces List [exclude_interfaces]No lfa_candidate_interfaces List [lfa_candidate_interfaces]No
Name Type Constraint Mandatory Default Value enable Boolean true, falseNo priority_limit Choice critical, high, mediumNo use_candidate_only Choice enable, disableNo exclude_interfaces List [exclude_interfaces]No lfa_candidate_interfaces List [lfa_candidate_interfaces]No
Name Type Constraint Mandatory Default Value mode Choice mpls, disableNo global_block_from Integer min: 16000, max: 1048575 No global_block_to Integer min: 1, max: 1048575 No prefix_sid_map_advertise_local Boolean true, falseNo prefix_sid_map_receive_disable Boolean true, falseNo sr_prefer Boolean true, falseNo sr_prefer_prefix_list String No forwarding Choice mpls, disableNo
Name Type Constraint Mandatory Default Value name String Yes bit_position Integer min: 0, max: 255 No
Name Type Constraint Mandatory Default Value number Integer min: 128, max: 255 Yes priority Integer min: 0, max: 255 No microloop_avoidance_disable Boolean true, falseNo prefix_metric Boolean true, falseNo metric_type Choice te-metric, delayNo advertise_definition Boolean true, falseNo fast_reroute_disable Boolean true, falseNo affinity_exclude_any List [affinity_exclude_any]No affinity_include_any List [affinity_include_any]No affinity_include_all List [affinity_include_all]No srlg_exclude_any List [srlg_exclude_any]No
Name Type Constraint Mandatory Default Value type Choice message-digest, keychain, nullNo keychain String No message_digest_keys List [message_digest_keys]No key Class [key]No
Name Type Constraint Mandatory Default Value name String Yes
Name Type Constraint Mandatory Default Value name String Yes admin_weight Integer min: 0, max: 65535 No
Name Type Constraint Mandatory Default Value name String Yes domain_id_type Choice 0005, 0105, 0205, 8005No domain_id_value String No domain_id_secondaries List [domain_id_secondaries]No domain_tag Integer min: 1, max: 4294967295 No disable_dn_bit_check Boolean true, falseNo log_adjacency_changes Choice detail, disableNo router_id String No redistribute_connected Boolean true, falseNo redistribute_connected_tag Integer min: 0, max: 4294967295 No redistribute_connected_metric_type Integer min: 1, max: 2 No redistribute_connected_route_policy String No redistribute_connected_metric Integer min: 1, max: 16777214 No redistribute_connected_metric_use_rib_metric Boolean true, falseNo redistribute_connected_lsa_type_summary Boolean true, falseNo redistribute_connected_nssa_only Boolean true, falseNo redistribute_static Boolean true, falseNo redistribute_static_tag Integer min: 0, max: 4294967295 No redistribute_static_metric_type Integer min: 1, max: 2 No redistribute_static_route_policy String No redistribute_static_metric Integer min: 1, max: 16777214 No redistribute_static_metric_use_rib_metric Boolean true, falseNo redistribute_static_lsa_type_summary Boolean true, falseNo redistribute_static_nssa_only Boolean true, falseNo redistribute_bgp List [redistribute_bgp]No redistribute_isis List [redistribute_isis]No redistribute_ospf List [redistribute_ospf]No distribute_list_in_acl String No distribute_list_in_route_policy String No distribute_list_out_acl String No distribute_list_out_connected_acl String No distribute_list_out_static_acl String No distribute_list_out_bgp_asn Any String or Integer[min: 1, max: 4294967295] or String[Regex: ^.*[\$\%]\{.*$] No distribute_list_out_bgp_acl String No distribute_list_out_ospf_process String No distribute_list_out_ospf_acl String No packet_size Integer min: 576, max: 10000 No bfd_fast_detect Choice enable, strict-modeNo bfd_minimum_interval Integer min: 3, max: 30000 No bfd_multiplier Integer min: 2, max: 50 No security_ttl Choice enableNo security_ttl_hops Integer min: 1, max: 254 No prefix_suppression Choice enableNo default_information_originate Boolean true, falseNo default_information_originate_always Boolean true, falseNo default_information_originate_metric Integer min: 1, max: 16777214 No default_information_originate_metric_type Integer min: 1, max: 2 No default_information_originate_route_policy String No default_metric Integer min: 1, max: 16777214 No distance_sources List [distance_sources]No distance_ospf_intra_area Integer min: 1, max: 255 No distance_ospf_inter_area Integer min: 1, max: 255 No distance_ospf_external Integer min: 1, max: 255 No auto_cost_reference_bandwidth Integer min: 1, max: 4294967 No auto_cost_disable Boolean true, falseNo ignore_lsa_mospf Boolean true, falseNo capability_opaque_disable Boolean true, falseNo capability_lls_disable Boolean true, falseNo capability_type7_prefer Boolean true, falseNo max_metric Class [max_metric]No max_lsa Integer min: 1, max: 4294967294 No max_lsa_threshold Integer min: 1, max: 100 No max_lsa_warning_only Boolean true, falseNo max_lsa_ignore_time Integer min: 1, max: 35791394 No max_lsa_ignore_count Integer min: 1, max: 4294967294 No max_lsa_reset_time Integer min: 2, max: 71582788 No timers Class [timers]No nsf_interval Integer min: 90, max: 3600 No nsf_lifetime Integer min: 90, max: 1800 No nsf_flush_delay_time Integer min: 1, max: 3600 No nsf_cisco Boolean true, falseNo nsf_cisco_enforce_global Boolean true, falseNo nsf_ietf Boolean true, falseNo nsf_ietf_strict_lsa_checking Boolean true, falseNo nsf_ietf_helper_disable Boolean true, falseNo address_family_ipv4_unicast Boolean true, falseNo maximum_interfaces Integer min: 1, max: 4294967295 No maximum_paths Integer min: 1, max: 64 No maximum_redistributed_prefixes Integer min: 1, max: 4294967295 No maximum_redistributed_prefixes_threshold Integer min: 1, max: 100 No maximum_redistributed_prefixes_warning_only Boolean true, falseNo queue_limit_high Integer min: 1000, max: 30000 No queue_limit_medium Integer min: 1000, max: 30000 No queue_limit_low Integer min: 1000, max: 30000 No queue_dispatch_incoming Integer min: 30, max: 3000 No queue_dispatch_rate_limited_lsa Integer min: 30, max: 3000 No queue_dispatch_flush_lsa Integer min: 30, max: 3000 No queue_dispatch_spf_lsa_limit Integer min: 30, max: 3000 No summary_prefixes List [summary_prefixes]No spf_prefix_priority_route_policy String No fast_reroute_per_prefix Class [fast_reroute_per_prefix]No fast_reroute_per_link Class [fast_reroute_per_link]No fast_reroute_disable Boolean true, falseNo loopback_stub_network Choice enable, disableNo link_down_fast_detect Boolean true, falseNo weight Integer min: 1, max: 16777214 No delay_normalize_interval Integer min: 1, max: 16777215 No delay_normalize_offset Integer min: 0, max: 16777215 No microloop_avoidance Choice enable, protected, segment-routingNo microloop_avoidance_rib_update_delay Integer min: 1, max: 600000 No authentication Class [authentication]No network Choice broadcast, non-broadcast, point-to-point, point-to-multipointNo mpls_ldp_sync Choice enableNo cost Integer min: 1, max: 65535 No cost_fallback Class [cost_fallback]No hello_interval Integer min: 1, max: 65535 No dead_interval Integer min: 1, max: 65535 No priority Integer min: 0, max: 255 No retransmit_interval Integer min: 1, max: 65535 No transmit_delay Integer min: 1, max: 65535 No flood_reduction Choice enable, disableNo demand_circuit Choice enable, disableNo mtu_ignore Choice enable, disableNo database_filter_all_out Choice enable, disableNo passive Choice enable, disableNo external_out Choice enable, disableNo summary_in Choice enable, disableNo adjacency_stagger_disable Boolean true, falseNo adjacency_stagger_initial_neighbors Integer min: 1, max: 65535 No adjacency_stagger_simultaneous_neighbors Integer min: 1, max: 65535 No snmp_context String No snmp_trap Boolean true, falseNo ucmp Boolean true, falseNo ucmp_variance Integer min: 101, max: 10000 No ucmp_prefix_list String No ucmp_exclude_interfaces List [ucmp_exclude_interfaces]No ucmp_delay_interval Integer min: 1, max: 5000 No max_external_lsa Integer min: 1, max: 4294967294 No max_external_lsa_threshold Integer min: 1, max: 100 No max_external_lsa_suppress_neighbor Boolean true, falseNo max_external_lsa_warning_only Boolean true, falseNo exchange_timer Integer min: 1, max: 35791394 No exchange_timer_hold_time Integer min: 1, max: 35791394 No exchange_timer_recovery_count Integer min: 1, max: 4294967294 No areas List [areas]No
Name Type Constraint Mandatory Default Value id Any IP or Integer[min: 0, max: 4294967295] or String[Regex: ^.*[\$\%]\{.*$] Yes default_cost Integer min: 1, max: 16777215 No stub Boolean true, falseNo stub_no_summary Boolean true, falseNo nssa Boolean true, falseNo nssa_no_redistribution Boolean true, falseNo nssa_default_information_originate Boolean true, falseNo nssa_default_information_originate_metric Integer min: 1, max: 16777214 No nssa_default_information_originate_metric_type Integer min: 1, max: 2 No nssa_no_summary Boolean true, falseNo nssa_translate_type7_always Boolean true, falseNo mpls_traffic_eng Boolean true, falseNo mpls_ldp_sync Choice enable, disableNo mpls_ldp_sync_igp_shortcuts Choice enable, disableNo mpls_ldp_auto_config Boolean true, falseNo route_policy_in String No route_policy_out String No external_out Choice enable, disableNo summary_in Choice enable, disableNo segment_routing Class [segment_routing]No distribute_link_state_disable Boolean true, falseNo distribute_link_state_excl_nssa Boolean true, falseNo distribute_link_state_excl_summary Boolean true, falseNo authentication Class [authentication]No network Choice broadcast, non-broadcast, point-to-point, point-to-multipointNo cost Integer min: 1, max: 65535 No cost_fallback Class [cost_fallback]No hello_interval Integer min: 1, max: 65535 No dead_interval Integer min: 1, max: 65535 No priority Integer min: 0, max: 255 No retransmit_interval Integer min: 1, max: 65535 No transmit_delay Integer min: 1, max: 65535 No flood_reduction Choice enable, disableNo demand_circuit Choice enable, disableNo mtu_ignore Choice enable, disableNo database_filter_all_out Choice enable, disableNo passive Choice enable, disableNo distribute_list_in_acl String No distribute_list_in_route_policy String No bfd_fast_detect Choice enable, strict-mode, disableNo bfd_minimum_interval Integer min: 3, max: 30000 No bfd_multiplier Integer min: 2, max: 50 No security_ttl Choice enable, disableNo security_ttl_hops Integer min: 1, max: 254 No prefix_suppression Choice enable, disableNo fast_reroute_disable Boolean true, falseNo fast_reroute_per_prefix Class [fast_reroute_per_prefix]No fast_reroute_per_link Class [fast_reroute_per_link]No loopback_stub_network Choice enable, disableNo link_down_fast_detect Boolean true, falseNo weight Integer min: 1, max: 16777214 No delay_normalize_interval Integer min: 1, max: 16777215 No delay_normalize_offset Integer min: 0, max: 16777215 No ranges List [ranges]No multi_area_interfaces List [multi_area_interfaces]No virtual_links List [virtual_links]No interfaces List [interfaces]No
Name Type Constraint Mandatory Default Value igp_metric_increment Integer min: 1, max: 65534 No igp_metric_multiplier Integer min: 1, max: 255 No igp_metric_value Integer min: 1, max: 65535 No te_metric_increment Integer min: 1, max: 4294967294 No te_metric_multiplier Integer min: 1, max: 255 No te_metric_value Integer min: 1, max: 4294967295 No
Name Type Constraint Mandatory Default Value enable Boolean true, falseNo include_stub Boolean true, falseNo summary_lsa Boolean true, falseNo summary_lsa_metric Integer min: 1, max: 16777215 No external_lsa Boolean true, falseNo external_lsa_metric Integer min: 1, max: 16777215 No on_startup Class [on_startup]No on_switchover Class [on_switchover]No on_proc_restart Class [on_proc_restart]No
Name Type Constraint Mandatory Default Value spf_initial_delay Integer min: 1, max: 600000 No spf_second_delay Integer min: 1, max: 600000 No spf_maximum_delay Integer min: 1, max: 600000 No lsa_all_initial_delay Integer min: 0, max: 600000 No lsa_all_minimum_delay Integer min: 1, max: 600000 No lsa_all_maximum_delay Integer min: 1, max: 600000 No fast_reroute Integer min: 50, max: 600000 No
Name Type Constraint Mandatory Default Value group_pacing Integer min: 10, max: 1800 No min_arrival Integer min: 0, max: 600000 No refresh Integer min: 1800, max: 2700 No
Name Type Constraint Mandatory Default Value flood Integer min: 5, max: 100 No
Name Type Constraint Mandatory Default Value initial_delay Integer min: 0, max: 90 No retain_routes Integer min: 0, max: 90 No
Name Type Constraint Mandatory Default Value downstream_index Integer min: 1, max: 255 No downstream_disable Boolean true, falseNo lc_disjoint_index Integer min: 1, max: 255 No lc_disjoint_disable Boolean true, falseNo lowest_backup_metric_index Integer min: 1, max: 255 No lowest_backup_metric_disable Boolean true, falseNo node_protecting_index Integer min: 1, max: 255 No node_protecting_disable Boolean true, falseNo primary_path_index Integer min: 1, max: 255 No primary_path_disable Boolean true, falseNo secondary_path_index Integer min: 1, max: 255 No secondary_path_disable Boolean true, falseNo interface_disjoint_index Integer min: 1, max: 255 No interface_disjoint_disable Boolean true, falseNo srlg_disjoint_index Integer min: 1, max: 255 No srlg_disjoint_disable Boolean true, falseNo
Name Type Constraint Mandatory Default Value name String Yes
Name Type Constraint Mandatory Default Value name String Yes
Name Type Constraint Mandatory Default Value name String Yes
Name Type Constraint Mandatory Default Value id Integer min: 1, max: 255 Yes algorithm Choice md5Yes password_type Choice 7No password String Yes
Name Type Constraint Mandatory Default Value password_type Choice 7No password String No
Name Type Constraint Mandatory Default Value type Choice 0005, 0105, 0205, 8005Yes value String Yes
Name Type Constraint Mandatory Default Value throttle Class [throttle]No lsa Class [lsa]No pacing Class [pacing]No
Name Type Constraint Mandatory Default Value enable Boolean true, falseNo priority_limit Choice critical, high, mediumNo load_sharing_disable Boolean true, falseNo use_candidate_only Choice enable, disableNo tiebreaker Class [tiebreaker]No exclude_interfaces List [exclude_interfaces]No lfa_candidate_interfaces List [lfa_candidate_interfaces]No
Name Type Constraint Mandatory Default Value enable Boolean true, falseNo priority_limit Choice critical, high, mediumNo use_candidate_only Choice enable, disableNo exclude_interfaces List [exclude_interfaces]No lfa_candidate_interfaces List [lfa_candidate_interfaces]No
Name Type Constraint Mandatory Default Value id Any IP or Integer[min: 0, max: 4294967295] or String[Regex: ^.*[\$\%]\{.*$] Yes default_cost Integer min: 1, max: 16777215 No stub Boolean true, falseNo stub_no_summary Boolean true, falseNo nssa Boolean true, falseNo nssa_no_redistribution Boolean true, falseNo nssa_default_information_originate Boolean true, falseNo nssa_default_information_originate_metric Integer min: 1, max: 16777214 No nssa_default_information_originate_metric_type Integer min: 1, max: 2 No nssa_no_summary Boolean true, falseNo nssa_translate_type7_always Boolean true, falseNo route_policy_in String No route_policy_out String No external_out Choice enable, disableNo summary_in Choice enable, disableNo authentication Class [authentication]No network Choice broadcast, non-broadcast, point-to-point, point-to-multipointNo mpls_ldp_sync Choice disableNo cost Integer min: 1, max: 65535 No cost_fallback Class [cost_fallback]No hello_interval Integer min: 1, max: 65535 No dead_interval Integer min: 1, max: 65535 No priority Integer min: 0, max: 255 No retransmit_interval Integer min: 1, max: 65535 No transmit_delay Integer min: 1, max: 65535 No flood_reduction Choice enable, disableNo demand_circuit Choice enable, disableNo mtu_ignore Choice enable, disableNo database_filter_all_out Choice enable, disableNo passive Choice enable, disableNo distribute_list_in_acl String No distribute_list_in_route_policy String No packet_size Integer min: 576, max: 10000 No bfd_fast_detect Choice enable, strict-mode, disableNo bfd_minimum_interval Integer min: 3, max: 30000 No bfd_multiplier Integer min: 2, max: 50 No security_ttl Choice enable, disableNo security_ttl_hops Integer min: 1, max: 254 No prefix_suppression Choice enable, disableNo fast_reroute_disable Boolean true, falseNo fast_reroute_per_link Class [fast_reroute_per_link]No fast_reroute_per_prefix Class [fast_reroute_per_prefix]No loopback_stub_network Choice enable, disableNo link_down_fast_detect Boolean true, falseNo weight Integer min: 1, max: 16777214 No delay_normalize_interval Integer min: 1, max: 16777215 No delay_normalize_offset Integer min: 0, max: 16777215 No ranges List [ranges]No virtual_links List [virtual_links]No sham_links List [sham_links]No interfaces List [interfaces]No
Name Type Constraint Mandatory Default Value anomaly_delay Class [anomaly_delay]No
Name Type Constraint Mandatory Default Value enable Boolean true, falseNo use_candidate_only Choice enable, disableNo remote_lfa_tunnel_mpls_ldp Boolean true, falseNo remote_lfa_disable Boolean true, falseNo remote_lfa_maximum_cost Integer min: 1, max: 4294967295 No ti_lfa Choice enable, disableNo tiebreaker Class [tiebreaker]No exclude_interfaces List [exclude_interfaces]No lfa_candidate_interfaces List [lfa_candidate_interfaces]No
Name Type Constraint Mandatory Default Value enable Boolean true, falseNo use_candidate_only Choice enable, disableNo exclude_interfaces List [exclude_interfaces]No lfa_candidate_interfaces List [lfa_candidate_interfaces]No srlg_disjoint_disable Boolean true, falseNo
Name Type Constraint Mandatory Default Value address IP Yes mask Any IP or Integer[min: 0, max: 32] or String[Regex: ^.*[\$\%]\{.*$] Yes advertise Boolean true, falseNo
Name Type Constraint Mandatory Default Value name String Yes authentication Class [authentication]No cost Integer min: 1, max: 65535 No cost_fallback Class [cost_fallback]No hello_interval Integer min: 1, max: 65535 No dead_interval Integer min: 1, max: 65535 No retransmit_interval Integer min: 1, max: 65535 No transmit_delay Integer min: 1, max: 65535 No mtu_ignore Choice enable, disableNo database_filter_all_out Choice enable, disableNo distribute_list_in_acl String No distribute_list_in_route_policy String No packet_size Integer min: 576, max: 10000 No fast_reroute_disable Boolean true, falseNo fast_reroute_per_prefix Class [fast_reroute_per_prefix]No fast_reroute_per_link Class [fast_reroute_per_link]No passive Choice enable, disableNo delay_normalize_interval Integer min: 1, max: 16777215 No delay_normalize_offset Integer min: 0, max: 16777215 No neighbors List [neighbors]No
Name Type Constraint Mandatory Default Value address IP Yes hello_interval Integer min: 1, max: 65535 No dead_interval Integer min: 1, max: 65535 No retransmit_interval Integer min: 1, max: 65535 No transmit_delay Integer min: 1, max: 65535 No authentication Class [authentication]No
Name Type Constraint Mandatory Default Value name String Yes authentication Class [authentication]No network Choice broadcast, non-broadcast, point-to-point, point-to-multipointNo mpls_ldp_sync Choice enable, disableNo cost Integer min: 1, max: 65535 No cost_fallback Class [cost_fallback]No hello_interval Integer min: 1, max: 65535 No dead_interval Integer min: 1, max: 65535 No priority Integer min: 0, max: 255 No retransmit_interval Integer min: 1, max: 65535 No transmit_delay Integer min: 1, max: 65535 No flood_reduction Choice enable, disableNo demand_circuit Choice enable, disableNo mtu_ignore Choice enable, disableNo database_filter_all_out Choice enable, disableNo passive Choice enable, disableNo distribute_list_in_acl String No distribute_list_in_route_policy String No packet_size Integer min: 576, max: 10000 No bfd_fast_detect Choice enable, strict-mode, disableNo bfd_minimum_interval Integer min: 3, max: 30000 No bfd_multiplier Integer min: 2, max: 50 No security_ttl Choice enable, disableNo security_ttl_hops Integer min: 1, max: 254 No prefix_suppression Choice enable, disableNo fast_reroute_disable Boolean true, falseNo fast_reroute_per_prefix Class [fast_reroute_per_prefix]No fast_reroute_per_link Class [fast_reroute_per_link]No loopback_stub_network Choice enable, disableNo link_down_fast_detect Boolean true, falseNo prefix_sid Class [prefix_sid]No prefix_sid_strict_spf Class [prefix_sid_strict_spf]No segment_routing Class [segment_routing]No weight Integer min: 1, max: 16777214 No advertise_prefix_route_policy String No delay_normalize_interval Integer min: 1, max: 16777215 No delay_normalize_offset Integer min: 0, max: 16777215 No affinity_flex_algos List [affinity_flex_algos]No neighbors List [neighbors]No prefix_sid_algorithms List [prefix_sid_algorithms]No adjacency_sids Class [adjacency_sids]No
Name Type Constraint Mandatory Default Value time Integer min: 5, max: 86400 No wait_for_bgp Boolean true, falseNo include_stub Boolean true, falseNo summary_lsa Boolean true, falseNo summary_lsa_metric Integer min: 1, max: 16777215 No external_lsa Boolean true, falseNo external_lsa_metric Integer min: 1, max: 16777215 No
Name Type Constraint Mandatory Default Value local_address IP Yes remote_address IP Yes cost Integer min: 1, max: 65535 No hello_interval Integer min: 1, max: 65535 No dead_interval Integer min: 1, max: 65535 No retransmit_interval Integer min: 1, max: 65535 No transmit_delay Integer min: 1, max: 65535 No authentication Class [authentication]No
Name Type Constraint Mandatory Default Value name String Yes authentication Class [authentication]No network Choice broadcast, non-broadcast, point-to-point, point-to-multipointNo mpls_ldp_sync Choice enable, disableNo cost Integer min: 1, max: 65535 No cost_fallback Class [cost_fallback]No hello_interval Integer min: 1, max: 65535 No dead_interval Integer min: 1, max: 65535 No priority Integer min: 0, max: 255 No retransmit_interval Integer min: 1, max: 65535 No transmit_delay Integer min: 1, max: 65535 No flood_reduction Choice enable, disableNo demand_circuit Choice enable, disableNo mtu_ignore Choice enable, disableNo database_filter_all_out Choice enable, disableNo passive Choice enable, disableNo distribute_list_in_acl String No distribute_list_in_route_policy String No packet_size Integer min: 576, max: 10000 No bfd_fast_detect Choice enable, strict-mode, disableNo bfd_minimum_interval Integer min: 3, max: 30000 No bfd_multiplier Integer min: 2, max: 50 No security_ttl Choice enable, disableNo security_ttl_hops Integer min: 1, max: 254 No prefix_suppression Choice enable, disableNo fast_reroute_disable Boolean true, falseNo fast_reroute_per_link Class [fast_reroute_per_link]No fast_reroute_per_prefix Class [fast_reroute_per_prefix]No loopback_stub_network Choice enable, disableNo link_down_fast_detect Boolean true, falseNo prefix_sid Class [prefix_sid]No prefix_sid_strict_spf Class [prefix_sid_strict_spf]No weight Integer min: 1, max: 16777214 No advertise_prefix_route_policy String No delay_normalize_interval Integer min: 1, max: 16777215 No delay_normalize_offset Integer min: 0, max: 16777215 No neighbors List [neighbors]No prefix_sid_algorithms List [prefix_sid_algorithms]No adjacency_sids Class [adjacency_sids]No
Name Type Constraint Mandatory Default Value igp_metric_increment Integer min: 1, max: 65534 No igp_metric_multiplier Integer min: 1, max: 255 No igp_metric_value Integer min: 1, max: 65535 No igp_metric_disable Boolean true, falseNo te_metric_increment Integer min: 1, max: 4294967294 No te_metric_multiplier Integer min: 1, max: 255 No te_metric_value Integer min: 1, max: 4294967295 No te_metric_disable Boolean true, falseNo
Name Type Constraint Mandatory Default Value cost Integer min: 1, max: 65535 No threshold Integer min: 1, max: 4294967 No
Name Type Constraint Mandatory Default Value address IP Yes database_filter_all_out Boolean true, falseNo poll_interval Integer min: 0, max: 4294967295 No cost Integer min: 1, max: 65535 No
Name Type Constraint Mandatory Default Value cost Integer min: 1, max: 65535 No threshold Integer min: 1, max: 4294967 No anomaly_delay Class [anomaly_delay]No
Name Type Constraint Mandatory Default Value index Class [index]No absolute Class [absolute]No
Name Type Constraint Mandatory Default Value address IP Yes database_filter_all_out Boolean true, falseNo priority Integer min: 0, max: 255 No poll_interval Integer min: 0, max: 65535 No cost Integer min: 1, max: 65535 No
Name Type Constraint Mandatory Default Value number Integer min: 128, max: 255 Yes index Class [index]No absolute Class [absolute]No
Name Type Constraint Mandatory Default Value index List [index]No absolute List [absolute]No
Name Type Constraint Mandatory Default Value id Integer min: 0, max: 1048575 Yes explicit_null Boolean true, falseNo n_flag_clear Boolean true, falseNo
Name Type Constraint Mandatory Default Value id Integer min: 0, max: 1048575 Yes protected Boolean true, falseNo neighbor_address String No
Name Type Constraint Mandatory Default Value id Integer min: 15000, max: 1048575 Yes protected Boolean true, falseNo neighbor_address String No
Mask Formats
The summary_prefixes.mask and area ranges.mask fields accept both dotted-decimal and prefix-length:
Dotted-decimal: 255.255.255.0
Prefix-length: 24
Both formats are accepted in the YAML input. The value is normalized to dotted-decimal notation before being sent to the device.
Example-1: OSPF with MPLS traffic engineering, LDP sync, and basic interface settings.
mpls_traffic_eng_router_id_interface : Loopback0
mpls_traffic_eng_multicast_intact : true
mpls_traffic_eng_autoroute_exclude_route_policy : POLICY_IN
mpls_traffic_eng_igp_intact : true
mpls_traffic_eng_ldp_sync_update : true
mpls_ldp_sync_igp_shortcuts : enable
mpls_ldp_auto_config : true
retransmit_interval : 1000
database_filter_all_out : enable
log_adjacency_changes : detail
Example-2: OSPF with redistribution from connected, static, BGP, ISIS, and OSPF.
redistribute_connected : true
redistribute_connected_tag : 1
redistribute_connected_metric_type : 1
redistribute_connected_route_policy : POLICY_IN
redistribute_connected_metric : 100
redistribute_connected_lsa_type_summary : true
redistribute_connected_nssa_only : true
redistribute_static : true
redistribute_static_tag : 2
redistribute_static_metric_type : 1
redistribute_static_route_policy : POLICY_IN
redistribute_static_metric : 100
redistribute_static_lsa_type_summary : true
redistribute_static_nssa_only : true
metric_use_rib_metric : true
match_nssa_external : true
Example-3: OSPF with distribute lists, BFD, and default information originate.
distribute_list_in_acl : ACL_IN
distribute_list_out_acl : ACL_OUT
bfd_fast_detect : strict-mode
bfd_minimum_interval : 300
prefix_suppression : enable
default_information_originate : true
default_information_originate_metric : 100
default_information_originate_metric_type : 1
default_information_originate_route_policy : POLICY_IN
Example-4: OSPF with segment routing, microloop avoidance, and flexible algorithms.
delay_normalize_interval : 2000
delay_normalize_offset : 10
microloop_avoidance : segment-routing
microloop_avoidance_rib_update_delay : 3000
prefix_sid_map_advertise_local : true
sr_prefer_prefix_list : PREFIX_LIST_1
microloop_avoidance_disable : true
advertise_definition : true
fast_reroute_disable : true
OSPF areas allow hierarchical network design, reduce routing table size, and minimize LSA flooding. This resource supports stub/NSSA areas, ranges, virtual links, multi-area interfaces, segment routing, fast reroute, MPLS TE/LDP integration, and authentication.
Example-1: Basic OSPF area with MPLS TE, LDP sync, and route policies.
mpls_ldp_sync_igp_shortcuts : enable
mpls_ldp_auto_config : true
route_policy_in : ROUTE_POLICY_1
route_policy_out : ROUTE_POLICY_1
distribute_link_state_excl_nssa : true
distribute_link_state_excl_summary : true
Example-2: OSPF area with authentication, network settings, BFD, and timers.
retransmit_interval : 1000
database_filter_all_out : enable
distribute_list_in_acl : ACL_1
bfd_fast_detect : strict-mode
bfd_minimum_interval : 300
prefix_suppression : enable
Example-3: OSPF area with ranges, fast reroute per-prefix, and TI-LFA.
use_candidate_only : enable
lowest_backup_metric_index : 30
node_protecting_index : 40
interface_disjoint_index : 70
- name : GigabitEthernet0/0/0/3
lfa_candidate_interfaces :
- name : GigabitEthernet0/0/0/4
link_down_fast_detect : true
Example-4: OSPF area with multi-area interfaces and virtual links.
- name : GigabitEthernet0/0/0/1
retransmit_interval : 1000
distribute_list_in_acl : ACL_1
use_candidate_only : enable
remote_lfa_tunnel_mpls_ldp : true
remote_lfa_maximum_cost : 500
use_candidate_only : enable
retransmit_interval : 1000
OSPF interfaces allow per-interface control of adjacency formation, authentication, timers, BFD, costs, fast reroute, segment routing SIDs, and neighbor relationships. This resource supports point-to-point and broadcast networks, passive interfaces, prefix suppression, and advanced features like TI-LFA and adjacency SIDs.
Example-1: Basic OSPF interface with authentication, network type, and timers.
retransmit_interval : 1000
Example-2: OSPF interface with BFD, security TTL, cost fallback, and prefix SID.
- name : GigabitEthernet0/0/0/0
bfd_minimum_interval : 300
database_filter_all_out : enable
distribute_list_in_acl : ACL_1
link_down_fast_detect : true
Example-3: OSPF interface with fast reroute per-prefix and TI-LFA.
- name : GigabitEthernet0/0/0/1
use_candidate_only : enable
remote_lfa_tunnel_mpls_ldp : true
remote_lfa_maximum_cost : 500
lowest_backup_metric_index : 30
node_protecting_index : 40
interface_disjoint_index : 70
- name : GigabitEthernet0/0/0/3
lfa_candidate_interfaces :
- name : GigabitEthernet0/0/0/4
OSPF VRFs allow running OSPF within a VPN Routing and Forwarding (VRF) instance for multi-tenant network environments. This resource supports domain IDs, redistribution, distribute lists, BFD, max-metric, timers, NSF, fast-reroute, authentication, and interface settings.
Example-1: OSPF VRF with domain ID, redistribution from connected, static, BGP, and ISIS.
domain_id_value : " 000000001111 "
disable_dn_bit_check : true
log_adjacency_changes : detail
redistribute_connected : true
redistribute_connected_tag : 1
redistribute_connected_metric_type : 1
redistribute_connected_route_policy : ROUTE_POLICY_1
redistribute_connected_metric : 100
redistribute_connected_lsa_type_summary : true
redistribute_connected_nssa_only : true
redistribute_static : true
redistribute_static_tag : 2
redistribute_static_metric_type : 1
redistribute_static_route_policy : ROUTE_POLICY_1
redistribute_static_metric_use_rib_metric : true
redistribute_static_lsa_type_summary : true
redistribute_static_nssa_only : true
route_policy : ROUTE_POLICY_1
route_policy : ROUTE_POLICY_1
route_policy : ROUTE_POLICY_1
match_nssa_external_two : true
Example-2: OSPF VRF with distribute lists, BFD, default information, and distance settings.
distribute_list_in_acl : ACL_1
distribute_list_out_acl : ACL_1
distribute_list_out_connected_acl : ACL_1
distribute_list_out_static_acl : ACL_1
distribute_list_out_bgp_asn : 65001
distribute_list_out_bgp_acl : ACL_1
distribute_list_out_ospf_process : OSPF2
distribute_list_out_ospf_acl : ACL_1
bfd_minimum_interval : 300
prefix_suppression : enable
default_information_originate_always : true
default_information_originate_metric : 100
default_information_originate_metric_type : 1
default_information_originate_route_policy : ROUTE_POLICY_1
distance_ospf_intra_area : 101
distance_ospf_inter_area : 102
distance_ospf_external : 103
auto_cost_reference_bandwidth : 100000
capability_type7_prefer : true
OSPF VRF areas allow hierarchical network design within VPN Routing and Forwarding instances. This resource supports stub/NSSA areas, ranges, virtual links, sham links, fast reroute, BFD, authentication, and network type settings.
Example-1: OSPF VRF area with route policies, authentication, and network settings.
route_policy_in : ROUTE_POLICY_1
route_policy_out : ROUTE_POLICY_1
retransmit_interval : 1000
distribute_list_in_acl : ACL_1
Example-2: OSPF VRF area with BFD, security TTL, fast reroute per-prefix, and timers.
bfd_fast_detect : strict-mode
bfd_minimum_interval : 300
database_filter_all_out : enable
link_down_fast_detect : true
use_candidate_only : enable
lowest_backup_metric_index : 30
node_protecting_index : 40
interface_disjoint_index : 70
- name : GigabitEthernet0/0/0/3
lfa_candidate_interfaces :
- name : GigabitEthernet0/0/0/4
OSPF VRF area interfaces allow per-interface control of adjacency formation, authentication, timers, BFD, costs, fast reroute, segment routing SIDs, and neighbor relationships. This resource supports point-to-point and broadcast networks, passive interfaces, prefix suppression, and advanced features like adjacency SIDs.
Example-1: Basic OSPF VRF area interface with authentication, network type, and timers.
retransmit_interval : 1000
Example-2: OSPF VRF area interface with BFD, security TTL, cost fallback.
- name : GigabitEthernet0/0/0/0
bfd_fast_detect : strict-mode
bfd_minimum_interval : 300
distribute_list_in_acl : ACL_1
link_down_fast_detect : true
Example-3: OSPF VRF area interface with fast reroute per-prefix and tiebreakers.
- name : GigabitEthernet0/0/0/1
use_candidate_only : enable
lowest_backup_metric_index : 30
node_protecting_index : 40
interface_disjoint_index : 70
- name : GigabitEthernet0/0/0/3
lfa_candidate_interfaces :
- name : GigabitEthernet0/0/0/4