New in version 2.1.
Manages Layer 2 interfaces
| parameter | required | default | choices | comments |
|---|---|---|---|---|
| access_vlan | no | If mode=access, used as the access VLAN ID. |
||
| 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. |
||
| mode | no |
| Mode for the Layer 2 port. |
|
| native_vlan | no | If mode=trunk, used as the trunk native VLAN ID. |
||
| 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 |
| 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. |
|
| 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". |
||
| trunk_vlans | no |
If mode=trunk, used as the VLAN range to ADD or REMOVE from the trunk.aliases: trunk_add_vlans
|
||
| use_ssl | 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. |
# ENSURE Eth1/5 is in its default switchport state
- nxos_switchport: interface=eth1/5 state=unconfigured host={{ inventory_hostname }}
# ENSURE Eth1/5 is configured for access vlan 20
- nxos_switchport: interface=eth1/5 mode=access access_vlan=20 host={{ inventory_hostname }}
# 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 host={{ inventory_hostname }}
# 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 host={{ inventory_hostname }}
# Ensure these VLANs are not being tagged on the trunk
- nxos_switchport: interface=eth1/5 mode=trunk trunk_vlans=51-4094 host={{ inventory_hostname }} state=absent
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 switchport after module execution | always | dict or null | {'native_vlan': '1', 'access_vlan': '10', 'switchport': 'Enabled', 'access_vlan_name': 'VLAN0010', 'trunk_vlans': '1-4094', 'mode': 'access', 'interface': 'Ethernet1/5', 'native_vlan_name': 'default'} |
| changed | check to see if a change was made on the device | always | boolean | True |
| updates | command string sent to the device | always | list | ['interface eth1/5', 'switchport access vlan 20'] |
| proposed | k/v pairs of parameters passed into module | always | dict | {'interface': 'eth1/5', 'access_vlan': '10', 'mode': 'access'} |
| existing | k/v pairs of existing switchport | dict | {'native_vlan': '1', 'access_vlan': '10', 'switchport': 'Enabled', 'access_vlan_name': 'VLAN0010', 'trunk_vlans': '1-4094', 'mode': 'access', 'interface': 'Ethernet1/5', 'native_vlan_name': 'default'} |
Note
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.
Note
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.
Note
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 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_switchport_module.html