cisco.nxos.nxos_vxlan_vtep module – Manages VXLAN Network Virtualization Endpoint (NVE).
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_vxlan_vtep
.
New in cisco.nxos 1.0.0
Synopsis
Manages VXLAN Network Virtualization Endpoint (NVE) overlay interface that terminates VXLAN tunnels.
Aliases: vxlan_vtep
Parameters
Parameter |
Comments |
---|---|
The advertise_virtual_rmac parameter lets BGP to use the VMAC with VIP as next-hop when advertising type-2 routes. Should be used together with advertise_pip parameter from cisco.nxos.nxos_bgp_address_family module. Choices:
|
|
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. |
|
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_interfaces 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 :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
- 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: |