Skip to content
Network as Code

Service BGP Feature

Configure the AS number, router ID, distance, maximum paths, neighbors, redistribution of protocols into BGP, hold time, and keepalive timers.

Diagram

Section titled “Diagram”
Diagram

Classes

Section titled “Classes”

service_profiles (sdwan.feature_profiles)

Section titled “service_profiles (sdwan.feature_profiles)”
NameTypeConstraintMandatoryDefault Value
bgp_featuresList[bgp_features]No

bgp_features (sdwan.feature_profiles.service_profiles)

Section titled “bgp_features (sdwan.feature_profiles.service_profiles)”
NameTypeConstraintMandatoryDefault Value
nameStringRegex: ^[^&<>! "]{1,128}$No
descriptionStringNo
always_compare_medBooleantrue, falseNo
always_compare_med_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
as_numberIntegermin: 1, max: 4294967295No
as_number_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
compare_router_idBooleantrue, falseNo
compare_router_id_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
deterministic_medBooleantrue, falseNo
deterministic_med_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
external_routes_distanceIntegermin: 1, max: 255No
external_routes_distance_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
hold_timeIntegermin: 0, max: 65535No
hold_time_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
internal_routes_distanceIntegermin: 1, max: 255No
internal_routes_distance_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
ipv4_aggregate_addressesList[ipv4_aggregate_addresses]No
ipv4_default_originateBooleantrue, falseNo
ipv4_default_originate_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
ipv4_eibgp_maximum_pathsIntegermin: 1, max: 32No
ipv4_eibgp_maximum_paths_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
ipv4_neighborsList[ipv4_neighbors]No
ipv4_networksList[ipv4_networks]No
ipv4_redistributesList[ipv4_redistributes]No
ipv4_table_map_filterBooleantrue, falseNo
ipv4_table_map_filter_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
ipv4_table_map_route_policyStringRegex: ^[^&<>! "]{1,128}$No
ipv6_aggregate_addressesList[ipv6_aggregate_addresses]No
ipv6_default_originateBooleantrue, falseNo
ipv6_default_originate_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
ipv6_eibgp_maximum_pathsIntegermin: 1, max: 32No
ipv6_eibgp_maximum_paths_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
ipv6_neighborsList[ipv6_neighbors]No
ipv6_networksList[ipv6_networks]No
ipv6_redistributesList[ipv6_redistributes]No
ipv6_table_map_filterBooleantrue, falseNo
ipv6_table_map_filter_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
ipv6_table_map_route_policyStringRegex: ^[^&<>! "]{1,128}$No
keepalive_timeIntegermin: 0, max: 65535No
keepalive_time_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
local_routes_distanceIntegermin: 1, max: 255No
local_routes_distance_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
missing_med_as_worstBooleantrue, falseNo
missing_med_as_worst_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
multipath_relaxBooleantrue, falseNo
multipath_relax_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
propagate_as_pathBooleantrue, falseNo
propagate_as_path_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
propagate_communityBooleantrue, falseNo
propagate_community_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
router_idIPNo
router_id_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No

ipv4_aggregate_addresses (sdwan.feature_profiles.service_profiles.bgp_features)

Section titled “ipv4_aggregate_addresses (sdwan.feature_profiles.service_profiles.bgp_features)”
NameTypeConstraintMandatoryDefault Value
as_set_pathBooleantrue, falseNo
as_set_path_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
network_addressIPNo
network_address_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
summary_onlyBooleantrue, falseNo
summary_only_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No

ipv4_neighbors (sdwan.feature_profiles.service_profiles.bgp_features)

Section titled “ipv4_neighbors (sdwan.feature_profiles.service_profiles.bgp_features)”
NameTypeConstraintMandatoryDefault Value
addressIPNo
address_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
address_familiesList[address_families]No
allowas_in_numberIntegermin: 1, max: 10No
allowas_in_number_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
as_overrideBooleantrue, falseNo
as_override_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
descriptionStringmin: 1, max: 32No
description_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
ebgp_multihopIntegermin: 1, max: 255No
ebgp_multihop_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
hold_timeIntegermin: 0, max: 65535No
hold_time_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
keepalive_timeIntegermin: 0, max: 65535No
keepalive_time_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
local_asIntegermin: 1, max: 4294967295No
local_as_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
next_hop_selfBooleantrue, falseNo
next_hop_self_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
passwordStringmin: 1, max: 25No
password_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
remote_asIntegermin: 1, max: 4294967295No
remote_as_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
send_communityBooleantrue, falseNo
send_community_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
send_extended_communityBooleantrue, falseNo
send_extended_community_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
send_labelBooleantrue, falseNo
shutdownBooleantrue, falseNo
shutdown_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
source_interfaceStringRegex: ^(GigabitEthernet|Loopback|TenGigabitEthernet|TwoGigabitEthernet|FortyGigabitEthernet|HundredGigE|Vlan)(([1-9]\d|\d)/){0,2}(0|[1-9]\d*)([:|\.][1-9]\d*)?No
source_interface_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No

ipv4_networks (sdwan.feature_profiles.service_profiles.bgp_features)

Section titled “ipv4_networks (sdwan.feature_profiles.service_profiles.bgp_features)”
NameTypeConstraintMandatoryDefault Value
network_addressIPNo
network_address_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

ipv4_redistributes (sdwan.feature_profiles.service_profiles.bgp_features)

Section titled “ipv4_redistributes (sdwan.feature_profiles.service_profiles.bgp_features)”
NameTypeConstraintMandatoryDefault Value
protocolChoicestatic, connected, omp, ospf, ospfv3, nat, eigrpNo
protocol_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
route_policyStringRegex: ^[^&<>! "]{1,128}$No
translate_rib_metricBooleantrue, falseNo
translate_rib_metric_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No

ipv6_aggregate_addresses (sdwan.feature_profiles.service_profiles.bgp_features)

Section titled “ipv6_aggregate_addresses (sdwan.feature_profiles.service_profiles.bgp_features)”
NameTypeConstraintMandatoryDefault Value
as_set_pathBooleantrue, falseNo
as_set_path_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
prefixIPNo
prefix_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
summary_onlyBooleantrue, falseNo
summary_only_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No

ipv6_neighbors (sdwan.feature_profiles.service_profiles.bgp_features)

Section titled “ipv6_neighbors (sdwan.feature_profiles.service_profiles.bgp_features)”
NameTypeConstraintMandatoryDefault Value
addressIPNo
address_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
address_familiesList[address_families]No
allowas_in_numberIntegermin: 1, max: 10No
allowas_in_number_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
as_overrideBooleantrue, falseNo
as_override_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
descriptionStringmin: 1, max: 32No
description_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
ebgp_multihopIntegermin: 1, max: 255No
ebgp_multihop_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
hold_timeIntegermin: 0, max: 65535No
hold_time_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
keepalive_timeIntegermin: 0, max: 65535No
keepalive_time_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
local_asIntegermin: 1, max: 4294967295No
local_as_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
next_hop_selfBooleantrue, falseNo
next_hop_self_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
passwordStringmin: 1, max: 25No
password_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
remote_asIntegermin: 1, max: 4294967295No
remote_as_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
send_communityBooleantrue, falseNo
send_community_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
send_extended_communityBooleantrue, falseNo
send_extended_community_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
shutdownBooleantrue, falseNo
shutdown_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
source_interfaceStringRegex: ^(GigabitEthernet|Loopback|TenGigabitEthernet|TwoGigabitEthernet|FortyGigabitEthernet|HundredGigE|Vlan)(([1-9]\d|\d)/){0,2}(0|[1-9]\d*)([:|\.][1-9]\d*)?No
source_interface_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No

ipv6_networks (sdwan.feature_profiles.service_profiles.bgp_features)

Section titled “ipv6_networks (sdwan.feature_profiles.service_profiles.bgp_features)”
NameTypeConstraintMandatoryDefault Value
prefixIPNo
prefix_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No

ipv6_redistributes (sdwan.feature_profiles.service_profiles.bgp_features)

Section titled “ipv6_redistributes (sdwan.feature_profiles.service_profiles.bgp_features)”
NameTypeConstraintMandatoryDefault Value
protocolChoicestatic, connected, ospf, ompNo
protocol_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
route_policyStringRegex: ^[^&<>! "]{1,128}$No
translate_rib_metricBooleantrue, falseNo
translate_rib_metric_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No

address_families (sdwan.feature_profiles.service_profiles.bgp_features.ipv4_neighbors)

Section titled “address_families (sdwan.feature_profiles.service_profiles.bgp_features.ipv4_neighbors)”
NameTypeConstraintMandatoryDefault Value
family_typeChoiceipv4-unicast, vpnv4-unicast, vpnv6-unicastYes
maximum_prefixes_reach_policyChoiceoff, restart, warning-only, disable-peerNooff
maximum_prefixes_numberIntegermin: 1, max: 4294967295No
maximum_prefixes_number_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
maximum_prefixes_restart_intervalIntegermin: 1, max: 65535No
maximum_prefixes_restart_interval_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
maximum_prefixes_thresholdIntegermin: 1, max: 100No
maximum_prefixes_threshold_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
route_policy_inStringRegex: ^[^&<>! "]{1,128}$No
route_policy_outStringRegex: ^[^&<>! "]{1,128}$No

address_families (sdwan.feature_profiles.service_profiles.bgp_features.ipv6_neighbors)

Section titled “address_families (sdwan.feature_profiles.service_profiles.bgp_features.ipv6_neighbors)”
NameTypeConstraintMandatoryDefault Value
family_typeChoiceipv6-unicast, vpnv6-unicastYes
maximum_prefixes_reach_policyChoiceoff, restart, warning-only, disable-peerNooff
maximum_prefixes_numberIntegermin: 1, max: 4294967295No
maximum_prefixes_number_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
maximum_prefixes_restart_intervalIntegermin: 1, max: 65535No
maximum_prefixes_restart_interval_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
maximum_prefixes_thresholdIntegermin: 1, max: 100No
maximum_prefixes_threshold_variableStringRegex: ^[./\[\]a-zA-Z0-9_-]{1,64}$No
route_policy_inStringRegex: ^[^&<>! "]{1,128}$No
route_policy_outStringRegex: ^[^&<>! "]{1,128}$No

Examples

Section titled “Examples”

Example-1: The example below demonstrates how to configure a service BGP feature with AS number 65000 that redistributes connected and static routes into BGP and has one neighbor with address and remote AS defined as variables.

sdwan:
  feature_profiles:
    service_profiles:
      - name: service1
        bgp_features:
          name: bgp1
          as_number: 65000
          ipv4_redistributes:
            - protocol: connected
            - protocol: static
          ipv4_neighbors:
            - address_variable: vpn0_bgp_ipv4_neighbor1_address
              remote_as_variable: vpn0_bgp_ipv4_neighbor1_remote_as