You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

arista.eos.eos_l2_interface module – (deprecated, removed after 2022-06-01) Manage L2 interfaces on Arista EOS network devices.

Note

This module is part of the arista.eos collection (version 5.0.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 arista.eos.

To use it in a playbook, specify: arista.eos.eos_l2_interface.

New in arista.eos 1.0.0

DEPRECATED 

Removed in:: major release after 2022-06-01
Why:: Updated modules released with more functionality
Alternative:: eos_l2_interfaces

Synopsis 

This module provides declarative management of L2 interfaces on Arista EOS network devices.

Parameters 

Parameter	Comments
access_vlan string	Configure given VLAN in access port. If `mode=access`, used as the access VLAN ID.
aggregate list / elements=dictionary	List of Layer-2 interface definitions.
access_vlan string	Configure given VLAN in access port. If `mode=access`, used as the access VLAN ID.
mode string	Mode in which interface needs to be configured. Choices: `"access"` `"trunk"`
name string / required	Name of the interface
native_vlan string	Native VLAN to be configured in trunk port. If `mode=trunk`, used as the trunk native VLAN ID.
state string	Manage the state of the Layer-2 Interface configuration. Choices: `"present"` `"absent"`
trunk_allowed_vlans aliases: trunk_vlans string	List of allowed VLANs in a given trunk port. If `mode=trunk`, these are the ONLY VLANs that will be configured on the trunk, i.e. `2-10,15`.
mode string	Mode in which interface needs to be configured. Choices: `"access"` `"trunk"`
name aliases: interface string	Name of the interface
native_vlan string	Native VLAN to be configured in trunk port. If `mode=trunk`, used as the trunk native VLAN ID.
provider dictionary	Deprecated Starting with Ansible 2.5 we recommend using `connection: network_cli`. Starting with Ansible 2.6 we recommend using `connection: httpapi` for eAPI. This option will be removed in a release after 2022-06-01. For more information please see the EOS Platform Options guide. A dict object containing connection details.
auth_pass string	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 `ANSIBLE_NET_AUTH_PASS` will be used instead.
authorize boolean	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 `ANSIBLE_NET_AUTHORIZE` will be used instead. Choices: `false` ← (default) `true`
host string	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.
password string	Specifies the password to use to authenticate the connection to the remote device. This is a common argument used for either cli or eapi transports. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead.
port integer	Specifies the port to use when building the connection to the remote device. This value applies to either cli or eapi. The port value will default to the appropriate transport common port if none is provided in the task (cli=22, http=80, https=443). Default: `0`
ssh_keyfile path	Specifies the SSH keyfile to use to authenticate the connection to the remote device. This argument is only used for cli transports. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_SSH_KEYFILE` will be used instead.
timeout integer	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.
transport string	Configures the transport connection to use when connecting to the remote device. Choices: `"cli"` ← (default) `"eapi"`
use_proxy boolean	If `no`, the environment variables `http_proxy` and `https_proxy` will be ignored. Choices: `false` `true` ← (default)
use_ssl boolean	Configures the transport to use SSL if set to `yes` only when the `transport=eapi`. If the transport argument is not eapi, this value is ignored. Choices: `false` `true` ← (default)
username string	Configures the username to use to authenticate the connection to the remote device. This value is used to authenticate either the CLI login or the eAPI authentication depending on which transport is used. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead.
validate_certs boolean	If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. If the transport argument is not eapi, this value is ignored. Choices: `false` `true` ← (default)
state string	Manage the state of the Layer-2 Interface configuration. Choices: `"present"` ← (default) `"absent"`
trunk_allowed_vlans aliases: trunk_vlans string	List of allowed VLANs in a given trunk port. If `mode=trunk`, these are the ONLY VLANs that will be configured on the trunk, i.e. `2-10,15`.

Notes 

Note

Tested against Arista EOS 4.24.6F
For information on using CLI, eAPI and privileged mode see the :ref:`EOS Platform Options guide <eos_platform_options>`
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 Arista EOS devices see the `Arista integration page <https://www.ansible.com/ansible-arista-networks>`_.

Examples 

- name: Ensure Ethernet1 does not have any switchport
  arista.eos.eos_l2_interface:
    name: Ethernet1
    state: absent

- name: Ensure Ethernet1 is configured for access vlan 20
  arista.eos.eos_l2_interface:
    name: Ethernet1
    mode: access
    access_vlan: 20

- name: Ensure Ethernet1 is a trunk port and ensure 2-50 are being tagged (doesn't
    mean others aren't also being tagged)
  arista.eos.eos_l2_interface:
    name: Ethernet1
    mode: trunk
    native_vlan: 10
    trunk_allowed_vlans: 2-50

- name: Set switchports on aggregate
  arista.eos.eos_l2_interface:
    aggregate:
    - {name: ethernet1, mode: access, access_vlan: 20}
    - {name: ethernet2, mode: trunk, native_vlan: 10}

Return Values 

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

Key	Description
commands list / elements=string	The list of configuration mode commands to send to the device Returned: always. Sample: `["interface ethernet1", "switchport access vlan 20"]`

Status 

This module will be removed in a major release after 2022-06-01. [deprecated]
For more information see DEPRECATED.

Authors

Ricardo Carrillo Cruz (@rcarrillocruz)

Collection links

Issue Tracker Repository (Sources)

arista.eos.eos_l2_interface module – (deprecated, removed after 2022-06-01) Manage L2 interfaces on Arista EOS network devices.

DEPRECATED

Synopsis

Parameters

Notes

Examples

Return Values

Status