cisco.nxos.nxos_vxlan_vtep_module.rst

cisco.nxos.nxos_vxlan_vtep

Manages VXLAN Network Virtualization Endpoint (NVE).

Version added: 1.0.0

• Synopsis
• Parameters
• Notes
• Examples
• Return Values
• Status

Synopsis

• Manages VXLAN Network Virtualization Endpoint (NVE) overlay interface that terminates VXLAN tunnels.

Parameters

Parameter	Choices/Defaults	Comments
advertise_virtual_rmac boolean	Choices: no yes	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.
description string		Description of the NVE interface.
global_ingress_replication_bgp boolean	Choices: no yes	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.
global_mcast_group_L2 string		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_mcast_group_L3 string		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.
global_suppress_arp boolean	Choices: no yes	Enables ARP suppression for all VNIs. This is available on NX-OS 9K series running 9.2.x or higher.
host_reachability boolean	Choices: no yes	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.
interface string / required		Interface name for the VXLAN Network Virtualization Endpoint.
multisite_border_gateway_interface string added in 1.1.0		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.
shutdown boolean	Choices: no yes	Administratively shutdown the NVE interface.
source_interface string		Specify the loopback interface whose IP address should be used for the NVE interface.
source_interface_hold_down_time string		Suppresses advertisement of the NVE loopback address until the overlay has converged.
state string	Choices: present ← absent	Determines whether the config should be present or not on the device.

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 :ref:`cisco.nxos.nxos_interfaces <cisco.nxos.nxos_interfaces_module>` 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.

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	Returned	Description
commands list	always	commands sent to the device 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']

Status

Authors

• Gabriele Gerbino (@GGabriele)