cisco.iosxr.iosxr_bgp module – Module to configure BGP protocol settings.
Note
This module is part of the cisco.iosxr collection (version 3.3.1).
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 cisco.iosxr
.
To use it in a playbook, specify: cisco.iosxr.iosxr_bgp
.
New in cisco.iosxr 1.0.0
DEPRECATED
- Removed in:
major release after 2023-01-29
- Why:
Updated module released with more functionality.
- Alternative:
iosxr_bgp_global
Synopsis
This module provides configuration management of global BGP parameters on devices running Cisco IOS-XR
Parameters
Parameter |
Comments |
---|---|
Specifies the BGP related configuration. |
|
Specifies BGP address family related configurations. |
|
Type of address family to configure. Choices:
|
|
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. |
|
Identifier for the routing protocol for configuring redistribute information. Valid for protocols ‘ospf’, ‘eigrp’, ‘isis’ and ‘ospfv3’. |
|
Specifies the metric for redistributed routes. |
|
Specifies the protocol for configuring redistribute information. Choices:
|
|
Specifies the route map reference. |
|
Specifies the type of cast for the address family. Choices:
|
|
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. |
|
Specifies the minimum interval (in seconds) between sending BGP routing updates. The range is from 0 to 600. |
|
Neighbor specific description. |
|
Specifies the maximum hop count for EBGP neighbors not on directly connected networks. The range is from 0 to 255. |
|
Administratively shutdown or enable a neighbor. Choices:
|
|
Neighbor router address. |
|
Password to authenticate the BGP peer connection. |
|
Remote AS of the BGP neighbor to configure. |
|
Specifies the TCP initial maximum segment size to use. The range is from 68 to 10000. |
|
Specifies BGP neighbor timer related configurations. |
|
Interval after not receiving a keepalive message that the software declares a peer dead. The range is from 3 to 65535. |
|
Frequency with which the Cisco IOS-XR software sends keepalive messages to its peer. The range is from 0 to 65535. |
|
Interval 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 3 to 65535. |
|
Source of the routing updates. |
|
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
This module works with connection
network_cli
. See the IOS-XR Platform Options.
Examples
- name: configure global bgp as 65000
cisco.iosxr.iosxr_bgp:
bgp_as: 65000
router_id: 1.1.1.1
neighbors:
- neighbor: 182.168.10.1
remote_as: 500
description: PEER_1
- neighbor: 192.168.20.1
remote_as: 500
update_source: GigabitEthernet 0/0/0/0
address_family:
- name: ipv4
cast: unicast
networks:
- network: 192.168.2.0/23
- network: 10.0.0.0/8
redistribute:
- protocol: ospf
id: 400
metric: 110
- name: remove bgp as 65000 from config
ios_bgp:
bgp_as: 65000
state: absent
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-29. [deprecated]
For more information see DEPRECATED.