W3cubDocs

/Ansible

nxos_vxlan_vtep - Manages VXLAN Network Virtualization Endpoint (NVE).

New in version 2.2.

Synopsis

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

Options

parameter required default choices comments
description
 no
Description of the NVE interface.
host
 yes
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.
host_reachability
 no
  • true
  • false
Specify mechanism for host reachability advertisement.
interface
 yes
Interface name for the VXLAN Network Virtualization Endpoint.
password
 no
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.
port
 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).
provider
 no
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.
shutdown
 no
  • true
  • false
Administratively shutdown the NVE interface.
source_interface
 no
Specify the loopback interface whose IP address should be used for the NVE interface.
source_interface_hold_down_time
 no
Suppresses advertisement of the NVE loopback address until the overlay has converged.
ssh_keyfile
 no
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.
state
 no present
  • present
  • absent
Determines whether the config should be present or not on the device.
transport
 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.
use_ssl
 no
  • yes
  • no
Configures the transport to use SSL if set to true only when the transport=nxapi, otherwise this value is ignored.
username
 no
Configures the username to use to authenticate the connection to the remote device. The value of username 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.

Examples

- nxos_vxlan_vtep:
    interface: nve1
    description: default
    host_reachability: default
    source_interface: Loopback0
    source_interface_hold_down_time: 30
    shutdown: default
    username: "{{ un }}"
    password: "{{ pwd }}"
    host: "{{ inventory_hostname }}"

Return Values

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

name description returned type sample
end_state k/v pairs of VXLAN VTEP configuration after module execution verbose mode dict {'description': 'simple description', 'shutdown': True, 'source_interface': 'loopback0', 'interface': 'nve1', 'host_reachability': True, 'source_interface_hold_down_time': '30'}
changed check to see if a change was made on the device always boolean True
updates commands sent to the device always list ['interface nve1', 'source-interface loopback0', 'source-interface hold-down-time 30', 'description simple description', 'shutdown', 'host-reachability protocol bgp']
proposed k/v pairs of parameters passed into module verbose mode dict {'description': 'simple description', 'shutdown': True, 'source_interface': 'loopback0', 'interface': 'nve1', 'host_reachability': True, 'source_interface_hold_down_time': '30'}
existing k/v pairs of existing VXLAN VTEP configuration verbose mode dict {}

Notes

Note

The module is used to manage NVE properties, not to create NVE interfaces. Use nxos_interface if you wish to do so.

Note

state=absent removes the interface.

Note

Default, where supported, restores params default value.

This is a Core Module

For more information on what this means please read Core Modules

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

© 2012–2016 Michael DeHaan
© 2016 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/nxos_vxlan_vtep_module.html