dellemc.enterprise_sonic.sonic_vxlans – Manage VxLAN EVPN 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_vxlans.

New in version 1.0.0: of dellemc.enterprise_sonic

Synopsis
Parameters
Notes
Examples
Return Values

Synopsis

Manages interface attributes of Enterprise SONiC interfaces.

Note

This module has a corresponding action plugin.

Parameters

Parameter			Choices/Defaults	Comments
config list / elements=dictionary				A list of VxLAN configurations. source_ip and evpn_nvo are required together.
	evpn_nvo string			EVPN nvo name
	name string / required			The name of the VxLAN.
	source_ip string			The source IP address of the VTEP.
	vlan_map list / elements=dictionary			The list of VNI map of VLAN.
		vlan integer		VLAN ID for VNI VLAN map.
		vni integer / required		Specifies the VNI ID.
	vrf_map list / elements=dictionary			list of VNI map of VRF.
		vni integer / required		Specifies the VNI ID.
		vrf string		VRF name for VNI VRF map.
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:
# -------------
#
# do show running-configuration
#
#interface vxlan vteptest1
# source-ip 1.1.1.1
# map vni 101 vlan 11
# map vni 102 vlan 12
# map vni 101 vrf Vrfcheck1
# map vni 102 vrf Vrfcheck2
#!
#
- name: "Test vxlans deleted state 01"
  dellemc.enterprise_sonic.sonic_vxlans:
    config:
      - name: vteptest1
        source_ip: 1.1.1.1
        vlan_map:
          - vni: 101
            vlan: 11
        vrf_map:
          - vni: 101
            vrf: Vrfcheck1
    state: deleted
#
# After state:
# ------------
#
# do show running-configuration
#
#interface vxlan vteptest1
# source-ip 1.1.1.1
# map vni 102 vlan 12
# map vni 102 vrf Vrfcheck2
#!
#
# Using deleted
#
# Before state:
# -------------
#
# do show running-configuration
#
#interface vxlan vteptest1
# source-ip 1.1.1.1
# map vni 102 vlan 12
# map vni 102 vrf Vrfcheck2
#!
#
- name: "Test vxlans deleted state 02"
  dellemc.enterprise_sonic.sonic_vxlans:
    config:
    state: deleted
#
# After state:
# ------------
#
# do show running-configuration
#
#!
#
# Using merged
#
# Before state:
# -------------
#
# do show running-configuration
#
#!
#
- name: "Test vxlans merged state 01"
  dellemc.enterprise_sonic.sonic_vxlans:
    config:
      - name: vteptest1
        source_ip: 1.1.1.1
        evpn_nvo_name: nvo1
        vlan_map:
          - vni: 101
            vlan: 11
          - vni: 102
            vlan: 12
        vrf_map:
          - vni: 101
            vrf: Vrfcheck1
          - vni: 102
            vrf: Vrfcheck2
    state: merged
#
# After state:
# ------------
#
# do show running-configuration
#
#interface vxlan vteptest1
# source-ip 1.1.1.1
# map vni 101 vlan 11
# map vni 102 vlan 12
# map vni 101 vrf Vrfcheck1
# map vni 102 vrf Vrfcheck2
#!
#

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 that are pushed to the remote device. Sample: ['command 1', 'command 2', 'command 3']

Authors

Niraimadaiselvam M (@niraimadaiselvamm)

© 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_vxlans_module.html