arista.eos.eos_bgp module – (deprecated, removed after 2023-01-29) Configure global BGP protocol settings on Arista EOS.
Note
This module is part of the arista.eos collection (version 6.2.2).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install arista.eos.
To use it in a playbook, specify: arista.eos.eos_bgp.
New in arista.eos 1.0.0
DEPRECATED
- Removed in:
major release after 2023-01-01
- Why:
Updated module released with more functionality.
- Alternative:
eos_bgp_global
Synopsis
This module provides configuration management of global BGP parameters on Arista EOS devices.
Parameters
Parameter |
Comments |
|---|---|
Specifies the BGP related configuration. |
|
Specifies BGP address family related configurations. |
|
Type of address family to configure. Choices:
|
|
Specifies BGP neighbor related configurations in Address Family configuration mode. |
|
Enable the Address Family for this Neighbor. Choices:
|
|
Originate default route to this neighbor. Choices:
|
|
Enable/disable graceful restart mode for this neighbor. Choices:
|
|
Neighbor router address. |
|
Assign weight for routes learnt from this neighbor. The range is from 0 to 65535 |
|
Specify Networks to announce via BGP. For operation replace, this option is mutually exclusive with root level networks option. |
|
Subnet mask length for the Network to announce(e.g, 8, 16, 24, etc.). |
|
Network ID to announce via BGP. |
|
Route map to modify the attributes. |
|
Specifies the redistribute information from another routing protocol. |
|
Specifies the protocol for configuring redistribute information. Choices:
|
|
Specifies the route map reference. |
|
Specifies the BGP Autonomous System (AS) number to configure on the device. |
|
Enable/disable logging neighbor up/down and reset reason. Choices:
|
|
Specifies BGP neighbor related configurations. |
|
Neighbor specific description. |
|
Specifies the maximum hop count for EBGP neighbors not on directly connected networks. The range is from 1 to 255. |
|
Administratively shutdown or enable a neighbor. Choices:
|
|
Maximum number of prefixes to accept from this peer. The range is from 0 to 4294967294. |
|
Neighbor router address. |
|
Password to authenticate the BGP peer connection. |
|
Name of the peer group that the neighbor is a member of. |
|
Remote AS of the BGP neighbor to configure. |
|
Remove the private AS number from outbound updates. Choices:
|
|
Specify a neighbor as a route reflector client. |
|
Specifies BGP neighbor timer related configurations. |
|
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). |
|
Frequency (in seconds) with which the device sends keepalive messages to its peer. The range is from 0 to 3600. |
|
Source of the routing updates. |
|
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. |
|
Subnet mask length for the Network to announce(e.g, 8, 16, 24, etc.). |
|
Network ID to announce via BGP. |
|
Route map to modify the attributes. |
|
Specifies the redistribute information from another routing protocol. |
|
Specifies the protocol for configuring redistribute information. Choices:
|
|
Specifies the route map reference. |
|
Configures the BGP routing process router-id value. |
|
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. Choices:
|
Notes
Note
Tested against Arista EOS 4.24.6F
Examples
- name: configure global bgp as 64496
arista.eos.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
arista.eos.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
arista.eos.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
arista.eos.eos_bgp:
config:
bgp_as: 64496
address_family:
- afi: ipv4
neighbors:
- neighbor: 203.0.113.10
activate: true
default_originate: true
- neighbor: 192.0.2.15
activate: true
graceful_restart: true
operation: merge
- name: remove bgp as 64496 from config
arista.eos.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 |
Description |
|---|---|
The list of configuration mode commands to send to the device Returned: always Sample: |
Status
This module will be removed in a major release after 2023-01-01. [deprecated]
For more information see DEPRECATED.