Try SpotterBGP Templates resource module.
| "added in version" 4.2.0 of cisco.nxos"
Authors: Nilashish Chakraborty (@NilashishC)
Install with ansible-galaxy collection install cisco.nxos:==7.0.0
collections:
- name: cisco.nxos
version: 7.0.0This module manages BGP templates on devices running Cisco NX-OS.
# Using merged
# Before state:
# --------------
#
# nxos9k# show running-config | section "^router bgp"
# nxos9k#
- name: Merge the provided configuration with the existing running configuration
cisco.nxos.nxos_bgp_templates:
config:
as_number: 65536
neighbor:
- name: neighbor_tmplt_1
address_family:
- afi: ipv4
safi: unicast
advertise_map:
route_map: rmap1
non_exist_map: nemap1
advertisement_interval: 60
disable_peer_as_check: true
bmp_activate_server: 2
capability:
suppress_4_byte_as: true
description: Test_BGP_PEER_TEMPLATE_1
local_as: 65536
remote_as: 65001
- name: neighbor_tmplt_2
description: Test_BGP_PEER_TEMPLATE_2
address_family:
- afi: ipv4
safi: multicast
advertise_map:
route_map: rmap1
exist_map: emap1
as_override: true
filter_list:
inbound: flist1
outbound: flist2
inherit:
peer_session: psession1
timers:
holdtime: 100
keepalive: 45
# Task Output:
# ------------
# before: {}
#
# commands:
# - router bgp 65536
# - template peer neighbor_tmplt_1
# - bmp-activate-server 2
# - capability suppress 4-byte-as
# - description Test_BGP_PEER_TEMPLATE_1
# - local-as 65536
# - remote-as 65001
# - address-family ipv4 unicast
# - advertise-map rmap1 non-exist-map nemap1
# - advertisement-interval 60
# - disable-peer-as-check
# - template peer neighbor_tmplt_2
# - description Test_BGP_PEER_TEMPLATE_2
# - inherit peer-session psession1
# - timers 45 100
# - address-family ipv4 multicast
# - advertise-map rmap1 exist-map emap1
# - as-override
# - filter-list flist1 in
# - filter-list flist2 out
#
# after:
# as_number: "65536"
# neighbor:
# - name: neighbor_tmplt_1
# address_family:
# - afi: ipv4
# safi: unicast
# advertise_map:
# non_exist_map: nemap1
# route_map: rmap1
# advertisement_interval: 60
# disable_peer_as_check: true
# bmp_activate_server: 2
# capability:
# suppress_4_byte_as: true
# description: Test_BGP_PEER_TEMPLATE_1
# local_as: "65536"
# remote_as: "65001"
#
# - name: neighbor_tmplt_2
# description: Test_BGP_PEER_TEMPLATE_2
# address_family:
# - afi: ipv4
# safi: multicast
# advertise_map:
# exist_map: emap1
# route_map: rmap1
# as_override: true
# filter_list:
# inbound: flist1
# outbound: flist2
# inherit:
# peer_session: psession1
# timers:
# holdtime: 100
# keepalive: 45
# After state:
# --------------
#
# nxos9k# show running-config | section "^router bgp"
# router bgp 65536
# template peer neighbor_tmplt_1
# capability suppress 4-byte-as
# bmp-activate-server 2
# description Test_BGP_PEER_TEMPLATE_1
# local-as 65536
# remote-as 65001
# address-family ipv4 unicast
# advertise-map rmap1 non-exist-map nemap1
# advertisement-interval 60
# disable-peer-as-check
# template peer neighbor_tmplt_2
# description Test_BGP_PEER_TEMPLATE_2
# inherit peer-session psession1
# timers 45 100
# address-family ipv4 multicast
# advertise-map rmap1 exist-map emap1
# as-override
# filter-list flist1 in
# filter-list flist2 out
# Using replaced
# Before state:
# -------------
#
# nxos9k# show running-config | section "^router bgp"
# router bgp 65536
# template peer neighbor_tmplt_1
# capability suppress 4-byte-as
# description Test_BGP_PEER_TEMPLATE_1
# bmp-activate-server 2
# local-as 65536
# remote-as 65001
# address-family ipv4 unicast
# advertise-map rmap1 non-exist-map nemap1
# advertisement-interval 60
# disable-peer-as-check
# template peer neighbor_tmplt_2
# description Test_BGP_PEER_TEMPLATE_2
# inherit peer-session psession1
# timers 45 100
# address-family ipv4 multicast
# advertise-map rmap1 exist-map emap1
# as-override
# filter-list flist1 in
# filter-list flist2 out
- name: Replace BGP templates configuration with provided configuration
cisco.nxos.nxos_bgp_templates:
config:
as_number: 65536
neighbor:
- name: neighbor_tmplt_1
address_family:
- afi: ipv4
safi: unicast
advertise_map:
route_map: rmap1
non_exist_map: nemap1
advertisement_interval: 60
disable_peer_as_check: true
inherit:
peer_session: psession1
description: Test_BGP_PEER_TEMPLATE_1
local_as: 65537
state: replaced
# Task output:
# ------------
#
# before:
# as_number: "65536"
# neighbor:
# - name: neighbor_tmplt_1
# address_family:
# - afi: ipv4
# safi: unicast
# advertise_map:
# non_exist_map: nemap1
# route_map: rmap1
# advertisement_interval: 60
# disable_peer_as_check: true
# bmp_activate_server: 2
# capability:
# suppress_4_byte_as: true
# description: Test_BGP_PEER_TEMPLATE_1
# local_as: "65536"
# remote_as: "65001"
#
# - name: neighbor_tmplt_2
# description: Test_BGP_PEER_TEMPLATE_2
# address_family:
# - afi: ipv4
# safi: multicast
# advertise_map:
# exist_map: emap1
# route_map: rmap1
# as_override: true
# filter_list:
# inbound: flist1
# outbound: flist2
# inherit:
# peer_session: psession1
# timers:
# holdtime: 100
# keepalive: 45
#
# commands:
# - router bgp 65536
# - template peer neighbor_tmplt_1
# - no bmp-activate-server 2
# - no capability suppress 4-byte-as
# - inherit peer-session psession1
# - local-as 65537
# - no remote-as 65001
#
# after:
# as_number: "65536"
# neighbor:
# - name: neighbor_tmplt_1
# address_family:
# - afi: ipv4
# safi: unicast
# advertise_map:
# non_exist_map: nemap1
# route_map: rmap1
# advertisement_interval: 60
# disable_peer_as_check: true
# description: Test_BGP_PEER_TEMPLATE_1
# inherit:
# peer_session: psession1
# local_as: "65537"
#
# - name: neighbor_tmplt_2
# description: Test_BGP_PEER_TEMPLATE_2
# address_family:
# - afi: ipv4
# safi: multicast
# advertise_map:
# exist_map: emap1
# route_map: rmap1
# as_override: true
# filter_list:
# inbound: flist1
# outbound: flist2
# inherit:
# peer_session: psession1
# timers:
# holdtime: 100
# keepalive: 45
# After state:
# ------------
#
# nxos9k# show running-config | section "^router bgp"
# router bgp 65536
# template peer neighbor_tmplt_1
# inherit peer-session psession1
# description Test_BGP_PEER_TEMPLATE_1
# local-as 65537
# address-family ipv4 unicast
# advertise-map rmap1 non-exist-map nemap1
# advertisement-interval 60
# disable-peer-as-check
# template peer neighbor_tmplt_2
# description Test_BGP_PEER_TEMPLATE_2
# inherit peer-session psession1
# bmp-activate-server 2
# timers 45 100
# address-family ipv4 multicast
# advertise-map rmap1 exist-map emap1
# as-override
# filter-list flist1 in
# filter-list flist2 out
# Using overridden
#
# Before state:
# -------------
#
# nxos9k# show running-config | section "^router bgp"
# router bgp 65536
# template peer neighbor_tmplt_1
# capability suppress 4-byte-as
# description Test_BGP_PEER_TEMPLATE_1
# bmp-activate-server 2
# local-as 65536
# remote-as 65001
# address-family ipv4 unicast
# advertise-map rmap1 non-exist-map nemap1
# advertisement-interval 60
# disable-peer-as-check
# template peer neighbor_tmplt_2
# description Test_BGP_PEER_TEMPLATE_2
# inherit peer-session psession1
# timers 45 100
# address-family ipv4 multicast
# advertise-map rmap1 exist-map emap1
# as-override
# filter-list flist1 in
# filter-list flist2 out
- name: Override BGP templates configuration with provided configuration
cisco.nxos.nxos_bgp_templates:
config:
as_number: 65536
neighbor:
- name: neighbor_tmplt_1
address_family:
- afi: ipv4
safi: unicast
advertise_map:
route_map: rmap1
non_exist_map: nemap1
advertisement_interval: 60
disable_peer_as_check: true
inherit:
peer_session: psession1
description: Test_BGP_PEER_TEMPLATE_1
local_as: 65537
state: overridden
# Task output:
# ------------
#
# before:
# as_number: "65536"
# neighbor:
# - name: neighbor_tmplt_1
# address_family:
# - afi: ipv4
# safi: unicast
# advertise_map:
# non_exist_map: nemap1
# route_map: rmap1
# advertisement_interval: 60
# disable_peer_as_check: true
# bmp_activate_server: 2
# capability:
# suppress_4_byte_as: true
# description: Test_BGP_PEER_TEMPLATE_1
# local_as: "65536"
# remote_as: "65001"
#
# - name: neighbor_tmplt_2
# description: Test_BGP_PEER_TEMPLATE_2
# address_family:
# - afi: ipv4
# safi: multicast
# advertise_map:
# exist_map: emap1
# route_map: rmap1
# as_override: true
# filter_list:
# inbound: flist1
# outbound: flist2
# inherit:
# peer_session: psession1
# timers:
# holdtime: 100
# keepalive: 45
#
# commands:
# - router bgp 65536
# - template peer neighbor_tmplt_1
# - no bmp-activate-server 2
# - no capability suppress 4-byte-as
# - inherit peer-session psession1
# - local-as 65537
# - no remote-as 65001
# - no template peer neighbor_tmplt_2
#
# after:
# as_number: "65536"
# neighbor:
# - name: neighbor_tmplt_1
# address_family:
# - afi: ipv4
# safi: unicast
# advertise_map:
# non_exist_map: nemap1
# route_map: rmap1
# advertisement_interval: 60
# disable_peer_as_check: true
# description: Test_BGP_PEER_TEMPLATE_1
# inherit:
# peer_session: psession1
# local_as: "65537"
# After state:
# ------------
#
# nxos9k# show running-config | section "^router bgp"
# router bgp 65536
# template peer neighbor_tmplt_1
# inherit peer-session psession1
# description Test_BGP_PEER_TEMPLATE_1
# local-as 65537
# address-family ipv4 unicast
# advertise-map rmap1 non-exist-map nemap1
# advertisement-interval 60
# disable-peer-as-check
# Using deleted
# Before state:
# --------------
#
# nxos9k# show running-config | section "^router bgp"
# router bgp 65536
# template peer neighbor_tmplt_1
# capability suppress 4-byte-as
# description Test_BGP_PEER_TEMPLATE_1
# bmp-activate-server 2
# local-as 65536
# remote-as 65001
# address-family ipv4 unicast
# advertise-map rmap1 non-exist-map nemap1
# advertisement-interval 60
# disable-peer-as-check
# template peer neighbor_tmplt_2
# description Test_BGP_PEER_TEMPLATE_2
# inherit peer-session psession1
# timers 45 100
# address-family ipv4 multicast
# advertise-map rmap1 exist-map emap1
# as-override
# filter-list flist1 in
# filter-list flist2 out
- name: Delete BGP configs handled by this module
cisco.nxos.nxos_bgp_templates:
state: deleted
state:
choices:
- merged
- replaced
- overridden
- deleted
- parsed
- gathered
- rendered
default: merged
description:
- The state the configuration should be left in.
- Refer to examples for more details.
type: str
config:
description: A list of BGP templates.
suboptions:
as_number:
description: Autonomous System Number of the router.
type: str
neighbor:
description: Configure BGP peer templates.
elements: dict
suboptions:
address_family:
description: Configure an address-family for peer.
elements: dict
suboptions:
advertise_map:
description: Specify route-map for conditional advertisement.
suboptions:
exist_map:
description: Condition route-map to advertise only when prefix in
condition exists.
type: str
non_exist_map:
description: Condition route-map to advertise only when prefix in
condition does not exist.
type: str
route_map:
description: Route-map name.
required: true
type: str
type: dict
advertisement_interval:
description: Minimum interval between sending BGP routing updates.
type: int
afi:
choices:
- ipv4
- ipv6
- link-state
- l2vpn
description: Address Family indicator.
required: true
type: str
allowas_in:
description: Accept as-path with my AS present in it.
suboptions:
max_occurences:
description: Number of occurrences of AS number, default is 3.
type: int
set:
description: Activate allowas-in property.
type: bool
type: dict
as_override:
description: Override matching AS-number while sending update.
type: bool
capability:
description: Advertise capability to the peer.
suboptions:
additional_paths:
description: Additional paths capability.
suboptions:
receive:
choices:
- enable
- disable
description: Additional paths Receive capability.
type: str
send:
choices:
- enable
- disable
description: Additional paths Send capability.
type: str
type: dict
type: dict
default_originate:
description: Originate a default toward this peer.
suboptions:
route_map:
description: Route-map to specify criteria for originating default.
type: str
set:
description: Set default-originate attribute.
type: bool
type: dict
disable_peer_as_check:
description: Disable checking of peer AS-number while advertising.
type: bool
filter_list:
description: Name of filter-list.
suboptions:
inbound:
description: Apply policy to incoming routes.
type: str
outbound:
description: Apply policy to outgoing routes.
type: str
type: dict
inherit:
description: Inherit a peer-policy template.
suboptions:
peer_policy:
description: Peer-policy template to inherit.
type: str
type: dict
maximum_prefix:
description: Maximum number of prefixes from this neighbor.
suboptions:
generate_warning_threshold:
description: Threshold percentage at which to generate a warning.
type: int
max_prefix_limit:
description: Maximum prefix limit.
type: int
restart_interval:
description: Restart bgp connection after limit is exceeded.
type: int
warning_only:
description: Only give a warning message when limit is exceeded.
type: bool
type: dict
next_hop_self:
description: Set our address as nexthop (non-reflected).
suboptions:
all_routes:
description: Set our address as nexthop for all routes.
type: bool
set:
description: Set next-hop-self attribute.
type: bool
type: dict
next_hop_third_party:
description: Compute a third-party nexthop if possible.
type: bool
prefix_list:
description: Apply prefix-list.
suboptions:
inbound:
description: Apply policy to incoming routes.
type: str
outbound:
description: Apply policy to outgoing routes.
type: str
type: dict
route_map:
description: Apply route-map to neighbor.
suboptions:
inbound:
description: Name of policy to apply to incoming routes.
type: str
outbound:
description: Name of policy to apply to outgoing routes.
type: str
type: dict
route_reflector_client:
description: Configure a neighbor as Route reflector client.
type: bool
safi:
choices:
- unicast
- multicast
- mvpn
- evpn
description: Sub Address Family indicator.
type: str
send_community:
choices:
- standard
- extended
- both
description: Send Community attribute to this neighbor.
type: str
soft_reconfiguration_inbound:
description: Soft reconfiguration.
suboptions:
always:
description: Always perform inbound soft reconfiguration.
type: bool
set:
description: Set soft-reconfiguration inbound attribute.
type: bool
type: dict
soo:
description: Specify Site-of-origin extcommunity.
type: str
suppress_inactive:
description: Advertise only active routes to peer.
type: bool
unsuppress_map:
description: Route-map to selectively unsuppress suppressed routes.
type: str
weight:
description: Set default weight for routes from this neighbor.
type: int
type: list
bfd:
description: Bidirectional Fast Detection for the neighbor.
suboptions:
multihop:
description: Multihop session.
suboptions:
interval:
description: Configure BFD session interval parameters.
suboptions:
min_rx_interval:
description: Minimum RX interval.
required: true
type: int
multiplier:
description: Detect Multiplier.
required: true
type: int
tx_interval:
description: TX interval in milliseconds.
required: true
type: int
type: dict
set:
description: Set BFD multihop.
type: bool
type: dict
set:
description: Set BFD for this neighbor.
type: bool
singlehop:
description: Single-hop session.
type: bool
type: dict
bmp_activate_server:
description: Specify server ID for activating BMP monitoring for the peer.
type: int
capability:
description: Capability.
suboptions:
suppress_4_byte_as:
description: Suppress 4-byte AS Capability.
type: bool
type: dict
description:
description: Neighbor specific descripion.
type: str
disable_connected_check:
description: Disable check for directly connected peer.
type: bool
dont_capability_negotiate:
description: Don't negotiate capability with this neighbor.
type: bool
dscp:
description: Set dscp value for tcp transport.
type: str
dynamic_capability:
description: Dynamic Capability
type: bool
ebgp_multihop:
description: Specify multihop TTL for remote peer.
type: int
graceful_shutdown:
description: Graceful-shutdown for this neighbor.
suboptions:
activate:
description: Send graceful-shutdown community.
suboptions:
route_map:
description: Apply route-map to modify attributes for outbound.
type: str
set:
description: Set activate.
type: bool
type: dict
type: dict
inherit:
description: Inherit a template.
suboptions:
peer_session:
description: Peer-session template to inherit.
type: str
type: dict
local_as:
description: Specify the local-as number for the eBGP neighbor.
type: str
log_neighbor_changes:
description: Log message for neighbor up/down event.
suboptions:
disable:
description:
- Disable logging of neighbor up/down event.
type: bool
set:
description:
- Set log-neighbor-changes.
type: bool
type: dict
low_memory:
description: Behaviour in low memory situations.
suboptions:
exempt:
description: Do not shutdown this peer when under memory pressure.
type: bool
type: dict
name:
description: Name of the BGP peer template.
type: str
password:
description: Configure a password for neighbor.
suboptions:
encryption:
description:
- 0 specifies an UNENCRYPTED neighbor password.
- 3 specifies an 3DES ENCRYPTED neighbor password will follow.
- 7 specifies a Cisco type 7 ENCRYPTED neighbor password will follow.
type: int
key:
description: Authentication password.
type: str
type: dict
path_attribute:
description: BGP path attribute optional filtering.
elements: dict
suboptions:
action:
choices:
- discard
- treat-as-withdraw
description: Action.
type: str
range:
description: Path attribute range.
suboptions:
end:
description: Path attribute range end value.
type: int
start:
description: Path attribute range start value.
type: int
type: dict
type:
description: Path attribute type
type: int
type: list
remote_as:
description: Specify Autonomous System Number of the neighbor.
type: str
remove_private_as:
description: Remove private AS number from outbound updates.
suboptions:
all:
description: All.
type: bool
replace_as:
description: Replace.
type: bool
set:
description: Remove private AS.
type: bool
type: dict
shutdown:
description: Administratively shutdown this neighbor.
type: bool
timers:
description: Configure keepalive and hold timers.
suboptions:
holdtime:
description: Holdtime (seconds).
type: int
keepalive:
description: Keepalive interval (seconds).
type: int
type: dict
transport:
description: BGP transport connection.
suboptions:
connection_mode:
description: Specify type of connection.
suboptions:
passive:
description: Allow passive connection setup only.
type: bool
type: dict
type: dict
ttl_security:
description: Enable TTL Security Mechanism.
suboptions:
hops:
description: Specify hop count for remote peer.
type: int
type: dict
update_source:
description: Specify source of BGP session and updates.
type: str
type: list
type: dict
running_config:
description:
- This option is used only with state I(parsed).
- The value of this option should be the output received from the NX-OS device by
executing the command B(show running-config bgp | section 'template').
- The state I(parsed) reads the configuration from C(running_config) option and transforms
it into Ansible structured data as per the resource module's argspec and the value
is then returned in the I(parsed) key within the result.
type: str
after:
description: The resulting configuration after module execution.
returned: when changed
sample: 'This output will always be in the same format as the module argspec.
'
type: dict
before:
description: The configuration prior to the module execution.
returned: when I(state) is C(merged), C(replaced), C(overridden), C(deleted) or
C(purged)
sample: 'This output will always be in the same format as the module argspec.
'
type: dict
commands:
description: The set of commands pushed to the remote device.
returned: when I(state) is C(merged), C(replaced), C(overridden), C(deleted) or
C(purged)
sample:
- router bgp 65536
- template peer neighbor_tmplt_1
- no bmp-activate-server 2
- no capability suppress 4-byte-as
- inherit peer-session psession1
- local-as 65537
- no remote-as 65001
- no template peer neighbor_tmplt_2
type: list
gathered:
description: Facts about the network resource gathered from the remote device as
structured data.
returned: when I(state) is C(gathered)
sample: 'This output will always be in the same format as the module argspec.
'
type: dict
parsed:
description: The device native config provided in I(running_config) option parsed
into structured data as per module argspec.
returned: when I(state) is C(parsed)
sample: 'This output will always be in the same format as the module argspec.
'
type: dict
rendered:
description: The provided configuration in the task rendered in device-native format
(offline).
returned: when I(state) is C(rendered)
sample:
- router bgp 65536
- template peer neighbor_tmplt_1
- bmp-activate-server 2
- no capability suppress 4-byte-as
- no template peer neighbor_tmplt_2
type: list