BGP

Border Gateway Protocol (BGP) is the de facto standard path-vector protocol used to exchange routing information between autonomous systems, supporting multi-address-family deployments including IPv4 unicast, IPv6 unicast, and L2VPN EVPN on NX-OS. It provides extensive policy control through peer templates, route maps, prefix lists, and per-neighbor address-family configuration with granular route filtering, community manipulation, and next-hop processing for both eBGP and iBGP sessions. BGP supports advanced features including enhanced error handling, graceful restart, route reflector functionality, maximum prefix limits, policy batching control, and fabric SOO for VXLAN EVPN deployments.

Diagram

Diagram

Classes

nxos

Name	Type	Constraint	Mandatory	Default Value
devices	List	devices	No
device_groups	List	device_groups	No
global	Class	global	No
templates	List	templates	No

devices (nxos)

Name	Type	Constraint	Mandatory	Default Value
configuration	Class	configuration	No

device_groups (nxos)

Name	Type	Constraint	Mandatory	Default Value
configuration	Class	configuration	No

global (nxos)

Name	Type	Constraint	Mandatory	Default Value
configuration	Class	configuration	No

templates (nxos)

Name	Type	Constraint	Mandatory	Default Value
configuration	Class	configuration	No

configuration (nxos.devices)

Name	Type	Constraint	Mandatory	Default Value
routing	Class	routing	No

routing (nxos.devices.configuration)

Name	Type	Constraint	Mandatory	Default Value
bgp	Class	bgp	No

bgp (nxos.devices.configuration.routing)

Name	Type	Constraint	Mandatory	Default Value
asn	Any	String or Integer[min: 0, max: 4294967295]	No
shutdown	Boolean	true, false	No
disable_policy_batching	Boolean	true, false	No
disable_policy_batching_nexthop	Boolean	true, false	No
disable_policy_batching_ipv4_prefix_list	String		No
disable_policy_batching_ipv6_prefix_list	String		No
fabric_soo	String		No
flush_routes	Boolean	true, false	No
isolate	Choice	enabled, disabled, include-local, custom	No
isolate_route_map	String		No
med_dampening_interval	Integer	min: 60, max: 4294967295	No
mvpn_vri_id	Integer	min: 1, max: 65535	No
nexthop_suppress_default_resolution	Boolean	true, false	No
rd_dual	Boolean	true, false	No
rd_dual_id	Integer	min: 1, max: 65535	No
peer_templates	List	peer_templates	No
peer_session_templates	List	peer_session_templates	No
peer_policy_templates	List	peer_policy_templates	No
router_id	IP		No
allocate_index	Integer	min: 1, max: 8000	No
bestpath_limit_always	Boolean	true, false	No
bestpath_limit	Integer	min: 1, max: 3600	No
reference_bandwidth	Integer	min: 0, max: 4294967295	No
reference_bandwidth_unit	Choice	mbps, gbps	No
cluster_id	Any	IP or Integer[min: 0, max: 4294967295] or String[Regex: ^.*[$%]\{.*$]	No
hold_time	Integer	min: 3, max: 3600	No
keepalive_interval	Integer	min: 0, max: 3600	No
local_as	Any	String or Integer[min: 0, max: 4294967295]	No
maxas_limit	Integer	min: 1, max: 512	No
mode	Choice	fabric, external, proxy	No
prefix_peer_timeout	Integer	min: 0, max: 1200	No
prefix_peer_wait	Integer	min: 0, max: 1200	No
reconnect_interval	Integer	min: 1, max: 60	No
router_id_auto	Boolean	true, false	No
log_neighbor_changes	Boolean	true, false	No
enforce_first_as	Boolean	true, false	No
neighbor_down_fib_accelerate	Boolean	true, false	No
suppress_fib_pending	Boolean	true, false	No
graceful_restart	Choice	helper, complete	No
graceful_restart_restart_time	Integer	min: 1, max: 3600	No
graceful_restart_stalepath_time	Integer	min: 1, max: 3600	No
bestpath	Class	bestpath	No
neighbors	List	neighbors	No
address_families	List	address_families	No
vrfs	List	vrfs	No

bgp (nxos.devices.configuration.routing)

Name	Type	Constraint	Mandatory	Default Value
asn	Any	String or Integer[min: 0, max: 4294967295]	No
shutdown	Boolean	true, false	No
disable_policy_batching	Boolean	true, false	No
disable_policy_batching_nexthop	Boolean	true, false	No
disable_policy_batching_ipv4_prefix_list	String		No
disable_policy_batching_ipv6_prefix_list	String		No
fabric_soo	String		No
flush_routes	Boolean	true, false	No
isolate	Choice	enabled, disabled, include-local, custom	No
isolate_route_map	String		No
med_dampening_interval	Integer	min: 60, max: 4294967295	No
nexthop_suppress_default_resolution	Boolean	true, false	No
rd_dual	Boolean	true, false	No
rd_dual_id	Integer	min: 1, max: 65535	No
peer_templates	List	peer_templates	No
router_id	IP		No
allocate_index	Integer	min: 1, max: 8000	No
bestpath_limit_always	Boolean	true, false	No
bestpath_limit	Integer	min: 1, max: 3600	No
bandwidth_reference	Integer	min: 0, max: 4294967295	No
bandwidth_reference_unit	Choice	mbps, gbps	No
cluster_id	Any	IP or Integer[min: 0, max: 4294967295] or String[Regex: ^.*[$%]\{.*$]	No
hold_time	Integer	min: 3, max: 3600	No
keepalive_interval	Integer	min: 0, max: 3600	No
local_as	Any	String or Integer[min: 0, max: 4294967295]	No
maxas_limit	Integer	min: 1, max: 512	No
mode	Choice	fabric, external, proxy	No
prefix_peer_timeout	Integer	min: 0, max: 1200	No
prefix_peer_wait	Integer	min: 0, max: 1200	No
reconnect_interval	Integer	min: 1, max: 60	No
router_id_auto	Boolean	true, false	No
log_neighbor_changes	Boolean	true, false	No
enforce_first_as	Boolean	true, false	No
neighbor_down_fib_accelerate	Boolean	true, false	No
suppress_fib_pending	Boolean	true, false	No
graceful_restart	Choice	helper, complete	No
graceful_restart_restart_time	Integer	min: 1, max: 3600	No
graceful_restart_stalepath_time	Integer	min: 1, max: 3600	No
neighbors	List	neighbors	No
address_families	List	address_families	No
vrfs	List	vrfs	No

peer_templates (nxos.devices.configuration.routing.bgp)

Name	Type	Constraint	Mandatory	Default Value
name	String		Yes
remote_as	Any	String or Integer[min: 0, max: 4294967295]	No
description	String		No
peer_type	Choice	fabric-internal, fabric-external, fabric-border-leaf	No
update_source_interface_type	Choice	ethernet, loopback, mgmt, port-channel, vlan, vni	No
update_source_interface_id	Any	String or Integer[min: 0]	No
shutdown	Boolean	true, false	No
affinity_group	Integer	min: 0, max: 65535	No
bfd_multihop	Boolean	true, false	No
bmp_activate_server_1	Boolean	true, false	No
bmp_activate_server_2	Boolean	true, false	No
capability_suppress_4_byte_as	Boolean	true, false	No
transport_connection_mode	Choice	passive	No
bfd	Boolean	true, false	No
disable_connected_check	Boolean	true, false	No
dont_capability_negotiate	Boolean	true, false	No
dynamic_capability	Boolean	true, false	No
hold_time	Integer	min: 3, max: 3600	No
keepalive_interval	Integer	min: 0, max: 3600	No
log_neighbor_changes	Boolean	true, false	No
low_memory_exempt	Boolean	true, false	No
maximum_peers	Integer	min: 1, max: 1000	No
password_type	Choice	0, 3, line, 6, 7	No
password	String		No
remove_private_as	Choice	none, enabled, all, replace-as	No
inherit_peer_session	String		No
ebgp_multihop_ttl	Integer	min: 2, max: 255	No
ttl_security_hops	Integer	min: 1, max: 254	No
address_families	List	address_families	No

peer_templates (nxos.devices.configuration.routing.bgp)

Name	Type	Constraint	Mandatory	Default Value
name	String		Yes
remote_as	Any	String or Integer[min: 0, max: 4294967295]	No
description	String		No
peer_type	Choice	fabric-internal, fabric-external, fabric-border-leaf	No
update_source_interface_type	Choice	ethernet, loopback, mgmt, port-channel, vlan, vni	No
update_source_interface_id	Any	String or Integer[min: 0]	No
shutdown	Boolean	true, false	No
affinity_group	Integer	min: 0, max: 65535	No
bfd_multihop	Boolean	true, false	No
bmp_activate_server_1	Boolean	true, false	No
bmp_activate_server_2	Boolean	true, false	No
capability_suppress_4_byte_as	Boolean	true, false	No
connection_mode	Choice	passive	No
bfd	Boolean	true, false	No
disable_connected_check	Boolean	true, false	No
dont_capability_negotiate	Boolean	true, false	No
dynamic_capability	Boolean	true, false	No
hold_time	Integer	min: 3, max: 3600	No
keepalive_interval	Integer	min: 0, max: 3600	No
log_neighbor_changes	Boolean	true, false	No
low_memory_exempt	Boolean	true, false	No
maximum_peers	Integer	min: 1, max: 1000	No
password_type	Choice	0, 3, line, 6, 7	No
password	String		No
remove_private_as	Choice	none, enabled, all, replace-as	No
inherit_peer_session	String		No
ebgp_multihop_ttl	Integer	min: 2, max: 255	No
ttl_security_hops	Integer	min: 1, max: 254	No
address_families	List	address_families	No

peer_session_templates (nxos.devices.configuration.routing.bgp)

Name	Type	Constraint	Mandatory	Default Value
name	String		Yes
remote_as	Any	String or Integer[min: 0, max: 4294967295]	No
description	String		No
peer_type	Choice	fabric-internal, fabric-external, fabric-border-leaf	No
update_source_interface_type	Choice	ethernet, loopback, mgmt, port-channel, vlan, vni	No
update_source_interface_id	Any	String or Integer[min: 0]	No
shutdown	Boolean	true, false	No
affinity_group	Integer	min: 0, max: 65535	No
bfd	Boolean	true, false	No
bfd_multihop	Boolean	true, false	No
bmp_activate_server_1	Boolean	true, false	No
bmp_activate_server_2	Boolean	true, false	No
capability_suppress_4_byte_as	Boolean	true, false	No
transport_connection_mode	Choice	passive	No
disable_connected_check	Boolean	true, false	No
dont_capability_negotiate	Boolean	true, false	No
dynamic_capability	Boolean	true, false	No
hold_time	Integer	min: 3, max: 3600	No
keepalive_interval	Integer	min: 0, max: 3600	No
log_neighbor_changes	Boolean	true, false	No
low_memory_exempt	Boolean	true, false	No
maximum_peers	Integer	min: 1, max: 1000	No
password_type	Choice	0, 3, line, 6, 7	No
password	String		No
remove_private_as	Choice	none, enabled, all, replace-as	No
inherit_peer_session	String		No
ebgp_multihop_ttl	Integer	min: 2, max: 255	No
ttl_security_hops	Integer	min: 1, max: 254	No
local_as	Any	String or Integer[min: 0, max: 4294967295]	No
local_as_propagation	Choice	none, no-prepend, replace-as, dual-as	No
dscp	Integer	min: 0, max: 63	No
internal_vpn_client	Boolean	true, false	No

peer_policy_templates (nxos.devices.configuration.routing.bgp)

Name	Type	Constraint	Mandatory	Default Value
name	String		Yes
send_community_standard	Boolean	true, false	No
send_community_extended	Boolean	true, false	No
route_reflector_client	Boolean	true, false	No
next_hop_self	Boolean	true, false	No
next_hop_self_all	Boolean	true, false	No
disable_peer_as_check	Boolean	true, false	No
allowas_in	Boolean	true, false	No
allowas_in_count	Integer	min: 0, max: 10	No
default_originate	Boolean	true, false	No
default_originate_route_map	String		No
suppress_inactive	Boolean	true, false	No
advertisement_interval	Integer	min: 1, max: 600	No
advertise_local_labeled_route	Boolean	true, false	No
aigp	Boolean	true, false	No
as_override	Boolean	true, false	No
capability_additional_paths_send	Boolean	true, false	No
capability_additional_paths_receive	Boolean	true, false	No
dmz_link_bandwidth	Boolean	true, false	No
link_bandwidth_cumulative	Boolean	true, false	No
next_hop_third_party	Boolean	true, false	No
soft_reconfiguration_inbound	Choice	none, inbound, inbound-always	No
soo	String		No
unsuppress_map	String		No
weight	Integer	min: 0, max: 65535	No
maximum_prefix	Class	maximum_prefix	No
route_map_in	String		No
route_map_out	String		No
prefix_list_in	String		No
prefix_list_out	String		No
filter_list_in	String		No
filter_list_out	String		No
inherit_peer_policies	List	inherit_peer_policies	No

bestpath (nxos.devices.configuration.routing.bgp)

Name	Type	Constraint	Mandatory	Default Value
always_compare_med	Boolean	true, false	No
compare_routerid	Boolean	true, false	No
compare_neighborid	Boolean	true, false	No
as_path_ignore	Boolean	true, false	No
as_path_multipath_relax	Boolean	true, false	No
aigp_ignore	Boolean	true, false	No
cost_community_ignore	Boolean	true, false	No
igp_metric_ignore	Boolean	true, false	No
med_confed	Boolean	true, false	No
med_missing_as_worst	Boolean	true, false	No
med_non_deterministic	Boolean	true, false	No

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

Name	Type	Constraint	Mandatory	Default Value
ip	IP		No
interface_type	Choice	ethernet, loopback, mgmt, port-channel, vlan, vni	No
interface_id	Any	String or Integer[min: 0]	No
remote_as	Any	String or Integer[min: 0, max: 4294967295]	No
description	String		No
inherit_peer	String		No
peer_type	Choice	fabric-internal, fabric-external, fabric-border-leaf	No
update_source_interface_type	Choice	ethernet, loopback, mgmt, port-channel, vlan, vni	No
update_source_interface_id	Any	String or Integer[min: 0]	No
hold_time	Integer	min: 3, max: 3600	No
keepalive_interval	Integer	min: 0, max: 3600	No
ebgp_multihop_ttl	Integer	min: 2, max: 255	No
bfd	Boolean	true, false	No
disable_connected_check	Boolean	true, false	No
dont_capability_negotiate	Boolean	true, false	No
dynamic_capability	Boolean	true, false	No
password_type	Choice	0, 3, line, 6, 7	No
password	String		No
shutdown	Boolean	true, false	No
affinity_group	Integer	min: 0, max: 65535	No
bfd_multihop	Boolean	true, false	No
bmp_activate_server_1	Boolean	true, false	No
bmp_activate_server_2	Boolean	true, false	No
capability_suppress_4_byte_as	Boolean	true, false	No
transport_connection_mode	Choice	passive	No
log_neighbor_changes	Boolean	true, false	No
low_memory_exempt	Boolean	true, false	No
maximum_peers	Integer	min: 1, max: 1000	No
remove_private_as	Choice	none, enabled, all, replace-as	No
inherit_peer_session	String		No
ttl_security_hops	Integer	min: 1, max: 254	No
local_as	Any	String or Integer[min: 0, max: 4294967295]	No
local_as_propagation	Choice	none, no-prepend, replace-as, dual-as	No
dscp	Integer	min: 0, max: 63	No
dynamic_route_map	String		No
egress_engineering	Boolean	true, false	No
egress_engineering_peer_set	String		No
internal_vpn_client	Boolean	true, false	No
address_families	List	address_families	No

address_families (nxos.devices.configuration.routing.bgp)

Name	Type	Constraint	Mandatory	Default Value
address_family	Choice	ipv4-unicast, ipv4-multicast, vpnv4-unicast, ipv6-unicast, ipv6-multicast, vpnv6-unicast, vpnv6-multicast, l2vpn-evpn, ipv4-lucast, ipv6-lucast, link-state, ipv4-mvpn, ipv6-mvpn, l2vpn-vpls, ipv4-mdt	Yes
advertise_l2vpn_evpn	Boolean	true, false	No
advertise_only_active_routes	Boolean	true, false	No
advertise_pip	Boolean	true, false	No
advertise_system_mac	Boolean	true, false	No
allocate_label_all	Boolean	true, false	No
allocate_label_option_b	Boolean	true, false	No
allocate_label_route_map	String		No
bestpath_origin_as_allow_invalid	Boolean	true, false	No
bestpath_origin_as_use_validity	Boolean	true, false	No
client_to_client_reflection	Boolean	true, false	No
nexthop_trigger_delay_critical	Integer	min: 1, max: 4294967295	No
default_information_originate	Boolean	true, false	No
default_information_originate_always_rd	String		No
default_information_originate_always_route_target	String		No
default_metric	Integer	min: 0, max: 4294967295	No
export_gateway_ip	Boolean	true, false	No
dampen_igp_metric	Integer	min: 0, max: 3600	No
label_allocation_mode	Boolean	true, false	No
load_balance_egress_filter_policy_route_map	String		No
load_balance_egress_multipath_auto_policy_route_map	String		No
maximum_paths	Integer	min: 1, max: 512	No
maximum_paths_eibgp	Integer	min: 1, max: 512	No
maximum_paths_ibgp	Integer	min: 1, max: 512	No
maximum_paths_local	Integer	min: 1, max: 512	No
maximum_paths_mixed	Integer	min: 1, max: 512	No
maximum_paths_unequal_cost	Boolean	true, false	No
nexthop_route_map	String		No
nexthop_load_balance_egress_multisite	Boolean	true, false	No
nexthop_trigger_delay_non_critical	Integer	min: 1, max: 4294967295	No
originate_map	String		No
origin_as_validate	Boolean	true, false	No
origin_as_validate_signal_ibgp	Boolean	true, false	No
prefix_priority	Choice	none, high	No
retain_route_target_all	Boolean	true, false	No
retain_route_target_route_map	String		No
table_map	String		No
table_map_filter	Boolean	true, false	No
timers_bestpath_defer	Integer	min: 100, max: 3000	No
timers_bestpath_defer_maximum	Integer	min: 300, max: 300000	No
allow_vni_in_ethertag	Boolean	true, false	No
wait_igp_convergence	Boolean	true, false	No
additional_paths_send	Boolean	true, false	No
additional_paths_receive	Boolean	true, false	No
additional_paths_install_backup	Boolean	true, false	No
additional_paths_selection_route_map	String		No
networks	List	networks	No
redistributions	List	redistributions	No
aggregate_addresses	List	aggregate_addresses	No

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

Name	Type	Constraint	Mandatory	Default Value
vrf	String		Yes
router_id	IP		No
allocate_index	Integer	min: 1, max: 8000	No
bestpath_limit_always	Boolean	true, false	No
bestpath_limit	Integer	min: 1, max: 3600	No
reference_bandwidth	Integer	min: 0, max: 4294967295	No
reference_bandwidth_unit	Choice	mbps, gbps	No
cluster_id	Any	IP or Integer[min: 0, max: 4294967295] or String[Regex: ^.*[$%]\{.*$]	No
hold_time	Integer	min: 3, max: 3600	No
keepalive_interval	Integer	min: 0, max: 3600	No
local_as	Any	String or Integer[min: 0, max: 4294967295]	No
maxas_limit	Integer	min: 1, max: 512	No
mode	Choice	fabric, external, proxy	No
prefix_peer_timeout	Integer	min: 0, max: 1200	No
prefix_peer_wait	Integer	min: 0, max: 1200	No
reconnect_interval	Integer	min: 1, max: 60	No
router_id_auto	Boolean	true, false	No
log_neighbor_changes	Boolean	true, false	No
enforce_first_as	Boolean	true, false	No
neighbor_down_fib_accelerate	Boolean	true, false	No
suppress_fib_pending	Boolean	true, false	No
graceful_restart	Choice	helper, complete	No
graceful_restart_restart_time	Integer	min: 1, max: 3600	No
graceful_restart_stalepath_time	Integer	min: 1, max: 3600	No
bestpath	Class	bestpath	No
neighbors	List	neighbors	No
address_families	List	address_families	No

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

Name	Type	Constraint	Mandatory	Default Value
vrf	String		Yes
router_id	IP		No
allocate_index	Integer	min: 1, max: 8000	No
bestpath_limit_always	Boolean	true, false	No
bestpath_limit	Integer	min: 1, max: 3600	No
reference_bandwidth	Integer	min: 0, max: 4294967295	No
reference_bandwidth_unit	Choice	mbps, gbps	No
cluster_id	Any	IP or Integer[min: 0, max: 4294967295] or String[Regex: ^.*[$%]\{.*$]	No
hold_time	Integer	min: 3, max: 3600	No
keepalive_interval	Integer	min: 0, max: 3600	No
local_as	Any	String or Integer[min: 0, max: 4294967295]	No
maxas_limit	Integer	min: 1, max: 512	No
mode	Choice	fabric, external, proxy	No
prefix_peer_timeout	Integer	min: 0, max: 1200	No
prefix_peer_wait	Integer	min: 0, max: 1200	No
reconnect_interval	Integer	min: 1, max: 60	No
router_id_auto	Boolean	true, false	No
log_neighbor_changes	Boolean	true, false	No
enforce_first_as	Boolean	true, false	No
neighbor_down_fib_accelerate	Boolean	true, false	No
suppress_fib_pending	Boolean	true, false	No
graceful_restart	Choice	helper, complete	No
graceful_restart_restart_time	Integer	min: 1, max: 3600	No
graceful_restart_stalepath_time	Integer	min: 1, max: 3600	No
neighbors	List	neighbors	No
address_families	List	address_families	No

address_families (nxos.devices.configuration.routing.bgp.peer_templates)

Name	Type	Constraint	Mandatory	Default Value
address_family	Choice	ipv4-unicast, ipv6-unicast, vpnv4-unicast, vpnv6-unicast, l2vpn-evpn, link-state	Yes
send_community_standard	Boolean	true, false	No
send_community_extended	Boolean	true, false	No
route_reflector_client	Boolean	true, false	No
next_hop_self	Boolean	true, false	No
next_hop_self_all	Boolean	true, false	No
disable_peer_as_check	Boolean	true, false	No
allowas_in	Boolean	true, false	No
default_originate	Boolean	true, false	No
suppress_inactive	Boolean	true, false	No
advertisement_interval	Integer	min: 1, max: 600	No
advertise_gateway_ip	Boolean	true, false	No
advertise_local_labeled_route	Boolean	true, false	No
aigp	Boolean	true, false	No
allowas_in_count	Integer	min: 0, max: 10	No
as_override	Boolean	true, false	No
default_originate_route_map	String		No
dmz_link_bandwidth	Boolean	true, false	No
encapsulation_mpls	Boolean	true, false	No
link_bandwidth_cumulative	Boolean	true, false	No
next_hop_third_party	Boolean	true, false	No
rewrite_evpn_rt_asn	Boolean	true, false	No
soft_reconfiguration_inbound	Choice	none, inbound, inbound-always	No
soo	String		No
unsuppress_map	String		No
weight	Integer	min: 0, max: 65535	No
maximum_prefix	Class	maximum_prefix	No
route_map_in	String		No
route_map_out	String		No
prefix_list_in	String		No
prefix_list_out	String		No
inherit_peer_policies	List	inherit_peer_policies	No

address_families (nxos.devices.configuration.routing.bgp.peer_templates)

Name	Type	Constraint	Mandatory	Default Value
address_family	Choice	ipv4-unicast, ipv6-unicast, vpnv4-unicast, vpnv6-unicast, l2vpn-evpn, link-state	Yes
send_community_standard	Boolean	true, false	No
send_community_extended	Boolean	true, false	No
route_reflector_client	Boolean	true, false	No
next_hop_self	Boolean	true, false	No
next_hop_self_all	Boolean	true, false	No
disable_peer_as_check	Boolean	true, false	No
allowas_in	Boolean	true, false	No
default_originate	Boolean	true, false	No
suppress_inactive	Boolean	true, false	No
advertisement_interval	Integer	min: 1, max: 600	No
advertise_gateway_ip	Boolean	true, false	No
advertise_local_labeled_route	Boolean	true, false	No
aigp	Boolean	true, false	No
allowas_in_count	Integer	min: 0, max: 10	No
as_override	Boolean	true, false	No
default_originate_route_map	String		No
dmz_link_bandwidth	Boolean	true, false	No
encapsulation_mpls	Boolean	true, false	No
link_bandwidth_cumulative	Boolean	true, false	No
next_hop_third_party	Boolean	true, false	No
rewrite_evpn_rt_asn	Boolean	true, false	No
soft_reconfiguration_inbound	Choice	none, inbound, inbound-always	No
soo	String		No
unsuppress_map	String		No
weight	Integer	min: 0, max: 65535	No
maximum_prefix	Class	maximum_prefix	No

maximum_prefix (nxos.devices.configuration.routing.bgp.peer_policy_templates)

Name	Type	Constraint	Mandatory	Default Value
number	Integer	min: 0, max: 4294967295	No
action	Choice	log, shut, restart	No
restart_time	Integer	min: 1, max: 65535	No
threshold	Integer	min: 1, max: 100	No

inherit_peer_policies (nxos.devices.configuration.routing.bgp.peer_policy_templates)

Name	Type	Constraint	Mandatory	Default Value
name	String		Yes
sequence	Integer	min: 1, max: 65535	Yes

address_families (nxos.devices.configuration.routing.bgp.neighbors)

Name	Type	Constraint	Mandatory	Default Value
address_family	Choice	ipv4-unicast, ipv4-mvpn, vpnv4-unicast, ipv6-unicast, vpnv6-unicast, l2vpn-evpn, link-state	Yes
send_community_standard	Boolean	true, false	No
send_community_extended	Boolean	true, false	No
route_reflector_client	Boolean	true, false	No
next_hop_self	Boolean	true, false	No
next_hop_self_all	Boolean	true, false	No
disable_peer_as_check	Boolean	true, false	No
allowas_in	Boolean	true, false	No
default_originate	Boolean	true, false	No
suppress_inactive	Boolean	true, false	No
advertisement_interval	Integer	min: 1, max: 600	No
advertise_gateway_ip	Boolean	true, false	No
advertise_local_labeled_route	Boolean	true, false	No
aigp	Boolean	true, false	No
allowas_in_count	Integer	min: 0, max: 10	No
as_override	Boolean	true, false	No
default_originate_route_map	String		No
dmz_link_bandwidth	Boolean	true, false	No
encapsulation_mpls	Boolean	true, false	No
link_bandwidth_cumulative	Boolean	true, false	No
next_hop_third_party	Boolean	true, false	No
rewrite_evpn_rt_asn	Boolean	true, false	No
soft_reconfiguration_inbound	Choice	none, inbound, inbound-always	No
soo	String		No
unsuppress_map	String		No
weight	Integer	min: 0, max: 65535	No
maximum_prefix	Class	maximum_prefix	No
route_map_in	String		No
route_map_out	String		No
prefix_list_in	String		No
prefix_list_out	String		No
inherit_peer_policies	List	inherit_peer_policies	No

address_families (nxos.devices.configuration.routing.bgp.neighbors)

Name	Type	Constraint	Mandatory	Default Value
address_family	Choice	ipv4-unicast, ipv4-mvpn, vpnv4-unicast, ipv6-unicast, vpnv6-unicast, l2vpn-evpn, link-state	Yes
send_community_standard	Boolean	true, false	No
send_community_extended	Boolean	true, false	No
route_reflector_client	Boolean	true, false	No
next_hop_self	Boolean	true, false	No
next_hop_self_all	Boolean	true, false	No
disable_peer_as_check	Boolean	true, false	No
allowas_in	Boolean	true, false	No
default_originate	Boolean	true, false	No
suppress_inactive	Boolean	true, false	No
advertisement_interval	Integer	min: 1, max: 600	No
advertise_gateway_ip	Boolean	true, false	No
advertise_local_labeled_route	Boolean	true, false	No
aigp	Boolean	true, false	No
allowas_in_count	Integer	min: 0, max: 10	No
as_override	Boolean	true, false	No
default_originate_route_map	String		No
dmz_link_bandwidth	Boolean	true, false	No
encapsulation_mpls	Boolean	true, false	No
link_bandwidth_cumulative	Boolean	true, false	No
next_hop_third_party	Boolean	true, false	No
rewrite_evpn_rt_asn	Boolean	true, false	No
soft_reconfiguration_inbound	Choice	none, inbound, inbound-always	No
soo	String		No
unsuppress_map	String		No
weight	Integer	min: 0, max: 65535	No
maximum_prefix	Class	maximum_prefix	No
route_map_in	String		No
route_map_out	String		No
prefix_list_in	String		No
prefix_list_out	String		No

networks (nxos.devices.configuration.routing.bgp.address_families)

Name	Type	Constraint	Mandatory	Default Value
prefix	IP		Yes
evpn	Boolean	true, false	No
route_map	String		No

networks (nxos.devices.configuration.routing.bgp.address_families)

Name	Type	Constraint	Mandatory	Default Value
prefix	String		Yes
evpn	Boolean	true, false	No
route_map	String		No

redistributions (nxos.devices.configuration.routing.bgp.address_families)

Name	Type	Constraint	Mandatory	Default Value
protocol	Choice	srv6, unspecified, static, direct, bgp, isis, ospf, ospfv3, eigrp, host, rip, amt, lisp, hmm, am, dhcpv6, icmpv6	Yes
protocol_instance	String		No
route_map	String		No
asn	Any	String or Integer[min: 0, max: 4294967295]	No

aggregate_addresses (nxos.devices.configuration.routing.bgp.address_families)

Name	Type	Constraint	Mandatory	Default Value
prefix	IP		Yes
as_set	Boolean	true, false	No
summary_only	Boolean	true, false	No
advertise_map	String		No
attribute_map	String		No
suppress_map	String		No

aggregate_addresses (nxos.devices.configuration.routing.bgp.address_families)

Name	Type	Constraint	Mandatory	Default Value
prefix	String		Yes
as_set	Boolean	true, false	No
summary_only	Boolean	true, false	No
advertise_map	String		No
attribute_map	String		No
suppress_map	String		No

maximum_prefix (nxos.devices.configuration.routing.bgp.peer_templates.address_families)

Name	Type	Constraint	Mandatory	Default Value
number	Integer	min: 0, max: 4294967295	No
action	Choice	log, shut, restart	No
restart_time	Integer	min: 1, max: 65535	No
threshold	Integer	min: 1, max: 100	No

Examples

Example 1: Basic iBGP spine-leaf peering with peer template for underlay

nxos:
  devices:
    - name: SPINE1
      configuration:
        routing:
          bgp:
            asn: "65000"
            peer_templates:
              - name: LEAF-PEERS
                remote_as: "65000"
                update_source_interface_type: loopback
                update_source_interface_id: "0"
                address_families:
                  - address_family: ipv4-unicast
                    send_community_standard: true
                    send_community_extended: true
                    route_reflector_client: true
            router_id: 10.1.100.1
            neighbors:
              - ip: 10.1.100.3
                inherit_peer: LEAF-PEERS
              - ip: 10.1.100.4
                inherit_peer: LEAF-PEERS

Example 2: EVPN address family on a leaf switch peering to spines

nxos:
  devices:
    - name: LEAF1
      configuration:
        routing:
          bgp:
            asn: "65000"
            peer_templates:
              - name: SPINE-PEERS
                remote_as: "65000"
                update_source_interface_type: loopback
                update_source_interface_id: "0"
                address_families:
                  - address_family: l2vpn-evpn
                    send_community_standard: true
                    send_community_extended: true
            router_id: 10.1.100.3
            neighbors:
              - ip: 10.1.100.1
                inherit_peer: SPINE-PEERS
              - ip: 10.1.100.2
                inherit_peer: SPINE-PEERS

Example 3: VRF-aware BGP with route targets for tenant routing

nxos:
  devices:
    - name: LEAF1
      configuration:
        routing:
          bgp:
            asn: "65000"
            vrfs:
              - vrf: BLUE
                router_id: 10.1.100.3
                log_neighbor_changes: true
                address_families:
                  - address_family: ipv4-unicast
                    advertise_l2vpn_evpn: true
                    maximum_paths: 2
                    redistributions:
                      - protocol: direct
                        route_map: PERMIT-CONNECTED
                    networks:
                      - prefix: 192.168.1.0/24
              - vrf: GREEN
                router_id: 10.1.100.3
                address_families:
                  - address_family: ipv4-unicast
                    advertise_l2vpn_evpn: true
                    maximum_paths: 2
                    redistributions:
                      - protocol: direct
                        route_map: PERMIT-CONNECTED
                    networks:
                      - prefix: 192.168.2.0/24

Example 4: Advanced peer template with route maps, BFD, and prefix limits

nxos:
  devices:
    - name: BORDER-LEAF1
      configuration:
        routing:
          bgp:
            asn: "65000"
            peer_templates:
              - name: SPINE-PEERS
                remote_as: "65000"
                update_source_interface_type: loopback
                update_source_interface_id: "0"
                bfd: true
                hold_time: 30
                keepalive_interval: 10
                log_neighbor_changes: true
                address_families:
                  - address_family: l2vpn-evpn
                    send_community_standard: true
                    send_community_extended: true
              - name: EXTERNAL-PEERS
                remote_as: "65100"
                peer_type: fabric-external
                ebgp_multihop_ttl: 2
                address_families:
                  - address_family: ipv4-unicast
                    send_community_standard: true
                    maximum_prefix:
                      number: 10000
                      action: log
                      threshold: 80
            router_id: 10.1.100.3
            neighbors:
              - ip: 10.1.100.1
                inherit_peer: SPINE-PEERS
              - ip: 10.1.100.2
                inherit_peer: SPINE-PEERS
              - ip: 172.17.1.1
                inherit_peer: EXTERNAL-PEERS
                description: "DC-Interconnect-Router"
                address_families:
                  - address_family: ipv4-unicast
                    route_map_in: INBOUND-FILTER
                    route_map_out: OUTBOUND-FILTER

Example 5: Full multi-VRF leaf with EVPN overlay, redistribute, graceful restart, and bestpath tuning

nxos:
  devices:
    - name: LEAF2
      configuration:
        routing:
          bgp:
            asn: "65000"
            flush_routes: true
            peer_templates:
              - name: SPINE-PEERS
                remote_as: "65000"
                update_source_interface_type: loopback
                update_source_interface_id: "0"
                address_families:
                  - address_family: l2vpn-evpn
                    send_community_standard: true
                    send_community_extended: true
            router_id: 10.1.100.4
            graceful_restart: complete
            graceful_restart_restart_time: 120
            graceful_restart_stalepath_time: 300
            bestpath:
              as_path_multipath_relax: true
              always_compare_med: true
              med_missing_as_worst: true
            log_neighbor_changes: true
            neighbors:
              - ip: 10.1.100.1
                inherit_peer: SPINE-PEERS
              - ip: 10.1.100.2
                inherit_peer: SPINE-PEERS
            address_families:
              - address_family: l2vpn-evpn
                retain_route_target_all: true
            vrfs:
              - vrf: BLUE
                router_id: 10.1.100.4
                bestpath:
                  as_path_multipath_relax: true
                  compare_routerid: true
                address_families:
                  - address_family: ipv4-unicast
                    advertise_l2vpn_evpn: true
                    maximum_paths: 2
                    networks:
                      - prefix: 192.168.1.0/24
                    redistributions:
                      - protocol: static
                        route_map: REDISTRIBUTE-STATIC
                      - protocol: direct
                        route_map: PERMIT-CONNECTED
              - vrf: GREEN
                router_id: 10.1.100.4
                address_families:
                  - address_family: ipv4-unicast
                    advertise_l2vpn_evpn: true
                    maximum_paths: 2
                    networks:
                      - prefix: 192.168.2.0/24
                    redistributions:
                      - protocol: direct
                        route_map: PERMIT-CONNECTED
                  - address_family: ipv6-unicast
                    advertise_l2vpn_evpn: true
                    networks:
                      - prefix: 2001:db8:2::/64

Example 6: BGP address family with load-balance egress policies and default-information originate RD/RT

nxos:
  devices:
    - name: BORDER-GW1
      configuration:
        routing:
          bgp:
            asn: "65000"
            router_id: 10.1.100.5
            address_families:
              - address_family: ipv4-unicast
                default_information_originate: true
                default_information_originate_always_rd: "rd:as2-nn2:1:1"
                default_information_originate_always_route_target: "route-target:as2-nn2:1:1"
                load_balance_egress_filter_policy_route_map: LB-EGRESS-FILTER
                load_balance_egress_multipath_auto_policy_route_map: LB-EGRESS-MPATH

Example 7: BGP additional paths and aggregate addresses

nxos:
  devices:
    - name: LEAF1
      configuration:
        routing:
          bgp:
            asn: "65000"
            router_id: 10.1.100.3
            address_families:
              - address_family: ipv4-unicast
                additional_paths_send: true
                additional_paths_receive: true
                additional_paths_install_backup: true
                additional_paths_selection_route_map: ADD-PATH-SELECT
                aggregate_addresses:
                  - prefix: 10.0.0.0/8
                    summary_only: true
                  - prefix: 172.16.0.0/12
                    as_set: true
                    advertise_map: AGG-ADV-MAP
                    attribute_map: AGG-ATTR-MAP
                    suppress_map: AGG-SUPPR-MAP

Example 8: BGP interface peers for unnumbered peering

nxos:
  devices:
    - name: LEAF1
      configuration:
        routing:
          bgp:
            asn: "65000"
            router_id: 10.1.100.3
            neighbors:
              - interface_type: ethernet
                interface_id: "1/1"
                inherit_peer: SPINE-PEERS
                description: "Spine1-Uplink"
                bfd: true
              - interface_type: ethernet
                interface_id: "1/2"
                inherit_peer: SPINE-PEERS
                description: "Spine2-Uplink"
                bfd: true
            vrfs:
              - vrf: BLUE
                neighbors:
                  - interface_type: ethernet
                    interface_id: "1/3"
                    remote_as: "65100"
                    description: "CE-Router"

Example 9: Peer-session and peer-policy templates inherited by neighbors and peer templates

nxos:
  devices:
    - name: BORDER1
      configuration:
        routing:
          bgp:
            asn: "65000"
            router_id: 10.1.100.5
            peer_session_templates:
              - name: BASE-SESSION
                update_source_interface_type: loopback
                update_source_interface_id: "0"
                bfd: true
                hold_time: 30
                keepalive_interval: 10
                log_neighbor_changes: true
              - name: EBGP-SESSION
                inherit_peer_session: BASE-SESSION
                remote_as: "65100"
                description: "External transit peers"
                ebgp_multihop_ttl: 5
                local_as: "65010"
                local_as_propagation: no-prepend
            peer_policy_templates:
              - name: BASE-POLICY
                send_community_standard: true
                send_community_extended: true
                soft_reconfiguration_inbound: inbound-always
              - name: EBGP-POLICY
                inherit_peer_policies:
                  - name: BASE-POLICY
                    sequence: 10
                route_map_in: RM-TRANSIT-IN
                route_map_out: RM-TRANSIT-OUT
                prefix_list_in: PL-TRANSIT-IN
                filter_list_out: AS-PATH-LOCAL
                maximum_prefix:
                  number: 10000
                  threshold: 80
                  action: restart
                  restart_time: 5
            peer_templates:
              - name: TRANSIT-PEERS
                inherit_peer_session: EBGP-SESSION
                address_families:
                  - address_family: ipv4-unicast
                    inherit_peer_policies:
                      - name: EBGP-POLICY
                        sequence: 10
                    route_map_in: RM-TRANSIT-IN
                    prefix_list_out: PL-TRANSIT-OUT
            neighbors:
              - ip: 192.0.2.1
                inherit_peer: TRANSIT-PEERS
              - ip: 192.0.2.5
                inherit_peer_session: EBGP-SESSION
                address_families:
                  - address_family: ipv4-unicast
                    inherit_peer_policies:
                      - name: EBGP-POLICY
                        sequence: 10

Example 10: BGP MVPN VRI ID for Tenant Routed Multicast (TRM)

nxos:
  devices:
    - name: LEAF1
      configuration:
        routing:
          bgp:
            asn: "65000"
            mvpn_vri_id: 100

Examples

Example 1: Basic iBGP spine-leaf peering with peer template for underlay

nxos:
  devices:
    - name: SPINE1
      configuration:
        routing:
          bgp:
            asn: "65000"
            peer_templates:
              - name: LEAF-PEERS
                remote_as: "65000"
                update_source_interface_type: loopback
                update_source_interface_id: "0"
                address_families:
                  - address_family: ipv4-unicast
                    send_community_standard: true
                    send_community_extended: true
                    route_reflector_client: true
            router_id: 10.1.100.1
            neighbors:
              - ip: 10.1.100.3
                inherit_peer: LEAF-PEERS
              - ip: 10.1.100.4
                inherit_peer: LEAF-PEERS

Example 2: EVPN address family on a leaf switch peering to spines

nxos:
  devices:
    - name: LEAF1
      configuration:
        routing:
          bgp:
            asn: "65000"
            peer_templates:
              - name: SPINE-PEERS
                remote_as: "65000"
                update_source_interface_type: loopback
                update_source_interface_id: "0"
                address_families:
                  - address_family: l2vpn-evpn
                    send_community_standard: true
                    send_community_extended: true
            router_id: 10.1.100.3
            neighbors:
              - ip: 10.1.100.1
                inherit_peer: SPINE-PEERS
              - ip: 10.1.100.2
                inherit_peer: SPINE-PEERS

Example 3: VRF-aware BGP with route targets for tenant routing

nxos:
  devices:
    - name: LEAF1
      configuration:
        routing:
          bgp:
            asn: "65000"
            vrfs:
              - vrf: BLUE
                router_id: 10.1.100.3
                log_neighbor_changes: true
                address_families:
                  - address_family: ipv4-unicast
                    advertise_l2vpn_evpn: true
                    maximum_paths: 2
                    redistributions:
                      - protocol: direct
                        route_map: PERMIT-CONNECTED
                    networks:
                      - prefix: 192.168.1.0/24
              - vrf: GREEN
                router_id: 10.1.100.3
                address_families:
                  - address_family: ipv4-unicast
                    advertise_l2vpn_evpn: true
                    maximum_paths: 2
                    redistributions:
                      - protocol: direct
                        route_map: PERMIT-CONNECTED
                    networks:
                      - prefix: 192.168.2.0/24

Example 4: Advanced peer template with route maps, BFD, and prefix limits

nxos:
  devices:
    - name: BORDER-LEAF1
      configuration:
        routing:
          bgp:
            asn: "65000"
            peer_templates:
              - name: SPINE-PEERS
                remote_as: "65000"
                update_source_interface_type: loopback
                update_source_interface_id: "0"
                bfd: true
                hold_time: 30
                keepalive_interval: 10
                log_neighbor_changes: true
                address_families:
                  - address_family: l2vpn-evpn
                    send_community_standard: true
                    send_community_extended: true
              - name: EXTERNAL-PEERS
                remote_as: "65100"
                peer_type: fabric-external
                ebgp_multihop_ttl: 2
                address_families:
                  - address_family: ipv4-unicast
                    send_community_standard: true
                    maximum_prefix:
                      number: 10000
                      action: log
                      threshold: 80
            router_id: 10.1.100.3
            neighbors:
              - ip: 10.1.100.1
                inherit_peer: SPINE-PEERS
              - ip: 10.1.100.2
                inherit_peer: SPINE-PEERS
              - ip: 172.17.1.1
                inherit_peer: EXTERNAL-PEERS
                description: "DC-Interconnect-Router"
                address_families:
                  - address_family: ipv4-unicast
                    route_map_in: INBOUND-FILTER
                    route_map_out: OUTBOUND-FILTER

Example 5: Full multi-VRF leaf with EVPN overlay, redistribute, and graceful restart

nxos:
  devices:
    - name: LEAF2
      configuration:
        routing:
          bgp:
            asn: "65000"
            flush_routes: true
            peer_templates:
              - name: SPINE-PEERS
                remote_as: "65000"
                update_source_interface_type: loopback
                update_source_interface_id: "0"
                address_families:
                  - address_family: l2vpn-evpn
                    send_community_standard: true
                    send_community_extended: true
            router_id: 10.1.100.4
            graceful_restart: complete
            graceful_restart_restart_time: 120
            graceful_restart_stalepath_time: 300
            log_neighbor_changes: true
            neighbors:
              - ip: 10.1.100.1
                inherit_peer: SPINE-PEERS
              - ip: 10.1.100.2
                inherit_peer: SPINE-PEERS
            address_families:
              - address_family: l2vpn-evpn
                retain_route_target_all: true
            vrfs:
              - vrf: BLUE
                router_id: 10.1.100.4
                address_families:
                  - address_family: ipv4-unicast
                    advertise_l2vpn_evpn: true
                    maximum_paths: 2
                    networks:
                      - prefix: 192.168.1.0/24
                    redistributions:
                      - protocol: static
                        route_map: REDISTRIBUTE-STATIC
                      - protocol: direct
                        route_map: PERMIT-CONNECTED
              - vrf: GREEN
                router_id: 10.1.100.4
                address_families:
                  - address_family: ipv4-unicast
                    advertise_l2vpn_evpn: true
                    maximum_paths: 2
                    networks:
                      - prefix: 192.168.2.0/24
                    redistributions:
                      - protocol: direct
                        route_map: PERMIT-CONNECTED
                  - address_family: ipv6-unicast
                    advertise_l2vpn_evpn: true
                    networks:
                      - prefix: 2001:db8:2::/64

Example 6: BGP address family with load-balance egress policies and default-information originate RD/RT

nxos:
  devices:
    - name: BORDER-GW1
      configuration:
        routing:
          bgp:
            asn: "65000"
            router_id: 10.1.100.5
            address_families:
              - address_family: ipv4-unicast
                default_information_originate: true
                default_information_originate_always_rd: "rd:as2-nn2:1:1"
                default_information_originate_always_route_target: "route-target:as2-nn2:1:1"
                load_balance_egress_filter_policy_route_map: LB-EGRESS-FILTER
                load_balance_egress_multipath_auto_policy_route_map: LB-EGRESS-MPATH

Example 7: BGP additional paths and aggregate addresses

nxos:
  devices:
    - name: LEAF1
      configuration:
        routing:
          bgp:
            asn: "65000"
            router_id: 10.1.100.3
            address_families:
              - address_family: ipv4-unicast
                additional_paths_send: true
                additional_paths_receive: true
                additional_paths_install_backup: true
                additional_paths_selection_route_map: ADD-PATH-SELECT
                aggregate_addresses:
                  - prefix: 10.0.0.0/8
                    summary_only: true
                  - prefix: 172.16.0.0/12
                    as_set: true
                    advertise_map: AGG-ADV-MAP
                    attribute_map: AGG-ATTR-MAP
                    suppress_map: AGG-SUPPR-MAP

Example 8: BGP interface peers for unnumbered peering

nxos:
  devices:
    - name: LEAF1
      configuration:
        routing:
          bgp:
            asn: "65000"
            router_id: 10.1.100.3
            neighbors:
              - interface_type: ethernet
                interface_id: "1/1"
                inherit_peer: SPINE-PEERS
                description: "Spine1-Uplink"
                bfd: true
              - interface_type: ethernet
                interface_id: "1/2"
                inherit_peer: SPINE-PEERS
                description: "Spine2-Uplink"
                bfd: true
            vrfs:
              - vrf: BLUE
                neighbors:
                  - interface_type: ethernet
                    interface_id: "1/3"
                    remote_as: "65100"
                    description: "CE-Router"