dellemc.enterprise_sonic.sonic_vxlans module – Manage VXLAN configuration on SONiC

Note

This module is part of the dellemc.enterprise_sonic collection (version 4.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 dellemc.enterprise_sonic 1.0.0

Synopsis 

This module provides configuration management of VXLAN for devices running SONiC

Parameters 

Parameter	Comments
config list / elements=dictionary	A list of VXLAN configurations
dscp integer added in dellemc.enterprise_sonic 4.0.0	DSCP value of the VXLAN tunnel outer IP header, range 0-63 Valid only when qos_mode=pipe Functional default is 0
evpn_nvo string	EVPN NVO name
external_ip string added in dellemc.enterprise_sonic 2.5.0	The VTEP MCLAG external IP address for this node
name string / required	Name of the VXLAN
primary_ip string	The VTEP MCLAG primary IP address for this node
qos_mode string added in dellemc.enterprise_sonic 4.0.0	QoS mode to use for prioritizing the network traffic within a VXLAN tunnel Functional default is `pipe` Choices: `"pipe"` `"uniform"`
source_ip string	Source IP address of the VTEP
suppress_vlan_neigh list / elements=dictionary added in dellemc.enterprise_sonic 3.1.0	List of suppress VLAN neighbor configuration
vlan_name string	Name of VLAN
vlan_map list / elements=dictionary	List of VNI VLAN map configuration
vlan integer	VLAN ID for VNI VLAN map
vni integer / required	Specifies the VNI ID
vrf_map list / elements=dictionary	List of VNI VRF map configuration
vni integer / required	Specifies the VNI ID
vrf string	VRF name for VNI VRF map
state string	The state of the configuration after module completion Choices: `"merged"` ← (default) `"deleted"` `"replaced"` `"overridden"`

Notes 

Note

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

Examples 

# Using "deleted" state
#
# Before state:
# -------------
#
# sonic# show running-configuration vxlan
#
# interface vxlan vteptest1
# source-ip 1.1.1.1
# primary-ip 2.2.2.2
# map vni 101 vlan 11
# map vni 102 vlan 12
# map vni 101 vrf Vrfcheck1
# map vni 102 vrf Vrfcheck2
# suppress vlan-neigh vlan_name Vlan11
# suppress vlan-neigh vlan_name Vlan12
# !

- 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
        suppress_vlan_neigh:
          - vlan_name: Vlan11
          - vlan_name: Vlan12
    state: deleted

# After state:
# ------------
#
# sonic# show running-configuration vxlan
#
# interface vxlan vteptest1
# source-ip 1.1.1.1
# map vni 102 vlan 12
# map vni 102 vrf Vrfcheck2
# !


# Using "deleted" state
#
# Before state:
# -------------
#
# sonic# show running-configuration vxlan
#
# interface vxlan vteptest1
# source-ip 1.1.1.1
# qos-mode pipe dscp 14
# 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:
# ------------
#
# sonic# show running-configuration vxlan
#
# !


# Using "merged" state
#
# Before state:
# -------------
#
# sonic# show running-configuration vxlan
#
# !

- name: "Test vxlans merged state 01"
  dellemc.enterprise_sonic.sonic_vxlans:
    config:
      - name: vteptest1
        source_ip: 1.1.1.1
        primary_ip: 2.2.2.2
        evpn_nvo: nvo1
        qos_mode: pipe
        dscp: 14
        vlan_map:
          - vni: 101
            vlan: 11
          - vni: 102
            vlan: 12
        vrf_map:
          - vni: 101
            vrf: Vrfcheck1
          - vni: 102
            vrf: Vrfcheck2
        suppress_vlan_neigh:
          - vlan_name: Vlan11
          - vlan_name: Vlan12
    state: merged

# After state:
# ------------
#
# sonic# show running-configuration vxlan
#
# interface vxlan vteptest1
# source-ip 1.1.1.1
# primary-ip 2.2.2.2
# qos-mode pipe dscp 14
# map vni 101 vlan 11
# map vni 102 vlan 12
# map vni 101 vrf Vrfcheck1
# map vni 102 vrf Vrfcheck2
# suppress vlan-neigh vlan-name Vlan11
# suppress vlan-neigh vlan-name Vlan12
# !


# Using "overridden" state
#
# Before state:
# -------------
#
# sonic# show running-configuration vxlan
#
# interface vxlan vteptest1
# source-ip 1.1.1.1
# primary-ip 2.2.2.2
# map vni 101 vlan 11
# map vni 102 vlan 12
# map vni 101 vrf Vrfcheck1
# map vni 102 vrf Vrfcheck2
# !

- name: "Test vxlans overridden state 01"
  dellemc.enterprise_sonic.sonic_vxlans:
    config:
      - name: vteptest2
        source_ip: 3.3.3.3
        primary_ip: 4.4.4.4
        evpn_nvo: nvo2
        vlan_map:
          - vni: 101
            vlan: 11
        vrf_map:
          - vni: 101
            vrf: Vrfcheck1
    state: overridden

# After state:
# ------------
#
# sonic# show running-configuration vxlan
#
# interface vxlan vteptest2
# source-ip 3.3.3.3
# primary-ip 4.4.4.4
# map vni 101 vlan 11
# map vni 101 vrf Vrfcheck1
# !


# Using "replaced" state
#
# Before state:
# -------------
#
# sonic# show running-configuration vxlan
#
# interface vxlan vteptest2
# source-ip 3.3.3.3
# primary-ip 4.4.4.4
# map vni 101 vlan 11
# map vni 101 vrf Vrfcheck
# !

- name: "Test vxlans replaced state 01"
  dellemc.enterprise_sonic.sonic_vxlans:
    config:
      - name: vteptest2
        source_ip: 5.5.5.5
        vlan_map:
          - vni: 101
            vlan: 12
    state: replaced

# After state:
# ------------
#
# sonic# show running-configuration vxlan
#
# interface vxlan vteptest2
# source-ip 5.5.5.5
# primary-ip 4.4.4.4
# map vni 101 vlan 12
# map vni 101 vrf Vrfcheck1
# !

Return Values 

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

Key	Description
after list / elements=string	The resulting configuration from module invocation. Returned: when changed
after_generated list / elements=string	The generated configuration from module invocation. Returned: when `check_mode`
before list / elements=string	The configuration prior to the module invocation. Returned: always
commands list / elements=string	The set of commands pushed to the remote device. Returned: always Sample: `["command 1", "command 2", "command 3"]`

Authors

Niraimadaiselvam M (@niraimadaiselvamm)

dellemc.enterprise_sonic.sonic_vxlans module – Manage VXLAN configuration on SONiC

Synopsis

Parameters

Notes

Examples

Return Values