W3cubDocs

/Ansible

nxos_vlan - Manages VLAN resources and attributes.

New in version 2.1.

Synopsis

Manages VLAN configurations on NX-OS switches.

Options

parameter required default choices comments
admin_state
 no up
  • up
  • down
Manage the VLAN administrative state of the VLAN equivalent to shut/no shut in VLAN config mode.
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.
mapped_vni
(added in 2.2)
 no
The Virtual Network Identifier (VNI) ID that is mapped to the VLAN. Valid values are integer and keyword 'default'.
name
 no
Name of VLAN.
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.
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
Manage the state of the resource.
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.
vlan_id
 no
Single VLAN ID.
vlan_range
 no
Range of VLANs such as 2-10 or 2,5,10-15, etc.
vlan_state
 no active
  • active
  • suspend
Manage the vlan operational state of the VLAN (equivalent to state {active | suspend} command.

Examples

# Ensure a range of VLANs are not present on the switch
- nxos_vlan: vlan_range="2-10,20,50,55-60,100-150" host=68.170.147.165 username=cisco password=cisco state=absent transport=nxapi

# Ensure VLAN 50 exists with the name WEB and is in the shutdown state
- nxos_vlan: vlan_id=50 host=68.170.147.165 admin_state=down name=WEB transport=nxapi username=cisco password=cisco

# Ensure VLAN is NOT on the device
- nxos_vlan: vlan_id=50 host=68.170.147.165 state=absent transport=nxapi username=cisco password=cisco

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
proposed k/v pairs of parameters passed into module (does not include vlan_id or vlan_range) always dict or null {'vlan_state': 'suspend', 'admin_state': 'down', 'name': 'app_vlan', 'mapped_vni': '5000'}
existing_vlans_list list of existing VLANs on the switch prior to making changes always list ['1', '2', '3', '4', '5', '20']
changed check to see if a change was made on the device always boolean True
end_state_vlans_list list of VLANs after the module is executed always list ['1', '2', '3', '4', '5', '20', '100']
existing k/v pairs of existing vlan or null when using vlan_range always dict {'vlan_state': 'suspend', 'admin_state': 'down', 'name': 'app_vlan', 'vlan_id': '20', 'mapped_vni': ''}
updates command string sent to the device always list ['vlan 20', 'vlan 55', 'vn-segment 5000']
end_state k/v pairs of the VLAN after executing module or null when using vlan_range always dict or null {'vlan_state': 'suspend', 'admin_state': 'down', 'name': 'app_vlan', 'vlan_id': '20', 'mapped_vni': '5000'}
proposed_vlans_list list of VLANs being proposed always list ['100']

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_vlan_module.html