ansible.builtin.ios_l2_interface (v2.8.13) — module

Install Ansible via pip

Install with pip install ansible==2.8.13

Description

This module provides declarative management of Layer-2 interfaces on Cisco IOS devices.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Ensure GigabitEthernet0/5 is in its default l2 interface state
  ios_l2_interface:
    name: GigabitEthernet0/5
    state: unconfigured

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Ensure GigabitEthernet0/5 is configured for access vlan 20
  ios_l2_interface:
    name: GigabitEthernet0/5
    mode: access
    access_vlan: 20

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Ensure GigabitEthernet0/5 only has vlans 5-10 as trunk vlans
  ios_l2_interface:
    name: GigabitEthernet0/5
    mode: trunk
    native_vlan: 10
    trunk_vlans: 5-10

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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_l2_interface:
    name: GigabitEthernet0/5
    mode: trunk
    native_vlan: 10
    trunk_vlans: 2-50

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Inputs

    
mode:
    choices:
    - access
    - trunk
    default: access
    description:
    - Mode in which interface needs to be configured.

name:
    aliases:
    - interface
    description:
    - Full name of the interface excluding any logical unit number, i.e. GigabitEthernet0/1.
    required: true

state:
    choices:
    - present
    - absent
    - unconfigured
    default: present
    description:
    - Manage the state of the Layer-2 Interface configuration.

aggregate:
    description:
    - List of Layer-2 interface definitions.

access_vlan:
    description:
    - Configure given VLAN in access port. If C(mode=access), used as the access VLAN
      ID.

native_vlan:
    description:
    - Native VLAN to be configured in trunk port. If C(mode=trunk), used as the trunk
      native VLAN ID.

trunk_vlans:
    description:
    - List of VLANs to be configured in trunk port. If C(mode=trunk), used as the VLAN
      range to ADD or REMOVE from the trunk.

trunk_allowed_vlans:
    description:
    - List of allowed VLANs in a given trunk port. If C(mode=trunk), these are the only
      VLANs that will be configured on the trunk, i.e. "2-10,15".

Outputs

commands:
  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/5
  - switchport access vlan 20
  type: list