eos_l2_interfaces – Manages Layer-2 interface attributes of Arista EOS devices — Ansible Documentation

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

Documentation

# eos_l2_interfaces – Manages Layer-2 interface attributes of Arista EOS devices

New in version 2.9.

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

## Synopsis

- This module provides declarative management of Layer-2 interface on Arista EOS devices.

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
config list / elements=dictionary |  | A dictionary of Layer-2 interface options
| access dictionary |  | Switchport mode access command to configure the interface as a layer 2 access.
|  | vlan integer |  | Configure given VLAN in access port. It's used as the access VLAN ID.
| name string / required |  | Full name of interface, e.g. Ethernet1.
| trunk dictionary |  | Switchport mode trunk command to configure the interface as a Layer 2 trunk.
|  | native_vlan integer |  | Native VLAN to be configured in trunk port. It is used as the trunk native VLAN ID.
|  | trunk_allowed_vlans list |  | List of allowed VLANs in a given trunk port. These are the only VLANs that will be configured on the trunk.
state string | Choices: merged ← replaced overridden deleted | The state of the configuration after module completion

## Notes

Note

- Tested against Arista EOS 4.20.10M
- This module works with connection `network_cli`. See the EOS Platform Options.

## Examples

    ---

    # Using merged

    # Before state:
    # -------------
    #
    # veos#show running-config | section interface
    # interface Ethernet1
    #    switchport access vlan 20
    # !
    # interface Ethernet2
    #    switchport trunk native vlan 20
    #    switchport mode trunk
    # !
    # interface Management1
    #    ip address dhcp
    #    ipv6 address auto-config
    # !

    - name: Merge provided configuration with device configuration.
      eos_l2_interfaces:
        config:
          - name: Ethernet1
            trunk:
              native_vlan: 10
          - name: Ethernet2
            access:
              vlan: 30
        state: merged

    # After state:
    # ------------
    #
    # veos#show running-config | section interface
    # interface Ethernet1
    #    switchport trunk native vlan 10
    #    switchport mode trunk
    # !
    # interface Ethernet2
    #    switchport access vlan 30
    # !
    # interface Management1
    #    ip address dhcp
    #    ipv6 address auto-config
    # !

    # Using replaced

    # Before state:
    # -------------
    #
    # veos2#show running-config | s int
    # interface Ethernet1
    #    switchport access vlan 20
    # !
    # interface Ethernet2
    #    switchport trunk native vlan 20
    #    switchport mode trunk
    # !
    # interface Management1
    #    ip address dhcp
    #    ipv6 address auto-config
    # !

    - name: Replace device configuration of specified L2 interfaces with provided configuration.
      eos_l2_interfaces:
        config:
          - name: Ethernet1
            trunk:
              native_vlan: 20
              trunk_vlans: 5-10, 15
        state: replaced

    # After state:
    # ------------
    #
    # veos#show running-config | section interface
    # interface Ethernet1
    #    switchport trunk native vlan 20
    #    switchport trunk allowed vlan 5-10,15
    #    switchport mode trunk
    # !
    # interface Ethernet2
    #    switchport trunk native vlan 20
    #    switchport mode trunk
    # !
    # interface Management1
    #    ip address dhcp
    #    ipv6 address auto-config
    # !

    # Using overridden

    # Before state:
    # -------------
    #
    # veos#show running-config | section interface
    # interface Ethernet1
    #    switchport access vlan 20
    # !
    # interface Ethernet2
    #    switchport trunk native vlan 20
    #    switchport mode trunk
    # !
    # interface Management1
    #    ip address dhcp
    #    ipv6 address auto-config
    # !

    - name: Override device configuration of all L2 interfaces on device with provided configuration.
      eos_l2_interfaces:
        config:
          - name: Ethernet2
            access:
              vlan: 30
        state: overridden

    # After state:
    # ------------
    #
    # veos#show running-config | section interface
    # interface Ethernet1
    # !
    # interface Ethernet2
    #    switchport access vlan 30
    # !
    # interface Management1
    #    ip address dhcp
    #    ipv6 address auto-config
    # !

    # Using deleted

    # Before state:
    # -------------
    #
    # veos#show running-config | section interface
    # interface Ethernet1
    #    switchport access vlan 20
    # !
    # interface Ethernet2
    #    switchport trunk native vlan 20
    #    switchport mode trunk
    # !
    # interface Management1
    #    ip address dhcp
    #    ipv6 address auto-config
    # !

    - name: Delete EOS L2 interfaces as in given arguments.
      eos_l2_interfaces:
        config:
          - name: Ethernet1
          - name: Ethernet2
        state: deleted

    # After state:
    # ------------
    #
    # veos#show running-config | section interface
    # interface Ethernet1
    # !
    # interface Ethernet2
    # !
    # interface Management1
    #    ip address dhcp
    #    ipv6 address auto-config

## Return Values

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

Key | Returned | Description
--- | --- | ---
after list | when changed | The configuration as structured data after module completion. Sample: The configuration returned will always be in the same format of the parameters above.
before list | always | The configuration as structured data prior to module invocation. Sample: The configuration returned will always be in the same format of the parameters above.
commands list | always | The set of commands pushed to the remote device. Sample: ['interface Ethernet2', 'switchport access vlan 20']

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Network Team. [network]

### Red Hat Support

More information about Red Hat’s support of this module is available from this Red Hat Knowledge Base article.

### Authors

- Nathaniel Case (@qalthos)

Hint

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