- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# nxos_l2_interface – Manage Layer-2 interface on Cisco NXOS devices

New in version 2.5.

- DEPRECATED
- Synopsis
- Parameters
- Notes
- Examples
- Return Values
- Status

## DEPRECATED

Removed in Ansible:
| version: 2.13
Why: | Updated modules released with more functionality
Alternative: | nxos_l2_interfaces

## Synopsis

- This module provides declarative management of Layer-2 interface on Cisco NXOS devices.

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
access_vlan - |  | Configure given VLAN in access port. If `mode=access`, used as the access VLAN ID.
aggregate - |  | List of Layer-2 interface definitions.
mode - | Choices: access trunk | Mode in which interface needs to be configured.
name - / required |  | Full name of the interface excluding any logical unit number, i.e. Ethernet1/1. aliases: interface
native_vlan - |  | Native VLAN to be configured in trunk port. 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 | Choices: no ← yes | 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 | 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 | Choices: cli ← nxapi | 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 | Choices: no yes ← | If `no`, the environment variables `http_proxy` and `https_proxy` will be ignored.
| use_ssl boolean | Choices: no ← yes | 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 | Choices: no yes ← | 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 - | Choices: present ← absent unconfigured | Manage the state of the Layer-2 Interface configuration.
trunk_allowed_vlans - |  | List of allowed VLANs in a given trunk port. If `mode=trunk`, these are the only VLANs that will be configured on the trunk, i.e. "2-10,15".
trunk_vlans - |  | List of VLANs to be configured in trunk port. 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.0(3)I5(1).
- 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 l2 interface state
      nxos_l2_interface:
        name: Ethernet1/5
        state: unconfigured

    - name: Ensure Eth1/5 is configured for access vlan 20
      nxos_l2_interface:
        name: Ethernet1/5
        mode: access
        access_vlan: 20

    - name: Ensure Eth1/5 only has vlans 5-10 as trunk vlans
      nxos_l2_interface:
        name: Ethernet1/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_l2_interface:
        name: Ethernet1/5
        mode: trunk
        native_vlan: 10
        trunk_vlans: 2-50

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

    -  name: Aggregate Configure interfaces for access_vlan with aggregate
       nxos_l2_interface:
         aggregate:
           - { name: "Ethernet1/2", access_vlan: 6 }
           - { name: "Ethernet1/7", access_vlan: 15 }
         mode: access

## Return Values

Common return values are documented here, the following are the fields unique to this module:

Key | Returned | Description
--- | --- | ---
commands list | always, except for the platforms that use Netconf transport to manage the device. | The list of configuration mode commands to send to the device Sample: ['interface eth1/5', 'switchport access vlan 20']

## Status

- This module will be removed in version 2.13. [deprecated]
- For more information see DEPRECATED.

### Authors

- Trishna Guha (@trishnaguha)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.