File: //usr/lib/python3.9/site-packages/ansible_collections/arista/eos/plugins/modules/eos_bgp.py
# -*- coding: utf-8 -*-
#
# (c) 2019, Ansible by Red Hat, inc
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
#
from __future__ import absolute_import, division, print_function
__metaclass__ = type
DOCUMENTATION = """
module: eos_bgp
author: Nilashish Chakraborty (@NilashishC)
short_description: (deprecated, removed after 2023-01-29) Configure global BGP protocol settings on Arista EOS.
description:
- This module provides configuration management of global BGP parameters on Arista
EOS devices.
version_added: 1.0.0
deprecated:
alternative: eos_bgp_global
why: Updated module released with more functionality.
removed_at_date: '2023-01-01'
notes:
- Tested against Arista EOS 4.24.6F
options:
config:
description:
- Specifies the BGP related configuration.
type: dict
suboptions:
bgp_as:
description:
- Specifies the BGP Autonomous System (AS) number to configure on the device.
type: int
required: true
router_id:
description:
- Configures the BGP routing process router-id value.
type: str
log_neighbor_changes:
description:
- Enable/disable logging neighbor up/down and reset reason.
type: bool
neighbors:
description:
- Specifies BGP neighbor related configurations.
type: list
elements: dict
suboptions:
neighbor:
description:
- Neighbor router address.
required: true
type: str
remote_as:
description:
- Remote AS of the BGP neighbor to configure.
type: int
required: true
update_source:
description:
- Source of the routing updates.
type: str
password:
description:
- Password to authenticate the BGP peer connection.
type: str
description:
description:
- Neighbor specific description.
type: str
ebgp_multihop:
description:
- Specifies the maximum hop count for EBGP neighbors not on directly connected
networks.
- The range is from 1 to 255.
type: int
peer_group:
description:
- Name of the peer group that the neighbor is a member of.
type: str
timers:
description:
- Specifies BGP neighbor timer related configurations.
type: dict
suboptions:
keepalive:
description:
- Frequency (in seconds) with which the device sends keepalive messages
to its peer.
- The range is from 0 to 3600.
type: int
required: true
holdtime:
description:
- 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).
type: int
required: true
route_reflector_client:
description:
- Specify a neighbor as a route reflector client.
type: int
remove_private_as:
description:
- Remove the private AS number from outbound updates.
type: bool
enabled:
description:
- Administratively shutdown or enable a neighbor.
type: bool
maximum_prefix:
description:
- Maximum number of prefixes to accept from this peer.
- The range is from 0 to 4294967294.
type: int
redistribute:
description:
- Specifies the redistribute information from another routing protocol.
type: list
elements: dict
suboptions:
protocol:
description:
- Specifies the protocol for configuring redistribute information.
required: true
type: str
choices: [ospf, ospfv3, static, connected, rip, isis]
route_map:
description:
- Specifies the route map reference.
type: str
networks:
description:
- 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.
type: list
elements: dict
suboptions:
prefix:
description:
- Network ID to announce via BGP.
required: true
type: str
masklen:
description:
- Subnet mask length for the Network to announce(e.g, 8, 16, 24, etc.).
type: int
route_map:
description:
- Route map to modify the attributes.
type: str
address_family:
description:
- Specifies BGP address family related configurations.
type: list
elements: dict
suboptions:
afi:
description:
- Type of address family to configure.
type: str
choices:
- ipv4
- ipv6
required: true
redistribute:
description:
- Specifies the redistribute information from another routing protocol.
type: list
elements: dict
suboptions:
protocol:
description:
- Specifies the protocol for configuring redistribute information.
required: true
type: str
choices:
- ospfv3
- ospf
- isis
- static
- connected
- rip
route_map:
description:
- Specifies the route map reference.
type: str
networks:
description:
- Specify Networks to announce via BGP.
- For operation replace, this option is mutually exclusive with root level
networks option.
type: list
elements: dict
suboptions:
prefix:
description:
- Network ID to announce via BGP.
required: true
type: str
masklen:
description:
- Subnet mask length for the Network to announce(e.g, 8, 16, 24, etc.).
type: int
route_map:
description:
- Route map to modify the attributes.
type: str
neighbors:
description:
- Specifies BGP neighbor related configurations in Address Family configuration
mode.
type: list
elements: dict
suboptions:
neighbor:
description:
- Neighbor router address.
required: true
type: str
activate:
description:
- Enable the Address Family for this Neighbor.
type: bool
default_originate:
description:
- Originate default route to this neighbor.
type: bool
graceful_restart:
description:
- Enable/disable graceful restart mode for this neighbor.
type: bool
weight:
description:
- Assign weight for routes learnt from this neighbor.
- The range is from 0 to 65535
type: int
operation:
description:
- 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.
type: str
default: merge
choices:
- merge
- replace
- override
- delete
"""
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: yes
default_originate: true
- neighbor: 192.0.2.15
activate: yes
graceful_restart: true
operation: merge
- name: remove bgp as 64496 from config
arista.eos.eos_bgp:
config:
bgp_as: 64496
operation: delete
"""
RETURN = """
commands:
description: The list of configuration mode commands to send to the device
returned: always
type: list
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
"""
from ansible.module_utils._text import to_text
from ansible_collections.arista.eos.plugins.module_utils.network.eos.providers.cli.config.bgp.process import (
REDISTRIBUTE_PROTOCOLS,
)
from ansible_collections.arista.eos.plugins.module_utils.network.eos.providers.module import (
NetworkModule,
)
def main():
"""main entry point for module execution"""
network_spec = {
"prefix": dict(required=True),
"masklen": dict(type="int"),
"route_map": dict(),
}
redistribute_spec = {
"protocol": dict(choices=list(REDISTRIBUTE_PROTOCOLS), required=True),
"route_map": dict(),
}
timer_spec = {
"keepalive": dict(type="int", required=True),
"holdtime": dict(type="int", required=True),
}
neighbor_spec = {
"neighbor": dict(required=True),
"remote_as": dict(type="int", required=True),
"update_source": dict(),
"password": dict(no_log=True),
"enabled": dict(type="bool"),
"description": dict(),
"ebgp_multihop": dict(type="int"),
"timers": dict(type="dict", options=timer_spec),
"peer_group": dict(),
"maximum_prefix": dict(type="int"),
"route_reflector_client": dict(type="int"),
"remove_private_as": dict(type="bool"),
}
af_neighbor_spec = {
"neighbor": dict(required=True),
"activate": dict(type="bool"),
"default_originate": dict(type="bool"),
"graceful_restart": dict(type="bool"),
"weight": dict(type="int"),
}
address_family_spec = {
"afi": dict(choices=["ipv4", "ipv6"], required=True),
"networks": dict(type="list", elements="dict", options=network_spec),
"redistribute": dict(
type="list",
elements="dict",
options=redistribute_spec,
),
"neighbors": dict(
type="list",
elements="dict",
options=af_neighbor_spec,
),
}
config_spec = {
"bgp_as": dict(type="int", required=True),
"router_id": dict(),
"log_neighbor_changes": dict(type="bool"),
"neighbors": dict(type="list", elements="dict", options=neighbor_spec),
"address_family": dict(
type="list",
elements="dict",
options=address_family_spec,
),
"redistribute": dict(
type="list",
elements="dict",
options=redistribute_spec,
),
"networks": dict(type="list", elements="dict", options=network_spec),
}
argument_spec = {
"config": dict(type="dict", options=config_spec),
"operation": dict(
default="merge",
choices=["merge", "replace", "override", "delete"],
),
}
module = NetworkModule(
argument_spec=argument_spec,
supports_check_mode=True,
)
try:
result = module.edit_config(config_filter="| section bgp")
except Exception as exc:
module.fail_json(msg=to_text(exc))
module.exit_json(**result)
if __name__ == "__main__":
main()