ansible.netcommon.net_l2_interface module – (deprecated, removed after 2022-06-01) Manage Layer-2 interface on network devices
Note
This module is part of the ansible.netcommon collection (version 2.6.1).
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 ansible.netcommon
.
To use it in a playbook, specify: ansible.netcommon.net_l2_interface
.
New in version 1.0.0: of ansible.netcommon
DEPRECATED
- Removed in
major release after 2022-06-01
- Why
Updated modules released with more functionality
- Alternative
Use platform-specific “[netos]_l2_interfaces” module
Synopsis
This module provides declarative management of Layer-2 interface on network devices.
Note
This module has a corresponding action plugin.
Parameters
Parameter |
Comments |
---|---|
Configure given VLAN in access port. |
|
List of Layer-2 interface definitions. |
|
Mode in which interface needs to be configured. Choices:
|
|
Name of the interface excluding any logical unit number. |
|
Native VLAN to be configured in trunk port. |
|
State of the Layer-2 Interface configuration. Choices:
|
|
List of allowed VLAN’s in a given trunk port. |
|
List of VLANs to be configured in trunk port. |
Notes
Note
This module is supported on
ansible_network_os
network platforms. See the Network Platform Options for details.
Examples
- name: configure Layer-2 interface
ansible.netcommon.net_l2_interface:
name: gigabitethernet0/0/1
mode: access
access_vlan: 30
- name: remove Layer-2 interface configuration
ansible.netcommon.net_l2_interface:
name: gigabitethernet0/0/1
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: [“interface gigabitethernet0/0/1”, “switchport mode access”, “switchport access vlan 30”] |
Status
This module will be removed in a major release after 2022-06-01. [deprecated]
For more information see DEPRECATED.
Authors
Ganesh Nalawade (@ganeshrn)