Documentation

nxos_vxlan_vtep_vni - Creates a Virtual Network Identifier member (VNI)

New in version 2.2.

Synopsis

  • Creates a Virtual Network Identifier member (VNI) for an NVE overlay interface.

Options

parameter required default choices comments
assoc_vrf
no
  • true
  • false
This attribute is used to identify and separate processing VNIs that are associated with a VRF and used for routing. The VRF and VNI specified with this command must match the configuration of the VNI under the VRF.
config
no
Configuration string to be used for module operations. If not specified, the module will use the current running configuration.
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.
include_defaults
no True
  • true
  • true
Specify to use or not the complete running configuration for module operations.
ingress_replication
no
  • bgp
  • static
Specifies mechanism for host reachability advertisement.
interface
yes
Interface name for the VXLAN Network Virtualization Endpoint.
multicast_group
no
The multicast group (range) of the VNI. Valid values are string and keyword 'default'.
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.
peer_list
no
Set the ingress-replication static peer list. Valid values are an array, a space-separated string of ip addresses, or the keyword 'default'.
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.
save
no
  • true
  • false
Specify to save the running configuration after module operations.
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.
suppress_arp
no
  • true
  • false
Suppress arp under layer 2 VNI.
timeout
(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).
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. 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.
validate_certs
no
  • yes
  • no
If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. If the transport argument is not nxapi, this value is ignored.
vni
yes
ID of the Virtual Network Identifier.

Examples

- nxos_vxlan_vtep_vni:
    interface: nve1
    vni: 6000
    ingress_replication: 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 configuration after module execution verbose mode dict {'multicast_group': '', 'assoc_vrf': False, 'peer_list': [], 'interface': 'nve1', 'ingress_replication': '', 'suppress_arp': False, '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 ['interface nve1', 'member vni 6000']
proposed k/v pairs of parameters passed into module verbose mode dict {'interface': 'nve1', 'ingress_replication': 'default', 'vni': '6000'}
existing k/v pairs of existing configuration verbose mode dict {}


Notes

Note

  • default, where supported, restores params default value.

Status

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

Support

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.