BGP

Diagram

Classes

routing (iosxe.devices.configuration)

Name	Type	Constraint	Mandatory	Default Value
bgp	Class	`[bgp]`	No

bgp (iosxe.devices.configuration.routing)

Name	Type	Constraint	Mandatory
as_number	Integer		Yes
router_id	IP		Yes
default_ipv4_unicast	Boolean	`true`, `false`	No
log_neighbor_changes	Boolean	`true`, `false`	No
router_id_loopback	Integer		No
address_family	Class	`[address_family]`	No
neighbors	List	`[neighbors]`	No

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

Name	Type	Constraint	Mandatory
ipv4_unicast	Class	`[ipv4_unicast]`	No
ipv6_unicast	Class	`[ipv6_unicast]`	No
l2vpn_evpn	Class	`[l2vpn_evpn]`	No

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

Name	Type	Constraint	Mandatory
ip	IP		Yes
remote_as	Integer		Yes
description	String		No
shutdown	Boolean	`true`, `false`	No
cluster_id	IP		No
version	Integer		No
disable_connected_check	Boolean	`true`, `false`	No
fall_over_default_enable	Boolean	`true`, `false`	No
fall_over_default_route_map	String		No
fall_over_bfd_multi_hop	Boolean	`true`, `false`	No
fall_over_bfd_single_hop	Boolean	`true`, `false`	No
fall_over_bfd_check_control_plane_failure	Boolean	`true`, `false`	No
fall_over_bfd_strict_mode	Boolean	`true`, `false`	No
fall_over_maximum_metric_route_map	String		No
local_as	Integer		No
local_as_no_prepend	Boolean	`true`, `false`	No
local_as_replace_as	Boolean	`true`, `false`	No
local_as_dual_as	Boolean	`true`, `false`	No
log_neighbor_changes	Boolean	`true`, `false`	No
password_type	Integer	min: `0`, max: `7`	No
password	String		No
peer_group	String		No
timers_keepalive	Integer	min: `0`, max: `3600`	No
timers_holdtime	Integer	min: `0`, max: `3600`	No
timers_minimum_neighbor_holdtime	Integer	min: `0`, max: `3600`	No
ttl_security_hops	Integer	min: `0`, max: `254`	No
update_source_loopback	Integer		No
ebgp_multihop	Boolean	`true`, `false`	No
ebgp_multihop_max_hop	Integer	min: `1`, max: `255`	No

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

Name	Type	Constraint	Mandatory
redistribute_connected	Boolean	`true`, `false`	No
redistribute_static	Boolean	`true`, `false`	No
aggregate_addresses	List	`[aggregate_addresses]`	No
networks	List	`[networks]`	No
neighbors	List	`[neighbors]`	No
vrfs	List	`[vrfs]`	No

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

Name	Type	Constraint	Mandatory
redistribute_connected	Boolean	`true`, `false`	No
redistribute_static	Boolean	`true`, `false`	No
networks	List	`[networks]`	No
vrfs	List	`[vrfs]`	No
neighbors	List	`[neighbors]`	No

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

Name	Type	Constraint	Mandatory	Default Value
neighbors	List	`[neighbors]`	No

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

Name	Type	Constraint	Mandatory	Default Value
address	IP		Yes
mask	IP		Yes

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

Name	Type	Constraint	Mandatory
network	IP		Yes
mask	IP		No
route_map	String		No
backdoor	Boolean	`true`, `false`	No

neighbors (iosxe.devices.configuration.routing.bgp.address_family.ipv4_unicast)

Name	Type	Constraint	Mandatory
ip	IP		Yes
activate	Boolean	`true`, `false`	No
send_community	Choice	`both`, `extended`, `standard`	No
route_reflector_client	Boolean	`true`, `false`	No
soft_reconfiguration	Choice	`inbound`	No
default_originate	Boolean	`true`, `false`	No
default_originate_route_map	String		No
route_maps	List	`[route_maps]`	No

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

Name	Type	Constraint	Mandatory
vrf	String		Yes
advertise_l2vpn_evpn	Boolean	`true`, `false`	No
redistribute_connected	Boolean	`true`, `false`	No
router_id_loopback	Integer		No
aggregate_addresses	List	`[aggregate_addresses]`	No
redistribute_static	Boolean	`true`, `false`	No
networks	List	`[networks]`	No
neighbors	List	`[neighbors]`	No

networks (iosxe.devices.configuration.routing.bgp.address_family.ipv6_unicast)

Name	Type	Constraint	Mandatory
prefix	IP		Yes
route_map	String		No
backdoor	Boolean	`true`, `false`	No

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

Name	Type	Constraint	Mandatory
vrf	String		Yes
advertise_l2vpn_evpn	Boolean	`true`, `false`	No
redistribute_connected	Boolean	`true`, `false`	No
redistribute_static	Boolean	`true`, `false`	No
networks	List	`[networks]`	No

neighbors (iosxe.devices.configuration.routing.bgp.address_family.ipv6_unicast)

Name	Type	Constraint	Mandatory
ip	IP		Yes
activate	Boolean	`true`, `false`	No
send_community	Choice	`both`, `extended`, `standard`	No
route_reflector_client	Boolean	`true`, `false`	No
soft_reconfiguration	Choice	`inbound`	No
default_originate	Boolean	`true`, `false`	No
default_originate_route_map	String		No

neighbors (iosxe.devices.configuration.routing.bgp.address_family.l2vpn_evpn)

Name	Type	Constraint	Mandatory
ip	IP		Yes
activate	Boolean	`true`, `false`	No
send_community	Choice	`both`, `extended`, `standard`	No
route_reflector_client	Boolean	`true`, `false`	No
soft_reconfiguration	Choice	`inbound`	No

route_maps (iosxe.devices.configuration.routing.bgp.address_family.ipv4_unicast.neighbors)

Name	Type	Constraint	Mandatory	Default Value
direction	Choice	`in`, `out`	Yes
name	String		Yes

aggregate_addresses (iosxe.devices.configuration.routing.bgp.address_family.ipv4_unicast.vrfs)

Name	Type	Constraint	Mandatory	Default Value
address	IP		Yes
mask	IP		Yes

networks (iosxe.devices.configuration.routing.bgp.address_family.ipv4_unicast.vrfs)

Name	Type	Constraint	Mandatory
network	IP		Yes
mask	IP		No
route_map	String		No
backdoor	Boolean	`true`, `false`	No
evpn	Boolean	`true`, `false`	No

neighbors (iosxe.devices.configuration.routing.bgp.address_family.ipv4_unicast.vrfs)

Name	Type	Constraint	Mandatory
ip	IP		Yes
remote_as	Integer		Yes
description	String		No
shutdown	Boolean	`true`, `false`	No
cluster_id	IP		No
log_neighbor_changes	Boolean	`true`, `false`	No
password_type	Integer	min: `0`, max: `7`	No
password	String		No
timers_keepalive	Integer	min: `0`, max: `3600`	No
timers_holdtime	Integer	min: `0`, max: `3600`	No
timers_minimum_holdtime	Integer	min: `0`, max: `3600`	No
fall_over_default_route_map	String		No
fall_over_bfd	Boolean	`true`, `false`	No
fall_over_bfd_multi_hop	Boolean	`true`, `false`	No
fall_over_bfd_single_hop	Boolean	`true`, `false`	No
fall_over_bfd_check_control_plane_failure	Boolean	`true`, `false`	No
fall_over_bfd_strict_mode	Boolean	`true`, `false`	No
fall_over_maximum_metric_route_map	String		No
disable_connected_check	Boolean	`true`, `false`	No
ttl_security_hops	Integer	min: `0`, max: `254`	No
local_as	Integer		No
local_as_no_prepend	Boolean	`true`, `false`	No
local_as_replace_as	Boolean	`true`, `false`	No
local_as_dual_as	Boolean	`true`, `false`	No
update_source_loopback	Integer		No
activate	Boolean	`true`, `false`	No
send_community	Choice	`both`, `extended`, `standard`	No
route_reflector_client	Boolean	`true`, `false`	No
soft_reconfiguration	Choice	`inbound`	No
default_originate	Boolean	`true`, `false`	No
default_originate_route_map	String		No
route_maps	List	`[route_maps]`	No
ebgp_multihop	Boolean	`true`, `false`	No
ebgp_multihop_max_hop	Integer	min: `1`, max: `255`	No
ha_mode_graceful_restart	Boolean	`true`, `false`	No
next_hop_self	Boolean	`true`, `false`	No
next_hop_self_all	Boolean	`true`, `false`	No
advertisement_interval	Integer	min: `0`, max: `600`	No

networks (iosxe.devices.configuration.routing.bgp.address_family.ipv6_unicast.vrfs)

Name	Type	Constraint	Mandatory
prefix	IP		Yes
route_map	String		No
backdoor	Boolean	`true`, `false`	No
evpn	Boolean	`true`, `false`	No

route_maps (iosxe.devices.configuration.routing.bgp.address_family.ipv4_unicast.vrfs.neighbors)

Name	Type	Constraint	Mandatory	Default Value
direction	Choice	`in`, `out`	Yes
name	String		Yes

Examples

iosxe:
  devices:
    - name: Device1
      configuration:
        routing:
          bgp: