nxos_switchport – Manages Layer 2 switchport interfaces¶
New in version 2.1.
DEPRECATED¶
- Removed in Ansible
version: 2.9
- Why
Replaced with generic version.
- Alternative
Use nxos_l2_interface instead.
Synopsis¶
Manages Layer 2 interfaces
Parameters¶
| Parameter | Choices/Defaults | Comments | |
|---|---|---|---|
|
access_vlan
-
|
If
mode=access, used as the access VLAN ID. |
||
|
interface
-
|
Full name of the interface, i.e. Ethernet1/1.
|
||
|
mode
-
|
|
Mode for the Layer 2 port.
|
|
|
native_vlan
-
|
If
mode=trunk, used as the trunk native VLAN ID. |
||
|
provider
dictionary
|
Deprecated
Starting with Ansible 2.5 we recommend using
connection: network_cli.This option is only required if you are using NX-API.
For more information please see the NXOS Platform Options guide.
A dict object containing connection details.
|
||
|
auth_pass
string
added in 2.5.3 |
Specifies the password to use if required to enter privileged mode on the remote device. If authorize is false, then this argument does nothing. If the value is not specified in the task, the value of environment variable
ANSIBLE_NET_AUTH_PASS will be used instead. |
||
|
authorize
boolean
added in 2.5.3 |
|
Instructs the module to enter privileged mode on the remote device before sending any commands. If not specified, the device will attempt to execute all commands in non-privileged mode. If the value is not specified in the task, the value of environment variable
ANSIBLE_NET_AUTHORIZE will be used instead. |
|
|
host
string
/ required
|
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.
|
||
|
password
string
|
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
integer
|
Default: "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).
|
|
|
ssh_keyfile
string
|
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. |
||
|
timeout
integer
added in 2.3 |
Default: 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
string
/ required
|
|
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_proxy
boolean
added in 2.5 |
|
If
no, the environment variables http_proxy and https_proxy will be ignored. |
|
|
use_ssl
boolean
|
|
Configures the transport to use SSL if set to
yes only when the transport=nxapi, otherwise this value is ignored. |
|
|
username
string
|
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
boolean
|
|
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. |
|
|
state
-
|
|
Manage the state of the resource.
|
|
|
trunk_allowed_vlans
-
added in 2.2 |
if
mode=trunk, these are the only VLANs that will be configured on the trunk, i.e. "2-10,15". |
||
|
trunk_vlans
-
|
If
mode=trunk, used as the VLAN range to ADD or REMOVE from the trunk.aliases: trunk_add_vlans |
||
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 information on using CLI and NX-API see the NXOS Platform Options guide
For more information on using Ansible to manage network devices see the Ansible Network Guide
For more information on using Ansible to manage Cisco devices see the Cisco integration page.
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 module:
| Key | Returned | Description |
|---|---|---|
|
commands
list
|
always |
command string sent to the device
Sample:
['interface eth1/5', 'switchport access vlan 20']
|
Status¶
This module will be removed in version 2.9. [deprecated]
For more information see DEPRECATED.