Documentation

nxos_switchport - Manages Layer 2 switchport interfaces.

New in version 2.1.

DEPRECATED

In:version:
Why:
Alternative:

Synopsis

  • Manages Layer 2 interfaces

Options

parameter
required
default
choices
comments
native_vlan
no
If mode=trunk, used as the trunk native VLAN ID.
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.
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.
interface
yes
Full name of the interface, i.e. Ethernet1/1.
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.
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).
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.
access_vlan
no
If mode=access, used as the access VLAN ID.
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.
use_proxy
(added in 2.5)
no
yes
  • yes
  • no
If no, the environment variables http_proxy and https_proxy will be ignored.
trunk_vlans
no
If mode=trunk, used as the VLAN range to ADD or REMOVE from the trunk.

aliases: trunk_add_vlans
state
no
present
  • present
  • absent
  • unconfigured
Manage the state of the resource.
trunk_allowed_vlans
(added in 2.2)
no
if mode=trunk, these are the only VLANs that will be configured on the trunk, i.e. "2-10,15".
mode
no
  • access
  • trunk
Mode for the Layer 2 port.
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).
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.
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.

Examples

- name: Ensure Eth1/5 is in its default switchport state
  nxos_switchport:
    interface: eth1/5
    state: unconfigured

- name: Ensure Eth1/5 is configured for access vlan 20
  nxos_switchport:
    interface: eth1/5
    mode: access
    access_vlan: 20

- name: Ensure Eth1/5 only has vlans 5-10 as trunk vlans
  nxos_switchport:
    interface: eth1/5
    mode: trunk
    native_vlan: 10
    trunk_vlans: 5-10

- name: Ensure eth1/5 is a trunk port and ensure 2-50 are being tagged (doesn't mean others aren't also being tagged)
  nxos_switchport:
    interface: eth1/5
    mode: trunk
    native_vlan: 10
    trunk_vlans: 2-50

- name: Ensure these VLANs are not being tagged on the trunk
  nxos_switchport:
    interface: eth1/5
    mode: trunk
    trunk_vlans: 51-4094
    state: absent

Return Values

Common return values are documented here, the following are the fields unique to this {{plugin_type}}:

name
description
returned
type
sample
commands
command string sent to the device
always
list
['interface eth1/5', 'switchport access vlan 20']


Notes

Note

  • Tested against NXOSv 7.3.(0)D1(1) on VIRL
  • When state=absent, VLANs can be added/removed from trunk links and the existing access VLAN can be ‘unconfigured’ to just having VLAN 1 on that interface.
  • When working with trunks VLANs the keywords add/remove are always sent in the switchport trunk allowed vlan command. Use verbose mode to see commands sent.
  • When state=unconfigured, the interface will result with having a default Layer 2 interface, i.e. vlan 1 in access mode.
  • For more information on using Ansible to manage Cisco devices see https://www.ansible.com/ansible-cisco.

Author

  • Jason Edelman (@jedelman8)

If you want to help with development, please read Community Information & Contributing, Testing Ansible and Developing Modules.