Skip to content
Network as Code

Router BGP

Configure Border Gateway Protocol (BGP) on IOS-XR devices. BGP is an exterior gateway protocol used to exchange routing information between autonomous systems. It supports multiple address families, VRFs, neighbor groups, and advanced features like route reflection, BGP bestpath manipulation, redistribution, graceful maintenance, RPKI validation, and confederation.

Diagram

Section titled “Diagram”
Diagram

Classes

Section titled “Classes”

routing (iosxr.devices.configuration)

Section titled “routing (iosxr.devices.configuration)”
NameTypeConstraintMandatoryDefault Value
bgpList[bgp]No

bgp (iosxr.devices.configuration.routing)

Section titled “bgp (iosxr.devices.configuration.routing)”
NameTypeConstraintMandatoryDefault Value
as_numberAnyString or Integer[min: 1, max: 4294967295] or String[Regex: ^.*[\$\%]\{.*$]Yes
default_metricIntegermin: 1, max: 4294967295No
mvpnBooleantrue, falseNo
segment_routing_srv6Class[segment_routing_srv6]No
neighborsList[neighbors]No
graceful_maintenance_activate_all_neighborsBooleantrue, falseNo
graceful_maintenance_activate_retain_routesBooleantrue, falseNo
graceful_maintenance_activate_interfacesList[graceful_maintenance_activate_interfaces]No
graceful_maintenance_activate_locationsList[graceful_maintenance_activate_locations]No
mpls_activate_interfacesList[mpls_activate_interfaces]No
as_league_peersList[as_league_peers]No
attribute_filter_groupsList[attribute_filter_groups]No
as_listsList[as_lists]No
default_information_originateBooleantrue, falseNo
socket_receive_buffer_sizeIntegermin: 512, max: 131072No
socket_receive_buffer_size_readIntegermin: 512, max: 131072No
socket_send_buffer_sizeIntegermin: 4096, max: 131072No
socket_send_buffer_size_writeIntegermin: 4096, max: 131072No
nexthop_mpls_forwarding_ibgpBooleantrue, falseNo
nexthop_validation_color_extcommChoicesr-policy, disableNo
nexthop_resolution_allow_defaultBooleantrue, falseNo
nexthop_srte_metric_disableBooleantrue, falseNo
slow_peer_dynamicBooleantrue, falseNo
slow_peer_dynamic_thresholdIntegermin: 120, max: 3600No
slow_peer_detection_disableBooleantrue, falseNo
bgp_redistribute_internalBooleantrue, falseNo
bgp_router_idStringNo
bgp_unsafe_ebgp_policyBooleantrue, falseNo
bgp_scan_timeIntegermin: 5, max: 3600No
bgp_read_onlyBooleantrue, falseNo
bgp_lpts_secure_bindingBooleantrue, falseNo
bgp_as_path_loopcheckBooleantrue, falseNo
bgp_auto_policy_soft_reset_disableBooleantrue, falseNo
bgp_bestpath_cost_community_ignoreBooleantrue, falseNo
bgp_bestpath_compare_routeridBooleantrue, falseNo
bgp_bestpath_aigp_ignoreBooleantrue, falseNo
bgp_bestpath_igp_metric_ignoreBooleantrue, falseNo
bgp_bestpath_igp_metric_sr_policyBooleantrue, falseNo
bgp_bestpath_med_missing_as_worstBooleantrue, falseNo
bgp_bestpath_med_alwaysBooleantrue, falseNo
bgp_bestpath_as_path_ignoreBooleantrue, falseNo
bgp_bestpath_as_path_multipath_relaxBooleantrue, falseNo
bgp_bestpath_origin_as_use_validityBooleantrue, falseNo
bgp_bestpath_origin_as_allow_invalidBooleantrue, falseNo
bgp_bestpath_sr_policyChoiceprefer, forceNo
bgp_cluster_idAnyInteger[min: 1, max: 4294967295] or String or String[Regex: ^.*[\$\%]\{.*$]No
bgp_default_local_preferenceIntegermin: 0, max: 4294967295No
bgp_enforce_first_as_disableBooleantrue, falseNo
bgp_fast_external_fallover_disableBooleantrue, falseNo
bgp_log_neighbor_changesChoicedetail, disableNo
bgp_log_message_disableBooleantrue, falseNo
bgp_log_memory_threshold_warningIntegermin: 1, max: 100No
bgp_log_memory_threshold_criticalIntegermin: 1, max: 100No
bgp_log_total_pathsIntegermin: 1, max: 2147483647No
bgp_log_total_paths_warn_thresholdIntegermin: 1, max: 100No
bgp_multipath_use_cluster_list_lengthBooleantrue, falseNo
bgp_multipath_as_path_ignore_onwardsBooleantrue, falseNo
bgp_confederation_identifierAnyString or Integer[min: 1, max: 4294967295] or String[Regex: ^.*[\$\%]\{.*$]No
bgp_confederation_peersList[bgp_confederation_peers]No
bgp_graceful_restart_enableBooleantrue, falseNo
bgp_graceful_restart_purge_timeIntegermin: 0, max: 6000No
bgp_graceful_restart_restart_timeIntegermin: 1, max: 4095No
bgp_graceful_restart_stalepath_timeIntegermin: 1, max: 4095No
bgp_graceful_restart_graceful_resetBooleantrue, falseNo
bgp_graceful_restart_retain_nbr_routes_disableBooleantrue, falseNo
bgp_install_diversionBooleantrue, falseNo
bgp_update_delayIntegermin: 0, max: 3600No
bgp_update_delay_alwaysBooleantrue, falseNo
bgp_maximum_neighborIntegermin: 1, max: 15000No
bgp_origin_as_validation_signal_ibgpBooleantrue, falseNo
bgp_origin_as_validation_time_offBooleantrue, falseNo
bgp_origin_as_validation_timeIntegermin: 5, max: 60No
timers_bgp_keepalive_intervalIntegermin: 0, max: 65535No
timers_bgp_holddown_zeroBooleantrue, falseNo
timers_bgp_holddown_zero_minimum_acceptable_zeroBooleantrue, falseNo
timers_bgp_holddown_zero_minimum_acceptable_holdtimeIntegermin: 3, max: 65535No
timers_bgp_holdtimeIntegermin: 3, max: 65535No
timers_bgp_holdtime_minimum_acceptable_holdtimeIntegermin: 3, max: 65535No
nsrBooleantrue, falseNo
nsr_disableBooleantrue, falseNo
ibgp_policy_out_enforce_modificationsBooleantrue, falseNo
openconfig_rib_telemetryBooleantrue, falseNo
update_limitIntegermin: 16, max: 2048No
update_in_error_handling_basic_ebgp_disableBooleantrue, falseNo
update_in_error_handling_basic_ibgp_disableBooleantrue, falseNo
update_in_error_handling_extended_ebgpBooleantrue, falseNo
update_in_error_handling_extended_ibgpBooleantrue, falseNo
update_out_loggingBooleantrue, falseNo
bfd_multiplierIntegermin: 2, max: 16No
bfd_minimum_intervalIntegermin: 3, max: 30000No
rpki_routesList[rpki_routes]No
rpki_serversList[rpki_servers]No
address_familyClass[address_family]No
neighbor_groupsList[neighbor_groups]No
session_groupsList[session_groups]No
af_groupsList[af_groups]No
vrfsList[vrfs]No

segment_routing_srv6 (iosxr.devices.configuration.routing.bgp)

Section titled “segment_routing_srv6 (iosxr.devices.configuration.routing.bgp)”
NameTypeConstraintMandatoryDefault Value
locatorStringNo
usid_allocation_wide_local_id_blockBooleantrue, falseNo

neighbors (iosxr.devices.configuration.routing.bgp)

Section titled “neighbors (iosxr.devices.configuration.routing.bgp)”
NameTypeConstraintMandatoryDefault Value
ipIPYes
remote_asAnyString or Integer[min: 1, max: 4294967295] or String[Regex: ^.*[\$\%]\{.*$]No
maximum_peersIntegermin: 1, max: 4095No
remote_as_listStringNo
as_path_loopcheck_outChoicedisable, enableNo
use_neighbor_groupStringNo
use_session_groupStringNo
advertisement_interval_secondsIntegermin: 0, max: 600No
advertisement_interval_millisecondsIntegermin: 0, max: 999No
descriptionStringNo
ignore_connected_checkBooleantrue, falseNo
ignore_connected_check_inheritance_disableBooleantrue, falseNo
ebgp_multihop_maximum_hop_countIntegermin: 1, max: 255No
ebgp_multihop_mplsBooleantrue, falseNo
tcp_mss_valueIntegermin: 68, max: 10000No
tcp_mss_inheritance_disableBooleantrue, falseNo
tcp_mtu_discoveryBooleantrue, falseNo
tcp_mtu_discovery_inheritance_disableBooleantrue, falseNo
tcp_ip_only_preferredBooleantrue, falseNo
tcp_ip_only_preferred_inheritance_disableBooleantrue, falseNo
bmp_activate_serversList[bmp_activate_servers]No
bfd_minimum_intervalIntegermin: 3, max: 30000No
bfd_multiplierIntegermin: 2, max: 16No
bfd_fast_detectChoiceenable, strict-mode, disable, strict-mode-negotiate, strict-mode-negotiate-overrideNo
keychain_nameStringmin: 1, max: 32No
keychain_inheritance_disableBooleantrue, falseNo
local_as_inheritance_disableBooleantrue, falseNo
local_asAnyString or Integer[min: 1, max: 4294967295] or String[Regex: ^.*[\$\%]\{.*$]No
local_as_modeChoiceno-prepend, no-prepend-replace-as, no-prepend-replace-as-dual-asNo
password_typeChoice7No
passwordStringNo
password_inheritance_disableBooleantrue, falseNo
receive_buffer_sizeIntegermin: 512, max: 131072No
receive_buffer_size_readIntegermin: 512, max: 131072No
send_buffer_sizeIntegermin: 4096, max: 131072No
send_buffer_size_writeIntegermin: 4096, max: 131072No
fast_falloverBooleantrue, falseNo
fast_fallover_inheritance_disableBooleantrue, falseNo
shutdownBooleantrue, falseNo
timers_keepalive_intervalIntegermin: 0, max: 65535No
timers_holddown_zeroBooleantrue, falseNo
timers_holddown_zero_minimum_acceptable_zeroBooleantrue, falseNo
timers_holddown_zero_minimum_acceptable_holdtimeIntegermin: 3, max: 65535No
timers_holdtimeIntegermin: 3, max: 65535No
timers_holdtime_minimum_acceptable_holdtimeIntegermin: 3, max: 65535No
local_addressStringNo
local_address_inheritance_disableBooleantrue, falseNo
log_neighbor_changesChoicedetail, disable, inheritance-disableNo
log_message_in_sizeIntegermin: 1, max: 500No
log_message_in_disableBooleantrue, falseNo
log_message_in_inheritance_disableBooleantrue, falseNo
log_message_out_sizeIntegermin: 1, max: 500No
log_message_out_disableBooleantrue, falseNo
log_message_out_inheritance_disableBooleantrue, falseNo
update_sourceStringNo
local_address_subnet_prefixStringNo
local_address_subnet_maskIntegermin: 0, max: 128No
dmz_link_bandwidthBooleantrue, falseNo
dmz_link_bandwidth_inheritance_disableBooleantrue, falseNo
ebgp_recv_extcommunity_dmzBooleantrue, falseNo
ebgp_recv_extcommunity_dmz_inheritance_disableBooleantrue, falseNo
ebgp_send_extcommunity_dmzBooleantrue, falseNo
ebgp_send_extcommunity_dmz_cumulativeBooleantrue, falseNo
ebgp_send_extcommunity_dmz_inheritance_disableBooleantrue, falseNo
ttl_securityBooleantrue, falseNo
ttl_security_inheritance_disableBooleantrue, falseNo
session_open_modeChoiceactive-only, passive-only, bothNo
dscpAnyInteger[min: 0, max: 63] or Choice[af11, af12, af13, af21, af22, af23, af31, af32, af33, af41, af42, af43, cs1, cs2, cs3, cs4, cs5, cs6, cs7, default, ef] or String[Regex: ^.*[\$\%]\{.*$]No
precedenceAnyInteger[min: 0, max: 7] or Choice[critical, flash, flash-override, immediate, internet, network, priority, routine] or String[Regex: ^.*[\$\%]\{.*$]No
capability_additional_paths_sendBooleantrue, falseNo
capability_additional_paths_send_disableBooleantrue, falseNo
capability_additional_paths_receiveBooleantrue, falseNo
capability_additional_paths_receive_disableBooleantrue, falseNo
capability_suppress_allBooleantrue, falseNo
capability_suppress_all_inheritance_disableBooleantrue, falseNo
capability_suppress_extended_nexthop_encodingBooleantrue, falseNo
capability_suppress_extended_nexthop_encoding_inheritance_disableBooleantrue, falseNo
capability_suppress_four_byte_asBooleantrue, falseNo
capability_suppress_four_byte_as_inheritance_disableBooleantrue, falseNo
graceful_restartBooleantrue, falseNo
graceful_restart_disableBooleantrue, falseNo
graceful_restart_helper_onlyBooleantrue, falseNo
graceful_restart_helper_only_inheritance_disableBooleantrue, falseNo
graceful_restart_restart_timeIntegermin: 1, max: 4095No
graceful_restart_stalepath_timeIntegermin: 0, max: 4095No
enforce_first_asChoiceenable, disableNo
cluster_idAnyInteger[min: 1, max: 4294967295] or String or String[Regex: ^.*[\$\%]\{.*$]No
idle_watch_timeIntegermin: 30, max: 1800No
allowas_inIntegermin: 1, max: 10No
egress_engineeringBooleantrue, falseNo
egress_engineering_inheritance_disableBooleantrue, falseNo
evpn_link_bandwidthBooleantrue, falseNo
evpn_link_bandwidth_per_path_numberIntegermin: 1, max: 65535No
evpn_link_bandwidth_inheritance_disableBooleantrue, falseNo
peer_setsList[peer_sets]No
peer_node_sid_indexIntegermin: 0, max: 1033575No
ao_key_chain_nameStringmin: 1, max: 32No
ao_key_chain_include_tcp_optionsChoicedisable, enableNo
ao_key_chain_accept_mismatchBooleantrue, falseNo
ao_inheritance_disableBooleantrue, falseNo
dampeningChoiceenable, disableNo
as_overrideChoiceenable, disableNo
default_policy_action_inChoiceaccept, rejectNo
default_policy_action_outChoiceaccept, rejectNo
origin_as_validation_disableBooleantrue, falseNo
send_extended_community_ebgpBooleantrue, falseNo
send_extended_community_ebgp_inheritance_disableBooleantrue, falseNo
bestpath_origin_as_allow_invalidBooleantrue, falseNo
update_in_filtering_message_buffersIntegermin: 0, max: 25No
update_in_filtering_message_buffers_typeChoicebuffers-number-enable, non-circularNo
update_in_filtering_logging_disableBooleantrue, falseNo
update_in_filtering_attribute_filter_groupStringNo
update_in_labeled_unicast_equivalentBooleantrue, falseNo
update_in_labeled_unicast_equivalent_inheritance_disableBooleantrue, falseNo
update_in_error_handling_avoid_resetChoicedisable, enableNo
update_in_error_handling_treat_as_withdrawChoicedisable, enableNo
graceful_maintenance_activateBooleantrue, falseNo
graceful_maintenance_activate_inheritance_disableBooleantrue, falseNo
graceful_maintenance_local_preferenceIntegermin: 0, max: 4294967295No
graceful_maintenance_local_preference_inheritance_disableBooleantrue, falseNo
graceful_maintenance_as_prepends_numberIntegermin: 0, max: 6No
graceful_maintenance_as_prepends_inheritance_disableBooleantrue, falseNo
graceful_maintenance_bandwidth_aware_percentage_thresholdIntegermin: 1, max: 100No
graceful_maintenance_bandwidth_aware_percentage_threshold_highIntegermin: 1, max: 100No
graceful_maintenance_bandwidth_aware_bandwidth_thresholdIntegermin: 1, max: 4294967295No
graceful_maintenance_bandwidth_aware_bandwidth_threshold_highIntegermin: 1, max: 4294967295No
graceful_maintenance_bandwidth_aware_inheritance_disableBooleantrue, falseNo
address_familyList[address_family]No

graceful_maintenance_activate_interfaces (iosxr.devices.configuration.routing.bgp)

Section titled “graceful_maintenance_activate_interfaces (iosxr.devices.configuration.routing.bgp)”
NameTypeConstraintMandatoryDefault Value
interface_nameStringYes

graceful_maintenance_activate_locations (iosxr.devices.configuration.routing.bgp)

Section titled “graceful_maintenance_activate_locations (iosxr.devices.configuration.routing.bgp)”
NameTypeConstraintMandatoryDefault Value
location_valueStringYes

mpls_activate_interfaces (iosxr.devices.configuration.routing.bgp)

Section titled “mpls_activate_interfaces (iosxr.devices.configuration.routing.bgp)”
NameTypeConstraintMandatoryDefault Value
interface_nameStringYes

as_league_peers (iosxr.devices.configuration.routing.bgp)

Section titled “as_league_peers (iosxr.devices.configuration.routing.bgp)”
NameTypeConstraintMandatoryDefault Value
peer_as_numberAnyString or Integer[min: 1, max: 4294967295] or String[Regex: ^.*[\$\%]\{.*$]Yes

attribute_filter_groups (iosxr.devices.configuration.routing.bgp)

Section titled “attribute_filter_groups (iosxr.devices.configuration.routing.bgp)”
NameTypeConstraintMandatoryDefault Value
group_nameStringYes
attribute_code_rangesList[attribute_code_ranges]No

as_lists (iosxr.devices.configuration.routing.bgp)

Section titled “as_lists (iosxr.devices.configuration.routing.bgp)”
NameTypeConstraintMandatoryDefault Value
list_nameStringYes
as_numbersList[as_numbers]No

bgp_confederation_peers (iosxr.devices.configuration.routing.bgp)

Section titled “bgp_confederation_peers (iosxr.devices.configuration.routing.bgp)”
NameTypeConstraintMandatoryDefault Value
peer_as_numberAnyString or Integer[min: 1, max: 4294967295] or String[Regex: ^.*[\$\%]\{.*$]Yes

rpki_routes (iosxr.devices.configuration.routing.bgp)

Section titled “rpki_routes (iosxr.devices.configuration.routing.bgp)”
NameTypeConstraintMandatoryDefault Value
route_addressStringYes
route_prefixIntegermin: 1, max: 128Yes
max_lengthIntegermin: 1, max: 128Yes
origin_asIntegermin: 1, max: 4294967295Yes

rpki_servers (iosxr.devices.configuration.routing.bgp)

Section titled “rpki_servers (iosxr.devices.configuration.routing.bgp)”
NameTypeConstraintMandatoryDefault Value
serverStringYes
refresh_time_secondsIntegermin: 15, max: 3600No
refresh_time_offBooleantrue, falseNo
response_time_secondsIntegermin: 15, max: 3600No
response_time_offBooleantrue, falseNo
purge_timeIntegermin: 30, max: 65535No
usernameStringNo
password_typeChoice7No
passwordStringNo
transport_tcp_portIntegermin: 1, max: 65535No
transport_ssh_portIntegermin: 1, max: 65535No
bind_source_interfaceStringNo
shutdownBooleantrue, falseNo

address_family (iosxr.devices.configuration.routing.bgp)

Section titled “address_family (iosxr.devices.configuration.routing.bgp)”
NameTypeConstraintMandatoryDefault Value
ipv4_unicastClass[ipv4_unicast]No
ipv6_unicastClass[ipv6_unicast]No
vpnv4_unicastClass[vpnv4_unicast]No
vpnv6_unicastClass[vpnv6_unicast]No
vpnv4_multicastClass[vpnv4_multicast]No
vpnv6_multicastClass[vpnv6_multicast]No
l2vpn_evpnClass[l2vpn_evpn]No

neighbor_groups (iosxr.devices.configuration.routing.bgp)

Section titled “neighbor_groups (iosxr.devices.configuration.routing.bgp)”
NameTypeConstraintMandatoryDefault Value
group_nameStringYes
remote_asAnyString or Integer[min: 1, max: 4294967295] or String[Regex: ^.*[\$\%]\{.*$]No
remote_as_listStringNo
maximum_peersIntegermin: 1, max: 4095No
as_path_loopcheck_outChoicedisable, enableNo
use_neighbor_groupStringNo
use_session_groupStringNo
advertisement_interval_secondsIntegermin: 0, max: 600No
advertisement_interval_millisecondsIntegermin: 0, max: 999No
descriptionStringNo
ignore_connected_checkBooleantrue, falseNo
ignore_connected_check_inheritance_disableBooleantrue, falseNo
ebgp_multihop_maximum_hop_countIntegermin: 1, max: 255No
ebgp_multihop_mplsBooleantrue, falseNo
tcp_mss_valueIntegermin: 68, max: 10000No
tcp_mss_inheritance_disableBooleantrue, falseNo
tcp_mtu_discoveryBooleantrue, falseNo
tcp_mtu_discovery_inheritance_disableBooleantrue, falseNo
tcp_ip_only_preferredBooleantrue, falseNo
tcp_ip_only_preferred_inheritance_disableBooleantrue, falseNo
fast_falloverBooleantrue, falseNo
fast_fallover_inheritance_disableBooleantrue, falseNo
internal_vpn_clientBooleantrue, falseNo
bmp_activate_serversList[bmp_activate_servers]No
bfd_minimum_intervalIntegermin: 3, max: 30000No
bfd_multiplierIntegermin: 2, max: 16No
bfd_fast_detectChoiceenable, strict-mode, disable, strict-mode-negotiate, strict-mode-negotiate-overrideNo
keychain_nameStringmin: 1, max: 32No
keychain_inheritance_disableBooleantrue, falseNo
local_as_inheritance_disableBooleantrue, falseNo
local_asAnyString or Integer[min: 1, max: 4294967295] or String[Regex: ^.*[\$\%]\{.*$]No
local_as_modeChoiceno-prepend, no-prepend-replace-as, no-prepend-replace-as-dual-asNo
password_typeChoice7No
passwordStringNo
password_inheritance_disableBooleantrue, falseNo
receive_buffer_sizeIntegermin: 512, max: 131072No
receive_buffer_size_readIntegermin: 512, max: 131072No
send_buffer_sizeIntegermin: 4096, max: 131072No
send_buffer_size_writeIntegermin: 4096, max: 131072No
dampeningChoiceenable, disableNo
as_overrideChoiceenable, disableNo
shutdownBooleantrue, falseNo
timers_keepalive_intervalIntegermin: 0, max: 65535No
timers_holddown_zeroBooleantrue, falseNo
timers_holddown_zero_minimum_acceptable_zeroBooleantrue, falseNo
timers_holddown_zero_minimum_acceptable_holdtimeIntegermin: 3, max: 65535No
timers_holdtimeIntegermin: 3, max: 65535No
timers_holdtime_minimum_acceptable_holdtimeIntegermin: 3, max: 65535No
local_addressStringNo
local_address_inheritance_disableBooleantrue, falseNo
log_neighbor_changesChoicedetail, disable, inheritance-disableNo
log_message_in_sizeIntegermin: 1, max: 500No
log_message_in_disableBooleantrue, falseNo
log_message_in_inheritance_disableBooleantrue, falseNo
log_message_out_sizeIntegermin: 1, max: 500No
log_message_out_disableBooleantrue, falseNo
log_message_out_inheritance_disableBooleantrue, falseNo
update_sourceStringNo
local_address_subnet_prefixStringNo
local_address_subnet_maskIntegermin: 0, max: 128No
dmz_link_bandwidthBooleantrue, falseNo
dmz_link_bandwidth_inheritance_disableBooleantrue, falseNo
ebgp_recv_extcommunity_dmzBooleantrue, falseNo
ebgp_recv_extcommunity_dmz_inheritance_disableBooleantrue, falseNo
ebgp_send_extcommunity_dmzBooleantrue, falseNo
ebgp_send_extcommunity_dmz_cumulativeBooleantrue, falseNo
ebgp_send_extcommunity_dmz_inheritance_disableBooleantrue, falseNo
ttl_securityBooleantrue, falseNo
ttl_security_inheritance_disableBooleantrue, falseNo
session_open_modeChoiceactive-only, passive-only, bothNo
dscpAnyInteger[min: 0, max: 63] or Choice[af11, af12, af13, af21, af22, af23, af31, af32, af33, af41, af42, af43, cs1, cs2, cs3, cs4, cs5, cs6, cs7, default, ef] or String[Regex: ^.*[\$\%]\{.*$]No
precedenceAnyInteger[min: 0, max: 7] or Choice[critical, flash, flash-override, immediate, internet, network, priority, routine] or String[Regex: ^.*[\$\%]\{.*$]No
capability_additional_paths_sendBooleantrue, falseNo
capability_additional_paths_send_disableBooleantrue, falseNo
capability_additional_paths_receiveBooleantrue, falseNo
capability_additional_paths_receive_disableBooleantrue, falseNo
capability_suppress_allBooleantrue, falseNo
capability_suppress_all_inheritance_disableBooleantrue, falseNo
capability_suppress_extended_nexthop_encodingBooleantrue, falseNo
capability_suppress_extended_nexthop_encoding_inheritance_disableBooleantrue, falseNo
capability_suppress_four_byte_asBooleantrue, falseNo
capability_suppress_four_byte_as_inheritance_disableBooleantrue, falseNo
graceful_restartBooleantrue, falseNo
graceful_restart_disableBooleantrue, falseNo
graceful_restart_helper_onlyBooleantrue, falseNo
graceful_restart_helper_only_inheritance_disableBooleantrue, falseNo
graceful_restart_restart_timeIntegermin: 1, max: 4095No
graceful_restart_stalepath_timeIntegermin: 0, max: 4095No
enforce_first_asChoiceenable, disableNo
cluster_idAnyInteger[min: 1, max: 4294967295] or String or String[Regex: ^.*[\$\%]\{.*$]No
idle_watch_timeIntegermin: 30, max: 1800No
allowas_inIntegermin: 1, max: 10No
egress_engineeringBooleantrue, falseNo
egress_engineering_inheritance_disableBooleantrue, falseNo
peer_setsList[peer_sets]No
ao_key_chain_nameStringmin: 1, max: 32No
ao_key_chain_include_tcp_optionsChoicedisable, enableNo
ao_key_chain_accept_mismatchBooleantrue, falseNo
ao_inheritance_disableBooleantrue, falseNo
default_policy_action_inChoiceaccept, rejectNo
default_policy_action_outChoiceaccept, rejectNo
update_in_filtering_message_buffersIntegermin: 0, max: 25No
update_in_filtering_message_buffers_typeChoicebuffers-number-enable, non-circularNo
update_in_filtering_logging_disableBooleantrue, falseNo
update_in_filtering_attribute_filter_groupStringNo
update_in_labeled_unicast_equivalentBooleantrue, falseNo
update_in_labeled_unicast_equivalent_inheritance_disableBooleantrue, falseNo
update_in_error_handling_avoid_resetChoicedisable, enableNo
update_in_error_handling_treat_as_withdrawChoicedisable, enableNo
graceful_maintenance_activateBooleantrue, falseNo
graceful_maintenance_activate_inheritance_disableBooleantrue, falseNo
graceful_maintenance_local_preferenceIntegermin: 0, max: 4294967295No
graceful_maintenance_local_preference_inheritance_disableBooleantrue, falseNo
graceful_maintenance_as_prepends_numberIntegermin: 0, max: 6No
graceful_maintenance_as_prepends_inheritance_disableBooleantrue, falseNo
graceful_maintenance_bandwidth_aware_percentage_thresholdIntegermin: 1, max: 100No
graceful_maintenance_bandwidth_aware_percentage_threshold_highIntegermin: 1, max: 100No
graceful_maintenance_bandwidth_aware_bandwidth_thresholdIntegermin: 1, max: 4294967295No
graceful_maintenance_bandwidth_aware_bandwidth_threshold_highIntegermin: 1, max: 4294967295No
graceful_maintenance_bandwidth_aware_inheritance_disableBooleantrue, falseNo
address_familyList[address_family]No

session_groups (iosxr.devices.configuration.routing.bgp)

Section titled “session_groups (iosxr.devices.configuration.routing.bgp)”
NameTypeConstraintMandatoryDefault Value
group_nameStringYes
remote_asAnyString or Integer[min: 1, max: 4294967295] or String[Regex: ^.*[\$\%]\{.*$]No
remote_as_listStringNo
maximum_peersIntegermin: 1, max: 4095No
send_community_ebgpBooleantrue, falseNo
send_community_ebgp_inheritance_disableBooleantrue, falseNo
send_extended_community_ebgpBooleantrue, falseNo
send_extended_community_ebgp_inheritance_disableBooleantrue, falseNo
as_path_loopcheck_outChoicedisable, enableNo
dampeningChoicedisable, enableNo
as_overrideChoicedisable, enableNo
use_session_groupStringNo
advertisement_interval_secondsIntegermin: 0, max: 600No
advertisement_interval_millisecondsIntegermin: 0, max: 999No
descriptionStringNo
ignore_connected_checkBooleantrue, falseNo
ignore_connected_check_inheritance_disableBooleantrue, falseNo
internal_vpn_clientBooleantrue, falseNo
ebgp_multihop_maximum_hop_countIntegermin: 1, max: 255No
ebgp_multihop_mplsBooleantrue, falseNo
tcp_mss_valueIntegermin: 68, max: 10000No
tcp_mss_inheritance_disableBooleantrue, falseNo
tcp_mtu_discoveryBooleantrue, falseNo
tcp_mtu_discovery_inheritance_disableBooleantrue, falseNo
tcp_ip_only_preferredBooleantrue, falseNo
tcp_ip_only_preferred_inheritance_disableBooleantrue, falseNo
bmp_activate_serversList[bmp_activate_servers]No
bfd_minimum_intervalIntegermin: 3, max: 30000No
bfd_multiplierIntegermin: 2, max: 16No
bfd_fast_detectChoiceenable, strict-mode, disable, strict-mode-negotiate, strict-mode-negotiate-overrideNo
keychain_nameStringmin: 1, max: 32No
keychain_inheritance_disableBooleantrue, falseNo
local_as_inheritance_disableBooleantrue, falseNo
local_asAnyString or Integer[min: 1, max: 4294967295] or String[Regex: ^.*[\$\%]\{.*$]No
local_as_modeChoiceno-prepend, no-prepend-replace-as, no-prepend-replace-as-dual-asNo
password_typeChoice7No
passwordStringNo
password_inheritance_disableBooleantrue, falseNo
receive_buffer_sizeIntegermin: 512, max: 131072No
receive_buffer_size_readIntegermin: 512, max: 131072No
send_buffer_sizeIntegermin: 4096, max: 131072No
send_buffer_size_writeIntegermin: 4096, max: 131072No
shutdownBooleantrue, falseNo
timers_keepalive_intervalIntegermin: 0, max: 65535No
timers_holddown_zeroBooleantrue, falseNo
timers_holddown_zero_minimum_acceptable_zeroBooleantrue, falseNo
timers_holddown_zero_minimum_acceptable_holdtimeIntegermin: 3, max: 65535No
timers_holdtimeIntegermin: 3, max: 65535No
timers_holdtime_minimum_acceptable_holdtimeIntegermin: 3, max: 65535No
local_addressStringNo
local_address_inheritance_disableBooleantrue, falseNo
log_neighbor_changesChoicedetail, disable, inheritance-disableNo
log_message_in_sizeIntegermin: 1, max: 500No
log_message_in_disableBooleantrue, falseNo
log_message_in_inheritance_disableBooleantrue, falseNo
log_message_out_sizeIntegermin: 1, max: 500No
log_message_out_disableBooleantrue, falseNo
log_message_out_inheritance_disableBooleantrue, falseNo
update_sourceStringNo
local_address_subnet_prefixStringNo
local_address_subnet_maskIntegermin: 0, max: 128No
dmz_link_bandwidthBooleantrue, falseNo
dmz_link_bandwidth_inheritance_disableBooleantrue, falseNo
ebgp_recv_extcommunity_dmzBooleantrue, falseNo
ebgp_recv_extcommunity_dmz_inheritance_disableBooleantrue, falseNo
ebgp_send_extcommunity_dmzBooleantrue, falseNo
ebgp_send_extcommunity_dmz_cumulativeBooleantrue, falseNo
ebgp_send_extcommunity_dmz_inheritance_disableBooleantrue, falseNo
ttl_securityBooleantrue, falseNo
ttl_security_inheritance_disableBooleantrue, falseNo
session_open_modeChoiceactive-only, passive-only, bothNo
dscpAnyInteger[min: 0, max: 63] or Choice[af11, af12, af13, af21, af22, af23, af31, af32, af33, af41, af42, af43, cs1, cs2, cs3, cs4, cs5, cs6, cs7, default, ef] or String[Regex: ^.*[\$\%]\{.*$]No
precedenceAnyInteger[min: 0, max: 7] or Choice[critical, flash, flash-override, immediate, internet, network, priority, routine] or String[Regex: ^.*[\$\%]\{.*$]No
capability_additional_paths_sendBooleantrue, falseNo
capability_additional_paths_send_disableBooleantrue, falseNo
capability_additional_paths_receiveBooleantrue, falseNo
capability_additional_paths_receive_disableBooleantrue, falseNo
capability_suppress_allBooleantrue, falseNo
capability_suppress_all_inheritance_disableBooleantrue, falseNo
capability_suppress_extended_nexthop_encodingBooleantrue, falseNo
capability_suppress_extended_nexthop_encoding_inheritance_disableBooleantrue, falseNo
capability_suppress_four_byte_asBooleantrue, falseNo
capability_suppress_four_byte_as_inheritance_disableBooleantrue, falseNo
graceful_restartBooleantrue, falseNo
graceful_restart_disableBooleantrue, falseNo
graceful_restart_helper_onlyBooleantrue, falseNo
graceful_restart_helper_only_inheritance_disableBooleantrue, falseNo
graceful_restart_restart_timeIntegermin: 1, max: 4095No
graceful_restart_stalepath_timeIntegermin: 0, max: 4095No
enforce_first_asChoicedisable, enableNo
cluster_idAnyInteger[min: 1, max: 4294967295] or String or String[Regex: ^.*[\$\%]\{.*$]No
idle_watch_timeIntegermin: 30, max: 1800No
allowas_inIntegermin: 1, max: 10No
egress_engineeringBooleantrue, falseNo
egress_engineering_inheritance_disableBooleantrue, falseNo
peer_setsList[peer_sets]No
ao_key_chain_nameStringmin: 1, max: 32No
ao_key_chain_include_tcp_optionsChoicedisable, enableNo
ao_key_chain_accept_mismatchBooleantrue, falseNo
ao_inheritance_disableBooleantrue, falseNo
default_policy_action_inChoiceaccept, rejectNo
default_policy_action_outChoiceaccept, rejectNo
fast_falloverBooleantrue, falseNo
fast_fallover_inheritance_disableBooleantrue, falseNo
update_in_labeled_unicast_equivalentBooleantrue, falseNo
update_in_labeled_unicast_equivalent_inheritance_disableBooleantrue, falseNo
update_in_error_handling_avoid_resetChoicedisable, enableNo
update_in_error_handling_treat_as_withdrawChoicedisable, enableNo

af_groups (iosxr.devices.configuration.routing.bgp)

Section titled “af_groups (iosxr.devices.configuration.routing.bgp)”
NameTypeConstraintMandatoryDefault Value
group_nameStringYes
address_familyList[address_family]No

vrfs (iosxr.devices.configuration.routing.bgp)

Section titled “vrfs (iosxr.devices.configuration.routing.bgp)”
NameTypeConstraintMandatoryDefault Value
vrf_nameStringmax: 32Yes
mpls_activate_interfacesList[mpls_activate_interfaces]No
default_information_originateBooleantrue, falseNo
default_metricIntegermin: 1, max: 4294967295No
socket_receive_buffer_sizeIntegermin: 512, max: 131072No
socket_receive_buffer_size_readIntegermin: 512, max: 131072No
socket_send_buffer_sizeIntegermin: 4096, max: 131072No
socket_send_buffer_size_writeIntegermin: 4096, max: 131072No
nexthop_mpls_forwarding_ibgpBooleantrue, falseNo
nexthop_resolution_allow_defaultBooleantrue, falseNo
timers_bgp_keepalive_intervalIntegermin: 0, max: 65535No
timers_bgp_holddown_zeroBooleantrue, falseNo
timers_bgp_holddown_zero_minimum_acceptable_zeroBooleantrue, falseNo
timers_bgp_holddown_zero_minimum_acceptable_holdtimeIntegermin: 3, max: 65535No
timers_bgp_holdtimeIntegermin: 3, max: 65535No
timers_bgp_holdtime_minimum_acceptable_holdtimeIntegermin: 3, max: 65535No
bgp_redistribute_internalBooleantrue, falseNo
bgp_router_idStringNo
bgp_unsafe_ebgp_policyBooleantrue, falseNo
bgp_auto_policy_soft_reset_disableBooleantrue, falseNo
bgp_bestpath_cost_community_ignoreBooleantrue, falseNo
bgp_bestpath_compare_routeridBooleantrue, falseNo
bgp_bestpath_aigp_ignoreBooleantrue, falseNo
bgp_bestpath_igp_metric_ignoreBooleantrue, falseNo
bgp_bestpath_med_missing_as_worstBooleantrue, falseNo
bgp_bestpath_med_alwaysBooleantrue, falseNo
bgp_bestpath_as_path_ignoreBooleantrue, falseNo
bgp_bestpath_as_path_multipath_relaxBooleantrue, falseNo
bgp_bestpath_origin_as_use_validityBooleantrue, falseNo
bgp_bestpath_origin_as_allow_invalidBooleantrue, falseNo
bgp_bestpath_sr_policyChoiceprefer, forceNo
bgp_default_local_preferenceIntegermin: 0, max: 4294967295No
bgp_enforce_first_as_disableBooleantrue, falseNo
bgp_fast_external_fallover_disableBooleantrue, falseNo
bgp_log_neighbor_changesChoicedisableNo
bgp_log_message_disableBooleantrue, falseNo
bgp_multipath_use_cluster_list_lengthBooleantrue, falseNo
bgp_origin_as_validation_signal_ibgpBooleantrue, falseNo
bgp_origin_as_validation_time_offBooleantrue, falseNo
bgp_origin_as_validation_timeIntegermin: 5, max: 60No
bfd_minimum_intervalIntegermin: 3, max: 30000No
bfd_multiplierIntegermin: 2, max: 16No
rdStringYes
neighborsList[neighbors]No
address_familyClass[address_family]No

bmp_activate_servers (iosxr.devices.configuration.routing.bgp.neighbors)

Section titled “bmp_activate_servers (iosxr.devices.configuration.routing.bgp.neighbors)”
NameTypeConstraintMandatoryDefault Value
server_numberIntegermin: 1, max: 8Yes

peer_sets (iosxr.devices.configuration.routing.bgp.neighbors)

Section titled “peer_sets (iosxr.devices.configuration.routing.bgp.neighbors)”
NameTypeConstraintMandatoryDefault Value
peerIntegermin: 1, max: 255Yes

address_family (iosxr.devices.configuration.routing.bgp.neighbors)

Section titled “address_family (iosxr.devices.configuration.routing.bgp.neighbors)”
NameTypeConstraintMandatoryDefault Value
af_nameChoiceipv4-unicast, ipv4-labeled-unicast, ipv4-multicast, ipv4-mdt, ipv4-mvpn, ipv4-flowspec, ipv4-rt-filter, ipv4-sr-policy, ipv4-tunnel, ipv6-unicast, ipv6-labeled-unicast, ipv6-multicast, ipv6-mvpn, ipv6-flowspec, ipv6-sr-policy, vpnv4-flowspec, vpnv4-multicast, vpnv4-unicast, vpnv6-flowspec, vpnv6-multicast, vpnv6-unicast, l2vpn-evpn, l2vpn-mspw, l2vpn-vpls-vpws, link-state-link-stateYes
encapsulation_typeChoicesrv6, vxlanNo
weightIntegermin: 0, max: 65535No
multipathBooleantrue, falseNo
use_af_groupStringNo
capability_orf_prefixChoiceboth, none, receive, sendNo
additional_paths_sendBooleantrue, falseNo
additional_paths_send_disableBooleantrue, falseNo
additional_paths_receiveBooleantrue, falseNo
additional_paths_receive_disableBooleantrue, falseNo
default_originateBooleantrue, falseNo
default_originate_route_policyStringNo
default_originate_inheritance_disableBooleantrue, falseNo
maximum_prefix_limitIntegermin: 1, max: 4294967295No
maximum_prefix_thresholdIntegermin: 1, max: 100No
maximum_prefix_restartIntegermin: 1, max: 65535No
maximum_prefix_discard_extra_pathsBooleantrue, falseNo
maximum_prefix_warning_onlyBooleantrue, falseNo
next_hop_selfBooleantrue, falseNo
next_hop_self_inheritance_disableBooleantrue, falseNo
next_hop_unchangedBooleantrue, falseNo
next_hop_unchanged_multipathBooleantrue, falseNo
next_hop_unchanged_inheritance_disableBooleantrue, falseNo
route_policy_inStringNo
route_policy_outStringNo
orf_route_policyStringNo
cluster_id_allow_equalBooleantrue, falseNo
cluster_id_allow_equal_disableBooleantrue, falseNo
replace_private_asBooleantrue, falseNo
replace_private_as_internalBooleantrue, falseNo
remove_private_as_inboundBooleantrue, falseNo
remove_private_as_inbound_entire_aspathBooleantrue, falseNo
remove_private_as_inbound_inheritance_disableBooleantrue, falseNo
remove_private_asBooleantrue, falseNo
remove_private_as_entire_aspathBooleantrue, falseNo
remove_private_as_internalBooleantrue, falseNo
route_reflector_clientBooleantrue, falseNo
route_reflector_client_inheritance_disableBooleantrue, falseNo
send_community_ebgpBooleantrue, falseNo
send_community_ebgp_inheritance_disableBooleantrue, falseNo
send_community_gshut_ebgpBooleantrue, falseNo
send_community_gshut_ebgp_inheritance_disableBooleantrue, falseNo
send_extended_community_ebgpBooleantrue, falseNo
send_extended_community_ebgp_inheritance_disableBooleantrue, falseNo
soft_reconfiguration_inboundBooleantrue, falseNo
soft_reconfiguration_inbound_alwaysBooleantrue, falseNo
update_out_originator_loopcheckBooleantrue, falseNo
update_out_originator_loopcheck_disableBooleantrue, falseNo
advertise_vpnv4_unicastBooleantrue, falseNo
advertise_vpnv4_unicast_re_originatedBooleantrue, falseNo
advertise_vpnv4_unicast_re_originated_stitching_rtBooleantrue, falseNo
advertise_vpnv6_unicastBooleantrue, falseNo
advertise_vpnv6_unicast_re_originatedBooleantrue, falseNo
advertise_vpnv6_unicast_re_originated_stitching_rtBooleantrue, falseNo
advertise_l2vpn_evpn_re_originatedBooleantrue, falseNo
advertise_l2vpn_evpn_re_originated_stitching_rtBooleantrue, falseNo
segment_routing_srv6_prefix_sid_type4Booleantrue, falseNo
import_stitching_rtBooleantrue, falseNo
import_stitching_rt_re_originateBooleantrue, falseNo
import_stitching_rt_re_originate_stitching_rtBooleantrue, falseNo
import_re_originateBooleantrue, falseNo
allowas_inIntegermin: 1, max: 10No
site_of_originStringNo
as_overrideBooleantrue, falseNo
as_override_inheritance_disableBooleantrue, falseNo
aigpBooleantrue, falseNo
aigp_disableBooleantrue, falseNo
aigp_send_medBooleantrue, falseNo
aigp_send_med_disableBooleantrue, falseNo
aigp_send_cost_community_disableBooleantrue, falseNo
aigp_send_cost_community_idIntegermin: 0, max: 255No
aigp_send_cost_community_id_poi_igp_costBooleantrue, falseNo
aigp_send_cost_community_id_poi_igp_cost_transitiveBooleantrue, falseNo
aigp_send_cost_community_id_poi_pre_bestpathBooleantrue, falseNo
aigp_send_cost_community_id_poi_pre_bestpath_transitiveBooleantrue, falseNo
send_multicast_attributesBooleantrue, falseNo
send_multicast_attributes_disableBooleantrue, falseNo
accept_ownBooleantrue, falseNo
accept_own_inheritance_disableBooleantrue, falseNo
slow_peer_dynamicBooleantrue, falseNo
slow_peer_dynamic_thresholdIntegermin: 120, max: 3600No
slow_peer_dynamic_disableBooleantrue, falseNo
slow_peer_staticBooleantrue, falseNo
origin_as_validation_disableBooleantrue, falseNo
bestpath_origin_as_allow_invalidBooleantrue, falseNo

attribute_code_ranges (iosxr.devices.configuration.routing.bgp.attribute_filter_groups)

Section titled “attribute_code_ranges (iosxr.devices.configuration.routing.bgp.attribute_filter_groups)”
NameTypeConstraintMandatoryDefault Value
startIntegermin: 4, max: 255Yes
endIntegermin: 5, max: 255Yes
discardBooleantrue, falseNo
treat_as_withdrawBooleantrue, falseNo

as_numbers (iosxr.devices.configuration.routing.bgp.as_lists)

Section titled “as_numbers (iosxr.devices.configuration.routing.bgp.as_lists)”
NameTypeConstraintMandatoryDefault Value
as_valueAnyString or Integer[min: 1, max: 4294967295] or String[Regex: ^.*[\$\%]\{.*$]Yes

ipv4_unicast (iosxr.devices.configuration.routing.bgp.address_family)

Section titled “ipv4_unicast (iosxr.devices.configuration.routing.bgp.address_family)”
NameTypeConstraintMandatoryDefault Value
enableBooleantrue, falseNo
distance_bgp_external_routeIntegermin: 1, max: 20000No
distance_bgp_internal_routeIntegermin: 1, max: 20000No
distance_bgp_local_routeIntegermin: 1, max: 20000No
import_from_bridge_domainBooleantrue, falseNo
additional_paths_sendBooleantrue, falseNo
additional_paths_receiveBooleantrue, falseNo
additional_paths_advertise_limitIntegermin: 1, max: 20000No
additional_paths_selection_route_policyStringNo
additional_paths_selection_disableBooleantrue, falseNo
permanent_network_route_policyStringNo
advertise_best_externalBooleantrue, falseNo
advertise_best_external_labeled_unicastBooleantrue, falseNo
advertise_best_external_disableBooleantrue, falseNo
advertise_local_labeled_route_safi_unicastChoicedisable, enableNo
advertise_epe_bgp_labeled_unicastBooleantrue, falseNo
allocate_label_allBooleantrue, falseNo
allocate_label_all_unlabeled_pathBooleantrue, falseNo
allocate_label_route_policyStringNo
allocate_label_route_policy_unlabeled_pathBooleantrue, falseNo
maximum_paths_ebgp_multipathIntegermin: 2, max: 1024No
maximum_paths_ebgp_selectiveBooleantrue, falseNo
maximum_paths_ebgp_route_policyStringNo
maximum_paths_ibgp_multipathIntegermin: 2, max: 1024No
maximum_paths_ibgp_unequal_costBooleantrue, falseNo
maximum_paths_ibgp_unequal_cost_deterministicBooleantrue, falseNo
maximum_paths_ibgp_selectiveBooleantrue, falseNo
maximum_paths_ibgp_route_policyStringNo
maximum_paths_eibgp_multipathIntegermin: 2, max: 1024No
maximum_paths_eibgp_equal_costBooleantrue, falseNo
maximum_paths_eibgp_selectiveBooleantrue, falseNo
maximum_paths_eibgp_route_policyStringNo
maximum_paths_unique_nexthop_check_disableBooleantrue, falseNo
nexthop_trigger_delay_criticalIntegermin: 0, max: 4294967295No
nexthop_trigger_delay_non_criticalIntegermin: 0, max: 4294967295No
label_modeChoiceper-prefix, per-ce, per-vrf, per-vrf-46No
label_mode_route_policyStringNo
redistribute_connectedBooleantrue, falseNo
redistribute_connected_metricIntegermin: 0, max: 4294967295No
redistribute_connected_multipathBooleantrue, falseNo
redistribute_connected_route_policyStringNo
redistribute_staticBooleantrue, falseNo
redistribute_static_metricIntegermin: 0, max: 4294967295No
redistribute_static_multipathBooleantrue, falseNo
redistribute_static_route_policyStringNo
redistribute_ripBooleantrue, falseNo
redistribute_rip_metricIntegermin: 0, max: 4294967295No
redistribute_rip_multipathBooleantrue, falseNo
redistribute_rip_route_policyStringNo
redistribute_ospfList[redistribute_ospf]No
redistribute_eigrpList[redistribute_eigrp]No
redistribute_isisList[redistribute_isis]No
table_policyStringNo
retain_local_labelIntegermin: 3, max: 60No
rnh_install_extcommBooleantrue, falseNo
rnh_install_extcomm_onlyBooleantrue, falseNo
prefix_ecmp_delayIntegermin: 10, max: 60000No
prefix_ecmp_delay_oor_thresholdIntegermin: 10, max: 90No
bgp_origin_as_validation_enableBooleantrue, falseNo
bgp_origin_as_validation_signal_ibgpBooleantrue, falseNo
bgp_bestpath_origin_as_use_validityBooleantrue, falseNo
bgp_bestpath_origin_as_allow_invalidBooleantrue, falseNo
bgp_scan_timeIntegermin: 5, max: 3600No
bgp_attribute_downloadBooleantrue, falseNo
bgp_import_delay_secondsIntegermin: 0, max: 10No
bgp_import_delay_millisecondsIntegermin: 0, max: 999No
bgp_label_delay_secondsIntegermin: 0, max: 10No
bgp_label_delay_millisecondsIntegermin: 0, max: 999No
bgp_client_to_client_reflection_disableBooleantrue, falseNo
bgp_client_to_client_reflection_cluster_idsList[bgp_client_to_client_reflection_cluster_ids]No
bgp_dampening_decay_half_lifeIntegermin: 1, max: 255No
bgp_dampening_reuse_thresholdIntegermin: 1, max: 255No
bgp_dampening_suppress_thresholdIntegermin: 1, max: 255No
bgp_dampening_max_suppress_timeIntegermin: 0, max: 4294967295No
bgp_dampening_route_policyStringNo
event_prefix_route_policyStringNo
dynamic_med_intervalIntegermin: 0, max: 10No
weight_reset_on_importBooleantrue, falseNo
nexthop_route_policyStringNo
nexthop_resolution_prefix_length_minimum_ipv4Integermin: 0, max: 32No
nexthop_resolution_prefix_length_minimum_ipv6Integermin: 0, max: 128No
update_limit_sub_group_ebgpIntegermin: 1, max: 512No
update_limit_sub_group_ibgpIntegermin: 1, max: 512No
update_limit_address_familyIntegermin: 4, max: 2048No
update_wait_installBooleantrue, falseNo
update_wait_install_delay_startupIntegermin: 1, max: 600No
as_path_loopcheck_out_disableBooleantrue, falseNo
epe_backup_enableBooleantrue, falseNo
default_martian_check_disableBooleantrue, falseNo
export_to_vrf_allow_backupBooleantrue, falseNo
export_to_vrf_allow_best_externalBooleantrue, falseNo
segment_routing_prefix_sid_mapBooleantrue, falseNo
segment_routing_srv6Class[segment_routing_srv6]No
aggregate_addressesList[aggregate_addresses]No
networksList[networks]No
peer_set_idsList[peer_set_ids]No

ipv6_unicast (iosxr.devices.configuration.routing.bgp.address_family)

Section titled “ipv6_unicast (iosxr.devices.configuration.routing.bgp.address_family)”
NameTypeConstraintMandatoryDefault Value
enableBooleantrue, falseNo
distance_bgp_external_routeIntegermin: 1, max: 20000No
distance_bgp_internal_routeIntegermin: 1, max: 20000No
distance_bgp_local_routeIntegermin: 1, max: 20000No
import_from_bridge_domainBooleantrue, falseNo
additional_paths_sendBooleantrue, falseNo
additional_paths_receiveBooleantrue, falseNo
additional_paths_advertise_limitIntegermin: 1, max: 20000No
additional_paths_selection_route_policyStringNo
additional_paths_selection_disableBooleantrue, falseNo
permanent_network_route_policyStringNo
advertise_best_externalBooleantrue, falseNo
advertise_best_external_labeled_unicastBooleantrue, falseNo
advertise_best_external_disableBooleantrue, falseNo
advertise_local_labeled_route_safi_unicastChoicedisable, enableNo
advertise_epe_bgp_labeled_unicastBooleantrue, falseNo
allocate_label_allBooleantrue, falseNo
allocate_label_all_unlabeled_pathBooleantrue, falseNo
allocate_label_route_policyStringNo
allocate_label_route_policy_unlabeled_pathBooleantrue, falseNo
maximum_paths_ebgp_multipathIntegermin: 2, max: 1024No
maximum_paths_ebgp_selectiveBooleantrue, falseNo
maximum_paths_ebgp_route_policyStringNo
maximum_paths_ibgp_multipathIntegermin: 2, max: 1024No
maximum_paths_ibgp_unequal_costBooleantrue, falseNo
maximum_paths_ibgp_unequal_cost_deterministicBooleantrue, falseNo
maximum_paths_ibgp_selectiveBooleantrue, falseNo
maximum_paths_ibgp_route_policyStringNo
maximum_paths_eibgp_multipathIntegermin: 2, max: 1024No
maximum_paths_eibgp_equal_costBooleantrue, falseNo
maximum_paths_eibgp_selectiveBooleantrue, falseNo
maximum_paths_eibgp_route_policyStringNo
maximum_paths_unique_nexthop_check_disableBooleantrue, falseNo
nexthop_trigger_delay_criticalIntegermin: 0, max: 4294967295No
nexthop_trigger_delay_non_criticalIntegermin: 0, max: 4294967295No
label_modeChoiceper-prefix, per-ce, per-vrf, per-vrf-46No
label_mode_route_policyStringNo
redistribute_connectedBooleantrue, falseNo
redistribute_connected_metricIntegermin: 0, max: 4294967295No
redistribute_connected_multipathBooleantrue, falseNo
redistribute_connected_route_policyStringNo
redistribute_staticBooleantrue, falseNo
redistribute_static_metricIntegermin: 0, max: 4294967295No
redistribute_static_multipathBooleantrue, falseNo
redistribute_static_route_policyStringNo
redistribute_ripBooleantrue, falseNo
redistribute_rip_metricIntegermin: 0, max: 4294967295No
redistribute_rip_multipathBooleantrue, falseNo
redistribute_rip_route_policyStringNo
redistribute_ospfv3List[redistribute_ospfv3]No
redistribute_eigrpList[redistribute_eigrp]No
redistribute_isisList[redistribute_isis]No
table_policyStringNo
retain_local_labelIntegermin: 3, max: 60No
retain_route_target_allBooleantrue, falseNo
retain_route_target_route_policyStringNo
rnh_install_extcommBooleantrue, falseNo
rnh_install_extcomm_onlyBooleantrue, falseNo
prefix_ecmp_delayIntegermin: 10, max: 60000No
prefix_ecmp_delay_oor_thresholdIntegermin: 10, max: 90No
bgp_origin_as_validation_enableBooleantrue, falseNo
bgp_origin_as_validation_signal_ibgpBooleantrue, falseNo
bgp_bestpath_origin_as_use_validityBooleantrue, falseNo
bgp_bestpath_origin_as_allow_invalidBooleantrue, falseNo
bgp_scan_timeIntegermin: 5, max: 3600No
bgp_attribute_downloadBooleantrue, falseNo
bgp_import_delay_secondsIntegermin: 0, max: 10No
bgp_import_delay_millisecondsIntegermin: 0, max: 999No
bgp_label_delay_secondsIntegermin: 0, max: 10No
bgp_label_delay_millisecondsIntegermin: 0, max: 999No
bgp_client_to_client_reflection_disableBooleantrue, falseNo
bgp_client_to_client_reflection_cluster_idsList[bgp_client_to_client_reflection_cluster_ids]No
bgp_dampening_decay_half_lifeIntegermin: 1, max: 255No
bgp_dampening_reuse_thresholdIntegermin: 1, max: 255No
bgp_dampening_suppress_thresholdIntegermin: 1, max: 255No
bgp_dampening_max_suppress_timeIntegermin: 0, max: 4294967295No
bgp_dampening_route_policyStringNo
event_prefix_route_policyStringNo
dynamic_med_intervalIntegermin: 0, max: 10No
weight_reset_on_importBooleantrue, falseNo
nexthop_route_policyStringNo
update_limit_sub_group_ebgpIntegermin: 1, max: 512No
update_limit_sub_group_ibgpIntegermin: 1, max: 512No
update_limit_address_familyIntegermin: 4, max: 2048No
update_wait_installBooleantrue, falseNo
update_wait_install_delay_startupIntegermin: 1, max: 600No
as_path_loopcheck_out_disableBooleantrue, falseNo
epe_backup_enableBooleantrue, falseNo
default_martian_check_disableBooleantrue, falseNo
export_to_vrf_allow_backupBooleantrue, falseNo
export_to_vrf_allow_best_externalBooleantrue, falseNo
segment_routing_srv6Class[segment_routing_srv6]No
aggregate_addressesList[aggregate_addresses]No
networksList[networks]No
peer_set_idsList[peer_set_ids]No

vpnv4_unicast (iosxr.devices.configuration.routing.bgp.address_family)

Section titled “vpnv4_unicast (iosxr.devices.configuration.routing.bgp.address_family)”
NameTypeConstraintMandatoryDefault Value
enableBooleantrue, falseNo
vrf_allClass[vrf_all]No
additional_paths_sendBooleantrue, falseNo
additional_paths_receiveBooleantrue, falseNo
additional_paths_advertise_limitIntegermin: 1, max: 20000No
additional_paths_selection_route_policyStringNo
advertise_best_externalBooleantrue, falseNo
advertise_best_external_disableBooleantrue, falseNo
nexthop_trigger_delay_criticalIntegermin: 0, max: 4294967295No
nexthop_trigger_delay_non_criticalIntegermin: 0, max: 4294967295No
label_mode_per_nexthop_received_labelBooleantrue, falseNo
label_mode_per_nexthop_received_label_allocate_secondary_labelBooleantrue, falseNo
retain_local_labelIntegermin: 3, max: 60No
retain_route_target_allBooleantrue, falseNo
retain_route_target_route_policyStringNo
bgp_scan_timeIntegermin: 5, max: 3600No
bgp_import_delay_secondsIntegermin: 0, max: 10No
bgp_import_delay_millisecondsIntegermin: 0, max: 999No
bgp_label_delay_secondsIntegermin: 0, max: 10No
bgp_label_delay_millisecondsIntegermin: 0, max: 999No
bgp_client_to_client_reflection_disableBooleantrue, falseNo
bgp_client_to_client_reflection_cluster_idsList[bgp_client_to_client_reflection_cluster_ids]No
bgp_dampening_decay_half_lifeIntegermin: 1, max: 255No
bgp_dampening_reuse_thresholdIntegermin: 1, max: 255No
bgp_dampening_suppress_thresholdIntegermin: 1, max: 255No
bgp_dampening_max_suppress_timeIntegermin: 0, max: 4294967295No
bgp_dampening_route_policyStringNo
event_prefix_route_policyStringNo
dynamic_med_intervalIntegermin: 0, max: 10No
weight_reset_on_importBooleantrue, falseNo
nexthop_route_policyStringNo
nexthop_resolution_prefix_length_minimum_ipv4Integermin: 0, max: 32No
nexthop_resolution_prefix_length_minimum_ipv6Integermin: 0, max: 128No
update_limit_sub_group_ebgpIntegermin: 1, max: 512No
update_limit_sub_group_ibgpIntegermin: 1, max: 512No
update_limit_address_familyIntegermin: 4, max: 2048No
update_wait_installBooleantrue, falseNo
update_wait_install_delay_startupIntegermin: 1, max: 600No
as_path_loopcheck_out_disableBooleantrue, falseNo
default_martian_check_disableBooleantrue, falseNo
export_to_vrf_allow_backupBooleantrue, falseNo
export_to_vrf_allow_best_externalBooleantrue, falseNo
segment_routing_srv6Class[segment_routing_srv6]No

vpnv6_unicast (iosxr.devices.configuration.routing.bgp.address_family)

Section titled “vpnv6_unicast (iosxr.devices.configuration.routing.bgp.address_family)”
NameTypeConstraintMandatoryDefault Value
enableBooleantrue, falseNo
vrf_allClass[vrf_all]No
additional_paths_sendBooleantrue, falseNo
additional_paths_receiveBooleantrue, falseNo
additional_paths_advertise_limitIntegermin: 1, max: 20000No
additional_paths_selection_route_policyStringNo
advertise_best_externalBooleantrue, falseNo
advertise_best_external_disableBooleantrue, falseNo
nexthop_trigger_delay_criticalIntegermin: 0, max: 4294967295No
nexthop_trigger_delay_non_criticalIntegermin: 0, max: 4294967295No
label_mode_per_nexthop_received_labelBooleantrue, falseNo
label_mode_per_nexthop_received_label_allocate_secondary_labelBooleantrue, falseNo
retain_local_labelIntegermin: 3, max: 60No
retain_route_target_allBooleantrue, falseNo
retain_route_target_route_policyStringNo
bgp_scan_timeIntegermin: 5, max: 3600No
bgp_import_delay_secondsIntegermin: 0, max: 10No
bgp_import_delay_millisecondsIntegermin: 0, max: 999No
bgp_label_delay_secondsIntegermin: 0, max: 10No
bgp_label_delay_millisecondsIntegermin: 0, max: 999No
bgp_client_to_client_reflection_disableBooleantrue, falseNo
bgp_client_to_client_reflection_cluster_idsList[bgp_client_to_client_reflection_cluster_ids]No
bgp_dampening_decay_half_lifeIntegermin: 1, max: 255No
bgp_dampening_reuse_thresholdIntegermin: 1, max: 255No
bgp_dampening_suppress_thresholdIntegermin: 1, max: 255No
bgp_dampening_max_suppress_timeIntegermin: 0, max: 4294967295No
bgp_dampening_route_policyStringNo
event_prefix_route_policyStringNo
dynamic_med_intervalIntegermin: 0, max: 10No
weight_reset_on_importBooleantrue, falseNo
nexthop_route_policyStringNo
update_limit_sub_group_ebgpIntegermin: 1, max: 512No
update_limit_sub_group_ibgpIntegermin: 1, max: 512No
update_limit_address_familyIntegermin: 4, max: 2048No
update_wait_installBooleantrue, falseNo
update_wait_install_delay_startupIntegermin: 1, max: 600No
as_path_loopcheck_out_disableBooleantrue, falseNo
default_martian_check_disableBooleantrue, falseNo
export_to_vrf_allow_backupBooleantrue, falseNo
export_to_vrf_allow_best_externalBooleantrue, falseNo
segment_routing_srv6Class[segment_routing_srv6]No

vpnv4_multicast (iosxr.devices.configuration.routing.bgp.address_family)

Section titled “vpnv4_multicast (iosxr.devices.configuration.routing.bgp.address_family)”
NameTypeConstraintMandatoryDefault Value
enableBooleantrue, falseNo
additional_paths_sendBooleantrue, falseNo
additional_paths_receiveBooleantrue, falseNo
additional_paths_advertise_limitIntegermin: 1, max: 20000No
additional_paths_selection_route_policyStringNo
advertise_best_externalBooleantrue, falseNo
advertise_best_external_disableBooleantrue, falseNo
nexthop_trigger_delay_criticalIntegermin: 0, max: 4294967295No
nexthop_trigger_delay_non_criticalIntegermin: 0, max: 4294967295No
retain_local_labelIntegermin: 3, max: 60No
retain_route_target_allBooleantrue, falseNo
retain_route_target_route_policyStringNo
bgp_scan_timeIntegermin: 5, max: 3600No
bgp_label_delay_secondsIntegermin: 0, max: 10No
bgp_label_delay_millisecondsIntegermin: 0, max: 999No
bgp_client_to_client_reflection_disableBooleantrue, falseNo
bgp_client_to_client_reflection_cluster_idsList[bgp_client_to_client_reflection_cluster_ids]No
bgp_dampening_decay_half_lifeIntegermin: 1, max: 255No
bgp_dampening_reuse_thresholdIntegermin: 1, max: 255No
bgp_dampening_suppress_thresholdIntegermin: 1, max: 255No
bgp_dampening_max_suppress_timeIntegermin: 0, max: 4294967295No
bgp_dampening_route_policyStringNo
event_prefix_route_policyStringNo
nexthop_route_policyStringNo
nexthop_resolution_prefix_length_minimum_ipv4Integermin: 0, max: 32No
update_limit_sub_group_ebgpIntegermin: 1, max: 512No
update_limit_sub_group_ibgpIntegermin: 1, max: 512No
update_limit_address_familyIntegermin: 4, max: 2048No
as_path_loopcheck_out_disableBooleantrue, falseNo
default_martian_check_disableBooleantrue, falseNo

vpnv6_multicast (iosxr.devices.configuration.routing.bgp.address_family)

Section titled “vpnv6_multicast (iosxr.devices.configuration.routing.bgp.address_family)”
NameTypeConstraintMandatoryDefault Value
enableBooleantrue, falseNo
additional_paths_sendBooleantrue, falseNo
additional_paths_receiveBooleantrue, falseNo
additional_paths_advertise_limitIntegermin: 1, max: 20000No
additional_paths_selection_route_policyStringNo
advertise_best_externalBooleantrue, falseNo
advertise_best_external_disableBooleantrue, falseNo
nexthop_trigger_delay_criticalIntegermin: 0, max: 4294967295No
nexthop_trigger_delay_non_criticalIntegermin: 0, max: 4294967295No
retain_local_labelIntegermin: 3, max: 60No
retain_route_target_allBooleantrue, falseNo
retain_route_target_route_policyStringNo
bgp_scan_timeIntegermin: 5, max: 3600No
bgp_label_delay_secondsIntegermin: 0, max: 10No
bgp_label_delay_millisecondsIntegermin: 0, max: 999No
bgp_client_to_client_reflection_disableBooleantrue, falseNo
bgp_client_to_client_reflection_cluster_idsList[bgp_client_to_client_reflection_cluster_ids]No
bgp_dampening_decay_half_lifeIntegermin: 1, max: 255No
bgp_dampening_reuse_thresholdIntegermin: 1, max: 255No
bgp_dampening_suppress_thresholdIntegermin: 1, max: 255No
bgp_dampening_max_suppress_timeIntegermin: 0, max: 4294967295No
bgp_dampening_route_policyStringNo
event_prefix_route_policyStringNo
nexthop_route_policyStringNo
nexthop_resolution_prefix_length_minimum_ipv4Integermin: 0, max: 32No
update_limit_sub_group_ebgpIntegermin: 1, max: 512No
update_limit_sub_group_ibgpIntegermin: 1, max: 512No
update_limit_address_familyIntegermin: 4, max: 2048No
as_path_loopcheck_out_disableBooleantrue, falseNo
default_martian_check_disableBooleantrue, falseNo

l2vpn_evpn (iosxr.devices.configuration.routing.bgp.address_family)

Section titled “l2vpn_evpn (iosxr.devices.configuration.routing.bgp.address_family)”
NameTypeConstraintMandatoryDefault Value
enableBooleantrue, falseNo
additional_paths_sendBooleantrue, falseNo
additional_paths_receiveBooleantrue, falseNo
additional_paths_advertise_limitIntegermin: 1, max: 20000No
additional_paths_selection_route_policyStringNo
advertise_best_externalBooleantrue, falseNo
advertise_best_external_disableBooleantrue, falseNo
nexthop_trigger_delay_criticalIntegermin: 0, max: 4294967295No
nexthop_trigger_delay_non_criticalIntegermin: 0, max: 4294967295No
retain_local_labelIntegermin: 3, max: 60No
retain_route_target_allBooleantrue, falseNo
retain_route_target_route_policyStringNo
bgp_scan_timeIntegermin: 5, max: 3600No
bgp_import_delay_secondsIntegermin: 0, max: 10No
bgp_import_delay_millisecondsIntegermin: 0, max: 999No
bgp_label_delay_secondsIntegermin: 0, max: 10No
bgp_label_delay_millisecondsIntegermin: 0, max: 999No
bgp_client_to_client_reflection_disableBooleantrue, falseNo
bgp_client_to_client_reflection_cluster_idsList[bgp_client_to_client_reflection_cluster_ids]No
bgp_dampening_decay_half_lifeIntegermin: 1, max: 255No
bgp_dampening_reuse_thresholdIntegermin: 1, max: 255No
bgp_dampening_suppress_thresholdIntegermin: 1, max: 255No
bgp_dampening_max_suppress_timeIntegermin: 0, max: 4294967295No
bgp_dampening_route_policyStringNo
event_prefix_route_policyStringNo
nexthop_route_policyStringNo
nexthop_resolution_prefix_length_minimum_ipv4Integermin: 0, max: 32No
nexthop_resolution_prefix_length_minimum_ipv6Integermin: 0, max: 128No
update_limit_sub_group_ebgpIntegermin: 1, max: 512No
update_limit_sub_group_ibgpIntegermin: 1, max: 512No
update_limit_address_familyIntegermin: 4, max: 2048No
as_path_loopcheck_out_disableBooleantrue, falseNo
default_martian_check_disableBooleantrue, falseNo

mpls_activate_interfaces (iosxr.devices.configuration.routing.bgp.vrfs)

Section titled “mpls_activate_interfaces (iosxr.devices.configuration.routing.bgp.vrfs)”
NameTypeConstraintMandatoryDefault Value
interface_nameStringYes

address_family (iosxr.devices.configuration.routing.bgp.vrfs)

Section titled “address_family (iosxr.devices.configuration.routing.bgp.vrfs)”
NameTypeConstraintMandatoryDefault Value
ipv4_unicastClass[ipv4_unicast]No
ipv6_unicastClass[ipv6_unicast]No
ipv4_multicastClass[ipv4_multicast]No
ipv6_multicastClass[ipv6_multicast]No

redistribute_ospf (iosxr.devices.configuration.routing.bgp.address_family.ipv4_unicast)

Section titled “redistribute_ospf (iosxr.devices.configuration.routing.bgp.address_family.ipv4_unicast)”
NameTypeConstraintMandatoryDefault Value
instance_idStringYes
matchChoicematch-external, match-external-1, match-external-1-nssa-external, match-external-1-nssa-external-1, match-external-1-nssa-external-2, match-external-2, match-external-2-nssa-external, match-external-2-nssa-external-1, match-external-2-nssa-external-2, match-external-nssa-external, match-external-nssa-external-1, match-external-nssa-external-2, match-internal, match-internal-external, match-internal-external-1, match-internal-external-1-nssa-external, match-internal-external-1-nssa-external-1, match-internal-external-1-nssa-external-2, match-internal-external-2, match-internal-external-2-nssa-external, match-internal-external-2-nssa-external-1, match-internal-external-2-nssa-external-2, match-internal-external-nssa-external, match-internal-external-nssa-external-1, match-internal-external-nssa-external-2, match-internal-nssa-external, match-internal-nssa-external-1, match-internal-nssa-external-2, match-nssa-external, match-nssa-external-1, match-nssa-external-2No
metricIntegermin: 0, max: 4294967295No
multipathBooleantrue, falseNo
route_policyStringNo

redistribute_eigrp (iosxr.devices.configuration.routing.bgp.address_family.ipv4_unicast)

Section titled “redistribute_eigrp (iosxr.devices.configuration.routing.bgp.address_family.ipv4_unicast)”
NameTypeConstraintMandatoryDefault Value
instance_idStringYes
matchChoicematch-internal, match-internal-external, match-externalNo
metricIntegermin: 0, max: 4294967295No
multipathBooleantrue, falseNo
route_policyStringNo

redistribute_isis (iosxr.devices.configuration.routing.bgp.address_family.ipv4_unicast)

Section titled “redistribute_isis (iosxr.devices.configuration.routing.bgp.address_family.ipv4_unicast)”
NameTypeConstraintMandatoryDefault Value
instance_idStringYes
levelChoicelevel-1, level-1-inter-area, level-1-level-1-inter-area, level-1-level-2, level-1-level-2-level-1-inter-area, level-2, level-2-level-1-inter-areaNo
metricIntegermin: 0, max: 4294967295No
multipathBooleantrue, falseNo
route_policyStringNo

bgp_client_to_client_reflection_cluster_ids (iosxr.devices.configuration.routing.bgp.address_family.ipv4_unicast)

Section titled “bgp_client_to_client_reflection_cluster_ids (iosxr.devices.configuration.routing.bgp.address_family.ipv4_unicast)”
NameTypeConstraintMandatoryDefault Value
cluster_idAnyString or Integer[min: 1, max: 4294967295] or String[Regex: ^.*[\$\%]\{.*\}.*$]Yes
disableBooleantrue, falseYes

segment_routing_srv6 (iosxr.devices.configuration.routing.bgp.address_family.ipv4_unicast)

Section titled “segment_routing_srv6 (iosxr.devices.configuration.routing.bgp.address_family.ipv4_unicast)”
NameTypeConstraintMandatoryDefault Value
locatorStringNo
usid_allocation_wide_local_id_blockBooleantrue, falseNo
alloc_modeChoiceper-ce, per-vrf, per-vrf-46No
alloc_mode_route_policyStringNo

aggregate_addresses (iosxr.devices.configuration.routing.bgp.address_family.ipv4_unicast)

Section titled “aggregate_addresses (iosxr.devices.configuration.routing.bgp.address_family.ipv4_unicast)”
NameTypeConstraintMandatoryDefault Value
addressIPYes
maskIntegermin: 0, max: 128Yes
as_confed_setBooleantrue, falseNo
as_setBooleantrue, falseNo
descriptionStringNo
route_policyStringNo
set_tagIntegermin: 0, max: 4294967295No
summary_onlyBooleantrue, falseNo

networks (iosxr.devices.configuration.routing.bgp.address_family.ipv4_unicast)

Section titled “networks (iosxr.devices.configuration.routing.bgp.address_family.ipv4_unicast)”
NameTypeConstraintMandatoryDefault Value
addressIPYes
maskIntegermin: 0, max: 128Yes
backdoorBooleantrue, falseNo
multipathBooleantrue, falseNo
route_policyStringNo

peer_set_ids (iosxr.devices.configuration.routing.bgp.address_family.ipv4_unicast)

Section titled “peer_set_ids (iosxr.devices.configuration.routing.bgp.address_family.ipv4_unicast)”
NameTypeConstraintMandatoryDefault Value
peer_idIntegermin: 1, max: 255Yes
peer_sid_indexIntegermin: 0, max: 1033575No

vrf_all (iosxr.devices.configuration.routing.bgp.address_family.vpnv4_unicast)

Section titled “vrf_all (iosxr.devices.configuration.routing.bgp.address_family.vpnv4_unicast)”
NameTypeConstraintMandatoryDefault Value
segment_routing_srv6Class[segment_routing_srv6]No
source_rt_import_policyBooleantrue, falseNo
label_modeChoiceper-ce, per-vrf, per-vrf-46No
label_mode_route_policyStringNo
rnh_install_extcommBooleantrue, falseNo
rnh_install_extcomm_onlyBooleantrue, falseNo
table_policyStringNo

segment_routing_srv6 (iosxr.devices.configuration.routing.bgp.address_family.vpnv4_unicast)

Section titled “segment_routing_srv6 (iosxr.devices.configuration.routing.bgp.address_family.vpnv4_unicast)”
NameTypeConstraintMandatoryDefault Value
locatorStringNo
usid_allocation_wide_local_id_blockBooleantrue, falseNo

ipv4_unicast (iosxr.devices.configuration.routing.bgp.vrfs.address_family)

Section titled “ipv4_unicast (iosxr.devices.configuration.routing.bgp.vrfs.address_family)”
NameTypeConstraintMandatoryDefault Value
enableBooleantrue, falseNo
distance_bgp_external_routeIntegermin: 1, max: 20000No
distance_bgp_internal_routeIntegermin: 1, max: 20000No
distance_bgp_local_routeIntegermin: 1, max: 20000No
bgp_attribute_downloadBooleantrue, falseNo
allow_vpn_default_originateBooleantrue, falseNo
additional_paths_sendBooleantrue, falseNo
additional_paths_send_disableBooleantrue, falseNo
additional_paths_receiveBooleantrue, falseNo
additional_paths_receive_disableBooleantrue, falseNo
additional_paths_advertise_limitIntegermin: 1, max: 20000No
additional_paths_selection_route_policyStringNo
additional_paths_selection_disableBooleantrue, falseNo
advertise_best_externalBooleantrue, falseNo
advertise_best_external_disableBooleantrue, falseNo
advertise_local_labeled_route_safi_unicastChoicedisable, enableNo
allocate_label_allBooleantrue, falseNo
allocate_label_all_unlabeled_pathBooleantrue, falseNo
allocate_label_route_policy_nameStringNo
allocate_label_route_policy_unlabeled_pathBooleantrue, falseNo
maximum_paths_ebgp_multipathIntegermin: 2, max: 128No
maximum_paths_ebgp_selectiveBooleantrue, falseNo
maximum_paths_ebgp_route_policyStringNo
maximum_paths_ibgp_multipathIntegermin: 2, max: 128No
maximum_paths_ibgp_unequal_costBooleantrue, falseNo
maximum_paths_ibgp_unequal_cost_deterministicBooleantrue, falseNo
maximum_paths_ibgp_selectiveBooleantrue, falseNo
maximum_paths_ibgp_route_policyStringNo
maximum_paths_eibgp_multipathIntegermin: 2, max: 128No
maximum_paths_eibgp_equal_costBooleantrue, falseNo
maximum_paths_eibgp_selectiveBooleantrue, falseNo
maximum_paths_eibgp_route_policyStringNo
maximum_paths_unique_nexthop_check_disableBooleantrue, falseNo
label_modeChoiceper-prefix, per-ce, per-vrf, per-vrf-46, per-nexthop-received-label, per-nexthop-received-label-allocate-secondary-labelNo
label_mode_route_policyStringNo
redistribute_connectedBooleantrue, falseNo
redistribute_connected_metricIntegermin: 0, max: 4294967295No
redistribute_connected_multipathBooleantrue, falseNo
redistribute_connected_route_policyStringNo
redistribute_staticBooleantrue, falseNo
redistribute_static_metricIntegermin: 0, max: 4294967295No
redistribute_static_multipathBooleantrue, falseNo
redistribute_static_route_policyStringNo
redistribute_ripBooleantrue, falseNo
redistribute_rip_metricIntegermin: 0, max: 4294967295No
redistribute_rip_multipathBooleantrue, falseNo
redistribute_rip_route_policyStringNo
table_policyStringNo
bgp_origin_as_validation_enableBooleantrue, falseNo
bgp_origin_as_validation_signal_ibgpBooleantrue, falseNo
bgp_bestpath_origin_as_use_validityBooleantrue, falseNo
bgp_bestpath_origin_as_allow_invalidBooleantrue, falseNo
bgp_dampening_decay_half_lifeIntegermin: 1, max: 255No
bgp_dampening_reuse_thresholdIntegermin: 1, max: 255No
bgp_dampening_suppress_thresholdIntegermin: 1, max: 255No
bgp_dampening_max_suppress_timeIntegermin: 0, max: 4294967295No
bgp_dampening_route_policyStringNo
dynamic_med_intervalIntegermin: 0, max: 10No
weight_reset_on_importBooleantrue, falseNo
nexthop_route_policyStringNo
as_path_loopcheck_out_disableBooleantrue, falseNo
mvpn_single_forwarder_selectionChoiceall, highest-ip-addressNo
segment_routing_srv6Class[segment_routing_srv6]No
aggregate_addressesList[aggregate_addresses]No
networksList[networks]No
redistribute_ospfList[redistribute_ospf]No
redistribute_ospfv3List[redistribute_ospfv3]No
redistribute_eigrpList[redistribute_eigrp]No
redistribute_isisList[redistribute_isis]No

ipv6_unicast (iosxr.devices.configuration.routing.bgp.vrfs.address_family)

Section titled “ipv6_unicast (iosxr.devices.configuration.routing.bgp.vrfs.address_family)”
NameTypeConstraintMandatoryDefault Value
enableBooleantrue, falseNo
distance_bgp_external_routeIntegermin: 1, max: 20000No
distance_bgp_internal_routeIntegermin: 1, max: 20000No
distance_bgp_local_routeIntegermin: 1, max: 20000No
bgp_attribute_downloadBooleantrue, falseNo
allow_vpn_default_originateBooleantrue, falseNo
additional_paths_sendBooleantrue, falseNo
additional_paths_send_disableBooleantrue, falseNo
additional_paths_receiveBooleantrue, falseNo
additional_paths_receive_disableBooleantrue, falseNo
additional_paths_advertise_limitIntegermin: 1, max: 20000No
additional_paths_selection_route_policyStringNo
additional_paths_selection_disableBooleantrue, falseNo
advertise_best_externalBooleantrue, falseNo
advertise_best_external_disableBooleantrue, falseNo
advertise_local_labeled_route_safi_unicastChoicedisable, enableNo
allocate_label_allBooleantrue, falseNo
allocate_label_all_unlabeled_pathBooleantrue, falseNo
allocate_label_route_policy_nameStringNo
allocate_label_route_policy_unlabeled_pathBooleantrue, falseNo
maximum_paths_ebgp_multipathIntegermin: 2, max: 128No
maximum_paths_ebgp_selectiveBooleantrue, falseNo
maximum_paths_ebgp_route_policyStringNo
maximum_paths_ibgp_multipathIntegermin: 2, max: 128No
maximum_paths_ibgp_unequal_costBooleantrue, falseNo
maximum_paths_ibgp_unequal_cost_deterministicBooleantrue, falseNo
maximum_paths_ibgp_selectiveBooleantrue, falseNo
maximum_paths_ibgp_route_policyStringNo
maximum_paths_eibgp_multipathIntegermin: 2, max: 128No
maximum_paths_eibgp_equal_costBooleantrue, falseNo
maximum_paths_eibgp_selectiveBooleantrue, falseNo
maximum_paths_eibgp_route_policyStringNo
maximum_paths_unique_nexthop_check_disableBooleantrue, falseNo
label_modeChoiceper-prefix, per-ce, per-vrf, per-vrf-46, per-nexthop-received-label, per-nexthop-received-label-allocate-secondary-labelNo
label_mode_route_policyStringNo
redistribute_connectedBooleantrue, falseNo
redistribute_connected_metricIntegermin: 0, max: 4294967295No
redistribute_connected_multipathBooleantrue, falseNo
redistribute_connected_route_policyStringNo
redistribute_staticBooleantrue, falseNo
redistribute_static_metricIntegermin: 0, max: 4294967295No
redistribute_static_multipathBooleantrue, falseNo
redistribute_static_route_policyStringNo
redistribute_ripBooleantrue, falseNo
redistribute_rip_metricIntegermin: 0, max: 4294967295No
redistribute_rip_multipathBooleantrue, falseNo
redistribute_rip_route_policyStringNo
table_policyStringNo
bgp_origin_as_validation_enableBooleantrue, falseNo
bgp_origin_as_validation_signal_ibgpBooleantrue, falseNo
bgp_bestpath_origin_as_use_validityBooleantrue, falseNo
bgp_bestpath_origin_as_allow_invalidBooleantrue, falseNo
bgp_dampening_decay_half_lifeIntegermin: 1, max: 255No
bgp_dampening_reuse_thresholdIntegermin: 1, max: 255No
bgp_dampening_suppress_thresholdIntegermin: 1, max: 255No
bgp_dampening_max_suppress_timeIntegermin: 0, max: 4294967295No
bgp_dampening_route_policyStringNo
dynamic_med_intervalIntegermin: 0, max: 10No
weight_reset_on_importBooleantrue, falseNo
nexthop_route_policyStringNo
as_path_loopcheck_out_disableBooleantrue, falseNo
mvpn_single_forwarder_selectionChoiceall, highest-ip-addressNo
segment_routing_srv6Class[segment_routing_srv6]No
aggregate_addressesList[aggregate_addresses]No
networksList[networks]No
redistribute_ospfList[redistribute_ospf]No
redistribute_ospfv3List[redistribute_ospfv3]No
redistribute_eigrpList[redistribute_eigrp]No
redistribute_isisList[redistribute_isis]No

ipv4_multicast (iosxr.devices.configuration.routing.bgp.vrfs.address_family)

Section titled “ipv4_multicast (iosxr.devices.configuration.routing.bgp.vrfs.address_family)”
NameTypeConstraintMandatoryDefault Value
enableBooleantrue, falseNo
distance_bgp_external_routeIntegermin: 1, max: 20000No
distance_bgp_internal_routeIntegermin: 1, max: 20000No
distance_bgp_local_routeIntegermin: 1, max: 20000No
maximum_paths_ebgp_multipathIntegermin: 2, max: 128No
maximum_paths_ebgp_selectiveBooleantrue, falseNo
maximum_paths_ebgp_route_policyStringNo
maximum_paths_ibgp_multipathIntegermin: 2, max: 128No
maximum_paths_ibgp_unequal_costBooleantrue, falseNo
maximum_paths_ibgp_unequal_cost_deterministicBooleantrue, falseNo
maximum_paths_ibgp_selectiveBooleantrue, falseNo
maximum_paths_ibgp_route_policyStringNo
maximum_paths_eibgp_multipathIntegermin: 2, max: 128No
maximum_paths_eibgp_equal_costBooleantrue, falseNo
maximum_paths_eibgp_selectiveBooleantrue, falseNo
maximum_paths_eibgp_route_policyStringNo
redistribute_connectedBooleantrue, falseNo
redistribute_connected_metricIntegermin: 0, max: 4294967295No
redistribute_connected_multipathBooleantrue, falseNo
redistribute_connected_route_policyStringNo
redistribute_staticBooleantrue, falseNo
redistribute_static_metricIntegermin: 0, max: 4294967295No
redistribute_static_multipathBooleantrue, falseNo
redistribute_static_route_policyStringNo
redistribute_ripBooleantrue, falseNo
redistribute_rip_metricIntegermin: 0, max: 4294967295No
redistribute_rip_multipathBooleantrue, falseNo
redistribute_rip_route_policyStringNo
table_policyStringNo
bgp_dampening_decay_half_lifeIntegermin: 1, max: 255No
bgp_dampening_reuse_thresholdIntegermin: 1, max: 255No
bgp_dampening_suppress_thresholdIntegermin: 1, max: 255No
bgp_dampening_max_suppress_timeIntegermin: 0, max: 4294967295No
bgp_dampening_route_policyStringNo
weight_reset_on_importBooleantrue, falseNo
nexthop_route_policyStringNo
as_path_loopcheck_out_disableBooleantrue, falseNo
mvpn_single_forwarder_selectionChoiceall, highest-ip-addressNo
aggregate_addressesList[aggregate_addresses]No
networksList[networks]No
redistribute_ospfList[redistribute_ospf]No
redistribute_eigrpList[redistribute_eigrp]No
redistribute_isisList[redistribute_isis]No

ipv6_multicast (iosxr.devices.configuration.routing.bgp.vrfs.address_family)

Section titled “ipv6_multicast (iosxr.devices.configuration.routing.bgp.vrfs.address_family)”
NameTypeConstraintMandatoryDefault Value
enableBooleantrue, falseNo
distance_bgp_external_routeIntegermin: 1, max: 20000No
distance_bgp_internal_routeIntegermin: 1, max: 20000No
distance_bgp_local_routeIntegermin: 1, max: 20000No
maximum_paths_ebgp_multipathIntegermin: 2, max: 128No
maximum_paths_ebgp_selectiveBooleantrue, falseNo
maximum_paths_ebgp_route_policyStringNo
maximum_paths_ibgp_multipathIntegermin: 2, max: 128No
maximum_paths_ibgp_unequal_costBooleantrue, falseNo
maximum_paths_ibgp_unequal_cost_deterministicBooleantrue, falseNo
maximum_paths_ibgp_selectiveBooleantrue, falseNo
maximum_paths_ibgp_route_policyStringNo
maximum_paths_eibgp_multipathIntegermin: 2, max: 128No
maximum_paths_eibgp_equal_costBooleantrue, falseNo
maximum_paths_eibgp_selectiveBooleantrue, falseNo
maximum_paths_eibgp_route_policyStringNo
redistribute_connectedBooleantrue, falseNo
redistribute_connected_metricIntegermin: 0, max: 4294967295No
redistribute_connected_multipathBooleantrue, falseNo
redistribute_connected_route_policyStringNo
redistribute_staticBooleantrue, falseNo
redistribute_static_metricIntegermin: 0, max: 4294967295No
redistribute_static_multipathBooleantrue, falseNo
redistribute_static_route_policyStringNo
redistribute_ripBooleantrue, falseNo
redistribute_rip_metricIntegermin: 0, max: 4294967295No
redistribute_rip_multipathBooleantrue, falseNo
redistribute_rip_route_policyStringNo
table_policyStringNo
bgp_dampening_decay_half_lifeIntegermin: 1, max: 255No
bgp_dampening_reuse_thresholdIntegermin: 1, max: 255No
bgp_dampening_suppress_thresholdIntegermin: 1, max: 255No
bgp_dampening_max_suppress_timeIntegermin: 0, max: 4294967295No
bgp_dampening_route_policyStringNo
weight_reset_on_importBooleantrue, falseNo
nexthop_route_policyStringNo
as_path_loopcheck_out_disableBooleantrue, falseNo
mvpn_single_forwarder_selectionChoiceall, highest-ip-addressNo
aggregate_addressesList[aggregate_addresses]No
networksList[networks]No
redistribute_ospfv3List[redistribute_ospfv3]No
redistribute_eigrpList[redistribute_eigrp]No
redistribute_isisList[redistribute_isis]No

segment_routing_srv6 (iosxr.devices.configuration.routing.bgp.address_family.vpnv4_unicast.vrf_all)

Section titled “segment_routing_srv6 (iosxr.devices.configuration.routing.bgp.address_family.vpnv4_unicast.vrf_all)”
NameTypeConstraintMandatoryDefault Value
locatorStringNo
usid_allocation_wide_local_id_blockBooleantrue, falseNo
alloc_modeChoiceper-ce, per-vrf, per-vrf-46No

Guidelines and Limitations

Section titled “Guidelines and Limitations”

Data Normalization

Section titled “Data Normalization”

BGP RD Formats

Fields that accept BGP Route Distinguishers can be in any of four formats:

  1. two-byte AS (e.g., 65001:100)
  2. four-byte AS (e.g., 65536:100)
  3. IPv4 address (e.g., 192.168.1.1:100)
  4. auto (e.g., auto)

All 4 formats can be used interchangeably. The normalization layer automatically detects the user-specified format and maps to the correct attributes before sending to the device.

DSCP and Precedence Values

DSCP and Precedence fields accept both numeric and named string values.

  • dscp: integer 0-63 or named value (e.g., ef, af11, cs3)
  • precedence: integer 0-7 or named value (e.g., flash, critical, network)

Both formats can be used interchangeably. The normalization layer automatically converts integer values to their named equivalents before sending to the device, preventing configuration drift.

Enabling an Address-Family

Section titled “Enabling an Address-Family”

In IOS-XR, simply enabling an address-family under BGP (e.g., address-family ipv4 unicast) is a valid and meaningful configuration, even without any additional sub-attributes. There are three supported ways to enable an address-family:

address_family:
  # 1. Enabled by having attributes configured in the address-family
  ipv4_unicast:
    distance_bgp_external_route: 200
    distance_bgp_internal_route: 195


  # 2. Explicitly enabled
  ipv6_unicast:
    enable: true


  # 3. Enabled with empty mapping
  vpnv4_unicast: {}

Note: All three forms produce the same result on the device. The enable: true form is preferred for clarity. The empty mapping {} is also supported. Declaring a key with no value (e.g., ipv6_unicast:) is not valid; use enable: true or {} instead.

BGP Examples

Section titled “BGP Examples”

Example-1: BGP with bestpath configuration and multipath settings.

iosxr:
  devices:
    - name: router-1
      host: 10.10.10.1:57400
      configuration:
        routing:
          bgp:
            - as_number: 65001
              bgp_router_id: 10.1.1.1
              bgp_bestpath_aigp_ignore: true
              bgp_bestpath_as_path_ignore: true
              bgp_bestpath_as_path_multipath_relax: true
              bgp_bestpath_compare_routerid: true
              bgp_bestpath_cost_community_ignore: true
              bgp_bestpath_igp_metric_sr_policy: true
              bgp_bestpath_med_missing_as_worst: true
              bgp_bestpath_origin_as_use_validity: true
              bgp_bestpath_origin_as_allow_invalid: true
              bgp_bestpath_sr_policy: "prefer"
              bgp_multipath_use_cluster_list_length: true
              bgp_multipath_as_path_ignore_onwards: true
              bgp_default_local_preference: 200
              bgp_auto_policy_soft_reset_disable: true
              default_metric: 100
              timers_bgp_keepalive_interval: 30
              timers_bgp_holdtime: 90
              bfd_minimum_interval: 10
              bfd_multiplier: 4

Example-2: BGP with segment routing SRv6 configuration.

iosxr:
  devices:
    - name: router-1
      host: 10.10.10.1:57400
      configuration:
        routing:
          bgp:
            - as_number: 65001
              bgp_router_id: 10.1.1.1
              segment_routing_srv6:
                locator: SRv6_LOCATOR
                usid_allocation_wide_local_id_block: true

Example-3: BGP with graceful maintenance and RPKI configuration.

iosxr:
  devices:
    - name: router-1
      host: 10.10.10.1:57400
      configuration:
        routing:
          bgp:
            - as_number: 65001
              bgp_router_id: 10.1.1.1
              graceful_maintenance_activate_all_neighbors: true
              graceful_maintenance_activate_retain_routes: true
              graceful_maintenance_activate_interfaces:
                - interface_name: GigabitEthernet0/0/0/0
                - interface_name: GigabitEthernet0/0/0/1
              bgp_origin_as_validation_signal_ibgp: true
              bgp_origin_as_validation_time: 45
              rpki_servers:
                - server: 192.168.1.100
                  refresh_time_seconds: 120
                  response_time_seconds: 240
                  purge_time: 180
                  username: rpki-user
                  password_type: 7
                  password: "060506324F41"
                  transport_tcp_port: 3323
              rpki_routes:
                - route_address: 10.0.0.0
                  route_prefix: 8
                  max_length: 24
                  origin_as: 65001

Example-4: BGP with confederation and AS list configuration.

iosxr:
  devices:
    - name: router-1
      host: 10.10.10.1:57400
      configuration:
        routing:
          bgp:
            - as_number: 65001
              bgp_router_id: 10.1.1.1
              bgp_confederation_identifier: 65001
              bgp_confederation_peers:
                - peer_as_number: 65002
                - peer_as_number: 65003
              as_league_peers:
                - peer_as_number: 65100
                - peer_as_number: 65200
              as_lists:
                - list_name: ALLOWED_AS
                  as_numbers:
                    - as_value: 65002
                    - as_value: 65003
              attribute_filter_groups:
                - group_name: FILTER_GROUP1
                  attribute_code_ranges:
                    - start: 4
                      end: 10
                      discard: true
              bgp_cluster_id: 100010
              bgp_enforce_first_as_disable: true
              bgp_as_path_loopcheck: true

BGP Address Family Examples

Section titled “BGP Address Family Examples”

BGP address families enable multi-protocol support including IPv4/IPv6 unicast, multicast, labeled unicast, VPNv4/v6, L2VPN EVPN, flowspec, and SR-policy. This feature provides extensive control over routing policies, redistribution, dampening, segment routing, label allocation, and advanced BGP behaviors per address family.

Example-1: Basic IPv4 unicast address family with distance BGP, multipath, and additional paths configuration.

iosxr:
  devices:
    - name: router-1
      host: 10.10.10.1:57400
      configuration:
        route_policy:
          - route_policy_name: ROUTE_POLICY_1
            rpl: |
              route-policy ROUTE_POLICY_1
                pass
              end-policy
        routing:
          bgp:
            - as_number: 65001
              address_family:
                ipv4_unicast:
                  distance_bgp_external_route: 200
                  distance_bgp_internal_route: 195
                  distance_bgp_local_route: 190
                  maximum_paths_eibgp_multipath: 10
                  maximum_paths_eibgp_equal_cost: true
                  maximum_paths_eibgp_selective: true
                  maximum_paths_eibgp_route_policy: ROUTE_POLICY_1
                  additional_paths_send: true
                  additional_paths_receive: true
                  additional_paths_advertise_limit: 40
                  additional_paths_selection_route_policy: ROUTE_POLICY_1
                  advertise_best_external: true
                  advertise_local_labeled_route_safi_unicast: disable
                  nexthop_trigger_delay_critical: 1000
                  nexthop_trigger_delay_non_critical: 2000
                  nexthop_route_policy: ROUTE_POLICY_1
                  nexthop_resolution_prefix_length_minimum_ipv4: 32
                  nexthop_resolution_prefix_length_minimum_ipv6: 128

Example-2: IPv4 unicast with networks, aggregate addresses, and redistribution of connected, static, OSPF, and ISIS routes.

iosxr:
  devices:
    - name: router-1
      host: 10.10.10.1:57400
      configuration:
        route_policy:
          - route_policy_name: ROUTE_POLICY_1
            rpl: |
              route-policy ROUTE_POLICY_1
                pass
              end-policy
        routing:
          bgp:
            - as_number: 65001
              address_family:
                ipv4_unicast:
                  networks:
                    - address: 11.0.0.0
                      mask: 8
                      route_policy: ROUTE_POLICY_1
                  aggregate_addresses:
                    - address: 10.0.0.0
                      mask: 8
                      as_set: true
                      as_confed_set: true
                      summary_only: true
                      route_policy: ROUTE_POLICY_1
                      description: "Aggregate route description"
                      set_tag: 100
                  redistribute_connected: true
                  redistribute_connected_metric: 100
                  redistribute_connected_multipath: true
                  redistribute_connected_route_policy: ROUTE_POLICY_1
                  redistribute_static: true
                  redistribute_static_metric: 100
                  redistribute_static_multipath: true
                  redistribute_static_route_policy: ROUTE_POLICY_1
                  redistribute_ospf:
                    - instance_id: OSPF1
                      match: match-external-1
                      metric: 100
                  redistribute_isis:
                    - instance_id: ISIS1
                      level: level-1-level-2
                      metric: 100
                      multipath: true
                      route_policy: ROUTE_POLICY_1
                  permanent_network_route_policy: ROUTE_POLICY_1
                  table_policy: ROUTE_POLICY_1

Example-3: IPv4 unicast with BGP dampening, origin AS validation, client-to-client reflection, and advanced timing controls.

iosxr:
  devices:
    - name: router-1
      host: 10.10.10.1:57400
      configuration:
        route_policy:
          - route_policy_name: ROUTE_POLICY_1
            rpl: |
              route-policy ROUTE_POLICY_1
                pass
              end-policy
        routing:
          bgp:
            - as_number: 65001
              address_family:
                ipv4_unicast:
                  bgp_dampening_decay_half_life: 10
                  bgp_dampening_reuse_threshold: 20
                  bgp_dampening_suppress_threshold: 30
                  bgp_dampening_max_suppress_time: 40
                  bgp_origin_as_validation_enable: true
                  bgp_origin_as_validation_signal_ibgp: true
                  bgp_bestpath_origin_as_use_validity: true
                  bgp_bestpath_origin_as_allow_invalid: true
                  bgp_scan_time: 60
                  bgp_attribute_download: true
                  bgp_label_delay_seconds: 5
                  bgp_label_delay_milliseconds: 500
                  bgp_client_to_client_reflection_cluster_ids:
                    - cluster_id: "100010"
                      disable: true
                    - cluster_id: 100011
                      disable: true
                    - cluster_id: 10.1.1.1
                      disable: true
                    - cluster_id: 10.1.1.2
                      disable: true
                  prefix_ecmp_delay: 1000
                  prefix_ecmp_delay_oor_threshold: 90
                  event_prefix_route_policy: ROUTE_POLICY_1
                  dynamic_med_interval: 5
                  update_limit_sub_group_ebgp: 10
                  update_limit_sub_group_ibgp: 10
                  update_limit_address_family: 10
                  update_wait_install_delay_startup: 300
                  retain_local_label: 40
                  rnh_install_extcomm_only: true

Example-4: IPv6 unicast with distance BGP, bridge domain import, additional paths, label allocation, multipath, redistribution, dampening, and origin AS validation.

iosxr:
  devices:
    - name: router-1
      host: 10.10.10.1:57400
      configuration:
        route_policy:
          - route_policy_name: POLICY_IN
            rpl: |
              route-policy POLICY_IN
                pass
              end-policy
        routing:
          bgp:
            - as_number: 65001
              address_family:
                ipv6_unicast:
                  distance_bgp_external_route: 200
                  distance_bgp_internal_route: 195
                  distance_bgp_local_route: 190
                  import_from_bridge_domain: true
                  additional_paths_send: true
                  additional_paths_receive: true
                  additional_paths_advertise_limit: 40
                  additional_paths_selection_route_policy: POLICY_IN
                  advertise_best_external: true
                  allocate_label_route_policy: POLICY_IN
                  allocate_label_route_policy_unlabeled_path: true
                  maximum_paths_eibgp_multipath: 10
                  maximum_paths_eibgp_equal_cost: true
                  maximum_paths_eibgp_selective: true
                  maximum_paths_eibgp_route_policy: POLICY_IN
                  nexthop_trigger_delay_critical: 1000
                  nexthop_trigger_delay_non_critical: 2000
                  nexthop_route_policy: POLICY_IN
                  redistribute_connected: true
                  redistribute_connected_metric: 100
                  redistribute_connected_multipath: true
                  redistribute_connected_route_policy: POLICY_IN
                  redistribute_static: true
                  redistribute_static_metric: 100
                  redistribute_static_multipath: true
                  redistribute_static_route_policy: POLICY_IN
                  redistribute_rip: true
                  redistribute_rip_metric: 100
                  redistribute_rip_multipath: true
                  redistribute_rip_route_policy: POLICY_IN
                  redistribute_ospfv3:
                    - instance_id: OSPF1
                      match: match-internal
                      metric: 100
                      multipath: true
                      route_policy: POLICY_IN
                  redistribute_isis:
                    - instance_id: ISIS1
                      level: level-2
                      metric: 100
                      multipath: true
                      route_policy: POLICY_IN
                  retain_local_label: 40
                  rnh_install_extcomm_only: true
                  prefix_ecmp_delay: 1000
                  prefix_ecmp_delay_oor_threshold: 90
                  bgp_origin_as_validation_enable: true
                  bgp_origin_as_validation_signal_ibgp: true
                  bgp_bestpath_origin_as_use_validity: true
                  bgp_bestpath_origin_as_allow_invalid: true
                  bgp_scan_time: 60
                  bgp_label_delay_seconds: 5
                  bgp_label_delay_milliseconds: 500
                  bgp_client_to_client_reflection_cluster_ids:
                    - cluster_id: 100010
                      disable: true
                    - cluster_id: 100011
                      disable: true
                    - cluster_id: 10.1.1.1
                      disable: true
                    - cluster_id: 10.1.1.2
                      disable: true
                  bgp_dampening_decay_half_life: 10
                  bgp_dampening_reuse_threshold: 20
                  bgp_dampening_suppress_threshold: 30
                  bgp_dampening_max_suppress_time: 40
                  dynamic_med_interval: 5
                  update_limit_sub_group_ebgp: 10
                  update_limit_sub_group_ibgp: 10
                  update_limit_address_family: 10
                  update_wait_install: true
                  as_path_loopcheck_out_disable: true

Example-5: VPNv4/VPNv6 unicast address families with VRF-all settings, label modes, segment routing SRv6, and route target retention.

iosxr:
  devices:
    - name: router-1
      host: 10.10.10.1:57400
      configuration:
        route_policy:
          - route_policy_name: ROUTE_POLICY_1
            rpl: |
              route-policy ROUTE_POLICY_1
                pass
              end-policy
        routing:
          bgp:
            - as_number: 65001
              address_family:
                vpnv4_unicast:
                  vrf_all:
                    segment_routing_srv6:
                      locator: LOC-ALL
                      usid_allocation_wide_local_id_block: true
                      alloc_mode: per-vrf
                    source_rt_import_policy: true
                    rnh_install_extcomm: true
                    table_policy: ROUTE_POLICY_1
                  additional_paths_send: true
                  additional_paths_receive: true
                  additional_paths_advertise_limit: 40
                  additional_paths_selection_route_policy: ROUTE_POLICY_1
                  advertise_best_external: true
                  nexthop_trigger_delay_critical: 1000
                  nexthop_trigger_delay_non_critical: 2000
                  nexthop_route_policy: ROUTE_POLICY_1
                  nexthop_resolution_prefix_length_minimum_ipv4: 32
                  nexthop_resolution_prefix_length_minimum_ipv6: 128
                  label_mode_per_nexthop_received_label: true
                  label_mode_per_nexthop_received_label_allocate_secondary_label: true
                  retain_local_label: 40
                  retain_route_target_route_policy: ROUTE_POLICY_1
                  bgp_scan_time: 60
                  bgp_label_delay_seconds: 5
                  bgp_label_delay_milliseconds: 500
                  bgp_client_to_client_reflection_cluster_ids:
                    - cluster_id: 100010
                      disable: true
                    - cluster_id: 100011
                      disable: true
                    - cluster_id: 10.1.1.1
                      disable: true
                    - cluster_id: 10.1.1.2
                      disable: true
                  bgp_dampening_decay_half_life: 10
                  bgp_dampening_reuse_threshold: 20
                  bgp_dampening_suppress_threshold: 30
                  bgp_dampening_max_suppress_time: 40
                  event_prefix_route_policy: ROUTE_POLICY_1
                  dynamic_med_interval: 5
                  weight_reset_on_import: true
                  update_limit_sub_group_ebgp: 10
                  update_limit_sub_group_ibgp: 10
                  update_limit_address_family: 10
                  update_wait_install: true
                  as_path_loopcheck_out_disable: true
                  default_martian_check_disable: true
                  export_to_vrf_allow_backup: true
                  export_to_vrf_allow_best_external: true
                  segment_routing_srv6:
                    locator: LOC-2
                    usid_allocation_wide_local_id_block: true
                vpnv6_unicast:
                  vrf_all:
                    segment_routing_srv6:
                      locator: LOC-ALL
                      usid_allocation_wide_local_id_block: true
                      alloc_mode: per-vrf
                    source_rt_import_policy: true
                    rnh_install_extcomm: true
                    table_policy: ROUTE_POLICY_1
                  additional_paths_send: true
                  additional_paths_receive: true
                  additional_paths_advertise_limit: 40
                  additional_paths_selection_route_policy: ROUTE_POLICY_1
                  advertise_best_external: true
                  nexthop_trigger_delay_critical: 1000
                  nexthop_trigger_delay_non_critical: 2000
                  nexthop_route_policy: ROUTE_POLICY_1
                  label_mode_per_nexthop_received_label: true
                  label_mode_per_nexthop_received_label_allocate_secondary_label: true
                  retain_local_label: 40
                  retain_route_target_route_policy: ROUTE_POLICY_1
                  bgp_scan_time: 60
                  bgp_label_delay_seconds: 5
                  bgp_label_delay_milliseconds: 500
                  bgp_client_to_client_reflection_cluster_ids:
                    - cluster_id: 100010
                      disable: true
                    - cluster_id: 100011
                      disable: true
                    - cluster_id: 10.1.1.1
                      disable: true
                    - cluster_id: 10.1.1.2
                      disable: true
                  bgp_dampening_decay_half_life: 10
                  bgp_dampening_reuse_threshold: 20
                  bgp_dampening_suppress_threshold: 30
                  bgp_dampening_max_suppress_time: 40
                  event_prefix_route_policy: ROUTE_POLICY_1
                  dynamic_med_interval: 5
                  weight_reset_on_import: true
                  update_limit_sub_group_ebgp: 10
                  update_limit_sub_group_ibgp: 10
                  update_limit_address_family: 10
                  update_wait_install: true
                  as_path_loopcheck_out_disable: true
                  default_martian_check_disable: true
                  export_to_vrf_allow_backup: true
                  export_to_vrf_allow_best_external: true
                  segment_routing_srv6:
                    locator: LOC-2
                    usid_allocation_wide_local_id_block: true

Example-6: VPNv4 multicast address family with additional paths, nexthop trigger delays, BGP dampening, and label delay configuration.

iosxr:
  devices:
    - name: router-1
      host: 10.10.10.1:57400
      configuration:
        routing:
          bgp:
            - as_number: 65001
              address_family:
                vpnv4_multicast:
                  additional_paths_send: true
                  additional_paths_receive: true
                  nexthop_trigger_delay_critical: 1000
                  nexthop_trigger_delay_non_critical: 2000
                  nexthop_resolution_prefix_length_minimum_ipv4: 32
                  bgp_dampening_decay_half_life: 10
                  bgp_dampening_reuse_threshold: 20
                  bgp_dampening_suppress_threshold: 30
                  bgp_dampening_max_suppress_time: 40
                  bgp_scan_time: 60
                  bgp_label_delay_seconds: 5
                  bgp_label_delay_milliseconds: 500
                  retain_local_label: 40

Example-7: VPNv6 multicast address family with additional paths, nexthop trigger delays, BGP dampening, and label delay configuration.

iosxr:
  devices:
    - name: router-1
      host: 10.10.10.1:57400
      configuration:
        routing:
          bgp:
            - as_number: 65001
              address_family:
                vpnv6_multicast:
                  additional_paths_send: true
                  additional_paths_receive: true
                  nexthop_trigger_delay_critical: 1000
                  nexthop_trigger_delay_non_critical: 2000
                  nexthop_resolution_prefix_length_minimum_ipv4: 32
                  bgp_dampening_decay_half_life: 10
                  bgp_dampening_reuse_threshold: 20
                  bgp_dampening_suppress_threshold: 30
                  bgp_dampening_max_suppress_time: 40
                  bgp_scan_time: 60
                  bgp_label_delay_seconds: 5
                  bgp_label_delay_milliseconds: 500
                  retain_local_label: 40

BGP Neighbor Address Family Examples

Section titled “BGP Neighbor Address Family Examples”

Per-neighbor address family configuration includes IPv4/IPv6 unicast, VPNv4/v6, multicast, labeled unicast, L2VPN EVPN, and other address families. It provides granular control over neighbor-specific routing policies, prefix limits, route reflection, AS path manipulation, additional paths, soft reconfiguration, encapsulation types, and advanced BGP features per address family.

Example-1: BGP neighbor with IPv4 unicast address family including additional paths, default originate, route policies, and SRv6 encapsulation.

iosxr:
  devices:
    - name: router-1
      host: 10.10.10.1:57400
      configuration:
        route_policy:
          - route_policy_name: POLICY_IN
            rpl: |
              route-policy POLICY_IN
                pass
              end-policy
          - route_policy_name: POLICY_OUT
            rpl: |
              route-policy POLICY_OUT
                pass
              end-policy
        routing:
          bgp:
            - as_number: 65001
              bgp_router_id: 10.1.1.1
              neighbors:
                - ip: 10.1.1.2
                  remote_as: 65001
                  description: "IPv4 unicast neighbor"
                  address_family:
                    - af_name: ipv4-unicast
                      additional_paths_send: true
                      additional_paths_receive: true
                      default_originate: true
                      default_originate_route_policy: POLICY_IN
                      maximum_prefix_limit: 1000
                      maximum_prefix_threshold: 50
                      maximum_prefix_restart: 100
                      next_hop_self: true
                      route_policy_in: POLICY_IN
                      route_policy_out: POLICY_OUT
                      orf_route_policy: POLICY_IN
                      cluster_id_allow_equal: true
                      remove_private_as_internal: true
                      route_reflector_client: true
                      soft_reconfiguration_inbound_always: true
                      update_out_originator_loopcheck: true
                      allowas_in: 3
                      as_override: true
                      aigp_send_cost_community_id: 1
                      aigp_send_cost_community_id_poi_pre_bestpath_transitive: true
                      send_multicast_attributes: true
                      slow_peer_dynamic_threshold: 300
                      encapsulation_type: srv6

Example-2: BGP neighbor with IPv6 unicast address family.

iosxr:
  devices:
    - name: router-1
      host: 10.10.10.1:57400
      configuration:
        route_policy:
          - route_policy_name: POLICY_IN
            rpl: |
              route-policy POLICY_IN
                pass
              end-policy
          - route_policy_name: POLICY_OUT
            rpl: |
              route-policy POLICY_OUT
                pass
              end-policy
        routing:
          bgp:
            - as_number: 65001
              bgp_router_id: 10.1.1.1
              neighbors:
                - ip: 10.1.1.2
                  remote_as: 65001
                  description: "IPv6 unicast neighbor"
                  address_family:
                    - af_name: ipv6-unicast
                      additional_paths_send: true
                      additional_paths_receive: true
                      default_originate: true
                      default_originate_route_policy: POLICY_IN
                      maximum_prefix_limit: 1000
                      maximum_prefix_threshold: 50
                      maximum_prefix_restart: 100
                      next_hop_self: true
                      route_policy_in: POLICY_IN
                      route_policy_out: POLICY_OUT
                      orf_route_policy: POLICY_IN
                      cluster_id_allow_equal: true
                      remove_private_as_internal: true
                      route_reflector_client: true
                      soft_reconfiguration_inbound_always: true
                      update_out_originator_loopcheck: true
                      allowas_in: 3
                      as_override: true
                      aigp_send_cost_community_id: 1
                      aigp_send_cost_community_id_poi_pre_bestpath_transitive: true
                      send_multicast_attributes: true
                      slow_peer_dynamic_threshold: 300
                      encapsulation_type: srv6

Example-3: BGP neighbor with VPNv4 unicast address family for MPLS L3VPN services with SRv6 encapsulation support.

iosxr:
  devices:
    - name: router-1
      host: 10.10.10.1:57400
      configuration:
        route_policy:
          - route_policy_name: POLICY_IN
            rpl: |
              route-policy POLICY_IN
                pass
              end-policy
          - route_policy_name: POLICY_OUT
            rpl: |
              route-policy POLICY_OUT
                pass
              end-policy
        routing:
          bgp:
            - as_number: 65001
              bgp_router_id: 10.1.1.1
              neighbors:
                - ip: 10.1.1.2
                  remote_as: 65001
                  description: "VPNv4 unicast neighbor"
                  address_family:
                    - af_name: vpnv4-unicast
                      additional_paths_send: true
                      additional_paths_receive: true
                      default_originate: true
                      default_originate_route_policy: POLICY_IN
                      maximum_prefix_limit: 1000
                      maximum_prefix_threshold: 50
                      maximum_prefix_restart: 100
                      next_hop_self: true
                      route_policy_in: POLICY_IN
                      route_policy_out: POLICY_OUT
                      cluster_id_allow_equal: true
                      remove_private_as_internal: true
                      route_reflector_client: true
                      soft_reconfiguration_inbound_always: true
                      update_out_originator_loopcheck: true
                      allowas_in: 3
                      as_override: true
                      aigp_send_cost_community_id: 1
                      aigp_send_cost_community_id_poi_pre_bestpath_transitive: true
                      slow_peer_dynamic_threshold: 300
                      encapsulation_type: srv6

BGP Neighbor Group Examples

Section titled “BGP Neighbor Group Examples”

Neighbor groups enable consistent configuration templates for multiple BGP neighbors, supporting address-family specific settings, BFD, authentication, timers, graceful restart, route policies, capabilities, and advanced BGP features. Neighbor groups simplify management by allowing inheritance of common configurations while permitting per-neighbor overrides.

Example-1: BGP neighbor group with IPv4 unicast address family, BFD, timers, and route policies.

iosxr:
  devices:
    - name: router-1
      host: 10.10.10.1:57400
      configuration:
        route_policy:
          - route_policy_name: ROUTE_POLICY_1
            rpl: |
              route-policy ROUTE_POLICY_1
                pass
              end-policy
        routing:
          bgp:
            - as_number: 65001
              bgp_router_id: 10.1.1.1
              neighbor_groups:
                - group_name: NGROUP1
                  remote_as: 65001
                  advertisement_interval_seconds: 10
                  description: "My Neighbor Group Description"
                  tcp_mss_value: 1460
                  tcp_mtu_discovery: true
                  fast_fallover: true
                  internal_vpn_client: true
                  bfd_minimum_interval: 10
                  bfd_multiplier: 4
                  bfd_fast_detect: "enable"
                  receive_buffer_size: 1024
                  receive_buffer_size_read: 1024
                  send_buffer_size: 4096
                  send_buffer_size_write: 4096
                  dampening: "enable"
                  shutdown: false
                  timers_keepalive_interval: 10
                  timers_holdtime: 30
                  timers_holdtime_minimum_acceptable_holdtime: 30
                  local_address: 192.168.1.1
                  log_neighbor_changes: detail
                  log_message_in_size: 256
                  log_message_out_size: 256
                  update_source: Loopback0
                  address_family:
                    - af_name: vpnv4-unicast
                      encapsulation_type: srv6
                      weight: 100
                      additional_paths_send: true
                      additional_paths_receive: true
                      maximum_prefix_limit: 1248576
                      maximum_prefix_threshold: 80
                      maximum_prefix_warning_only: true
                      next_hop_self: true
                      route_policy_in: ROUTE_POLICY_1
                      route_policy_out: ROUTE_POLICY_1
                      route_reflector_client: true
                      soft_reconfiguration_inbound_always: true

Example-2: BGP neighbor group with BFD strict mode, and graceful restart.

iosxr:
  devices:
    - name: router-1
      host: 10.10.10.1:57400
      configuration:
        routing:
          bgp:
            - as_number: 65001
              bgp_router_id: 10.1.1.1
              neighbor_groups:
                - group_name: NGROUP1
                  remote_as: 65001
                  maximum_peers: 1000
                  as_path_loopcheck_out: enable
                  advertisement_interval_seconds: 10
                  description: "Neighbor Group Description"
                  bfd_fast_detect: strict-mode-negotiate-override
                  bfd_minimum_interval: 10
                  bfd_multiplier: 4
                  password_type: 7
                  password: "12341C2713181F13253920"
                  session_open_mode: active-only
                  dscp: ef
                  capability_additional_paths_send: true
                  capability_additional_paths_receive: true
                  capability_suppress_all: true
                  capability_suppress_extended_nexthop_encoding: true
                  capability_suppress_four_byte_as: true
                  cluster_id: 100010
                  idle_watch_time: 240
                  allowas_in: 3
                  egress_engineering: true
                  address_family:
                    - af_name: vpnv4-unicast
                      encapsulation_type: srv6
                      weight: 100
                      multipath: true
                      additional_paths_send: true
                      additional_paths_receive: true
                      default_originate: true
                      default_originate_route_policy: ROUTE_POLICY_1
                      maximum_prefix_limit: 1248576
                      maximum_prefix_threshold: 80
                      maximum_prefix_warning_only: true
                      next_hop_self: true
                      route_policy_in: ROUTE_POLICY_1
                      route_policy_out: ROUTE_POLICY_1
                      cluster_id_allow_equal: true
                      route_reflector_client: true
                      soft_reconfiguration_inbound_always: true
                      update_out_originator_loopcheck: true
                      allowas_in: 3
                      as_override: true
                      accept_own: true

Example-3: BGP neighbor group with VPNv4/v6 advertise options, AIGP, SRv6, and slow peer detection.

iosxr:
  devices:
    - name: router-1
      host: 10.10.10.1:57400
      configuration:
        route_policy:
          - route_policy_name: ROUTE_POLICY_1
            rpl: |
              route-policy ROUTE_POLICY_1
                pass
              end-policy
        routing:
          bgp:
            - as_number: 65001
              bgp_router_id: 10.1.1.1
              neighbor_groups:
                - group_name: NGROUP1
                  remote_as: 65001
                  advertisement_interval_seconds: 10
                  description: "My Neighbor Group Description"
                  tcp_mss_value: 1460
                  tcp_mtu_discovery: true
                  fast_fallover: true
                  internal_vpn_client: true
                  bfd_minimum_interval: 10
                  bfd_multiplier: 4
                  bfd_fast_detect: enable
                  receive_buffer_size: 1024
                  receive_buffer_size_read: 1024
                  send_buffer_size: 4096
                  send_buffer_size_write: 4096
                  dampening: enable
                  as_override: enable
                  shutdown: false
                  timers_keepalive_interval: 10
                  timers_holdtime: 30
                  timers_holdtime_minimum_acceptable_holdtime: 30
                  local_address: 192.168.1.1
                  log_neighbor_changes: detail
                  log_message_in_size: 256
                  log_message_out_size: 256
                  update_source: Loopback0
                  session_open_mode: active-only
                  dscp: ef
                  capability_additional_paths_send: true
                  capability_additional_paths_receive: true
                  capability_suppress_all: true
                  capability_suppress_extended_nexthop_encoding: true
                  capability_suppress_four_byte_as: true
                  cluster_id: 100010
                  idle_watch_time: 240
                  allowas_in: 3
                  egress_engineering: true
                  address_family:
                    - af_name: vpnv4-unicast
                      encapsulation_type: srv6
                      weight: 100
                      multipath: true
                      additional_paths_send: true
                      additional_paths_receive: true
                      default_originate: true
                      default_originate_route_policy: ROUTE_POLICY_1
                      maximum_prefix_limit: 1248576
                      maximum_prefix_threshold: 80
                      maximum_prefix_warning_only: true
                      next_hop_self: true
                      route_policy_in: ROUTE_POLICY_1
                      route_policy_out: ROUTE_POLICY_1
                      cluster_id_allow_equal: true
                      route_reflector_client: true
                      soft_reconfiguration_inbound_always: true
                      update_out_originator_loopcheck: true
                      advertise_vpnv4_unicast: true
                      advertise_vpnv4_unicast_re_originated: true
                      advertise_vpnv4_unicast_re_originated_stitching_rt: true
                      advertise_vpnv6_unicast: true
                      advertise_vpnv6_unicast_re_originated: true
                      advertise_vpnv6_unicast_re_originated_stitching_rt: true
                      segment_routing_srv6_prefix_sid_type4: true
                      allowas_in: 3
                      as_override: true
                      aigp: true
                      aigp_send_med: true
                      aigp_send_cost_community_id: 5
                      aigp_send_cost_community_id_poi_igp_cost_transitive: true
                      accept_own: true
                      slow_peer_dynamic: true
                      slow_peer_dynamic_threshold: 260

BGP Session Group Examples

Section titled “BGP Session Group Examples”

Session groups provide reusable BGP session configuration templates that can be applied to multiple neighbors or neighbor groups through inheritance. Session groups enable consistent configuration of TCP parameters, BFD, authentication, timers, capabilities, and other session-level BGP attributes, simplifying management and ensuring uniformity across similar BGP sessions.

Example-1: Basic BGP session group with BFD, TCP settings, timers, and logging.

iosxr:
  devices:
    - name: router-1
      host: 10.10.10.1:57400
      configuration:
        routing:
          bgp:
            - as_number: 65001
              bgp_router_id: 10.1.1.1
              session_groups:
                - group_name: SGROUP1
                  remote_as: 65001
                  advertisement_interval_seconds: 10
                  advertisement_interval_milliseconds: 500
                  description: "IBGP Session Group"
                  tcp_mss_value: 1460
                  tcp_mtu_discovery: true
                  bfd_minimum_interval: 10
                  bfd_multiplier: 4
                  bfd_fast_detect: "enable"
                  receive_buffer_size: 1024
                  receive_buffer_size_read: 1024
                  send_buffer_size: 4096
                  send_buffer_size_write: 4096
                  dampening: "enable"
                  shutdown: false
                  timers_keepalive_interval: 10
                  timers_holdtime: 30
                  timers_holdtime_minimum_acceptable_holdtime: 30
                  log_neighbor_changes: detail
                  log_message_in_size: 256
                  log_message_out_size: 256
                  update_source: Loopback0

Example-2: BGP session group with BFD strict mode, capabilities, and cluster configuration.

iosxr:
  devices:
    - name: router-1
      host: 10.10.10.1:57400
      configuration:
        routing:
          bgp:
            - as_number: 65001
              bgp_router_id: 10.1.1.1
              session_groups:
                - group_name: SGROUP1
                  remote_as: 65001
                  maximum_peers: 1000
                  as_path_loopcheck_out: enable
                  advertisement_interval_seconds: 10
                  description: "IBGP Session Group"
                  bfd_minimum_interval: 10
                  bfd_multiplier: 4
                  bfd_fast_detect: strict-mode-negotiate-override
                  password_type: 7
                  password: "030752180500"
                  receive_buffer_size: 1024
                  receive_buffer_size_read: 1024
                  send_buffer_size: 4096
                  send_buffer_size_write: 4096
                  shutdown: false
                  timers_keepalive_interval: 10
                  timers_holdtime: 30
                  timers_holdtime_minimum_acceptable_holdtime: 30
                  session_open_mode: active-only
                  dscp: ef
                  capability_additional_paths_send: true
                  capability_additional_paths_receive: true
                  capability_suppress_all: true
                  capability_suppress_extended_nexthop_encoding: true
                  capability_suppress_four_byte_as: true
                  cluster_id: 100010
                  idle_watch_time: 240
                  allowas_in: 3
                  egress_engineering: true

BGP AF Group Examples

Section titled “BGP AF Group Examples”

AF groups provide a template-based approach to configure address family-specific BGP parameters that can be applied to multiple neighbors. This enables centralized management of routing policies, prefix limits, route reflection, AS path manipulation, additional paths, soft reconfiguration, encapsulation types, and advanced BGP features per address family across neighbor groups.

Example-1: BGP AF group with VPNv4 unicast address family including additional paths, default originate, route policies, and SRv6 encapsulation.

iosxr:
  devices:
    - name: router-1
      host: 10.10.10.1:57400
      configuration:
        route_policy:
          - route_policy_name: ROUTE_POLICY_1
            rpl: |
              route-policy ROUTE_POLICY_1
                pass
              end-policy
        routing:
          bgp:
            - as_number: 65001
              bgp_router_id: 10.1.1.1
              address_family:
                - af_name: vpnv4-unicast
              af_groups:
                - group_name: AFGROUP1
                  address_family:
                    - af_name: vpnv4-unicast
                      encapsulation_type: srv6
                      weight: 100
                      multipath: true
                      additional_paths_send: true
                      additional_paths_receive: true
                      default_originate: true
                      default_originate_route_policy: ROUTE_POLICY_1
                      maximum_prefix_limit: 1248576
                      maximum_prefix_threshold: 80
                      maximum_prefix_warning_only: true
                      route_policy_in: ROUTE_POLICY_1
                      route_policy_out: ROUTE_POLICY_1
                      cluster_id_allow_equal: true
                      route_reflector_client: true
                      soft_reconfiguration_inbound_always: true
                      update_out_originator_loopcheck: true
                      advertise_vpnv4_unicast: true
                      advertise_vpnv4_unicast_re_originated: true
                      advertise_vpnv4_unicast_re_originated_stitching_rt: true
                      segment_routing_srv6_prefix_sid_type4: true
                      aigp: true
                      aigp_send_med: true
                      aigp_send_cost_community_id: 5
                      aigp_send_cost_community_id_poi_igp_cost_transitive: true
                      accept_own: true
                      slow_peer_dynamic: true
                      slow_peer_dynamic_threshold: 260

Example-2: BGP AF group with VPNv6 unicast address family.

iosxr:
  devices:
    - name: router-1
      host: 10.10.10.1:57400
      configuration:
        route_policy:
          - route_policy_name: ROUTE_POLICY_1
            rpl: |
              route-policy ROUTE_POLICY_1
                pass
              end-policy
        routing:
          bgp:
            - as_number: 65001
              bgp_router_id: 10.1.1.1
              address_family:
                - af_name: vpnv6-unicast
              af_groups:
                - group_name: AFGROUP1
                  address_family:
                    - af_name: vpnv6-unicast
                      encapsulation_type: srv6
                      weight: 100
                      multipath: true
                      additional_paths_send: true
                      additional_paths_receive: true
                      default_originate: true
                      default_originate_route_policy: ROUTE_POLICY_1
                      maximum_prefix_limit: 1248576
                      maximum_prefix_threshold: 80
                      maximum_prefix_warning_only: true
                      route_policy_in: ROUTE_POLICY_1
                      route_policy_out: ROUTE_POLICY_1
                      cluster_id_allow_equal: true
                      route_reflector_client: true
                      soft_reconfiguration_inbound_always: true
                      update_out_originator_loopcheck: true
                      advertise_vpnv6_unicast: true
                      segment_routing_srv6_prefix_sid_type4: true
                      aigp: true
                      aigp_send_med: true
                      aigp_send_cost_community_id: 5
                      aigp_send_cost_community_id_poi_igp_cost_transitive: true
                      slow_peer_dynamic: true
                      slow_peer_dynamic_threshold: 260

Example-3: BGP AF group with IPv4 unicast address family for standard routing.

iosxr:
  devices:
    - name: router-1
      host: 10.10.10.1:57400
      configuration:
        route_policy:
          - route_policy_name: ROUTE_POLICY_1
            rpl: |
              route-policy ROUTE_POLICY_1
                pass
              end-policy
        routing:
          bgp:
            - as_number: 65001
              bgp_router_id: 10.1.1.1
              address_family:
                - af_name: ipv4-unicast
              af_groups:
                - group_name: AFGROUP1
                  address_family:
                    - af_name: ipv4-unicast
                      encapsulation_type: srv6
                      weight: 100
                      multipath: true
                      additional_paths_send: true
                      additional_paths_receive: true
                      default_originate: true
                      default_originate_route_policy: ROUTE_POLICY_1
                      maximum_prefix_limit: 1248576
                      maximum_prefix_threshold: 80
                      maximum_prefix_warning_only: true
                      next_hop_self: true
                      route_policy_in: ROUTE_POLICY_1
                      route_policy_out: ROUTE_POLICY_1
                      cluster_id_allow_equal: true
                      route_reflector_client: true
                      soft_reconfiguration_inbound_always: true
                      update_out_originator_loopcheck: true
                      aigp: true
                      aigp_send_med: true
                      aigp_send_cost_community_id: 5
                      aigp_send_cost_community_id_poi_igp_cost_transitive: true
                      slow_peer_dynamic: true
                      slow_peer_dynamic_threshold: 260

BGP VRF Examples

Section titled “BGP VRF Examples”

BGP VRFs allow you to create multiple isolated routing domains within a single router, enabling network segmentation and multi-tenancy. Each VRF can have independent BGP configuration including neighbors, route distinguishers, address families, and advanced features like BFD, graceful maintenance, and MPLS activation.

Example-1: Basic VRF configuration with MPLS, timers, and route distinguisher.

iosxr:
  devices:
    - name: router-1
      host: 10.10.10.1:57400
      configuration:
        routing:
          bgp:
            - as_number: 65001
              bgp_router_id: 22.22.22.22
              vrfs:
                - vrf_name: VRF1
                  rd: auto
                  mpls_activate_interfaces:
                    - interface_name: GigabitEthernet0/0/0/1
                  default_information_originate: true
                  default_metric: 125
                  socket_receive_buffer_size: 1024
                  socket_receive_buffer_size_read: 1024
                  socket_send_buffer_size: 4096
                  socket_send_buffer_size_write: 4096
                  nexthop_resolution_allow_default: true
                  timers_bgp_keepalive_interval: 0
                  timers_bgp_holddown_zero: true
                  timers_bgp_holddown_zero_minimum_acceptable_zero: true
                  bgp_router_id: 22.22.22.22
                  bgp_unsafe_ebgp_policy: true
                  bgp_bestpath_cost_community_ignore: true
                  bgp_bestpath_compare_routerid: true
                  bgp_bestpath_aigp_ignore: true
                  bgp_bestpath_igp_metric_ignore: true
                  bgp_bestpath_med_missing_as_worst: true
                  bgp_bestpath_as_path_ignore: true
                  bgp_bestpath_as_path_multipath_relax: true
                  bgp_default_local_preference: 200
                  bgp_enforce_first_as_disable: true
                  bgp_log_neighbor_changes: "disable"
                  bgp_log_message_disable: true
                  bgp_multipath_use_cluster_list_length: true
                  bgp_origin_as_validation_signal_ibgp: true
                  bfd_minimum_interval: 10
                  bfd_multiplier: 4

Example-2: VRF with neighbors including BFD, authentication, and graceful restart.

iosxr:
  devices:
    - name: router-1
      host: 10.10.10.1:57400
      configuration:
        routing:
          bgp:
            - as_number: 65001
              bgp_router_id: 22.22.22.22
              vrfs:
                - vrf_name: VRF2
                  rd: "100:100"
                  neighbors:
                    - ip: 10.1.1.2
                      remote_as: "100"
                      maximum_peers: 1000
                      as_path_loopcheck_out: enable
                      advertisement_interval_seconds: 10
                      description: My Neighbor Description
                      ignore_connected_check: true
                      ebgp_multihop_maximum_hop_count: 10
                      ebgp_multihop_mpls: true
                      tcp_mss_value: 1460
                      tcp_mtu_discovery: true
                      bfd_minimum_interval: 10
                      bfd_multiplier: 4
                      bfd_fast_detect: enable
                      local_as: 10
                      local_as_mode: no-prepend-replace-as-dual-as
                      password_type: 7
                      password: "12341C2713181F13253920"
                      receive_buffer_size: 1024
                      receive_buffer_size_read: 1024
                      send_buffer_size: 4096
                      send_buffer_size_write: 4096
                      shutdown: false
                      timers_keepalive_interval: 0
                      timers_holddown_zero: true
                      timers_holddown_zero_minimum_acceptable_holdtime: 30
                      log_neighbor_changes: detail
                      log_message_in_size: 256
                      log_message_out_size: 256
                      update_source: GigabitEthernet0/0/0/1

BGP VRF Address Family Examples

Section titled “BGP VRF Address Family Examples”

BGP VRF address families enable per-VRF routing configuration including IPv4/IPv6 unicast and multicast support. This feature provides control over routing policies, redistribution, label allocation, multipath, MVPN configuration, dampening, and advanced BGP behaviors specific to each VRF’s address family.

Example-1: Basic IPv4 unicast VRF address family with additional paths, multipath, label mode, and redistribution.

iosxr:
  devices:
    - name: router-1
      host: 10.10.10.1:57400
      configuration:
        routing:
          bgp:
            - as_number: 65001
              vrfs:
                - vrf_name: VRF1
                  rd: auto
                  address_family:
                    ipv4_unicast:
                      additional_paths_send: true
                      additional_paths_receive: true
                      maximum_paths_eibgp_multipath: 10
                      maximum_paths_eibgp_selective: true
                      allow_vpn_default_originate: true
                      allocate_label_all: true
                      label_mode: per-vrf
                      redistribute_connected: true

Example-2: IPv6 unicast VRF address family with label allocation, multipath, redistribution, and route aggregation.

iosxr:
  devices:
    - name: router-1
      host: 10.10.10.1:57400
      configuration:
        route_policy:
          - route_policy_name: POLICY_IN
            rpl: |
              route-policy POLICY_IN
                pass
              end-policy
        routing:
          bgp:
            - as_number: 65001
              vrfs:
                - vrf_name: VRF1
                  rd: "100:100"
                  address_family:
                    ipv6_unicast:
                      additional_paths_send: true
                      additional_paths_receive: true
                      maximum_paths_eibgp_multipath: 10
                      maximum_paths_eibgp_selective: true
                      label_mode: per-vrf
                      redistribute_connected: true
                      redistribute_connected_metric: 100
                      redistribute_connected_route_policy: POLICY_IN
                      redistribute_static: true
                      redistribute_static_metric: 200
                      redistribute_static_route_policy: POLICY_IN
                      aggregate_addresses:
                        - address: "2001:db8:100:100::"
                          mask: 64
                          as_set: true
                          summary_only: true
                          route_policy: POLICY_IN

Example-3: IPv4 multicast VRF address family with MVPN single forwarder selection, distance BGP, and redistribution configuration.

iosxr:
  devices:
    - name: router-1
      host: 10.10.10.1:57400
      configuration:
        routing:
          bgp:
            - as_number: 65001
              vrfs:
                - vrf_name: VRF1
                  rd: "65536:100"
                  address_family:
                    ipv4_multicast:
                      distance_bgp_external_route: 200
                      distance_bgp_internal_route: 190
                      distance_bgp_local_route: 195
                      mvpn_single_forwarder_selection: all
                      maximum_paths_ebgp_multipath: 10
                      maximum_paths_ebgp_selective: true
                      redistribute_connected: true
                      redistribute_static: true

Example-4: IPv6 multicast VRF address family with MVPN and BGP dampening.

iosxr:
  devices:
    - name: router-1
      host: 10.10.10.1:57400
      configuration:
        route_policy:
          - route_policy_name: POLICY_IN
            rpl: |
              route-policy POLICY_IN
                pass
              end-policy
        routing:
          bgp:
            - as_number: 65001
              vrfs:
                - vrf_name: VRF1
                  rd: "10.10.10.3:100"
                  address_family:
                    ipv6_multicast:
                      distance_bgp_external_route: 200
                      distance_bgp_internal_route: 190
                      distance_bgp_local_route: 195
                      mvpn_single_forwarder_selection: highest-ip-address
                      maximum_paths_ebgp_multipath: 10
                      maximum_paths_ebgp_selective: true
                      redistribute_connected: true
                      bgp_dampening_decay_half_life: 10
                      bgp_dampening_reuse_threshold: 20
                      bgp_dampening_suppress_threshold: 30
                      bgp_dampening_max_suppress_time: 40

BGP VRF Neighbor Address Family Examples

Section titled “BGP VRF Neighbor Address Family Examples”

VRF per-neighbor address family configuration within BGP VRFs including IPv4/IPv6 unicast, multicast, and other address families. It provides granular control over VRF neighbor-specific routing policies, prefix limits, route reflection, AS path manipulation, additional paths, soft reconfiguration, site-of-origin, and other BGP features per address family.

Example-1: BGP VRF neighbor with IPv4 and IPv6 unicast address families using two-byte AS number for site-of-origin.

iosxr:
  devices:
    - name: router-1
      host: 10.10.10.1:57400
      configuration:
        route_policy:
          - route_policy_name: POLICY_IN
            rpl: |
              route-policy POLICY_IN
                pass
              end-policy
          - route_policy_name: POLICY_OUT
            rpl: |
              route-policy POLICY_OUT
                pass
              end-policy
        routing:
          bgp:
            - as_number: 65001
              bgp_router_id: 10.1.1.1
              vrfs:
                - vrf_name: VRF1
                  neighbors:
                    - ip: 10.1.1.2
                      remote_as: 65002
                      description: "VRF neighbor with two-byte AS site-of-origin"
                      address_family:
                        - af_name: ipv4-unicast
                          additional_paths_send: true
                          additional_paths_receive: true
                          default_originate: true
                          default_originate_route_policy: POLICY_IN
                          maximum_prefix_limit: 1000
                          maximum_prefix_threshold: 50
                          maximum_prefix_restart: 100
                          next_hop_self: true
                          route_policy_in: POLICY_IN
                          route_policy_out: POLICY_OUT
                          orf_route_policy: POLICY_IN
                          remove_private_as: true
                          soft_reconfiguration_inbound_always: true
                          update_out_originator_loopcheck: true
                          as_override: true
                          aigp_send_cost_community_id: 1
                          aigp_send_cost_community_id_poi_pre_bestpath_transitive: true
                          site_of_origin: "100:100"
                        - af_name: ipv6-unicast
                          additional_paths_send: true
                          additional_paths_receive: true
                          default_originate: true
                          default_originate_route_policy: POLICY_IN
                          maximum_prefix_limit: 1000
                          maximum_prefix_threshold: 50
                          maximum_prefix_restart: 100
                          next_hop_self: true
                          route_policy_in: POLICY_IN
                          route_policy_out: POLICY_OUT
                          orf_route_policy: POLICY_IN
                          remove_private_as: true
                          soft_reconfiguration_inbound_always: true
                          update_out_originator_loopcheck: true
                          as_override: true
                          aigp_send_cost_community_id: 1
                          aigp_send_cost_community_id_poi_pre_bestpath_transitive: true
                          site_of_origin: "100:100"

Example-2: BGP VRF neighbor with IPv4 and IPv6 unicast address families using four-byte AS number for site-of-origin.

iosxr:
  devices:
    - name: router-1
      host: 10.10.10.1:57400
      configuration:
        route_policy:
          - route_policy_name: POLICY_IN
            rpl: |
              route-policy POLICY_IN
                pass
              end-policy
          - route_policy_name: POLICY_OUT
            rpl: |
              route-policy POLICY_OUT
                pass
              end-policy
        routing:
          bgp:
            - as_number: 65001
              bgp_router_id: 10.1.1.1
              vrfs:
                - vrf_name: VRF2
                  neighbors:
                    - ip: 10.1.1.3
                      remote_as: 65003
                      description: "VRF neighbor with four-byte AS site-of-origin"
                      address_family:
                        - af_name: ipv4-unicast
                          additional_paths_send: true
                          additional_paths_receive: true
                          default_originate: true
                          default_originate_route_policy: POLICY_IN
                          maximum_prefix_limit: 1000
                          maximum_prefix_threshold: 50
                          maximum_prefix_restart: 100
                          next_hop_self: true
                          route_policy_in: POLICY_IN
                          route_policy_out: POLICY_OUT
                          orf_route_policy: POLICY_IN
                          remove_private_as: true
                          soft_reconfiguration_inbound_always: true
                          update_out_originator_loopcheck: true
                          as_override: true
                          aigp_send_cost_community_id: 1
                          aigp_send_cost_community_id_poi_pre_bestpath_transitive: true
                          site_of_origin: "65536:100"
                        - af_name: ipv6-unicast
                          additional_paths_send: true
                          additional_paths_receive: true
                          default_originate: true
                          default_originate_route_policy: POLICY_IN
                          maximum_prefix_limit: 1000
                          maximum_prefix_threshold: 50
                          maximum_prefix_restart: 100
                          next_hop_self: true
                          route_policy_in: POLICY_IN
                          route_policy_out: POLICY_OUT
                          orf_route_policy: POLICY_IN
                          remove_private_as: true
                          soft_reconfiguration_inbound_always: true
                          update_out_originator_loopcheck: true
                          as_override: true
                          aigp_send_cost_community_id: 1
                          aigp_send_cost_community_id_poi_pre_bestpath_transitive: true
                          site_of_origin: "65536:100"