Skip to content
Network as Code

BGP

Diagram

Diagram

Classes

routing (iosxe.devices.configuration)

NameTypeConstraintMandatoryDefault Value
bgpClass[bgp]No

bgp (iosxe.devices.configuration.routing)

NameTypeConstraintMandatoryDefault Value
as_numberIntegerYes
default_ipv4_unicastBooleantrue, falseNo
log_neighbor_changesBooleantrue, falseNo
router_id_loopbackIntegerNo
address_familyClass[address_family]No
neighborsList[neighbors]No

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

NameTypeConstraintMandatoryDefault Value
ipv4_unicastClass[ipv4_unicast]No
ipv6_unicastClass[ipv6_unicast]No
l2vpn_evpnClass[l2vpn_evpn]No

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

NameTypeConstraintMandatoryDefault Value
ipIPYes
remote_asIntegerYes
descriptionStringNo
shutdownBooleantrue, falseNo
cluster_idIPNo
versionIntegerNo
disable_connected_checkBooleantrue, falseNo
fall_over_default_enableBooleantrue, falseNo
fall_over_default_route_mapStringNo
fall_over_bfd_multi_hopBooleantrue, falseNo
fall_over_bfd_single_hopBooleantrue, falseNo
fall_over_bfd_check_control_plane_failureBooleantrue, falseNo
fall_over_bfd_strict_modeBooleantrue, falseNo
fall_over_maximum_metric_route_mapStringNo
local_asIntegerNo
local_as_no_prependBooleantrue, falseNo
local_as_replace_asBooleantrue, falseNo
local_as_dual_asBooleantrue, falseNo
log_neighbor_changesBooleantrue, falseNo
password_typeIntegermin: 0, max: 7No
passwordStringNo
peer_groupStringNo
timers_keepaliveIntegermin: 0, max: 3600No
timers_holdtimeIntegermin: 0, max: 3600No
timers_minimum_neighbor_holdtimeIntegermin: 0, max: 3600No
ttl_security_hopsIntegermin: 0, max: 254No
update_source_loopbackIntegerNo
ebgp_multihopBooleantrue, falseNo
ebgp_multihop_max_hopIntegermin: 1, max: 255No

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

NameTypeConstraintMandatoryDefault Value
redistribute_connectedBooleantrue, falseNo
redistribute_staticBooleantrue, falseNo
aggregate_addressesList[aggregate_addresses]No
networksList[networks]No
neighborsList[neighbors]No
vrfsList[vrfs]No

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

NameTypeConstraintMandatoryDefault Value
redistribute_connectedBooleantrue, falseNo
redistribute_staticBooleantrue, falseNo
networksList[networks]No
vrfsList[vrfs]No
neighborsList[neighbors]No

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

NameTypeConstraintMandatoryDefault Value
neighborsList[neighbors]No

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

NameTypeConstraintMandatoryDefault Value
addressIPYes
maskIPYes

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

NameTypeConstraintMandatoryDefault Value
networkIPYes
maskIPNo
route_mapStringNo
backdoorBooleantrue, falseNo

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

NameTypeConstraintMandatoryDefault Value
ipIPYes
activateBooleantrue, falseNo
send_communityChoiceboth, extended, standardNo
route_reflector_clientBooleantrue, falseNo
soft_reconfigurationChoiceinboundNo
default_originateBooleantrue, falseNo
default_originate_route_mapStringNo
route_mapsList[route_maps]No

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

NameTypeConstraintMandatoryDefault Value
vrfStringYes
advertise_l2vpn_evpnBooleantrue, falseNo
redistribute_connectedBooleantrue, falseNo
router_id_loopbackIntegerNo
aggregate_addressesList[aggregate_addresses]No
redistribute_staticBooleantrue, falseNo
networksList[networks]No
neighborsList[neighbors]No

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

NameTypeConstraintMandatoryDefault Value
prefixIPYes
route_mapStringNo
backdoorBooleantrue, falseNo

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

NameTypeConstraintMandatoryDefault Value
vrfStringYes
advertise_l2vpn_evpnBooleantrue, falseNo
redistribute_connectedBooleantrue, falseNo
redistribute_staticBooleantrue, falseNo
networksList[networks]No

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

NameTypeConstraintMandatoryDefault Value
ipIPYes
activateBooleantrue, falseNo
send_communityChoiceboth, extended, standardNo
route_reflector_clientBooleantrue, falseNo
soft_reconfigurationChoiceinboundNo
default_originateBooleantrue, falseNo
default_originate_route_mapStringNo

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

NameTypeConstraintMandatoryDefault Value
ipIPYes
activateBooleantrue, falseNo
send_communityChoiceboth, extended, standardNo
route_reflector_clientBooleantrue, falseNo
soft_reconfigurationChoiceinboundNo

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

NameTypeConstraintMandatoryDefault Value
directionChoicein, outYes
nameStringYes

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

NameTypeConstraintMandatoryDefault Value
addressIPYes
maskIPYes

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

NameTypeConstraintMandatoryDefault Value
networkIPYes
maskIPNo
route_mapStringNo
backdoorBooleantrue, falseNo

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

NameTypeConstraintMandatoryDefault Value
ipIPYes
remote_asIntegerYes
descriptionStringNo
shutdownBooleantrue, falseNo
cluster_idIPNo
log_neighbor_changesBooleantrue, falseNo
password_typeIntegermin: 0, max: 7No
passwordStringNo
timers_keepaliveIntegermin: 0, max: 3600No
timers_holdtimeIntegermin: 0, max: 3600No
timers_minimum_holdtimeIntegermin: 0, max: 3600No
fall_over_default_route_mapStringNo
fall_over_bfdBooleantrue, falseNo
fall_over_bfd_multi_hopBooleantrue, falseNo
fall_over_bfd_single_hopBooleantrue, falseNo
fall_over_bfd_check_control_plane_failureBooleantrue, falseNo
fall_over_bfd_strict_modeBooleantrue, falseNo
fall_over_maximum_metric_route_mapStringNo
disable_connected_checkBooleantrue, falseNo
ttl_security_hopsIntegermin: 0, max: 254No
local_asIntegerNo
local_as_no_prependBooleantrue, falseNo
local_as_replace_asBooleantrue, falseNo
local_as_dual_asBooleantrue, falseNo
update_source_loopbackIntegerNo
activateBooleantrue, falseNo
send_communityChoiceboth, extended, standardNo
route_reflector_clientBooleantrue, falseNo
soft_reconfigurationChoiceinboundNo
default_originateBooleantrue, falseNo
default_originate_route_mapStringNo
route_mapsList[route_maps]No
ebgp_multihopBooleantrue, falseNo
ebgp_multihop_max_hopIntegermin: 1, max: 255No
ha_mode_graceful_restartBooleantrue, falseNo
next_hop_selfBooleantrue, falseNo
next_hop_self_allBooleantrue, falseNo
advertisement_intervalIntegermin: 0, max: 600No

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

NameTypeConstraintMandatoryDefault Value
prefixIPYes
route_mapStringNo
backdoorBooleantrue, falseNo
evpnBooleantrue, falseNo

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

NameTypeConstraintMandatoryDefault Value
directionChoicein, outYes
nameStringYes

Examples

Example 1: The example below shows basic BGP configuration to bring up an IPv4 Unicast Neighbor and includes basic attributes such as Password protected session, aggregate adderesses, redistribution, network advertisement and applying a route-map to the neighbor.

iosxe:
  devices:
    - name: device1
      configuration:
        routing:
          bgp:
            as_number: 65000
            default_ipv4_unicast: true
            log_neighbor_changes: true
            router_id_loopback: 0
            neighbors:
              - ip: 192.168.1.1
                remote_as: 65001
                password: 045802150C2E1D1C5A
                password_type: 7
            address_family:
              ipv4_unicast:
                redistribute_connected: true
                redistribute_static: true
                aggregate_addresses:
                  - address: 192.168.0.0
                    mask: 255.255.0.0
                  - address: 10.0.0.0
                    mask: 255.255.255.0
                networks:
                  - network: 10.0.0.0
                    mask: 255.255.255.0
                    route_map: RM1
                    backdoor: false
                  - network: 172.16.12.0
                    mask: 255.255.255.0
                  - network: 192.168.12.0
                    route_map: RM2
                    backdoor: true
                  - network: 172.16.19.0
                neighbors:
                  - ip: 192.168.1.1
                    route_maps:
                      - direction: in
                        name: RM3

Example 2: The example below shows basic BGP configuration to bring up an VRF aware IPv4 Unicast Neighbor and includes basic attributes such as Password protected session, aggregate adderesses, redistribution, network advertisement and applying a route-map to the neighbor.

iosxe:
  devices:
    - name: device1
      configuration:
        routing:
          bgp:
            as_number: 65000
            log_neighbor_changes: true
            address_family:
              ipv4_unicast:
                vrfs:
                  - vrf: MY_VRF
                    redistribute_connected: true
                    redistribute_static: false
                    aggregate_addresses:
                      - address: 192.168.17.0
                        mask: 255.255.255.0
                      - address: 192.168.18.0
                        mask: 255.255.255.0
                    networks:
                      - network: 10.0.0.0
                        mask: 255.255.255.0
                        route_map: RM1
                        backdoor: false
                      - network: 172.16.12.0
                        mask: 255.255.255.0
                      - network: 192.168.12.0
                        route_map: RM2
                        backdoor: true
                      - network: 172.16.19.0
                    neighbors:
                      - ip: 192.168.1.1
                        remote_as: 65001
                        description: "REMOTE_ROUTER"
                        shutdown: false
                        log_neighbor_changes: true
                        password_type: 7
                        password: 045802150C2E1D1C5A
                        activate: true
                        send_community: both
                        soft_reconfiguration: inbound
                        route_maps:
                          - direction: in
                            name: RM2

Example 3: The Example below is a full blank data model for IPv4 address-family of BGP - VRF and non-VRF aware.

iosxe:
  devices:
    - name: router1
      configuration:
        routing:
          bgp:
            as_number: 65001
            default_ipv4_unicast: true
            log_neighbor_changes: true
            router_id_loopback: 100
            neighbors:
              - ip: 10.0.0.1
                remote_as: 65000
                description: "router2"
                shutdown: false
                cluster_id: 2.2.2.2
                version: 4
                disable_connected_check: false
                fall_over_default_enable: false
                fall_over_default_route_map: RM1
                fall_over_bfd_multi_hop: false
                fall_over_bfd_single_hop: false
                fall_over_bfd_check_control_plane_failure: false
                fall_over_bfd_strict_mode: false
                fall_over_maximum_metric_route_map: RM2
                local_as: 65003
                local_as_no_prepend: false
                local_as_replace_as: false
                local_as_dual_as: false
                log_neighbor_changes: true
                password_type: 7
                password: 045802150C2E1D1C5A
                peer_group: PEER1
                timers_keepalive: 60
                timers_holdtime: 180
                timers_minimum_neighbor_holdtime: 30
                ttl_security_hops: 1
                update_source_loopback: 100
                ebgp_multihop: false
                ebgp_multihop_max_hop: 5
            address_family:
              ipv4_unicast:
                redistribute_connected: true
                redistribute_static: false
                aggregate_addresses:
                  - address: 192.168.0.0
                    mask: 255.255.0.0
                networks:
                  - network: 10.10.10.0
                    mask: 255.255.255.0
                    route_map: RM3
                    backdoor: false
                  - network: 192.168.0.0
                    route_map: RM4
                    backdoor: false
                neighbors:
                  - ip: 10.0.01
                    activate: true
                    send_community: both
                    route_reflector_client: false
                    soft_reconfiguration: inbound
                    default_originate: false
                    default_originate_route_map:
                    route_maps:
                      - direction: in
                        name: RM5
                vrfs:
                  - vrf:
                    redistribute_connected: true
                    redistribute_static: true
                    router_id_loopback: 200
                    aggregate_addresses:
                      - address: 172.16.0.0
                        mask: 255.255.0.0
                    networks:
                      - network: 10.10.20.0
                        mask: 255.255.0.0
                        route_map: RM6
                        backdoor: false
                      - network: 192.168.32.0
                        route_map: RM7
                        backdoor: false
                    neighbors:
                      - ip: 20.20.20.1
                        remote_as: 65003
                        description: "router3"
                        shutdown: false
                        cluster_id: 2.2.2.2
                        log_neighbor_changes: true
                        password_type: 7
                        password: 045802150C2E1D1C5A
                        timers_keepalive: 60
                        timers_holdtime: 180
                        timers_minimum_holdtime: 30
                        fall_over_default_route_map: RM8
                        fall_over_bfd_multi_hop: false
                        fall_over_bfd_single_hop: false
                        fall_over_bfd_check_control_plane_failure: false
                        fall_over_bfd_strict_mode: false
                        fall_over_maximum_metric_route_map: RM9
                        disable_connected_check: false
                        ttl_security_hops: 1
                        local_as: 65000
                        local_as_no_prepend: false
                        local_as_replace_as: false
                        local_as_dual_as: false
                        update_source_loopback: 200
                        activate: true
                        send_community: both
                        route_reflector_client: false
                        soft_reconfiguration: inbound
                        default_originate: false
                        default_originate_route_map: RM10
                        route_maps:
                          - direction: out
                            name: RM11
                        ebgp_multihop: false
                        ebgp_multihop_max_hop: 5
                        ha_mode_graceful_restart: false
                        next_hop_self: false
                        next_hop_self_all: false
                        advertisement_interval: 60