dellemc.enterprise_sonic.sonic_bgp_as_paths – Manage BGP autonomous system path (or as-path-list) and its parameters

Note

This plugin is part of the dellemc.enterprise_sonic collection (version 1.1.0).

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_as_paths.

New in version 1.0.0: of dellemc.enterprise_sonic

Synopsis
Parameters
Notes
Examples
Return Values

Synopsis

This module provides configuration management of BGP bgp_as_paths for devices running Enterprise SONiC Distribution by Dell Technologies.

Note

This module has a corresponding action plugin.

Parameters

Parameter		Choices/Defaults	Comments
config list / elements=dictionary			A list of 'bgp_as_paths' configurations.
	members list / elements=string		Members of this BGP as-path; regular expression string can be provided.
	name string / required		Name of as-path-list.
state string		Choices: merged ← deleted	The state of the configuration after module completion.

Notes

Note

Tested against Enterprise SONiC Distribution by Dell Technologies.
Supports check_mode.

Examples

# Using deleted

# Before state:
# -------------
#
# show bgp as-path-access-list
# AS path list test:
#   members: 808.*,909.*

- name: Delete BGP as path list
  dellemc.enterprise_sonic.sonic_bgp_as_paths:
    config:
      - name: test
        members:
        - 909.*
    state: deleted

# After state:
# ------------
#
# show bgp as-path-access-list
# AS path list test:
#   members: 808.*


# Using deleted

# Before state:
# -------------
#
# show bgp as-path-access-list
# AS path list test:
#   members: 808.*,909.*
# AS path list test1:
#   members: 608.*,709.*

- name: Deletes BGP as-path list
  dellemc.enterprise_sonic.sonic_bgp_as_paths:
    config:
      - name: test
        members:
    state: deleted

# After state:
# ------------
#
# show bgp as-path-access-list
# AS path list test1:
#   members: 608.*,709.*


# Using deleted

# Before state:
# -------------
#
# show bgp as-path-access-list
# AS path list test:
#   members: 808.*,909.*

- name: Deletes BGP as-path list
  dellemc.enterprise_sonic.sonic_bgp_as_paths:
    config:
    state: deleted

# After state:
# ------------
#
# show bgp as-path-access-list
#


# Using merged

# Before state:
# -------------
#
# show bgp as-path-access-list
# AS path list test:

- name: Adds 909.* to test as-path list
  dellemc.enterprise_sonic.sonic_bgp_as_paths:
    config:
      - name: test
        members:
        - 909.*
    state: merged

# After state:
# ------------
#
# show bgp as-path-access-list
# AS path list test:
#   members: 909.*

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
after list / elements=string	when changed	The resulting configuration model invocation. Sample: The configuration returned is always in the same format of the parameters above.
before list / elements=string	always	The configuration prior to the model invocation. Sample: The configuration returned is always in the same format of the parameters above.
commands list / elements=string	always	The set of commands pushed to the remote device. Sample: ['command 1', 'command 2', 'command 3']

Authors

Kumaraguru Narayanan (@nkumaraguru)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/dellemc/enterprise_sonic/sonic_bgp_as_paths_module.html