cisco.nxos.nxos_evpn_vni module – Manages Cisco EVPN VXLAN Network Identifier (VNI).
Note
This module is part of the cisco.nxos collection (version 8.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 cisco.nxos
.
To use it in a playbook, specify: cisco.nxos.nxos_evpn_vni
.
New in cisco.nxos 1.0.0
Synopsis
Manages Cisco Ethernet Virtual Private Network (EVPN) VXLAN Network Identifier (VNI) configurations of a Nexus device.
Aliases: evpn_vni
Parameters
Parameter |
Comments |
---|---|
The VPN Route Distinguisher (RD). The RD is combined with the IPv4 or IPv6 prefix learned by the PE router to create a globally unique address. |
|
Enables/Disables route-target settings for both import and export target communities using a single property. |
|
Sets the route-target ‘export’ extended communities. |
|
Sets the route-target ‘import’ extended communities. |
|
Determines whether the config should be present or not on the device. Choices:
|
|
The EVPN VXLAN Network Identifier. |
Notes
Note
Tested against NXOSv 7.3.(0)D1(1) on VIRL
Unsupported for Cisco MDS
default, where supported, restores params default value.
RD override is not permitted. You should set it to the default values first and then reconfigure it.
route_target_both
,route_target_import
androute_target_export valid
values are a list of extended communities, (i.e. [‘1.2.3.4:5’, ‘33:55’]) or the keywords ‘auto’ or ‘default’.The
route_target_both
property is discouraged due to the inconsistent behavior of the property across Nexus platforms and image versions. For this reason it is recommended to use explicitroute_target_export
androute_target_import
properties instead ofroute_target_both
.RD valid values are a string in one of the route-distinguisher formats, the keyword ‘auto’, or the keyword ‘default’.
For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide <nxos_platform_options>`
For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide <network_guide>`
For more information on using Ansible to manage Cisco devices see the `Cisco integration page <https://www.ansible.com/integrations/networks/cisco>`_.
Examples
- name: vni configuration
cisco.nxos.nxos_evpn_vni:
vni: 6000
route_distinguisher: 60:10
route_target_import:
- "5000:10"
- "4100:100"
route_target_export: auto
route_target_both: default
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
commands sent to the device Returned: always Sample: |