eos_bgp – Configure global BGP protocol settings on Arista EOS

New in version 2.8.

Synopsis

  • This module provides configuration management of global BGP parameters on Arista EOS devices.

Parameters

Parameter Choices/Defaults Comments
config
-
Specifies the BGP related configuration.
address_family
-
Specifies BGP address family related configurations.
afi
- / required
    Choices:
  • ipv4
  • ipv6
Type of address family to configure.
neighbors
-
Specifies BGP neighbor related configurations in Address Family configuration mode.
activate
boolean
    Choices:
  • no
  • yes
Enable the Address Family for this Neighbor.
default_originate
boolean
    Choices:
  • no
  • yes
Originate default route to this neighbor.
graceful_restart
boolean
    Choices:
  • no
  • yes
Enable/disable graceful restart mode for this neighbor.
neighbor
- / required
Neighbor router address.
weight
integer
Assign weight for routes learnt from this neighbor.
The range is from 0 to 65535
networks
-
Specify Networks to announce via BGP.
For operation replace, this option is mutually exclusive with root level networks option.
masklen
-
Subnet mask length for the Network to announce(e.g, 8, 16, 24, etc.).
prefix
- / required
Network ID to announce via BGP.
route_map
-
Route map to modify the attributes.
redistribute
-
Specifies the redistribute information from another routing protocol.
protocol
- / required
Specifies the protocol for configuring redistribute information.
route_map
-
Specifies the route map reference.
bgp_as
integer / required
Specifies the BGP Autonomous System (AS) number to configure on the device.
log_neighbor_changes
boolean
    Choices:
  • no
  • yes
Enable/disable logging neighbor up/down and reset reason.
neighbors
-
Specifies BGP neighbor related configurations.
description
-
Neighbor specific description.
ebgp_multihop
integer
Specifies the maximum hop count for EBGP neighbors not on directly connected networks.
The range is from 1 to 255.
enabled
-
Administratively shutdown or enable a neighbor.
maximum_prefix
integer
Maximum number of prefixes to accept from this peer.
The range is from 0 to 4294967294.
neighbor
- / required
Neighbor router address.
password
-
Password to authenticate the BGP peer connection.
peer_group
-
Name of the peer group that the neighbor is a member of.
remote_as
integer / required
Remote AS of the BGP neighbor to configure.
remove_private_as
boolean
    Choices:
  • no
  • yes
Remove the private AS number from outbound updates.
route_reflector_client
boolean
    Choices:
  • no
  • yes
Specify a neighbor as a route reflector client.
timers
-
Specifies BGP neighbor timer related configurations.
holdtime
integer / required
Interval (in seconds) after not receiving a keepalive message that device declares a peer dead.
The range is from 3 to 7200.
Setting this value to 0 will not send keep-alives (hold forever).
keepalive
integer / required
Frequency (in seconds) with which the device sends keepalive messages to its peer.
The range is from 0 to 3600.
update_source
-
Source of the routing updates.
networks
-
Specify Networks to announce via BGP.
For operation replace, this option is mutually exclusive with networks option under address_family.
For operation replace, if the device already has an address family activated, this option is not allowed.
masklen
-
Subnet mask length for the Network to announce(e.g, 8, 16, 24, etc.).
prefix
- / required
Network ID to announce via BGP.
route_map
-
Route map to modify the attributes.
redistribute
-
Specifies the redistribute information from another routing protocol.
protocol
- / required
Specifies the protocol for configuring redistribute information.
route_map
-
Specifies the route map reference.
router_id
-
Configures the BGP routing process router-id value.
operation
-
    Choices:
  • merge ←
  • replace
  • override
  • delete
Specifies the operation to be performed on the BGP process configured on the device.
In case of merge, the input configuration will be merged with the existing BGP configuration on the device.
In case of replace, if there is a diff between the existing configuration and the input configuration, the existing configuration will be replaced by the input configuration for every option that has the diff.
In case of override, all the existing BGP configuration will be removed from the device and replaced with the input configuration.
In case of delete the existing BGP configuration will be removed from the device.

Notes

Note

  • Tested against Arista vEOS Version 4.15.9M.

Examples

- name: configure global bgp as 64496
  eos_bgp:
    config:
      bgp_as: 64496
      router_id: 192.0.2.1
      log_neighbor_changes: True
      neighbors:
        - neighbor: 203.0.113.5
          remote_as: 64511
          timers:
            keepalive: 300
            holdtime: 360
        - neighbor: 198.51.100.2
          remote_as: 64498
      networks:
        - prefix: 198.51.100.0
          route_map: RMAP_1
        - prefix: 192.0.2.0
          masklen: 23
      address_family:
        - afi: ipv4
          safi: unicast
          redistribute:
            - protocol: isis
              route_map: RMAP_1
    operation: merge

- name: Configure BGP neighbors
  eos_bgp:
    config:
      bgp_as: 64496
      neighbors:
        - neighbor: 192.0.2.10
          remote_as: 64496
          description: IBGP_NBR_1
          ebgp_multihop: 100
          timers:
            keepalive: 300
            holdtime: 360

        - neighbor: 192.0.2.15
          remote_as: 64496
          description: IBGP_NBR_2
          ebgp_multihop: 150
    operation: merge

- name: Configure root-level networks for BGP
  eos_bgp:
    config:
      bgp_as: 64496
      networks:
        - prefix: 203.0.113.0
          masklen: 27
          route_map: RMAP_1

        - prefix: 203.0.113.32
          masklen: 27
          route_map: RMAP_2
    operation: merge

- name: Configure BGP neighbors under address family mode
  eos_bgp:
    config:
      bgp_as: 64496
      address_family:
        - afi: ipv4
          neighbors:
            - neighbor: 203.0.113.10
              activate: yes
              default_originate: True

            - neighbor: 192.0.2.15
              activate: yes
              graceful_restart: True
    operation: merge

- name: remove bgp as 64496 from config
  eos_bgp:
    config:
      bgp_as: 64496
    operation: delete

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
commands
list
always
The list of configuration mode commands to send to the device

Sample:
['router bgp 64496', 'bgp router-id 192.0.2.1', 'bgp log-neighbor-changes', 'neighbor 203.0.113.5 remote-as 64511', 'neighbor 203.0.113.5 timers 300 360', 'neighbor 198.51.100.2 remote-as 64498', 'network 198.51.100.0 route-map RMAP_1', 'network 192.0.2.0 mask 255.255.254.0', 'address-family ipv4', 'redistribute isis route-map RMAP_1', 'exit-address-family']


Status

Red Hat Support

More information about Red Hat’s support of this module is available from this Red Hat Knowledge Base article.

Authors

  • Nilashish Chakraborty (@NilashishC)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.