W3cubDocs

/Ansible 2.11

ansible.netcommon.net_l2_interface – (deprecated, removed after 2022-06-01) Manage Layer-2 interface on network devices

Note

This plugin is part of the ansible.netcommon collection (version 1.5.0).

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 Choices/Defaults Comments
access_vlan
string
Configure given VLAN in access port.
aggregate
string
List of Layer-2 interface definitions.
mode
string
    Choices:
  • access ←
  • trunk
Mode in which interface needs to be configured.
name
string
Name of the interface excluding any logical unit number.
native_vlan
string
Native VLAN to be configured in trunk port.
state
string
    Choices:
  • present ←
  • absent
State of the Layer-2 Interface configuration.
trunk_allowed_vlans
string
List of allowed VLAN's in a given trunk port.
trunk_vlans
string
List of VLANs to be configured in trunk port.

Notes

Note

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 Returned Description
commands
list / elements=string
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 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)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/ansible/netcommon/net_l2_interface_module.html