dellemc.enterprise_sonic.sonic_bgp_communities module – Manage BGP community and its parameters
Note
This module is part of the dellemc.enterprise_sonic collection (version 2.5.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 dellemc.enterprise_sonic
.
To use it in a playbook, specify: dellemc.enterprise_sonic.sonic_bgp_communities
.
New in dellemc.enterprise_sonic 1.0.0
Synopsis
This module provides configuration management of BGP bgp_communities for device running Enterprise SONiC Distribution by Dell Technologies.
Note
This module has a corresponding action plugin.
Parameters
Parameter |
Comments |
---|---|
A list of ‘bgp_communities’ configurations. |
|
Community number aa:nn format 0..65535:0..65535; applicable for standard BGP community type. |
|
Do not send outside local AS (well-known community); applicable for standard BGP community type. Choices:
|
|
Matches any/all of the members. Choices:
|
|
Members of this BGP community list. |
|
Members of this BGP community list. Regular expression string can be given here. Applicable for expanded BGP community type. |
|
Name of the BGP community-list. |
|
Do not advertise to any peer (well-known community); applicable for standard BGP community type. Choices:
|
|
Do not export to next AS (well-known community); applicable for standard BGP community type. Choices:
|
|
Do not export to next AS (well-known community); applicable for standard BGP community type. Choices:
|
|
Permits or denies this community. Default value while adding a new community-list is Choices:
|
|
Whether it is a standard or expanded community-list entry. Choices:
|
|
The state of the configuration after module completion. Choices:
|
Notes
Note
Tested against Enterprise SONiC Distribution by Dell Technologies.
Supports
check_mode
.
Examples
# Using deleted
# Before state:
# -------------
#
# show bgp community-list
# Standard community list test: match: ANY
# permit local-as
# permit no-peer
# Expanded community list test1: match: ANY
# deny 101
# deny 302
- name: Delete a BGP community-list member
dellemc.enterprise_sonic.sonic_bgp_communities:
config:
- name: test1
type: expanded
permit: false
members:
regex:
- 302
state: deleted
# After state:
# ------------
#
# show bgp community-list
# Standard community list test: match: ANY
# permit local-as
# permit no-peer
# Expanded community list test1: match: ANY
# deny 101
# Using deleted
# Before state:
# -------------
#
# show bgp community-list
# Standard community list test: match: ANY
# permit local-as
# permit no-peer
# Expanded community list test1: match: ANY
# deny 101
# deny 302
- name: Delete a single BGP community-list
dellemc.enterprise_sonic.sonic_bgp_communities:
config:
- name: test
type: standard
state: deleted
# After state:
# ------------
#
# show bgp community-list
# Expanded community list test1: match: ANY
# deny 101
# deny 302
# Using deleted
# Before state:
# -------------
#
# show bgp community-list
# Standard community list test: match: ANY
# permit local-as
# permit no-peer
# Expanded community list test1: match: ANY
# deny 101
# deny 302
- name: Delete All BGP community-lists
dellemc.enterprise_sonic.sonic_bgp_communities:
config:
state: deleted
# After state:
# ------------
#
# show bgp community-list
#
# Using deleted
# Before state:
# -------------
#
# show bgp community-list
# Standard community list test: match: ANY
# permit local-as
# permit no-peer
# Expanded community list test1: match: ANY
# deny 101
# deny 302
- name: Delete all members in a single BGP community-list
dellemc.enterprise_sonic.sonic_bgp_communities:
config:
- name: test1
type: expanded
members:
regex:
state: deleted
# After state:
# ------------
#
# show bgp community-list
# Standard community list test: match: ANY
# permit local-as
# permit no-peer
# Using merged
# Before state:
# -------------
#
# show bgp community-list
# Expanded community list test1: match: ANY
# permit 101
# permit 302
- name: Add a new BGP community-list
dellemc.enterprise_sonic.sonic_bgp_communities:
config:
- name: test2
type: expanded
permit: true
members:
regex:
- 909
state: merged
# After state:
# ------------
#
# show bgp community-list
# Expanded community list test1: match: ANY
# permit 101
# permit 302
# Expanded community list test2: match: ANY
# permit 909
# Using replaced
# Before state:
# -------------
#
# show bgp community-list
# Standard community list test: match: ANY
# permit local-as
# permit no-peer
# Expanded community list test1: match: ANY
# deny 101
# deny 302
- name: Replacing a single BGP community-list
dellemc.enterprise_sonic.sonic_bgp_communities:
config:
- name: test
type: expanded
members:
regex:
- 301
- name: test3
type: standard
no_advertise: true
no_peer: true
permit: false
match: ALL
state: replaced
# After state:
# ------------
#
# show bgp community-list
# Expanded community list test: match: ANY
# deny 301
# Expanded community list test1: match: ANY
# deny 101
# deny 302
# Standard community list test3: match: ALL
# deny no-advertise
# deny no-peer
# Using overridden
# Before state:
# -------------
#
# show bgp community-list
# Standard community list test: match: ANY
# permit local-as
# permit no-peer
# Expanded community list test1: match: ANY
# deny 101
# deny 302
- name: Override entire BGP community-lists
dellemc.enterprise_sonic.sonic_bgp_communities:
config:
- name: test3
type: expanded
members:
regex:
- 301
state: overridden
# After state:
# ------------
#
# show bgp community-list
# Expanded community list test3: match: ANY
# deny 301
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The resulting configuration module invocation. Returned: when changed Sample: |
|
The configuration prior to the module invocation. Returned: always Sample: |
|
The set of commands that are pushed to the remote device. Returned: always Sample: |