cisco.nxos.nxos_vxlan_vtep – Manages VXLAN Network Virtualization Endpoint (NVE).
Note
This plugin is part of the cisco.nxos collection (version 2.8.2).
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_vxlan_vtep
.
New in version 1.0.0: of cisco.nxos
Synopsis
Manages VXLAN Network Virtualization Endpoint (NVE) overlay interface that terminates VXLAN tunnels.
Note
This module has a corresponding action plugin.
Parameters
Parameter |
Comments |
---|---|
Description of the NVE interface. |
|
Configures ingress replication protocol as bgp for all VNIs. This is available on Nexus 9000 series switches running NX-OS software release 9.2(x) or higher. Choices:
|
|
Global multicast IP prefix for L2 VNIs or the keyword ‘default’. This is available on Nexus 9000 series switches running NX-OS software release 9.2(x) or higher. |
|
Global multicast IP prefix for L3 VNIs or the keyword ‘default’. This is available on Nexus 9000 series switches running NX-OS software release 9.2(x) or higher. |
|
Enables ARP suppression for all VNIs. This is available on NX-OS 9K series running 9.2.x or higher. Choices:
|
|
Specify mechanism for host reachability advertisement. A Boolean value of ‘true’ indicates that BGP will be used for host reachability advertisement. A Boolean value of ‘false’ indicates that no protocol is used for host reachability advertisement. Other host reachability advertisement protocols (e.g. OpenFlow, controller, etc.) are not supported. Choices:
|
|
Interface name for the VXLAN Network Virtualization Endpoint. |
|
Specify the loopback interface whose IP address should be used for the NVE Multisite Border-gateway Interface. This is available on specific Nexus 9000 series switches running NX-OS 7.0(3)I7(x) or higher. Specify “default” to remove an existing gateway config. |
|
Deprecated Starting with Ansible 2.5 we recommend using Starting with Ansible 2.6 we recommend using This option will be removed in a release after 2022-06-01. For more information please see the https://docs.ansible.com/ansible/latest/network/user_guide/platform_nxos.html. A dict object containing connection details. |
|
Specifies the password to use if required to enter privileged mode on the remote device. If authorize is false, then this argument does nothing. If the value is not specified in the task, the value of environment variable |
|
Instructs the module to enter privileged mode on the remote device before sending any commands. If not specified, the device will attempt to execute all commands in non-privileged mode. If the value is not specified in the task, the value of environment variable Choices:
|
|
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 |
|
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). |
|
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 |
|
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). |
|
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. Choices:
|
|
If Choices:
|
|
Configures the transport to use SSL if set to Choices:
|
|
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 |
|
If Choices:
|
|
Administratively shutdown the NVE interface. Choices:
|
|
Specify the loopback interface whose IP address should be used for the NVE interface. |
|
Suppresses advertisement of the NVE loopback address until the overlay has converged. |
|
Determines whether the config should be present or not on the device. Choices:
|
Notes
Note
Tested against NXOSv 7.3.(0)D1(1) on VIRL
Unsupported for Cisco MDS
The module is used to manage NVE properties, not to create NVE interfaces. Use cisco.nxos.nxos_interface if you wish to do so.
state=absent
removes the interface.Default, where supported, restores params default value.
For information on using CLI and NX-API see the NXOS Platform Options guide
For more information on using Ansible to manage network devices see the Ansible Network Guide
For more information on using Ansible to manage Cisco devices see the Cisco integration page.
Examples
- cisco.nxos.nxos_vxlan_vtep:
interface: nve1
description: default
host_reachability: true
source_interface: Loopback0
source_interface_hold_down_time: 30
shutdown: default
multisite_border_gateway_interface: Loopback0
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: [“interface nve1”, “source-interface loopback0”, “source-interface hold-down-time 30”, “description simple description”, “shutdown”, “host-reachability protocol bgp”, “multisite border-gateway interface loopback0”] |
Authors
Gabriele Gerbino (@GGabriele)