Try SpotterConfigure global BGP protocol settings on Cisco IOS.
| "added in version" 2.8 of ansible.builtin"
Authors: Nilashish Chakraborty (@NilashishC)
preview | supported by network
pipInstall with pip install ansible==2.9.27
This module provides configuration management of global BGP parameters on devices running Cisco IOS
- name: configure global bgp as 64496
ios_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
min_neighbor_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: ospf
id: 223
metric: 10
operation: merge
- name: Configure BGP neighbors
ios_bgp:
config:
bgp_as: 64496
neighbors:
- neighbor: 192.0.2.10
remote_as: 64496
password: ansible
description: IBGP_NBR_1
ebgp_multihop: 100
timers:
keepalive: 300
holdtime: 360
min_neighbor_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
ios_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
ios_bgp:
config:
bgp_as: 64496
address_family:
- afi: ipv4
safi: unicast
neighbors:
- neighbor: 203.0.113.10
activate: yes
maximum_prefix: 250
advertisement_interval: 120
- neighbor: 192.0.2.15
activate: yes
route_reflector_client: True
operation: merge
- name: remove bgp as 64496 from config
ios_bgp:
config:
bgp_as: 64496
operation: delete
config:
description:
- Specifies the BGP related configuration.
suboptions:
address_family:
description:
- Specifies BGP address family related configurations.
suboptions:
afi:
choices:
- ipv4
- ipv6
description:
- Type of address family to configure.
required: true
auto_summary:
description:
- Enable/disable automatic network number summarization.
type: bool
neighbors:
description:
- Specifies BGP neighbor related configurations in Address Family configuration
mode.
suboptions:
activate:
description:
- Enable the Address Family for this Neighbor.
type: bool
advertisement_interval:
description:
- Minimum interval between sending BGP routing updates for this neighbor.
type: int
maximum_prefix:
description:
- Maximum number of prefixes to accept from this peer.
- The range is from 1 to 2147483647.
type: int
neighbor:
description:
- Neighbor router address.
required: true
next_hop_self:
description:
- Enable/disable the next hop calculation for this neighbor.
type: bool
next_hop_unchanged:
description:
- Propagate next hop unchanged for iBGP paths to this neighbor.
type: bool
remove_private_as:
description:
- Remove the private AS number from outbound updates.
type: bool
route_reflector_client:
description:
- Specify a neighbor as a route reflector client.
type: bool
route_server_client:
description:
- Specify a neighbor as a route server client.
type: bool
networks:
description:
- Specify Networks to announce via BGP.
- For operation replace, this option is mutually exclusive with root level
networks option.
suboptions:
masklen:
description:
- Subnet mask length for the Network to announce(e.g, 8, 16, 24, etc.).
prefix:
description:
- Network ID to announce via BGP.
required: true
route_map:
description:
- Route map to modify the attributes.
redistribute:
description:
- Specifies the redistribute information from another routing protocol.
suboptions:
id:
description:
- Identifier for the routing protocol for configuring redistribute information.
- Valid for protocols 'ospf', 'ospfv3' and 'eigrp'.
metric:
description:
- Specifies the metric for redistributed routes.
protocol:
choices:
- ospf
- ospfv3
- eigrp
- isis
- static
- connected
- odr
- lisp
- mobile
- rip
description:
- Specifies the protocol for configuring redistribute information.
required: true
route_map:
description:
- Specifies the route map reference.
safi:
choices:
- flowspec
- unicast
- multicast
- labeled-unicast
default: unicast
description:
- Specifies the type of cast for the address family.
synchronization:
description:
- Enable/disable IGP synchronization.
type: bool
bgp_as:
description:
- Specifies the BGP Autonomous System (AS) number to configure on the device.
required: true
type: int
log_neighbor_changes:
description:
- Enable/disable logging neighbor up/down and reset reason.
type: bool
neighbors:
description:
- Specifies BGP neighbor related configurations.
suboptions:
description:
description:
- Neighbor specific description.
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
enabled:
description:
- Administratively shutdown or enable a neighbor.
type: bool
local_as:
description:
- The local AS number for the neighbor.
type: int
neighbor:
description:
- Neighbor router address.
required: true
password:
description:
- Password to authenticate the BGP peer connection.
peer_group:
description:
- Name of the peer group that the neighbor is a member of.
remote_as:
description:
- Remote AS of the BGP neighbor to configure.
required: true
type: int
timers:
description:
- Specifies BGP neighbor timer related configurations.
suboptions:
holdtime:
description:
- Interval (in seconds) after not receiving a keepalive message that IOS
declares a peer dead.
- The range is from 0 to 65535.
required: true
type: int
keepalive:
description:
- Frequency (in seconds) with which the device sends keepalive messages
to its peer.
- The range is from 0 to 65535.
required: true
type: int
min_neighbor_holdtime:
description:
- Interval (in seconds) specifying the minimum acceptable hold-time from
a BGP neighbor.
- The minimum acceptable hold-time must be less than, or equal to, the
interval specified in the holdtime argument.
- The range is from 0 to 65535.
type: int
update_source:
description:
- Source of the routing updates.
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.
suboptions:
masklen:
description:
- Subnet mask length for the Network to announce(e.g, 8, 16, 24, etc.).
prefix:
description:
- Network ID to announce via BGP.
required: true
route_map:
description:
- Route map to modify the attributes.
router_id:
default: null
description:
- Configures the BGP routing process router-id value.
operation:
choices:
- merge
- replace
- override
- delete
default: merge
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.
commands: description: The list of configuration mode commands to send to the device returned: always 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 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 ospf 223 metric 70 - exit-address-family type: list