cisco.ios.ios_l2_interface module – (deprecated, removed after 2022-06-01) Manage Layer-2 interface on Cisco IOS devices.
Note
This module is part of the cisco.ios collection (version 3.3.2).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install cisco.ios
.
To use it in a playbook, specify: cisco.ios.ios_l2_interface
.
New in cisco.ios 1.0.0
DEPRECATED
- Removed in:
major release after 2022-06-01
- Why:
Newer and updated modules released with more functionality in Ansible 2.9
- Alternative:
ios_l2_interfaces
Synopsis
This module provides declarative management of Layer-2 interfaces on Cisco IOS devices.
Note
This module has a corresponding action plugin.
Parameters
Parameter |
Comments |
---|---|
Configure given VLAN in access port. If |
|
List of Layer-2 interface definitions. |
|
Configure given VLAN in access port. If |
|
Mode in which interface needs to be configured. Choices:
|
|
Full name of the interface excluding any logical unit number, i.e. GigabitEthernet0/1. |
|
Native VLAN to be configured in trunk port. If |
|
Manage the state of the Layer-2 Interface configuration. Choices:
|
|
List of allowed VLANs in a given trunk port. If |
|
List of VLANs to be configured in trunk port. If |
|
Mode in which interface needs to be configured. Choices:
|
|
Full name of the interface excluding any logical unit number, i.e. GigabitEthernet0/1. |
|
Native VLAN to be configured in trunk port. If |
|
Deprecated Starting with Ansible 2.5 we recommend using For more information please see the https://docs.ansible.com/ansible/latest/network/user_guide/platform_ios.html. A dict object containing connection details. |
|
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 |
|
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 Choices:
|
|
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. |
|
Specifies the password to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable |
|
Specifies the port to use when building the connection to the remote device. |
|
Specifies the SSH key to use to authenticate the connection to the remote device. This value is the path to the key used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable |
|
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. |
|
Configures the username to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable |
|
Manage the state of the Layer-2 Interface configuration. Choices:
|
|
List of allowed VLANs in a given trunk port. If |
|
List of VLANs to be configured in trunk port. If |
Notes
Note
For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide <network_guide>`
For more information on using Ansible to manage Cisco devices see the `Cisco integration page <https://www.ansible.com/integrations/networks/cisco>`_.
Examples
- name: Ensure GigabitEthernet0/5 is in its default l2 interface state
ios.ios_l2_interface:
name: GigabitEthernet0/5
state: unconfigured
- name: Ensure GigabitEthernet0/5 is configured for access vlan 20
ios.ios_l2_interface:
name: GigabitEthernet0/5
mode: access
access_vlan: 20
- name: Ensure GigabitEthernet0/5 only has vlans 5-10 as trunk vlans
ios.ios_l2_interface:
name: GigabitEthernet0/5
mode: trunk
native_vlan: 10
trunk_allowed_vlans: 5-10
- name: Ensure GigabitEthernet0/5 is a trunk port and ensure 2-50 are being tagged
(doesn't mean others aren't also being tagged)
ios.ios_l2_interface:
name: GigabitEthernet0/5
mode: trunk
native_vlan: 10
trunk_vlans: 2-50
- name: Ensure these VLANs are not being tagged on the trunk
ios.ios_l2_interface:
name: GigabitEthernet0/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 |
Description |
---|---|
The list of configuration mode commands to send to the device Returned: always, except for the platforms that use Netconf transport to manage the device. Sample: |
Status
This module will be removed in a major release after 2022-06-01. [deprecated]
For more information see DEPRECATED.