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

Classes

iosxr

Name	Type	Constraint	Mandatory
devices	List	devices	No
device_groups	List	device_groups	No
global	Class	global	No

devices (iosxr)

Name	Type	Constraint	Mandatory	Default Value
configuration	Class	configuration	No

device_groups (iosxr)

Name	Type	Constraint	Mandatory	Default Value
configuration	Class	configuration	No

global (iosxr)

Name	Type	Constraint	Mandatory	Default Value
configuration	Class	configuration	No

configuration (iosxr.devices)

Name	Type	Constraint	Mandatory	Default Value
routing	Class	routing	No

routing (iosxr.devices.configuration)

Name	Type	Constraint	Mandatory	Default Value
bgp	List	bgp	No

bgp (iosxr.devices.configuration.routing)

Name	Type	Constraint	Mandatory
as_number	Any	String or Integer[min: `1`, max: `4294967295`] or String[Regex: `^.[\$\%]\{.$`]	Yes
default_metric	Integer	min: `1`, max: `4294967295`	No
mvpn	Boolean	`true`, `false`	No
segment_routing_srv6	Class	segment_routing_srv6	No
neighbors	List	neighbors	No
graceful_maintenance_activate	Class	graceful_maintenance_activate	No
mpls_activate_interfaces	List	mpls_activate_interfaces	No
as_league_peers	List	as_league_peers	No
attribute_filter_groups	List	attribute_filter_groups	No
as_lists	List	as_lists	No
default_information_originate	Boolean	`true`, `false`	No
socket_receive_buffer_size	Integer	min: `512`, max: `131072`	No
socket_receive_buffer_read_size	Integer	min: `512`, max: `131072`	No
socket_send_buffer_size	Integer	min: `4096`, max: `131072`	No
socket_send_buffer_write_size	Integer	min: `4096`, max: `131072`	No
nexthop_mpls_forwarding_ibgp	Boolean	`true`, `false`	No
nexthop_validation_color_extcomm	Choice	`sr-policy`, `disable`	No
nexthop_resolution_allow_default	Boolean	`true`, `false`	No
nexthop_srte_metric_disable	Boolean	`true`, `false`	No
slow_peer_dynamic	Boolean	`true`, `false`	No
slow_peer_dynamic_threshold	Integer	min: `120`, max: `3600`	No
slow_peer_detection_disable	Boolean	`true`, `false`	No
bgp_redistribute_internal	Boolean	`true`, `false`	No
bgp_router_id	String		No
bgp_unsafe_ebgp_policy	Boolean	`true`, `false`	No
bgp_scan_time	Integer	min: `5`, max: `3600`	No
bgp_read_only	Boolean	`true`, `false`	No
bgp_lpts_secure_binding	Boolean	`true`, `false`	No
bgp_as_path_loopcheck	Boolean	`true`, `false`	No
bgp_auto_policy_soft_reset_disable	Boolean	`true`, `false`	No
bgp_bestpath_cost_community_ignore	Boolean	`true`, `false`	No
bgp_bestpath_compare_routerid	Boolean	`true`, `false`	No
bgp_bestpath_aigp_ignore	Boolean	`true`, `false`	No
bgp_bestpath_igp_metric_ignore	Boolean	`true`, `false`	No
bgp_bestpath_igp_metric_sr_policy	Boolean	`true`, `false`	No
bgp_bestpath_med_missing_as_worst	Boolean	`true`, `false`	No
bgp_bestpath_med_always	Boolean	`true`, `false`	No
bgp_bestpath_as_path_ignore	Boolean	`true`, `false`	No
bgp_bestpath_as_path_multipath_relax	Boolean	`true`, `false`	No
bgp_bestpath_origin_as_use_validity	Boolean	`true`, `false`	No
bgp_bestpath_origin_as_allow_invalid	Boolean	`true`, `false`	No
bgp_bestpath_sr_policy	Choice	`prefer`, `force`	No
bgp_cluster_id	Any	Integer[min: `1`, max: `4294967295`] or String or String[Regex: `^.[\$\%]\{.$`]	No
bgp_default_local_preference	Integer	min: `0`, max: `4294967295`	No
bgp_enforce_first_as_disable	Boolean	`true`, `false`	No
bgp_fast_external_fallover_disable	Boolean	`true`, `false`	No
bgp_log_neighbor_changes	Choice	`detail`, `disable`	No
bgp_log_message_disable	Boolean	`true`, `false`	No
bgp_log_memory_threshold_warning	Integer	min: `1`, max: `100`	No
bgp_log_memory_threshold_critical	Integer	min: `1`, max: `100`	No
bgp_log_total_paths	Integer	min: `1`, max: `2147483647`	No
bgp_log_total_paths_warn_threshold	Integer	min: `1`, max: `100`	No
bgp_multipath_use_cluster_list_length	Boolean	`true`, `false`	No
bgp_multipath_as_path_ignore_onwards	Boolean	`true`, `false`	No
bgp_confederation_identifier	Any	String or Integer[min: `1`, max: `4294967295`] or String[Regex: `^.[\$\%]\{.$`]	No
bgp_confederation_peers	List	bgp_confederation_peers	No
bgp_graceful_restart_enable	Boolean	`true`, `false`	No
bgp_graceful_restart_purge_time	Integer	min: `0`, max: `6000`	No
bgp_graceful_restart_restart_time	Integer	min: `1`, max: `4095`	No
bgp_graceful_restart_stalepath_time	Integer	min: `1`, max: `4095`	No
bgp_graceful_restart_graceful_reset	Boolean	`true`, `false`	No
bgp_graceful_restart_retain_nbr_routes_disable	Boolean	`true`, `false`	No
bgp_install_diversion	Boolean	`true`, `false`	No
bgp_update_delay	Integer	min: `0`, max: `3600`	No
bgp_update_delay_always	Boolean	`true`, `false`	No
bgp_maximum_neighbor	Integer	min: `1`, max: `15000`	No
bgp_origin_as_validation_signal_ibgp	Boolean	`true`, `false`	No
bgp_origin_as_validation_time	Any	Integer[min: `5`, max: `60`] or Choice[`off`] or String[Regex: `^.[\$\%]\{.$`]	No
timers_bgp_keepalive_interval	Integer	min: `0`, max: `65535`	No
timers_bgp_holddown_zero	Boolean	`true`, `false`	No
timers_bgp_holddown_zero_minimum_acceptable_zero	Boolean	`true`, `false`	No
timers_bgp_holddown_zero_minimum_acceptable_holdtime	Integer	min: `3`, max: `65535`	No
timers_bgp_holdtime	Integer	min: `3`, max: `65535`	No
timers_bgp_holdtime_minimum_acceptable_holdtime	Integer	min: `3`, max: `65535`	No
nsr	Choice	`enable`, `disable`	No
ibgp_policy_out_enforce_modifications	Boolean	`true`, `false`	No
openconfig_rib_telemetry	Boolean	`true`, `false`	No
update_limit	Integer	min: `16`, max: `2048`	No
update_in_error_handling_basic_ebgp_disable	Boolean	`true`, `false`	No
update_in_error_handling_basic_ibgp_disable	Boolean	`true`, `false`	No
update_in_error_handling_extended_ebgp	Boolean	`true`, `false`	No
update_in_error_handling_extended_ibgp	Boolean	`true`, `false`	No
update_out_logging	Boolean	`true`, `false`	No
bfd_multiplier	Integer	min: `2`, max: `16`	No
bfd_minimum_interval	Integer	min: `3`, max: `30000`	No
rpki_routes	List	rpki_routes	No
rpki_servers	List	rpki_servers	No
address_family	Class	address_family	No
neighbor_groups	List	neighbor_groups	No
session_groups	List	session_groups	No
af_groups	List	af_groups	No
vrfs	List	vrfs	No

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

Name	Type	Constraint	Mandatory	Default Value
locator	String		No
usid_allocation_wide_local_id_block	Boolean	`true`, `false`	No

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

Name	Type	Constraint	Mandatory
address	IP		Yes
remote_as	Any	String or Integer[min: `1`, max: `4294967295`] or String[Regex: `^.[\$\%]\{.$`]	No
maximum_peers	Integer	min: `1`, max: `4095`	No
remote_as_list	String		No
as_path_loopcheck_out	Choice	`disable`, `enable`	No
use_neighbor_group	String		No
use_session_group	String		No
advertisement_interval_seconds	Integer	min: `0`, max: `600`	No
advertisement_interval_milliseconds	Integer	min: `0`, max: `999`	No
description	String		No
ignore_connected_check	Boolean	`true`, `false`	No
ignore_connected_check_inheritance_disable	Boolean	`true`, `false`	No
ebgp_multihop_maximum_hop_count	Integer	min: `1`, max: `255`	No
ebgp_multihop_mpls	Boolean	`true`, `false`	No
tcp_mss	Integer	min: `68`, max: `10000`	No
tcp_mss_inheritance_disable	Boolean	`true`, `false`	No
tcp_mtu_discovery	Boolean	`true`, `false`	No
tcp_mtu_discovery_inheritance_disable	Boolean	`true`, `false`	No
tcp_ip_only_preferred	Boolean	`true`, `false`	No
tcp_ip_only_preferred_inheritance_disable	Boolean	`true`, `false`	No
bmp_activate_servers	List	bmp_activate_servers	No
bfd_minimum_interval	Integer	min: `3`, max: `30000`	No
bfd_multiplier	Integer	min: `2`, max: `16`	No
bfd_fast_detect	Choice	`enable`, `strict-mode`, `disable`, `strict-mode-negotiate`, `strict-mode-negotiate-override`	No
keychain	String	min: `1`, max: `32`	No
keychain_inheritance_disable	Boolean	`true`, `false`	No
local_as_inheritance_disable	Boolean	`true`, `false`	No
local_as	Any	String or Integer[min: `1`, max: `4294967295`] or String[Regex: `^.[\$\%]\{.$`]	No
local_as_mode	Choice	`no-prepend`, `no-prepend-replace-as`, `no-prepend-replace-as-dual-as`	No
password_type	Choice	`7`	No
password	String		No
password_inheritance_disable	Boolean	`true`, `false`	No
receive_buffer_size	Integer	min: `512`, max: `131072`	No
receive_buffer_read_size	Integer	min: `512`, max: `131072`	No
send_buffer_size	Integer	min: `4096`, max: `131072`	No
send_buffer_write_size	Integer	min: `4096`, max: `131072`	No
fast_fallover	Boolean	`true`, `false`	No
fast_fallover_inheritance_disable	Boolean	`true`, `false`	No
shutdown	Boolean	`true`, `false`	No
timers_keepalive_interval	Integer	min: `0`, max: `65535`	No
timers_holddown_zero	Boolean	`true`, `false`	No
timers_holddown_zero_minimum_acceptable_zero	Boolean	`true`, `false`	No
timers_holddown_zero_minimum_acceptable_holdtime	Integer	min: `3`, max: `65535`	No
timers_holdtime	Integer	min: `3`, max: `65535`	No
timers_holdtime_minimum_acceptable_holdtime	Integer	min: `3`, max: `65535`	No
local_address	String		No
local_address_inheritance_disable	Boolean	`true`, `false`	No
log_neighbor_changes	Choice	`detail`, `disable`, `inheritance-disable`	No
log_message_in	Integer	min: `1`, max: `500`	No
log_message_in_disable	Boolean	`true`, `false`	No
log_message_in_inheritance_disable	Boolean	`true`, `false`	No
log_message_out	Integer	min: `1`, max: `500`	No
log_message_out_disable	Boolean	`true`, `false`	No
log_message_out_inheritance_disable	Boolean	`true`, `false`	No
update_source	String		No
local_address_subnet_prefix	String		No
local_address_subnet_length	Integer	min: `0`, max: `128`	No
dmz_link_bandwidth	Boolean	`true`, `false`	No
dmz_link_bandwidth_inheritance_disable	Boolean	`true`, `false`	No
ebgp_recv_extcommunity_dmz	Boolean	`true`, `false`	No
ebgp_recv_extcommunity_dmz_inheritance_disable	Boolean	`true`, `false`	No
ebgp_send_extcommunity_dmz	Boolean	`true`, `false`	No
ebgp_send_extcommunity_dmz_cumulative	Boolean	`true`, `false`	No
ebgp_send_extcommunity_dmz_inheritance_disable	Boolean	`true`, `false`	No
ttl_security	Boolean	`true`, `false`	No
ttl_security_inheritance_disable	Boolean	`true`, `false`	No
session_open_mode	Choice	`active-only`, `passive-only`, `both`	No
dscp	Any	Integer[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
precedence	Any	Integer[min: `0`, max: `7`] or Choice[`critical`, `flash`, `flash-override`, `immediate`, `internet`, `network`, `priority`, `routine`] or String[Regex: `^.[\$\%]\{.$`]	No
capability_additional_paths_send	Boolean	`true`, `false`	No
capability_additional_paths_send_disable	Boolean	`true`, `false`	No
capability_additional_paths_receive	Boolean	`true`, `false`	No
capability_additional_paths_receive_disable	Boolean	`true`, `false`	No
capability_suppress_all	Boolean	`true`, `false`	No
capability_suppress_all_inheritance_disable	Boolean	`true`, `false`	No
capability_suppress_extended_nexthop_encoding	Boolean	`true`, `false`	No
capability_suppress_extended_nexthop_encoding_inheritance_disable	Boolean	`true`, `false`	No
capability_suppress_four_byte_as	Boolean	`true`, `false`	No
capability_suppress_four_byte_as_inheritance_disable	Boolean	`true`, `false`	No
graceful_restart	Choice	`enable`, `disable`	No
graceful_restart_helper_only	Boolean	`true`, `false`	No
graceful_restart_helper_only_inheritance_disable	Boolean	`true`, `false`	No
graceful_restart_restart_time	Integer	min: `1`, max: `4095`	No
graceful_restart_stalepath_time	Integer	min: `0`, max: `4095`	No
enforce_first_as	Choice	`enable`, `disable`	No
cluster_id	Any	Integer[min: `1`, max: `4294967295`] or String or String[Regex: `^.[\$\%]\{.$`]	No
idle_watch_time	Integer	min: `30`, max: `1800`	No
allowas_in	Integer	min: `1`, max: `10`	No
egress_engineering	Boolean	`true`, `false`	No
egress_engineering_inheritance_disable	Boolean	`true`, `false`	No
evpn_link_bandwidth	Boolean	`true`, `false`	No
evpn_link_bandwidth_per_path_number	Integer	min: `1`, max: `65535`	No
evpn_link_bandwidth_inheritance_disable	Boolean	`true`, `false`	No
peer_sets	List	peer_sets	No
peer_node_sid_index	Integer	min: `0`, max: `1033575`	No
ao_key_chain	String	min: `1`, max: `32`	No
ao_key_chain_include_tcp_options	Choice	`disable`, `enable`	No
ao_key_chain_accept_mismatch	Boolean	`true`, `false`	No
ao_inheritance_disable	Boolean	`true`, `false`	No
dampening	Choice	`enable`, `disable`	No
as_override	Choice	`enable`, `disable`	No
default_policy_action_in	Choice	`accept`, `reject`	No
default_policy_action_out	Choice	`accept`, `reject`	No
origin_as_validation_disable	Boolean	`true`, `false`	No
send_extended_community_ebgp	Boolean	`true`, `false`	No
send_extended_community_ebgp_inheritance_disable	Boolean	`true`, `false`	No
bestpath_origin_as_allow_invalid	Boolean	`true`, `false`	No
update_in_filtering_message_buffers	Integer	min: `0`, max: `25`	No
update_in_filtering_message_buffers_type	Choice	`buffers-number-enable`, `non-circular`	No
update_in_filtering_logging_disable	Boolean	`true`, `false`	No
update_in_filtering_attribute_filter_group	String		No
update_in_labeled_unicast_equivalent	Boolean	`true`, `false`	No
update_in_labeled_unicast_equivalent_inheritance_disable	Boolean	`true`, `false`	No
update_in_error_handling_avoid_reset	Choice	`disable`, `enable`	No
update_in_error_handling_treat_as_withdraw	Choice	`disable`, `enable`	No
graceful_maintenance	Class	graceful_maintenance	No
address_family	List	address_family	No

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

Name	Type	Constraint	Mandatory
all_neighbors	Boolean	`true`, `false`	No
retain_routes	Boolean	`true`, `false`	No
interfaces	List	interfaces	No
locations	List	locations	No

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

Name	Type	Constraint	Mandatory	Default Value
name	String		Yes

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

Name	Type	Constraint	Mandatory	Default Value
as_number	Any	String or Integer[min: `1`, max: `4294967295`] or String[Regex: `^.[\$\%]\{.$`]	Yes

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

Name	Type	Constraint	Mandatory	Default Value
name	String		Yes
code_ranges	List	code_ranges	No

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

Name	Type	Constraint	Mandatory	Default Value
name	String		Yes
asns	List	asns	No

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

Name	Type	Constraint	Mandatory	Default Value
as_number	Any	String or Integer[min: `1`, max: `4294967295`] or String[Regex: `^.[\$\%]\{.$`]	Yes

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

Name	Type	Constraint	Mandatory
prefix	String		Yes
length	Integer	min: `1`, max: `128`	Yes
max_length	Integer	min: `1`, max: `128`	Yes
origin_as	Integer	min: `1`, max: `4294967295`	Yes

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

Name	Type	Constraint	Mandatory
address	String		Yes
refresh_time	Integer	min: `15`, max: `3600`	No
refresh_time_off	Boolean	`true`, `false`	No
response_time	Integer	min: `15`, max: `3600`	No
response_time_off	Boolean	`true`, `false`	No
purge_time	Integer	min: `30`, max: `65535`	No
username	String		No
password_type	Choice	`7`	No
password	String		No
transport_tcp_port	Integer	min: `1`, max: `65535`	No
transport_ssh_port	Integer	min: `1`, max: `65535`	No
bind_source_interface	String		No
shutdown	Boolean	`true`, `false`	No

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

Name	Type	Constraint	Mandatory
ipv4_unicast	Class	ipv4_unicast	No
ipv6_unicast	Class	ipv6_unicast	No
vpnv4_unicast	Class	vpnv4_unicast	No
vpnv6_unicast	Class	vpnv6_unicast	No
vpnv4_multicast	Class	vpnv4_multicast	No
vpnv6_multicast	Class	vpnv6_multicast	No
l2vpn_evpn	Class	l2vpn_evpn	No

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

Name	Type	Constraint	Mandatory
name	String		Yes
remote_as	Any	String or Integer[min: `1`, max: `4294967295`] or String[Regex: `^.[\$\%]\{.$`]	No
remote_as_list	String		No
maximum_peers	Integer	min: `1`, max: `4095`	No
as_path_loopcheck_out	Choice	`disable`, `enable`	No
use_neighbor_group	String		No
use_session_group	String		No
advertisement_interval_seconds	Integer	min: `0`, max: `600`	No
advertisement_interval_milliseconds	Integer	min: `0`, max: `999`	No
description	String		No
ignore_connected_check	Boolean	`true`, `false`	No
ignore_connected_check_inheritance_disable	Boolean	`true`, `false`	No
ebgp_multihop_maximum_hop_count	Integer	min: `1`, max: `255`	No
ebgp_multihop_mpls	Boolean	`true`, `false`	No
tcp_mss	Integer	min: `68`, max: `10000`	No
tcp_mss_inheritance_disable	Boolean	`true`, `false`	No
tcp_mtu_discovery	Boolean	`true`, `false`	No
tcp_mtu_discovery_inheritance_disable	Boolean	`true`, `false`	No
tcp_ip_only_preferred	Boolean	`true`, `false`	No
tcp_ip_only_preferred_inheritance_disable	Boolean	`true`, `false`	No
fast_fallover	Boolean	`true`, `false`	No
fast_fallover_inheritance_disable	Boolean	`true`, `false`	No
internal_vpn_client	Boolean	`true`, `false`	No
bmp_activate_servers	List	bmp_activate_servers	No
bfd_minimum_interval	Integer	min: `3`, max: `30000`	No
bfd_multiplier	Integer	min: `2`, max: `16`	No
bfd_fast_detect	Choice	`enable`, `strict-mode`, `disable`, `strict-mode-negotiate`, `strict-mode-negotiate-override`	No
keychain	String	min: `1`, max: `32`	No
keychain_inheritance_disable	Boolean	`true`, `false`	No
local_as_inheritance_disable	Boolean	`true`, `false`	No
local_as	Any	String or Integer[min: `1`, max: `4294967295`] or String[Regex: `^.[\$\%]\{.$`]	No
local_as_mode	Choice	`no-prepend`, `no-prepend-replace-as`, `no-prepend-replace-as-dual-as`	No
password_type	Choice	`7`	No
password	String		No
password_inheritance_disable	Boolean	`true`, `false`	No
receive_buffer_size	Integer	min: `512`, max: `131072`	No
receive_buffer_read_size	Integer	min: `512`, max: `131072`	No
send_buffer_size	Integer	min: `4096`, max: `131072`	No
send_buffer_write_size	Integer	min: `4096`, max: `131072`	No
dampening	Choice	`enable`, `disable`	No
as_override	Choice	`enable`, `disable`	No
shutdown	Boolean	`true`, `false`	No
timers_keepalive_interval	Integer	min: `0`, max: `65535`	No
timers_holddown_zero	Boolean	`true`, `false`	No
timers_holddown_zero_minimum_acceptable_zero	Boolean	`true`, `false`	No
timers_holddown_zero_minimum_acceptable_holdtime	Integer	min: `3`, max: `65535`	No
timers_holdtime	Integer	min: `3`, max: `65535`	No
timers_holdtime_minimum_acceptable_holdtime	Integer	min: `3`, max: `65535`	No
local_address	String		No
local_address_inheritance_disable	Boolean	`true`, `false`	No
log_neighbor_changes	Choice	`detail`, `disable`, `inheritance-disable`	No
log_message_in	Integer	min: `1`, max: `500`	No
log_message_in_disable	Boolean	`true`, `false`	No
log_message_in_inheritance_disable	Boolean	`true`, `false`	No
log_message_out	Integer	min: `1`, max: `500`	No
log_message_out_disable	Boolean	`true`, `false`	No
log_message_out_inheritance_disable	Boolean	`true`, `false`	No
update_source	String		No
local_address_subnet_prefix	String		No
local_address_subnet_length	Integer	min: `0`, max: `128`	No
dmz_link_bandwidth	Boolean	`true`, `false`	No
dmz_link_bandwidth_inheritance_disable	Boolean	`true`, `false`	No
ebgp_recv_extcommunity_dmz	Boolean	`true`, `false`	No
ebgp_recv_extcommunity_dmz_inheritance_disable	Boolean	`true`, `false`	No
ebgp_send_extcommunity_dmz	Boolean	`true`, `false`	No
ebgp_send_extcommunity_dmz_cumulative	Boolean	`true`, `false`	No
ebgp_send_extcommunity_dmz_inheritance_disable	Boolean	`true`, `false`	No
ttl_security	Boolean	`true`, `false`	No
ttl_security_inheritance_disable	Boolean	`true`, `false`	No
session_open_mode	Choice	`active-only`, `passive-only`, `both`	No
dscp	Any	Integer[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
precedence	Any	Integer[min: `0`, max: `7`] or Choice[`critical`, `flash`, `flash-override`, `immediate`, `internet`, `network`, `priority`, `routine`] or String[Regex: `^.[\$\%]\{.$`]	No
capability_additional_paths_send	Boolean	`true`, `false`	No
capability_additional_paths_send_disable	Boolean	`true`, `false`	No
capability_additional_paths_receive	Boolean	`true`, `false`	No
capability_additional_paths_receive_disable	Boolean	`true`, `false`	No
capability_suppress_all	Boolean	`true`, `false`	No
capability_suppress_all_inheritance_disable	Boolean	`true`, `false`	No
capability_suppress_extended_nexthop_encoding	Boolean	`true`, `false`	No
capability_suppress_extended_nexthop_encoding_inheritance_disable	Boolean	`true`, `false`	No
capability_suppress_four_byte_as	Boolean	`true`, `false`	No
capability_suppress_four_byte_as_inheritance_disable	Boolean	`true`, `false`	No
graceful_restart	Choice	`enable`, `disable`	No
graceful_restart_helper_only	Boolean	`true`, `false`	No
graceful_restart_helper_only_inheritance_disable	Boolean	`true`, `false`	No
graceful_restart_restart_time	Integer	min: `1`, max: `4095`	No
graceful_restart_stalepath_time	Integer	min: `0`, max: `4095`	No
enforce_first_as	Choice	`enable`, `disable`	No
cluster_id	Any	Integer[min: `1`, max: `4294967295`] or String or String[Regex: `^.[\$\%]\{.$`]	No
idle_watch_time	Integer	min: `30`, max: `1800`	No
allowas_in	Integer	min: `1`, max: `10`	No
egress_engineering	Boolean	`true`, `false`	No
egress_engineering_inheritance_disable	Boolean	`true`, `false`	No
peer_sets	List	peer_sets	No
ao_key_chain	String	min: `1`, max: `32`	No
ao_key_chain_include_tcp_options	Choice	`disable`, `enable`	No
ao_key_chain_accept_mismatch	Boolean	`true`, `false`	No
ao_inheritance_disable	Boolean	`true`, `false`	No
default_policy_action_in	Choice	`accept`, `reject`	No
default_policy_action_out	Choice	`accept`, `reject`	No
update_in_filtering_message_buffers	Integer	min: `0`, max: `25`	No
update_in_filtering_message_buffers_type	Choice	`buffers-number-enable`, `non-circular`	No
update_in_filtering_logging_disable	Boolean	`true`, `false`	No
update_in_filtering_attribute_filter_group	String		No
update_in_labeled_unicast_equivalent	Boolean	`true`, `false`	No
update_in_labeled_unicast_equivalent_inheritance_disable	Boolean	`true`, `false`	No
update_in_error_handling_avoid_reset	Choice	`disable`, `enable`	No
update_in_error_handling_treat_as_withdraw	Choice	`disable`, `enable`	No
graceful_maintenance	Class	graceful_maintenance	No
address_family	List	address_family	No

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

Name	Type	Constraint	Mandatory
name	String		Yes
remote_as	Any	String or Integer[min: `1`, max: `4294967295`] or String[Regex: `^.[\$\%]\{.$`]	No
remote_as_list	String		No
maximum_peers	Integer	min: `1`, max: `4095`	No
send_community_ebgp	Boolean	`true`, `false`	No
send_community_ebgp_inheritance_disable	Boolean	`true`, `false`	No
send_extended_community_ebgp	Boolean	`true`, `false`	No
send_extended_community_ebgp_inheritance_disable	Boolean	`true`, `false`	No
as_path_loopcheck_out	Choice	`disable`, `enable`	No
dampening	Choice	`disable`, `enable`	No
as_override	Choice	`disable`, `enable`	No
use_session_group	String		No
advertisement_interval_seconds	Integer	min: `0`, max: `600`	No
advertisement_interval_milliseconds	Integer	min: `0`, max: `999`	No
description	String		No
ignore_connected_check	Boolean	`true`, `false`	No
ignore_connected_check_inheritance_disable	Boolean	`true`, `false`	No
internal_vpn_client	Boolean	`true`, `false`	No
ebgp_multihop_maximum_hop_count	Integer	min: `1`, max: `255`	No
ebgp_multihop_mpls	Boolean	`true`, `false`	No
tcp_mss	Integer	min: `68`, max: `10000`	No
tcp_mss_inheritance_disable	Boolean	`true`, `false`	No
tcp_mtu_discovery	Boolean	`true`, `false`	No
tcp_mtu_discovery_inheritance_disable	Boolean	`true`, `false`	No
tcp_ip_only_preferred	Boolean	`true`, `false`	No
tcp_ip_only_preferred_inheritance_disable	Boolean	`true`, `false`	No
bmp_activate_servers	List	bmp_activate_servers	No
bfd_minimum_interval	Integer	min: `3`, max: `30000`	No
bfd_multiplier	Integer	min: `2`, max: `16`	No
bfd_fast_detect	Choice	`enable`, `strict-mode`, `disable`, `strict-mode-negotiate`, `strict-mode-negotiate-override`	No
keychain	String	min: `1`, max: `32`	No
keychain_inheritance_disable	Boolean	`true`, `false`	No
local_as_inheritance_disable	Boolean	`true`, `false`	No
local_as	Any	String or Integer[min: `1`, max: `4294967295`] or String[Regex: `^.[\$\%]\{.$`]	No
local_as_mode	Choice	`no-prepend`, `no-prepend-replace-as`, `no-prepend-replace-as-dual-as`	No
password_type	Choice	`7`	No
password	String		No
password_inheritance_disable	Boolean	`true`, `false`	No
receive_buffer_size	Integer	min: `512`, max: `131072`	No
receive_buffer_read_size	Integer	min: `512`, max: `131072`	No
send_buffer_size	Integer	min: `4096`, max: `131072`	No
send_buffer_write_size	Integer	min: `4096`, max: `131072`	No
shutdown	Boolean	`true`, `false`	No
timers_keepalive_interval	Integer	min: `0`, max: `65535`	No
timers_holddown_zero	Boolean	`true`, `false`	No
timers_holddown_zero_minimum_acceptable_zero	Boolean	`true`, `false`	No
timers_holddown_zero_minimum_acceptable_holdtime	Integer	min: `3`, max: `65535`	No
timers_holdtime	Integer	min: `3`, max: `65535`	No
timers_holdtime_minimum_acceptable_holdtime	Integer	min: `3`, max: `65535`	No
local_address	String		No
local_address_inheritance_disable	Boolean	`true`, `false`	No
log_neighbor_changes	Choice	`detail`, `disable`, `inheritance-disable`	No
log_message_in	Integer	min: `1`, max: `500`	No
log_message_in_disable	Boolean	`true`, `false`	No
log_message_in_inheritance_disable	Boolean	`true`, `false`	No
log_message_out	Integer	min: `1`, max: `500`	No
log_message_out_disable	Boolean	`true`, `false`	No
log_message_out_inheritance_disable	Boolean	`true`, `false`	No
update_source	String		No
local_address_subnet_prefix	String		No
local_address_subnet_length	Integer	min: `0`, max: `128`	No
dmz_link_bandwidth	Boolean	`true`, `false`	No
dmz_link_bandwidth_inheritance_disable	Boolean	`true`, `false`	No
ebgp_recv_extcommunity_dmz	Boolean	`true`, `false`	No
ebgp_recv_extcommunity_dmz_inheritance_disable	Boolean	`true`, `false`	No
ebgp_send_extcommunity_dmz	Boolean	`true`, `false`	No
ebgp_send_extcommunity_dmz_cumulative	Boolean	`true`, `false`	No
ebgp_send_extcommunity_dmz_inheritance_disable	Boolean	`true`, `false`	No
ttl_security	Boolean	`true`, `false`	No
ttl_security_inheritance_disable	Boolean	`true`, `false`	No
session_open_mode	Choice	`active-only`, `passive-only`, `both`	No
dscp	Any	Integer[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
precedence	Any	Integer[min: `0`, max: `7`] or Choice[`critical`, `flash`, `flash-override`, `immediate`, `internet`, `network`, `priority`, `routine`] or String[Regex: `^.[\$\%]\{.$`]	No
capability_additional_paths_send	Boolean	`true`, `false`	No
capability_additional_paths_send_disable	Boolean	`true`, `false`	No
capability_additional_paths_receive	Boolean	`true`, `false`	No
capability_additional_paths_receive_disable	Boolean	`true`, `false`	No
capability_suppress_all	Boolean	`true`, `false`	No
capability_suppress_all_inheritance_disable	Boolean	`true`, `false`	No
capability_suppress_extended_nexthop_encoding	Boolean	`true`, `false`	No
capability_suppress_extended_nexthop_encoding_inheritance_disable	Boolean	`true`, `false`	No
capability_suppress_four_byte_as	Boolean	`true`, `false`	No
capability_suppress_four_byte_as_inheritance_disable	Boolean	`true`, `false`	No
graceful_restart	Choice	`enable`, `disable`	No
graceful_restart_helper_only	Boolean	`true`, `false`	No
graceful_restart_helper_only_inheritance_disable	Boolean	`true`, `false`	No
graceful_restart_restart_time	Integer	min: `1`, max: `4095`	No
graceful_restart_stalepath_time	Integer	min: `0`, max: `4095`	No
enforce_first_as	Choice	`disable`, `enable`	No
cluster_id	Any	Integer[min: `1`, max: `4294967295`] or String or String[Regex: `^.[\$\%]\{.$`]	No
idle_watch_time	Integer	min: `30`, max: `1800`	No
allowas_in	Integer	min: `1`, max: `10`	No
egress_engineering	Boolean	`true`, `false`	No
egress_engineering_inheritance_disable	Boolean	`true`, `false`	No
peer_sets	List	peer_sets	No
ao_key_chain	String	min: `1`, max: `32`	No
ao_key_chain_include_tcp_options	Choice	`disable`, `enable`	No
ao_key_chain_accept_mismatch	Boolean	`true`, `false`	No
ao_inheritance_disable	Boolean	`true`, `false`	No
default_policy_action_in	Choice	`accept`, `reject`	No
default_policy_action_out	Choice	`accept`, `reject`	No
fast_fallover	Boolean	`true`, `false`	No
fast_fallover_inheritance_disable	Boolean	`true`, `false`	No
update_in_labeled_unicast_equivalent	Boolean	`true`, `false`	No
update_in_labeled_unicast_equivalent_inheritance_disable	Boolean	`true`, `false`	No
update_in_error_handling_avoid_reset	Choice	`disable`, `enable`	No
update_in_error_handling_treat_as_withdraw	Choice	`disable`, `enable`	No

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

Name	Type	Constraint	Mandatory	Default Value
name	String		Yes
address_family	List	address_family	No

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

Name	Type	Constraint	Mandatory
name	String	max: `32`	Yes
mpls_activate_interfaces	List	mpls_activate_interfaces	No
default_information_originate	Boolean	`true`, `false`	No
default_metric	Integer	min: `1`, max: `4294967295`	No
socket_receive_buffer_size	Integer	min: `512`, max: `131072`	No
socket_receive_buffer_read_size	Integer	min: `512`, max: `131072`	No
socket_send_buffer_size	Integer	min: `4096`, max: `131072`	No
socket_send_buffer_write_size	Integer	min: `4096`, max: `131072`	No
nexthop_mpls_forwarding_ibgp	Boolean	`true`, `false`	No
nexthop_resolution_allow_default	Boolean	`true`, `false`	No
timers_bgp_keepalive_interval	Integer	min: `0`, max: `65535`	No
timers_bgp_holddown_zero	Boolean	`true`, `false`	No
timers_bgp_holddown_zero_minimum_acceptable_zero	Boolean	`true`, `false`	No
timers_bgp_holddown_zero_minimum_acceptable_holdtime	Integer	min: `3`, max: `65535`	No
timers_bgp_holdtime	Integer	min: `3`, max: `65535`	No
timers_bgp_holdtime_minimum_acceptable_holdtime	Integer	min: `3`, max: `65535`	No
bgp_redistribute_internal	Boolean	`true`, `false`	No
bgp_router_id	String		No
bgp_unsafe_ebgp_policy	Boolean	`true`, `false`	No
bgp_auto_policy_soft_reset_disable	Boolean	`true`, `false`	No
bgp_bestpath_cost_community_ignore	Boolean	`true`, `false`	No
bgp_bestpath_compare_routerid	Boolean	`true`, `false`	No
bgp_bestpath_aigp_ignore	Boolean	`true`, `false`	No
bgp_bestpath_igp_metric_ignore	Boolean	`true`, `false`	No
bgp_bestpath_med_missing_as_worst	Boolean	`true`, `false`	No
bgp_bestpath_med_always	Boolean	`true`, `false`	No
bgp_bestpath_as_path_ignore	Boolean	`true`, `false`	No
bgp_bestpath_as_path_multipath_relax	Boolean	`true`, `false`	No
bgp_bestpath_origin_as_use_validity	Boolean	`true`, `false`	No
bgp_bestpath_origin_as_allow_invalid	Boolean	`true`, `false`	No
bgp_bestpath_sr_policy	Choice	`prefer`, `force`	No
bgp_default_local_preference	Integer	min: `0`, max: `4294967295`	No
bgp_enforce_first_as_disable	Boolean	`true`, `false`	No
bgp_fast_external_fallover_disable	Boolean	`true`, `false`	No
bgp_log_neighbor_changes	Choice	`disable`	No
bgp_log_message_disable	Boolean	`true`, `false`	No
bgp_multipath_use_cluster_list_length	Boolean	`true`, `false`	No
bgp_origin_as_validation_signal_ibgp	Boolean	`true`, `false`	No
bgp_origin_as_validation_time	Any	Integer[min: `5`, max: `60`] or Choice[`off`] or String[Regex: `^.[\$\%]\{.$`]	No
bfd_minimum_interval	Integer	min: `3`, max: `30000`	No
bfd_multiplier	Integer	min: `2`, max: `16`	No
rd	String		Yes
neighbors	List	neighbors	No
address_family	Class	address_family	No

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

Name	Type	Constraint	Mandatory	Default Value
number	Integer	min: `1`, max: `8`	Yes

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

Name	Type	Constraint	Mandatory	Default Value
id	Integer	min: `1`, max: `255`	Yes

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

Name	Type	Constraint	Mandatory
activate	Boolean	`true`, `false`	No
activate_inheritance_disable	Boolean	`true`, `false`	No
local_preference	Integer	min: `0`, max: `4294967295`	No
local_preference_inheritance_disable	Boolean	`true`, `false`	No
as_prepends	Integer	min: `0`, max: `6`	No
as_prepends_inheritance_disable	Boolean	`true`, `false`	No
bandwidth_aware_percentage_threshold	Integer	min: `1`, max: `100`	No
bandwidth_aware_percentage_threshold_high	Integer	min: `1`, max: `100`	No
bandwidth_aware_bandwidth_threshold	Integer	min: `1`, max: `4294967295`	No
bandwidth_aware_bandwidth_threshold_high	Integer	min: `1`, max: `4294967295`	No
bandwidth_aware_inheritance_disable	Boolean	`true`, `false`	No

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

Name	Type	Constraint	Mandatory
name	Choice	`ipv4-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-state`	Yes
encapsulation_type	Choice	`srv6`, `vxlan`	No
weight	Integer	min: `0`, max: `65535`	No
multipath	Boolean	`true`, `false`	No
use_af_group	String		No
capability_orf_prefix	Choice	`both`, `none`, `receive`, `send`	No
additional_paths_send	Boolean	`true`, `false`	No
additional_paths_send_disable	Boolean	`true`, `false`	No
additional_paths_receive	Boolean	`true`, `false`	No
additional_paths_receive_disable	Boolean	`true`, `false`	No
default_originate	Boolean	`true`, `false`	No
default_originate_route_policy	String		No
default_originate_inheritance_disable	Boolean	`true`, `false`	No
maximum_prefix_limit	Integer	min: `1`, max: `4294967295`	No
maximum_prefix_threshold	Integer	min: `1`, max: `100`	No
maximum_prefix_restart	Integer	min: `1`, max: `65535`	No
maximum_prefix_discard_extra_paths	Boolean	`true`, `false`	No
maximum_prefix_warning_only	Boolean	`true`, `false`	No
next_hop_self	Boolean	`true`, `false`	No
next_hop_self_inheritance_disable	Boolean	`true`, `false`	No
next_hop_unchanged	Boolean	`true`, `false`	No
next_hop_unchanged_multipath	Boolean	`true`, `false`	No
next_hop_unchanged_inheritance_disable	Boolean	`true`, `false`	No
route_policy_in	String		No
route_policy_out	String		No
orf_route_policy	String		No
cluster_id_allow_equal	Boolean	`true`, `false`	No
cluster_id_allow_equal_disable	Boolean	`true`, `false`	No
replace_private_as	Boolean	`true`, `false`	No
replace_private_as_internal	Boolean	`true`, `false`	No
remove_private_as_inbound	Boolean	`true`, `false`	No
remove_private_as_inbound_entire_aspath	Boolean	`true`, `false`	No
remove_private_as_inbound_inheritance_disable	Boolean	`true`, `false`	No
remove_private_as	Boolean	`true`, `false`	No
remove_private_as_entire_aspath	Boolean	`true`, `false`	No
remove_private_as_internal	Boolean	`true`, `false`	No
route_reflector_client	Boolean	`true`, `false`	No
route_reflector_client_inheritance_disable	Boolean	`true`, `false`	No
send_community_ebgp	Boolean	`true`, `false`	No
send_community_ebgp_inheritance_disable	Boolean	`true`, `false`	No
send_community_gshut_ebgp	Boolean	`true`, `false`	No
send_community_gshut_ebgp_inheritance_disable	Boolean	`true`, `false`	No
send_extended_community_ebgp	Boolean	`true`, `false`	No
send_extended_community_ebgp_inheritance_disable	Boolean	`true`, `false`	No
soft_reconfiguration_inbound	Boolean	`true`, `false`	No
soft_reconfiguration_inbound_always	Boolean	`true`, `false`	No
update_out_originator_loopcheck	Boolean	`true`, `false`	No
update_out_originator_loopcheck_disable	Boolean	`true`, `false`	No
advertise_vpnv4_unicast	Boolean	`true`, `false`	No
advertise_vpnv4_unicast_re_originated	Boolean	`true`, `false`	No
advertise_vpnv4_unicast_re_originated_stitching_rt	Boolean	`true`, `false`	No
advertise_vpnv6_unicast	Boolean	`true`, `false`	No
advertise_vpnv6_unicast_re_originated	Boolean	`true`, `false`	No
advertise_vpnv6_unicast_re_originated_stitching_rt	Boolean	`true`, `false`	No
advertise_l2vpn_evpn_re_originated	Boolean	`true`, `false`	No
advertise_l2vpn_evpn_re_originated_stitching_rt	Boolean	`true`, `false`	No
segment_routing_srv6_prefix_sid_type4	Boolean	`true`, `false`	No
import_stitching_rt	Boolean	`true`, `false`	No
import_stitching_rt_re_originate	Boolean	`true`, `false`	No
import_stitching_rt_re_originate_stitching_rt	Boolean	`true`, `false`	No
import_re_originate	Boolean	`true`, `false`	No
allowas_in	Integer	min: `1`, max: `10`	No
site_of_origin	String		No
as_override	Boolean	`true`, `false`	No
as_override_inheritance_disable	Boolean	`true`, `false`	No
aigp	Boolean	`true`, `false`	No
aigp_disable	Boolean	`true`, `false`	No
aigp_send_med	Boolean	`true`, `false`	No
aigp_send_med_disable	Boolean	`true`, `false`	No
aigp_send_cost_community_disable	Boolean	`true`, `false`	No
aigp_send_cost_community_id	Integer	min: `0`, max: `255`	No
aigp_send_cost_community_id_poi_igp_cost	Boolean	`true`, `false`	No
aigp_send_cost_community_id_poi_igp_cost_transitive	Boolean	`true`, `false`	No
aigp_send_cost_community_id_poi_pre_bestpath	Boolean	`true`, `false`	No
aigp_send_cost_community_id_poi_pre_bestpath_transitive	Boolean	`true`, `false`	No
send_multicast_attributes	Boolean	`true`, `false`	No
send_multicast_attributes_disable	Boolean	`true`, `false`	No
accept_own	Boolean	`true`, `false`	No
accept_own_inheritance_disable	Boolean	`true`, `false`	No
slow_peer_dynamic	Boolean	`true`, `false`	No
slow_peer_dynamic_threshold	Integer	min: `120`, max: `3600`	No
slow_peer_dynamic_disable	Boolean	`true`, `false`	No
slow_peer_static	Boolean	`true`, `false`	No
origin_as_validation_disable	Boolean	`true`, `false`	No
bestpath_origin_as_allow_invalid	Boolean	`true`, `false`	No

interfaces (iosxr.devices.configuration.routing.bgp.graceful_maintenance_activate)

Name	Type	Constraint	Mandatory	Default Value
name	String		Yes

locations (iosxr.devices.configuration.routing.bgp.graceful_maintenance_activate)

Name	Type	Constraint	Mandatory	Default Value
name	String		Yes

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

Name	Type	Constraint	Mandatory
from	Integer	min: `4`, max: `255`	Yes
to	Integer	min: `5`, max: `255`	Yes
discard	Boolean	`true`, `false`	No
treat_as_withdraw	Boolean	`true`, `false`	No

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

Name	Type	Constraint	Mandatory	Default Value
as_number	Any	String or Integer[min: `1`, max: `4294967295`] or String[Regex: `^.[\$\%]\{.$`]	Yes

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

Name	Type	Constraint	Mandatory
enable	Boolean	`true`, `false`	No
distance_bgp_external_route	Integer	min: `1`, max: `20000`	No
distance_bgp_internal_route	Integer	min: `1`, max: `20000`	No
distance_bgp_local_route	Integer	min: `1`, max: `20000`	No
import_from_bridge_domain	Boolean	`true`, `false`	No
additional_paths_send	Boolean	`true`, `false`	No
additional_paths_receive	Boolean	`true`, `false`	No
additional_paths_advertise_limit	Integer	min: `1`, max: `20000`	No
additional_paths_selection_route_policy	String		No
additional_paths_selection_disable	Boolean	`true`, `false`	No
permanent_network_route_policy	String		No
advertise_best_external	Boolean	`true`, `false`	No
advertise_best_external_labeled_unicast	Boolean	`true`, `false`	No
advertise_best_external_disable	Boolean	`true`, `false`	No
advertise_local_labeled_route_safi_unicast	Choice	`disable`, `enable`	No
advertise_epe_bgp_labeled_unicast	Boolean	`true`, `false`	No
allocate_label_all	Boolean	`true`, `false`	No
allocate_label_all_unlabeled_path	Boolean	`true`, `false`	No
allocate_label_route_policy	String		No
allocate_label_route_policy_unlabeled_path	Boolean	`true`, `false`	No
maximum_paths_ebgp_multipath	Integer	min: `2`, max: `1024`	No
maximum_paths_ebgp_selective	Boolean	`true`, `false`	No
maximum_paths_ebgp_route_policy	String		No
maximum_paths_ibgp_multipath	Integer	min: `2`, max: `1024`	No
maximum_paths_ibgp_unequal_cost	Boolean	`true`, `false`	No
maximum_paths_ibgp_unequal_cost_deterministic	Boolean	`true`, `false`	No
maximum_paths_ibgp_selective	Boolean	`true`, `false`	No
maximum_paths_ibgp_route_policy	String		No
maximum_paths_eibgp_multipath	Integer	min: `2`, max: `1024`	No
maximum_paths_eibgp_equal_cost	Boolean	`true`, `false`	No
maximum_paths_eibgp_selective	Boolean	`true`, `false`	No
maximum_paths_eibgp_route_policy	String		No
maximum_paths_unique_nexthop_check_disable	Boolean	`true`, `false`	No
nexthop_trigger_delay_critical	Integer	min: `0`, max: `4294967295`	No
nexthop_trigger_delay_non_critical	Integer	min: `0`, max: `4294967295`	No
label_mode	Choice	`per-prefix`, `per-ce`, `per-vrf`, `per-vrf-46`	No
label_mode_route_policy	String		No
redistribute_connected	Boolean	`true`, `false`	No
redistribute_connected_metric	Integer	min: `0`, max: `4294967295`	No
redistribute_connected_multipath	Boolean	`true`, `false`	No
redistribute_connected_route_policy	String		No
redistribute_static	Boolean	`true`, `false`	No
redistribute_static_metric	Integer	min: `0`, max: `4294967295`	No
redistribute_static_multipath	Boolean	`true`, `false`	No
redistribute_static_route_policy	String		No
redistribute_rip	Boolean	`true`, `false`	No
redistribute_rip_metric	Integer	min: `0`, max: `4294967295`	No
redistribute_rip_multipath	Boolean	`true`, `false`	No
redistribute_rip_route_policy	String		No
redistribute_ospf	List	redistribute_ospf	No
redistribute_eigrp	List	redistribute_eigrp	No
redistribute_isis	List	redistribute_isis	No
table_policy	String		No
retain_local_label	Integer	min: `3`, max: `60`	No
rnh_install_extcomm	Boolean	`true`, `false`	No
rnh_install_extcomm_only	Boolean	`true`, `false`	No
prefix_ecmp_delay	Integer	min: `10`, max: `60000`	No
prefix_ecmp_delay_oor_threshold	Integer	min: `10`, max: `90`	No
bgp_origin_as_validation_enable	Boolean	`true`, `false`	No
bgp_origin_as_validation_signal_ibgp	Boolean	`true`, `false`	No
bgp_bestpath_origin_as_use_validity	Boolean	`true`, `false`	No
bgp_bestpath_origin_as_allow_invalid	Boolean	`true`, `false`	No
bgp_scan_time	Integer	min: `5`, max: `3600`	No
bgp_attribute_download	Boolean	`true`, `false`	No
bgp_import_delay_seconds	Integer	min: `0`, max: `10`	No
bgp_import_delay_milliseconds	Integer	min: `0`, max: `999`	No
bgp_label_delay_seconds	Integer	min: `0`, max: `10`	No
bgp_label_delay_milliseconds	Integer	min: `0`, max: `999`	No
bgp_client_to_client_reflection	Class	bgp_client_to_client_reflection	No
bgp_dampening_decay_half_life	Integer	min: `1`, max: `255`	No
bgp_dampening_reuse_threshold	Integer	min: `1`, max: `255`	No
bgp_dampening_suppress_threshold	Integer	min: `1`, max: `255`	No
bgp_dampening_max_suppress_time	Integer	min: `0`, max: `4294967295`	No
bgp_dampening_route_policy	String		No
event_prefix_route_policy	String		No
dynamic_med_interval	Integer	min: `0`, max: `10`	No
weight_reset_on_import	Boolean	`true`, `false`	No
nexthop_route_policy	String		No
nexthop_resolution_prefix_length_minimum_ipv4	Integer	min: `0`, max: `32`	No
nexthop_resolution_prefix_length_minimum_ipv6	Integer	min: `0`, max: `128`	No
update_limit_sub_group_ebgp	Integer	min: `1`, max: `512`	No
update_limit_sub_group_ibgp	Integer	min: `1`, max: `512`	No
update_limit_address_family	Integer	min: `4`, max: `2048`	No
update_wait_install	Boolean	`true`, `false`	No
update_wait_install_delay_startup	Integer	min: `1`, max: `600`	No
as_path_loopcheck_out_disable	Boolean	`true`, `false`	No
epe_backup_enable	Boolean	`true`, `false`	No
default_martian_check_disable	Boolean	`true`, `false`	No
export_to_vrf_allow_backup	Boolean	`true`, `false`	No
export_to_vrf_allow_best_external	Boolean	`true`, `false`	No
segment_routing_prefix_sid_map	Boolean	`true`, `false`	No
segment_routing_srv6	Class	segment_routing_srv6	No
aggregate_addresses	List	aggregate_addresses	No
networks	List	networks	No
peer_set_ids	List	peer_set_ids	No

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

Name	Type	Constraint	Mandatory
enable	Boolean	`true`, `false`	No
distance_bgp_external_route	Integer	min: `1`, max: `20000`	No
distance_bgp_internal_route	Integer	min: `1`, max: `20000`	No
distance_bgp_local_route	Integer	min: `1`, max: `20000`	No
import_from_bridge_domain	Boolean	`true`, `false`	No
additional_paths_send	Boolean	`true`, `false`	No
additional_paths_receive	Boolean	`true`, `false`	No
additional_paths_advertise_limit	Integer	min: `1`, max: `20000`	No
additional_paths_selection_route_policy	String		No
additional_paths_selection_disable	Boolean	`true`, `false`	No
permanent_network_route_policy	String		No
advertise_best_external	Boolean	`true`, `false`	No
advertise_best_external_labeled_unicast	Boolean	`true`, `false`	No
advertise_best_external_disable	Boolean	`true`, `false`	No
advertise_local_labeled_route_safi_unicast	Choice	`disable`, `enable`	No
advertise_epe_bgp_labeled_unicast	Boolean	`true`, `false`	No
allocate_label_all	Boolean	`true`, `false`	No
allocate_label_all_unlabeled_path	Boolean	`true`, `false`	No
allocate_label_route_policy	String		No
allocate_label_route_policy_unlabeled_path	Boolean	`true`, `false`	No
maximum_paths_ebgp_multipath	Integer	min: `2`, max: `1024`	No
maximum_paths_ebgp_selective	Boolean	`true`, `false`	No
maximum_paths_ebgp_route_policy	String		No
maximum_paths_ibgp_multipath	Integer	min: `2`, max: `1024`	No
maximum_paths_ibgp_unequal_cost	Boolean	`true`, `false`	No
maximum_paths_ibgp_unequal_cost_deterministic	Boolean	`true`, `false`	No
maximum_paths_ibgp_selective	Boolean	`true`, `false`	No
maximum_paths_ibgp_route_policy	String		No
maximum_paths_eibgp_multipath	Integer	min: `2`, max: `1024`	No
maximum_paths_eibgp_equal_cost	Boolean	`true`, `false`	No
maximum_paths_eibgp_selective	Boolean	`true`, `false`	No
maximum_paths_eibgp_route_policy	String		No
maximum_paths_unique_nexthop_check_disable	Boolean	`true`, `false`	No
nexthop_trigger_delay_critical	Integer	min: `0`, max: `4294967295`	No
nexthop_trigger_delay_non_critical	Integer	min: `0`, max: `4294967295`	No
label_mode	Choice	`per-prefix`, `per-ce`, `per-vrf`, `per-vrf-46`	No
label_mode_route_policy	String		No
redistribute_connected	Boolean	`true`, `false`	No
redistribute_connected_metric	Integer	min: `0`, max: `4294967295`	No
redistribute_connected_multipath	Boolean	`true`, `false`	No
redistribute_connected_route_policy	String		No
redistribute_static	Boolean	`true`, `false`	No
redistribute_static_metric	Integer	min: `0`, max: `4294967295`	No
redistribute_static_multipath	Boolean	`true`, `false`	No
redistribute_static_route_policy	String		No
redistribute_rip	Boolean	`true`, `false`	No
redistribute_rip_metric	Integer	min: `0`, max: `4294967295`	No
redistribute_rip_multipath	Boolean	`true`, `false`	No
redistribute_rip_route_policy	String		No
redistribute_ospfv3	List	redistribute_ospfv3	No
redistribute_eigrp	List	redistribute_eigrp	No
redistribute_isis	List	redistribute_isis	No
table_policy	String		No
retain_local_label	Integer	min: `3`, max: `60`	No
retain_route_target_all	Boolean	`true`, `false`	No
retain_route_target_route_policy	String		No
rnh_install_extcomm	Boolean	`true`, `false`	No
rnh_install_extcomm_only	Boolean	`true`, `false`	No
prefix_ecmp_delay	Integer	min: `10`, max: `60000`	No
prefix_ecmp_delay_oor_threshold	Integer	min: `10`, max: `90`	No
bgp_origin_as_validation_enable	Boolean	`true`, `false`	No
bgp_origin_as_validation_signal_ibgp	Boolean	`true`, `false`	No
bgp_bestpath_origin_as_use_validity	Boolean	`true`, `false`	No
bgp_bestpath_origin_as_allow_invalid	Boolean	`true`, `false`	No
bgp_scan_time	Integer	min: `5`, max: `3600`	No
bgp_attribute_download	Boolean	`true`, `false`	No
bgp_import_delay_seconds	Integer	min: `0`, max: `10`	No
bgp_import_delay_milliseconds	Integer	min: `0`, max: `999`	No
bgp_label_delay_seconds	Integer	min: `0`, max: `10`	No
bgp_label_delay_milliseconds	Integer	min: `0`, max: `999`	No
bgp_client_to_client_reflection	Class	bgp_client_to_client_reflection	No
bgp_dampening_decay_half_life	Integer	min: `1`, max: `255`	No
bgp_dampening_reuse_threshold	Integer	min: `1`, max: `255`	No
bgp_dampening_suppress_threshold	Integer	min: `1`, max: `255`	No
bgp_dampening_max_suppress_time	Integer	min: `0`, max: `4294967295`	No
bgp_dampening_route_policy	String		No
event_prefix_route_policy	String		No
dynamic_med_interval	Integer	min: `0`, max: `10`	No
weight_reset_on_import	Boolean	`true`, `false`	No
nexthop_route_policy	String		No
update_limit_sub_group_ebgp	Integer	min: `1`, max: `512`	No
update_limit_sub_group_ibgp	Integer	min: `1`, max: `512`	No
update_limit_address_family	Integer	min: `4`, max: `2048`	No
update_wait_install	Boolean	`true`, `false`	No
update_wait_install_delay_startup	Integer	min: `1`, max: `600`	No
as_path_loopcheck_out_disable	Boolean	`true`, `false`	No
epe_backup_enable	Boolean	`true`, `false`	No
default_martian_check_disable	Boolean	`true`, `false`	No
export_to_vrf_allow_backup	Boolean	`true`, `false`	No
export_to_vrf_allow_best_external	Boolean	`true`, `false`	No
segment_routing_srv6	Class	segment_routing_srv6	No
aggregate_addresses	List	aggregate_addresses	No
networks	List	networks	No
peer_set_ids	List	peer_set_ids	No

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

Name	Type	Constraint	Mandatory
enable	Boolean	`true`, `false`	No
vrf_all	Class	vrf_all	No
additional_paths_send	Boolean	`true`, `false`	No
additional_paths_receive	Boolean	`true`, `false`	No
additional_paths_advertise_limit	Integer	min: `1`, max: `20000`	No
additional_paths_selection_route_policy	String		No
advertise_best_external	Boolean	`true`, `false`	No
advertise_best_external_disable	Boolean	`true`, `false`	No
nexthop_trigger_delay_critical	Integer	min: `0`, max: `4294967295`	No
nexthop_trigger_delay_non_critical	Integer	min: `0`, max: `4294967295`	No
label_mode_per_nexthop_received_label	Boolean	`true`, `false`	No
label_mode_per_nexthop_received_label_allocate_secondary_label	Boolean	`true`, `false`	No
retain_local_label	Integer	min: `3`, max: `60`	No
retain_route_target_all	Boolean	`true`, `false`	No
retain_route_target_route_policy	String		No
bgp_scan_time	Integer	min: `5`, max: `3600`	No
bgp_import_delay_seconds	Integer	min: `0`, max: `10`	No
bgp_import_delay_milliseconds	Integer	min: `0`, max: `999`	No
bgp_label_delay_seconds	Integer	min: `0`, max: `10`	No
bgp_label_delay_milliseconds	Integer	min: `0`, max: `999`	No
bgp_client_to_client_reflection	Class	bgp_client_to_client_reflection	No
bgp_dampening_decay_half_life	Integer	min: `1`, max: `255`	No
bgp_dampening_reuse_threshold	Integer	min: `1`, max: `255`	No
bgp_dampening_suppress_threshold	Integer	min: `1`, max: `255`	No
bgp_dampening_max_suppress_time	Integer	min: `0`, max: `4294967295`	No
bgp_dampening_route_policy	String		No
event_prefix_route_policy	String		No
dynamic_med_interval	Integer	min: `0`, max: `10`	No
weight_reset_on_import	Boolean	`true`, `false`	No
nexthop_route_policy	String		No
nexthop_resolution_prefix_length_minimum_ipv4	Integer	min: `0`, max: `32`	No
nexthop_resolution_prefix_length_minimum_ipv6	Integer	min: `0`, max: `128`	No
update_limit_sub_group_ebgp	Integer	min: `1`, max: `512`	No
update_limit_sub_group_ibgp	Integer	min: `1`, max: `512`	No
update_limit_address_family	Integer	min: `4`, max: `2048`	No
update_wait_install	Boolean	`true`, `false`	No
update_wait_install_delay_startup	Integer	min: `1`, max: `600`	No
as_path_loopcheck_out_disable	Boolean	`true`, `false`	No
default_martian_check_disable	Boolean	`true`, `false`	No
export_to_vrf_allow_backup	Boolean	`true`, `false`	No
export_to_vrf_allow_best_external	Boolean	`true`, `false`	No
segment_routing_srv6	Class	segment_routing_srv6	No

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

Name	Type	Constraint	Mandatory
enable	Boolean	`true`, `false`	No
vrf_all	Class	vrf_all	No
additional_paths_send	Boolean	`true`, `false`	No
additional_paths_receive	Boolean	`true`, `false`	No
additional_paths_advertise_limit	Integer	min: `1`, max: `20000`	No
additional_paths_selection_route_policy	String		No
advertise_best_external	Boolean	`true`, `false`	No
advertise_best_external_disable	Boolean	`true`, `false`	No
nexthop_trigger_delay_critical	Integer	min: `0`, max: `4294967295`	No
nexthop_trigger_delay_non_critical	Integer	min: `0`, max: `4294967295`	No
label_mode_per_nexthop_received_label	Boolean	`true`, `false`	No
label_mode_per_nexthop_received_label_allocate_secondary_label	Boolean	`true`, `false`	No
retain_local_label	Integer	min: `3`, max: `60`	No
retain_route_target_all	Boolean	`true`, `false`	No
retain_route_target_route_policy	String		No
bgp_scan_time	Integer	min: `5`, max: `3600`	No
bgp_import_delay_seconds	Integer	min: `0`, max: `10`	No
bgp_import_delay_milliseconds	Integer	min: `0`, max: `999`	No
bgp_label_delay_seconds	Integer	min: `0`, max: `10`	No
bgp_label_delay_milliseconds	Integer	min: `0`, max: `999`	No
bgp_client_to_client_reflection	Class	bgp_client_to_client_reflection	No
bgp_dampening_decay_half_life	Integer	min: `1`, max: `255`	No
bgp_dampening_reuse_threshold	Integer	min: `1`, max: `255`	No
bgp_dampening_suppress_threshold	Integer	min: `1`, max: `255`	No
bgp_dampening_max_suppress_time	Integer	min: `0`, max: `4294967295`	No
bgp_dampening_route_policy	String		No
event_prefix_route_policy	String		No
dynamic_med_interval	Integer	min: `0`, max: `10`	No
weight_reset_on_import	Boolean	`true`, `false`	No
nexthop_route_policy	String		No
update_limit_sub_group_ebgp	Integer	min: `1`, max: `512`	No
update_limit_sub_group_ibgp	Integer	min: `1`, max: `512`	No
update_limit_address_family	Integer	min: `4`, max: `2048`	No
update_wait_install	Boolean	`true`, `false`	No
update_wait_install_delay_startup	Integer	min: `1`, max: `600`	No
as_path_loopcheck_out_disable	Boolean	`true`, `false`	No
default_martian_check_disable	Boolean	`true`, `false`	No
export_to_vrf_allow_backup	Boolean	`true`, `false`	No
export_to_vrf_allow_best_external	Boolean	`true`, `false`	No
segment_routing_srv6	Class	segment_routing_srv6	No

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

Name	Type	Constraint	Mandatory
enable	Boolean	`true`, `false`	No
additional_paths_send	Boolean	`true`, `false`	No
additional_paths_receive	Boolean	`true`, `false`	No
additional_paths_advertise_limit	Integer	min: `1`, max: `20000`	No
additional_paths_selection_route_policy	String		No
advertise_best_external	Boolean	`true`, `false`	No
advertise_best_external_disable	Boolean	`true`, `false`	No
nexthop_trigger_delay_critical	Integer	min: `0`, max: `4294967295`	No
nexthop_trigger_delay_non_critical	Integer	min: `0`, max: `4294967295`	No
retain_local_label	Integer	min: `3`, max: `60`	No
retain_route_target_all	Boolean	`true`, `false`	No
retain_route_target_route_policy	String		No
bgp_scan_time	Integer	min: `5`, max: `3600`	No
bgp_label_delay_seconds	Integer	min: `0`, max: `10`	No
bgp_label_delay_milliseconds	Integer	min: `0`, max: `999`	No
bgp_client_to_client_reflection	Class	bgp_client_to_client_reflection	No
bgp_dampening_decay_half_life	Integer	min: `1`, max: `255`	No
bgp_dampening_reuse_threshold	Integer	min: `1`, max: `255`	No
bgp_dampening_suppress_threshold	Integer	min: `1`, max: `255`	No
bgp_dampening_max_suppress_time	Integer	min: `0`, max: `4294967295`	No
bgp_dampening_route_policy	String		No
event_prefix_route_policy	String		No
nexthop_route_policy	String		No
nexthop_resolution_prefix_length_minimum_ipv4	Integer	min: `0`, max: `32`	No
update_limit_sub_group_ebgp	Integer	min: `1`, max: `512`	No
update_limit_sub_group_ibgp	Integer	min: `1`, max: `512`	No
update_limit_address_family	Integer	min: `4`, max: `2048`	No
as_path_loopcheck_out_disable	Boolean	`true`, `false`	No
default_martian_check_disable	Boolean	`true`, `false`	No

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

Name	Type	Constraint	Mandatory
enable	Boolean	`true`, `false`	No
additional_paths_send	Boolean	`true`, `false`	No
additional_paths_receive	Boolean	`true`, `false`	No
additional_paths_advertise_limit	Integer	min: `1`, max: `20000`	No
additional_paths_selection_route_policy	String		No
advertise_best_external	Boolean	`true`, `false`	No
advertise_best_external_disable	Boolean	`true`, `false`	No
nexthop_trigger_delay_critical	Integer	min: `0`, max: `4294967295`	No
nexthop_trigger_delay_non_critical	Integer	min: `0`, max: `4294967295`	No
retain_local_label	Integer	min: `3`, max: `60`	No
retain_route_target_all	Boolean	`true`, `false`	No
retain_route_target_route_policy	String		No
bgp_scan_time	Integer	min: `5`, max: `3600`	No
bgp_label_delay_seconds	Integer	min: `0`, max: `10`	No
bgp_label_delay_milliseconds	Integer	min: `0`, max: `999`	No
bgp_client_to_client_reflection	Class	bgp_client_to_client_reflection	No
bgp_dampening_decay_half_life	Integer	min: `1`, max: `255`	No
bgp_dampening_reuse_threshold	Integer	min: `1`, max: `255`	No
bgp_dampening_suppress_threshold	Integer	min: `1`, max: `255`	No
bgp_dampening_max_suppress_time	Integer	min: `0`, max: `4294967295`	No
bgp_dampening_route_policy	String		No
event_prefix_route_policy	String		No
nexthop_route_policy	String		No
nexthop_resolution_prefix_length_minimum_ipv4	Integer	min: `0`, max: `32`	No
update_limit_sub_group_ebgp	Integer	min: `1`, max: `512`	No
update_limit_sub_group_ibgp	Integer	min: `1`, max: `512`	No
update_limit_address_family	Integer	min: `4`, max: `2048`	No
as_path_loopcheck_out_disable	Boolean	`true`, `false`	No
default_martian_check_disable	Boolean	`true`, `false`	No

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

Name	Type	Constraint	Mandatory
enable	Boolean	`true`, `false`	No
additional_paths_send	Boolean	`true`, `false`	No
additional_paths_receive	Boolean	`true`, `false`	No
additional_paths_advertise_limit	Integer	min: `1`, max: `20000`	No
additional_paths_selection_route_policy	String		No
advertise_best_external	Boolean	`true`, `false`	No
advertise_best_external_disable	Boolean	`true`, `false`	No
nexthop_trigger_delay_critical	Integer	min: `0`, max: `4294967295`	No
nexthop_trigger_delay_non_critical	Integer	min: `0`, max: `4294967295`	No
retain_local_label	Integer	min: `3`, max: `60`	No
retain_route_target_all	Boolean	`true`, `false`	No
retain_route_target_route_policy	String		No
bgp_scan_time	Integer	min: `5`, max: `3600`	No
bgp_import_delay_seconds	Integer	min: `0`, max: `10`	No
bgp_import_delay_milliseconds	Integer	min: `0`, max: `999`	No
bgp_label_delay_seconds	Integer	min: `0`, max: `10`	No
bgp_label_delay_milliseconds	Integer	min: `0`, max: `999`	No
bgp_client_to_client_reflection	Class	bgp_client_to_client_reflection	No
bgp_dampening_decay_half_life	Integer	min: `1`, max: `255`	No
bgp_dampening_reuse_threshold	Integer	min: `1`, max: `255`	No
bgp_dampening_suppress_threshold	Integer	min: `1`, max: `255`	No
bgp_dampening_max_suppress_time	Integer	min: `0`, max: `4294967295`	No
bgp_dampening_route_policy	String		No
event_prefix_route_policy	String		No
nexthop_route_policy	String		No
nexthop_resolution_prefix_length_minimum_ipv4	Integer	min: `0`, max: `32`	No
nexthop_resolution_prefix_length_minimum_ipv6	Integer	min: `0`, max: `128`	No
update_limit_sub_group_ebgp	Integer	min: `1`, max: `512`	No
update_limit_sub_group_ibgp	Integer	min: `1`, max: `512`	No
update_limit_address_family	Integer	min: `4`, max: `2048`	No
as_path_loopcheck_out_disable	Boolean	`true`, `false`	No
default_martian_check_disable	Boolean	`true`, `false`	No

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

Name	Type	Constraint	Mandatory	Default Value
name	String		Yes

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

Name	Type	Constraint	Mandatory
ipv4_unicast	Class	ipv4_unicast	No
ipv6_unicast	Class	ipv6_unicast	No
ipv4_multicast	Class	ipv4_multicast	No
ipv6_multicast	Class	ipv6_multicast	No

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

Name	Type	Constraint	Mandatory
process	String		Yes
match	Choice	`match-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-2`	No
metric	Integer	min: `0`, max: `4294967295`	No
multipath	Boolean	`true`, `false`	No
route_policy	String		No

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

Name	Type	Constraint	Mandatory
process	String		Yes
match	Choice	`match-internal`, `match-internal-external`, `match-external`	No
metric	Integer	min: `0`, max: `4294967295`	No
multipath	Boolean	`true`, `false`	No
route_policy	String		No

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

Name	Type	Constraint	Mandatory
process	String		Yes
level	Choice	`level-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-area`	No
metric	Integer	min: `0`, max: `4294967295`	No
multipath	Boolean	`true`, `false`	No
route_policy	String		No

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

Name	Type	Constraint	Mandatory	Default Value
disable	Boolean	`true`, `false`	No
cluster_ids	List	cluster_ids	No

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

Name	Type	Constraint	Mandatory
locator	String		No
usid_allocation_wide_local_id_block	Boolean	`true`, `false`	No
alloc_mode	Choice	`per-ce`, `per-vrf`, `per-vrf-46`	No
alloc_mode_route_policy	String		No

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

Name	Type	Constraint	Mandatory
address	IP		Yes
length	Integer	min: `0`, max: `128`	Yes
as_confed_set	Boolean	`true`, `false`	No
as_set	Boolean	`true`, `false`	No
description	String		No
route_policy	String		No
set_tag	Integer	min: `0`, max: `4294967295`	No
summary_only	Boolean	`true`, `false`	No

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

Name	Type	Constraint	Mandatory
address	IP		Yes
length	Integer	min: `0`, max: `128`	Yes
backdoor	Boolean	`true`, `false`	No
multipath	Boolean	`true`, `false`	No
route_policy	String		No

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

Name	Type	Constraint	Mandatory	Default Value
peer_id	Integer	min: `1`, max: `255`	Yes
peer_sid_index	Integer	min: `0`, max: `1033575`	No

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

Name	Type	Constraint	Mandatory
process	String		Yes
match	Choice	`match-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-2`	No
metric	Integer	min: `0`, max: `4294967295`	No
multipath	Boolean	`true`, `false`	No
route_policy	String		No

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

Name	Type	Constraint	Mandatory
segment_routing_srv6	Class	segment_routing_srv6	No
source_rt_import_policy	Boolean	`true`, `false`	No
label_mode	Choice	`per-ce`, `per-vrf`, `per-vrf-46`	No
label_mode_route_policy	String		No
rnh_install_extcomm	Boolean	`true`, `false`	No
rnh_install_extcomm_only	Boolean	`true`, `false`	No
table_policy	String		No

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

Name	Type	Constraint	Mandatory	Default Value
locator	String		No
usid_allocation_wide_local_id_block	Boolean	`true`, `false`	No

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

Name	Type	Constraint	Mandatory
enable	Boolean	`true`, `false`	No
distance_bgp_external_route	Integer	min: `1`, max: `20000`	No
distance_bgp_internal_route	Integer	min: `1`, max: `20000`	No
distance_bgp_local_route	Integer	min: `1`, max: `20000`	No
bgp_attribute_download	Boolean	`true`, `false`	No
allow_vpn_default_originate	Boolean	`true`, `false`	No
additional_paths_send	Boolean	`true`, `false`	No
additional_paths_send_disable	Boolean	`true`, `false`	No
additional_paths_receive	Boolean	`true`, `false`	No
additional_paths_receive_disable	Boolean	`true`, `false`	No
additional_paths_advertise_limit	Integer	min: `1`, max: `20000`	No
additional_paths_selection_route_policy	String		No
additional_paths_selection_disable	Boolean	`true`, `false`	No
advertise_best_external	Boolean	`true`, `false`	No
advertise_best_external_disable	Boolean	`true`, `false`	No
advertise_local_labeled_route_safi_unicast	Choice	`disable`, `enable`	No
allocate_label_all	Boolean	`true`, `false`	No
allocate_label_all_unlabeled_path	Boolean	`true`, `false`	No
allocate_label_route_policy_name	String		No
allocate_label_route_policy_unlabeled_path	Boolean	`true`, `false`	No
maximum_paths_ebgp_multipath	Integer	min: `2`, max: `128`	No
maximum_paths_ebgp_selective	Boolean	`true`, `false`	No
maximum_paths_ebgp_route_policy	String		No
maximum_paths_ibgp_multipath	Integer	min: `2`, max: `128`	No
maximum_paths_ibgp_unequal_cost	Boolean	`true`, `false`	No
maximum_paths_ibgp_unequal_cost_deterministic	Boolean	`true`, `false`	No
maximum_paths_ibgp_selective	Boolean	`true`, `false`	No
maximum_paths_ibgp_route_policy	String		No
maximum_paths_eibgp_multipath	Integer	min: `2`, max: `128`	No
maximum_paths_eibgp_equal_cost	Boolean	`true`, `false`	No
maximum_paths_eibgp_selective	Boolean	`true`, `false`	No
maximum_paths_eibgp_route_policy	String		No
maximum_paths_unique_nexthop_check_disable	Boolean	`true`, `false`	No
label_mode	Choice	`per-prefix`, `per-ce`, `per-vrf`, `per-vrf-46`, `per-nexthop-received-label`, `per-nexthop-received-label-allocate-secondary-label`	No
label_mode_route_policy	String		No
redistribute_connected	Boolean	`true`, `false`	No
redistribute_connected_metric	Integer	min: `0`, max: `4294967295`	No
redistribute_connected_multipath	Boolean	`true`, `false`	No
redistribute_connected_route_policy	String		No
redistribute_static	Boolean	`true`, `false`	No
redistribute_static_metric	Integer	min: `0`, max: `4294967295`	No
redistribute_static_multipath	Boolean	`true`, `false`	No
redistribute_static_route_policy	String		No
redistribute_rip	Boolean	`true`, `false`	No
redistribute_rip_metric	Integer	min: `0`, max: `4294967295`	No
redistribute_rip_multipath	Boolean	`true`, `false`	No
redistribute_rip_route_policy	String		No
table_policy	String		No
bgp_origin_as_validation_enable	Boolean	`true`, `false`	No
bgp_origin_as_validation_signal_ibgp	Boolean	`true`, `false`	No
bgp_bestpath_origin_as_use_validity	Boolean	`true`, `false`	No
bgp_bestpath_origin_as_allow_invalid	Boolean	`true`, `false`	No
bgp_dampening_decay_half_life	Integer	min: `1`, max: `255`	No
bgp_dampening_reuse_threshold	Integer	min: `1`, max: `255`	No
bgp_dampening_suppress_threshold	Integer	min: `1`, max: `255`	No
bgp_dampening_max_suppress_time	Integer	min: `0`, max: `4294967295`	No
bgp_dampening_route_policy	String		No
dynamic_med_interval	Integer	min: `0`, max: `10`	No
weight_reset_on_import	Boolean	`true`, `false`	No
nexthop_route_policy	String		No
as_path_loopcheck_out_disable	Boolean	`true`, `false`	No
mvpn_single_forwarder_selection	Choice	`all`, `highest-ip-address`	No
segment_routing_srv6	Class	segment_routing_srv6	No
aggregate_addresses	List	aggregate_addresses	No
networks	List	networks	No
redistribute_ospf	List	redistribute_ospf	No
redistribute_ospfv3	List	redistribute_ospfv3	No
redistribute_eigrp	List	redistribute_eigrp	No
redistribute_isis	List	redistribute_isis	No

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

Name	Type	Constraint	Mandatory
enable	Boolean	`true`, `false`	No
distance_bgp_external_route	Integer	min: `1`, max: `20000`	No
distance_bgp_internal_route	Integer	min: `1`, max: `20000`	No
distance_bgp_local_route	Integer	min: `1`, max: `20000`	No
bgp_attribute_download	Boolean	`true`, `false`	No
allow_vpn_default_originate	Boolean	`true`, `false`	No
additional_paths_send	Boolean	`true`, `false`	No
additional_paths_send_disable	Boolean	`true`, `false`	No
additional_paths_receive	Boolean	`true`, `false`	No
additional_paths_receive_disable	Boolean	`true`, `false`	No
additional_paths_advertise_limit	Integer	min: `1`, max: `20000`	No
additional_paths_selection_route_policy	String		No
additional_paths_selection_disable	Boolean	`true`, `false`	No
advertise_best_external	Boolean	`true`, `false`	No
advertise_best_external_disable	Boolean	`true`, `false`	No
advertise_local_labeled_route_safi_unicast	Choice	`disable`, `enable`	No
allocate_label_all	Boolean	`true`, `false`	No
allocate_label_all_unlabeled_path	Boolean	`true`, `false`	No
allocate_label_route_policy_name	String		No
allocate_label_route_policy_unlabeled_path	Boolean	`true`, `false`	No
maximum_paths_ebgp_multipath	Integer	min: `2`, max: `128`	No
maximum_paths_ebgp_selective	Boolean	`true`, `false`	No
maximum_paths_ebgp_route_policy	String		No
maximum_paths_ibgp_multipath	Integer	min: `2`, max: `128`	No
maximum_paths_ibgp_unequal_cost	Boolean	`true`, `false`	No
maximum_paths_ibgp_unequal_cost_deterministic	Boolean	`true`, `false`	No
maximum_paths_ibgp_selective	Boolean	`true`, `false`	No
maximum_paths_ibgp_route_policy	String		No
maximum_paths_eibgp_multipath	Integer	min: `2`, max: `128`	No
maximum_paths_eibgp_equal_cost	Boolean	`true`, `false`	No
maximum_paths_eibgp_selective	Boolean	`true`, `false`	No
maximum_paths_eibgp_route_policy	String		No
maximum_paths_unique_nexthop_check_disable	Boolean	`true`, `false`	No
label_mode	Choice	`per-prefix`, `per-ce`, `per-vrf`, `per-vrf-46`, `per-nexthop-received-label`, `per-nexthop-received-label-allocate-secondary-label`	No
label_mode_route_policy	String		No
redistribute_connected	Boolean	`true`, `false`	No
redistribute_connected_metric	Integer	min: `0`, max: `4294967295`	No
redistribute_connected_multipath	Boolean	`true`, `false`	No
redistribute_connected_route_policy	String		No
redistribute_static	Boolean	`true`, `false`	No
redistribute_static_metric	Integer	min: `0`, max: `4294967295`	No
redistribute_static_multipath	Boolean	`true`, `false`	No
redistribute_static_route_policy	String		No
redistribute_rip	Boolean	`true`, `false`	No
redistribute_rip_metric	Integer	min: `0`, max: `4294967295`	No
redistribute_rip_multipath	Boolean	`true`, `false`	No
redistribute_rip_route_policy	String		No
table_policy	String		No
bgp_origin_as_validation_enable	Boolean	`true`, `false`	No
bgp_origin_as_validation_signal_ibgp	Boolean	`true`, `false`	No
bgp_bestpath_origin_as_use_validity	Boolean	`true`, `false`	No
bgp_bestpath_origin_as_allow_invalid	Boolean	`true`, `false`	No
bgp_dampening_decay_half_life	Integer	min: `1`, max: `255`	No
bgp_dampening_reuse_threshold	Integer	min: `1`, max: `255`	No
bgp_dampening_suppress_threshold	Integer	min: `1`, max: `255`	No
bgp_dampening_max_suppress_time	Integer	min: `0`, max: `4294967295`	No
bgp_dampening_route_policy	String		No
dynamic_med_interval	Integer	min: `0`, max: `10`	No
weight_reset_on_import	Boolean	`true`, `false`	No
nexthop_route_policy	String		No
as_path_loopcheck_out_disable	Boolean	`true`, `false`	No
mvpn_single_forwarder_selection	Choice	`all`, `highest-ip-address`	No
segment_routing_srv6	Class	segment_routing_srv6	No
aggregate_addresses	List	aggregate_addresses	No
networks	List	networks	No
redistribute_ospf	List	redistribute_ospf	No
redistribute_ospfv3	List	redistribute_ospfv3	No
redistribute_eigrp	List	redistribute_eigrp	No
redistribute_isis	List	redistribute_isis	No

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

Name	Type	Constraint	Mandatory
enable	Boolean	`true`, `false`	No
distance_bgp_external_route	Integer	min: `1`, max: `20000`	No
distance_bgp_internal_route	Integer	min: `1`, max: `20000`	No
distance_bgp_local_route	Integer	min: `1`, max: `20000`	No
maximum_paths_ebgp_multipath	Integer	min: `2`, max: `128`	No
maximum_paths_ebgp_selective	Boolean	`true`, `false`	No
maximum_paths_ebgp_route_policy	String		No
maximum_paths_ibgp_multipath	Integer	min: `2`, max: `128`	No
maximum_paths_ibgp_unequal_cost	Boolean	`true`, `false`	No
maximum_paths_ibgp_unequal_cost_deterministic	Boolean	`true`, `false`	No
maximum_paths_ibgp_selective	Boolean	`true`, `false`	No
maximum_paths_ibgp_route_policy	String		No
maximum_paths_eibgp_multipath	Integer	min: `2`, max: `128`	No
maximum_paths_eibgp_equal_cost	Boolean	`true`, `false`	No
maximum_paths_eibgp_selective	Boolean	`true`, `false`	No
maximum_paths_eibgp_route_policy	String		No
redistribute_connected	Boolean	`true`, `false`	No
redistribute_connected_metric	Integer	min: `0`, max: `4294967295`	No
redistribute_connected_multipath	Boolean	`true`, `false`	No
redistribute_connected_route_policy	String		No
redistribute_static	Boolean	`true`, `false`	No
redistribute_static_metric	Integer	min: `0`, max: `4294967295`	No
redistribute_static_multipath	Boolean	`true`, `false`	No
redistribute_static_route_policy	String		No
redistribute_rip	Boolean	`true`, `false`	No
redistribute_rip_metric	Integer	min: `0`, max: `4294967295`	No
redistribute_rip_multipath	Boolean	`true`, `false`	No
redistribute_rip_route_policy	String		No
table_policy	String		No
bgp_dampening_decay_half_life	Integer	min: `1`, max: `255`	No
bgp_dampening_reuse_threshold	Integer	min: `1`, max: `255`	No
bgp_dampening_suppress_threshold	Integer	min: `1`, max: `255`	No
bgp_dampening_max_suppress_time	Integer	min: `0`, max: `4294967295`	No
bgp_dampening_route_policy	String		No
weight_reset_on_import	Boolean	`true`, `false`	No
nexthop_route_policy	String		No
as_path_loopcheck_out_disable	Boolean	`true`, `false`	No
mvpn_single_forwarder_selection	Choice	`all`, `highest-ip-address`	No
aggregate_addresses	List	aggregate_addresses	No
networks	List	networks	No
redistribute_ospf	List	redistribute_ospf	No
redistribute_eigrp	List	redistribute_eigrp	No
redistribute_isis	List	redistribute_isis	No

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

Name	Type	Constraint	Mandatory
enable	Boolean	`true`, `false`	No
distance_bgp_external_route	Integer	min: `1`, max: `20000`	No
distance_bgp_internal_route	Integer	min: `1`, max: `20000`	No
distance_bgp_local_route	Integer	min: `1`, max: `20000`	No
maximum_paths_ebgp_multipath	Integer	min: `2`, max: `128`	No
maximum_paths_ebgp_selective	Boolean	`true`, `false`	No
maximum_paths_ebgp_route_policy	String		No
maximum_paths_ibgp_multipath	Integer	min: `2`, max: `128`	No
maximum_paths_ibgp_unequal_cost	Boolean	`true`, `false`	No
maximum_paths_ibgp_unequal_cost_deterministic	Boolean	`true`, `false`	No
maximum_paths_ibgp_selective	Boolean	`true`, `false`	No
maximum_paths_ibgp_route_policy	String		No
maximum_paths_eibgp_multipath	Integer	min: `2`, max: `128`	No
maximum_paths_eibgp_equal_cost	Boolean	`true`, `false`	No
maximum_paths_eibgp_selective	Boolean	`true`, `false`	No
maximum_paths_eibgp_route_policy	String		No
redistribute_connected	Boolean	`true`, `false`	No
redistribute_connected_metric	Integer	min: `0`, max: `4294967295`	No
redistribute_connected_multipath	Boolean	`true`, `false`	No
redistribute_connected_route_policy	String		No
redistribute_static	Boolean	`true`, `false`	No
redistribute_static_metric	Integer	min: `0`, max: `4294967295`	No
redistribute_static_multipath	Boolean	`true`, `false`	No
redistribute_static_route_policy	String		No
redistribute_rip	Boolean	`true`, `false`	No
redistribute_rip_metric	Integer	min: `0`, max: `4294967295`	No
redistribute_rip_multipath	Boolean	`true`, `false`	No
redistribute_rip_route_policy	String		No
table_policy	String		No
bgp_dampening_decay_half_life	Integer	min: `1`, max: `255`	No
bgp_dampening_reuse_threshold	Integer	min: `1`, max: `255`	No
bgp_dampening_suppress_threshold	Integer	min: `1`, max: `255`	No
bgp_dampening_max_suppress_time	Integer	min: `0`, max: `4294967295`	No
bgp_dampening_route_policy	String		No
weight_reset_on_import	Boolean	`true`, `false`	No
nexthop_route_policy	String		No
as_path_loopcheck_out_disable	Boolean	`true`, `false`	No
mvpn_single_forwarder_selection	Choice	`all`, `highest-ip-address`	No
aggregate_addresses	List	aggregate_addresses	No
networks	List	networks	No
redistribute_ospfv3	List	redistribute_ospfv3	No
redistribute_eigrp	List	redistribute_eigrp	No
redistribute_isis	List	redistribute_isis	No

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

Name	Type	Constraint	Mandatory	Default Value
id	Any	String or Integer[min: `1`, max: `4294967295`] or String[Regex: `^.[\$\%]\{.\}.*$`]	Yes
disable	Boolean	`true`, `false`	Yes

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

Name	Type	Constraint	Mandatory
locator	String		No
usid_allocation_wide_local_id_block	Boolean	`true`, `false`	No
alloc_mode	Choice	`per-ce`, `per-vrf`, `per-vrf-46`	No

Guidelines and Limitations

Data Normalization

BGP RD Formats

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

two-byte AS (e.g., 65001:100)
four-byte AS (e.g., 65536:100)
IPv4 address (e.g., 192.168.1.1:100)
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

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 two 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

Note: Both forms produce the same result on the device. Declaring a key with no value (e.g., ipv6_unicast:) is not valid; use enable: true instead.

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
                retain_routes: true
                interfaces:
                  - name: GigabitEthernet0/0/0/0
                  - name: GigabitEthernet0/0/0/1
              bgp_origin_as_validation_signal_ibgp: true
              bgp_origin_as_validation_time: 45
              rpki_servers:
                - address: 192.168.1.100
                  refresh_time: 120
                  response_time: 240
                  purge_time: 180
                  username: rpki-user
                  password_type: 7
                  password: "060506324F41"
                  transport_tcp_port: 3323
              rpki_routes:
                - prefix: 10.0.0.0
                  length: 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:
                - as_number: 65002
                - as_number: 65003
              as_league_peers:
                - as_number: 65100
                - as_number: 65200
              as_lists:
                - name: ALLOWED_AS
                  asns:
                    - as_number: 65002
                    - as_number: 65003
              attribute_filter_groups:
                - name: FILTER_GROUP1
                  code_ranges:
                    - from: 4
                      to: 10
                      discard: true
              bgp_cluster_id: 100010
              bgp_enforce_first_as_disable: true
              bgp_as_path_loopcheck: true

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_policies:
          - 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_policies:
          - 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
                      length: 8
                      route_policy: ROUTE_POLICY_1
                  aggregate_addresses:
                    - address: 10.0.0.0
                      length: 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:
                    - process: OSPF1
                      match: match-external-1
                      metric: 100
                  redistribute_isis:
                    - process: 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_policies:
          - 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:
                      - id: "100010"
                        disable: true
                      - id: 100011
                        disable: true
                      - id: 10.1.1.1
                        disable: true
                      - 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_policies:
          - 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:
                    - process: OSPF1
                      match: match-internal
                      metric: 100
                      multipath: true
                      route_policy: POLICY_IN
                  redistribute_isis:
                    - process: 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:
                      - id: 100010
                        disable: true
                      - id: 100011
                        disable: true
                      - id: 10.1.1.1
                        disable: true
                      - 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_policies:
          - 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:
                      - id: 100010
                        disable: true
                      - id: 100011
                        disable: true
                      - id: 10.1.1.1
                        disable: true
                      - 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:
                      - id: 100010
                        disable: true
                      - id: 100011
                        disable: true
                      - id: 10.1.1.1
                        disable: true
                      - 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

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_policies:
          - name: POLICY_IN
            rpl: |
              route-policy POLICY_IN
                pass
              end-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:
                - address: 10.1.1.2
                  remote_as: 65001
                  description: "IPv4 unicast neighbor"
                  address_family:
                    - 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_policies:
          - name: POLICY_IN
            rpl: |
              route-policy POLICY_IN
                pass
              end-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:
                - address: 10.1.1.2
                  remote_as: 65001
                  description: "IPv6 unicast neighbor"
                  address_family:
                    - 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_policies:
          - name: POLICY_IN
            rpl: |
              route-policy POLICY_IN
                pass
              end-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:
                - address: 10.1.1.2
                  remote_as: 65001
                  description: "VPNv4 unicast neighbor"
                  address_family:
                    - 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

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_policies:
          - 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:
                - name: NGROUP1
                  remote_as: 65001
                  advertisement_interval_seconds: 10
                  description: "My Neighbor Group Description"
                  tcp_mss: 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_read_size: 1024
                  send_buffer_size: 4096
                  send_buffer_write_size: 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: 256
                  log_message_out: 256
                  update_source: Loopback0
                  address_family:
                    - 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:
                - 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:
                    - 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_policies:
          - 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:
                - name: NGROUP1
                  remote_as: 65001
                  advertisement_interval_seconds: 10
                  description: "My Neighbor Group Description"
                  tcp_mss: 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_read_size: 1024
                  send_buffer_size: 4096
                  send_buffer_write_size: 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: 256
                  log_message_out: 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:
                    - 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

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:
                - name: SGROUP1
                  remote_as: 65001
                  advertisement_interval_seconds: 10
                  advertisement_interval_milliseconds: 500
                  description: "IBGP Session Group"
                  tcp_mss: 1460
                  tcp_mtu_discovery: true
                  bfd_minimum_interval: 10
                  bfd_multiplier: 4
                  bfd_fast_detect: "enable"
                  receive_buffer_size: 1024
                  receive_buffer_read_size: 1024
                  send_buffer_size: 4096
                  send_buffer_write_size: 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: 256
                  log_message_out: 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:
                - 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_read_size: 1024
                  send_buffer_size: 4096
                  send_buffer_write_size: 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

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_policies:
          - 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:
                - name: vpnv4-unicast
              af_groups:
                - name: AFGROUP1
                  address_family:
                    - 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_policies:
          - 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:
                - name: vpnv6-unicast
              af_groups:
                - name: AFGROUP1
                  address_family:
                    - 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_policies:
          - 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:
                - name: ipv4-unicast
              af_groups:
                - name: AFGROUP1
                  address_family:
                    - 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

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:
                - name: VRF1
                  rd: auto
                  mpls_activate_interfaces:
                    - name: GigabitEthernet0/0/0/1
                  default_information_originate: true
                  default_metric: 125
                  socket_receive_buffer_size: 1024
                  socket_receive_buffer_read_size: 1024
                  socket_send_buffer_size: 4096
                  socket_send_buffer_write_size: 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:
                - name: VRF2
                  rd: "100:100"
                  neighbors:
                    - address: 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: 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_read_size: 1024
                      send_buffer_size: 4096
                      send_buffer_write_size: 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: 256
                      log_message_out: 256
                      update_source: GigabitEthernet0/0/0/1

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:
                - 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_policies:
          - name: POLICY_IN
            rpl: |
              route-policy POLICY_IN
                pass
              end-policy
        routing:
          bgp:
            - as_number: 65001
              vrfs:
                - 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::"
                          length: 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:
                - 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_policies:
          - name: POLICY_IN
            rpl: |
              route-policy POLICY_IN
                pass
              end-policy
        routing:
          bgp:
            - as_number: 65001
              vrfs:
                - 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

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_policies:
          - name: POLICY_IN
            rpl: |
              route-policy POLICY_IN
                pass
              end-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:
                - name: VRF1
                  neighbors:
                    - address: 10.1.1.2
                      remote_as: 65002
                      description: "VRF neighbor with two-byte AS site-of-origin"
                      address_family:
                        - 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"
                        - 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_policies:
          - name: POLICY_IN
            rpl: |
              route-policy POLICY_IN
                pass
              end-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:
                - name: VRF2
                  neighbors:
                    - address: 10.1.1.3
                      remote_as: 65003
                      description: "VRF neighbor with four-byte AS site-of-origin"
                      address_family:
                        - 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"
                        - 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"