nxos_evpn_vni - Manages Cisco EVPN VXLAN Network Identifier (VNI).

New in version 2.2.


  • Manages Cisco Ethernet Virtual Private Network (EVPN) VXLAN Network Identifier (VNI) configurations of a Nexus device.


parameter required default choices comments
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
Specifies the password to use to authenticate the connection to the remote device. This is a common argument used for either cli or nxapi transports. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
no 0 (use common port)
Specifies the port to use when building the connection to the remote device. This value applies to either cli or nxapi. The port value will default to the appropriate transport common port if none is provided in the task. (cli=22, http=80, https=443).
Convenience method that allows all nxos arguments to be passed as a dict object. All constraints (required, choices, etc) must be met either by individual arguments or values in this dict.
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 'import' extended communities.
Sets the route-target 'import' extended communities.
Specifies the SSH key to use to authenticate the connection to the remote device. This argument is only used for the cli transport. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_SSH_KEYFILE will be used instead.
no present
  • present
  • absent
Determines whether the config should be present or not on the device.
(added in 2.3)
no 10
Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. NX-API can be slow to return on long-running commands (sh mac, sh bgp, etc).
yes cli
Configures the transport connection to use when connecting to the remote device. The transport argument supports connectivity to the device over cli (ssh) or nxapi.
  • yes
  • no
Configures the transport to use SSL if set to true only when the transport=nxapi, otherwise this value is ignored.
Configures the username to use to authenticate the connection to the remote device. This value is used to authenticate either the CLI login or the nxapi authentication depending on which transport is used. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
The EVPN VXLAN Network Identifier.


- nxos_evpn_vni:
    vni: 6000
    route_distinguisher: "60:10"
        - "5000:10"
        - "4100:100"
    route_target_export: auto
    route_target_both: default
    username: "{{ un }}"
    password: "{{ pwd }}"
    host: "{{ inventory_hostname }}"

Return Values

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

name description returned type sample
end_state k/v pairs of EVPN VNI configuration after module execution verbose mode dict {'route_target_export': [], 'route_distinguisher': '70:10', 'route_target_import': ['4100:100', '5000:10', '5001:10'], 'route_target_both': [], 'vni': '6000'}
changed check to see if a change was made on the device always boolean True
updates commands sent to the device always list ['evpn', 'vni 6000 l2', 'route-target import 5001:10']
proposed k/v pairs of parameters passed into module verbose mode dict {'route_target_import': ['5000:10', '4100:100', '5001:10'], 'vni': '6000'}
existing k/v pairs of existing EVPN VNI configuration verbose mode dict {'route_target_export': [], 'route_distinguisher': '70:10', 'route_target_import': ['4100:100', '5000:10'], 'route_target_both': [], 'vni': '6000'}



  • 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 and route_target_export valid values are a list of extended communities, (i.e. [‘’, ‘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 explicit route_target_export and route_target_import properties instead of route_target_both.
  • RD valid values are a string in one of the route-distinguisher formats, the keyword ‘auto’, or the keyword ‘default’.


This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.


This module is community maintained without core committer oversight.

For more information on what this means please read Module Support

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.