arista.eos.eos_interface module – (deprecated, removed after 2022-06-01) Manage Interface 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_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_interfaces
Synopsis
This module provides declarative management of Interfaces on Arista EOS network devices.
Parameters
Parameter |
Comments |
---|---|
List of Interfaces definitions. Each of the entry in aggregate list should define name of interface |
|
Time in seconds to wait before checking for the operational state on remote device. This wait is applicable for operational state argument which are state with values Default: |
|
Description of Interface upto 240 characters. |
|
Interface link status. If the value is True the interface state will be enabled, else if value is False interface will be in disable (shutdown) state. Choices:
|
|
Set maximum transmission unit size in bytes of transmit packet for the interface given in |
|
Name of the Interface to be configured on remote device. The name of interface should be in expanded format and not abbreviated. |
|
Check the operational state of given interface The following suboptions are available. |
|
LLDP neighbor host for given interface |
|
LLDP neighbor port to which given interface |
|
Receiver rate in bits per second (bps) for the interface given in This is state check parameter only. Supports conditionals, see Conditionals in Networking Modules |
|
This option configures autoneg and speed/duplex/flowcontrol for the interface given in |
|
State of the Interface configuration, Choices:
|
|
Transmit rate in bits per second (bps) for the interface given in This is state check parameter only. Supports conditionals, see Conditionals in Networking Modules |
|
Time in seconds to wait before checking for the operational state on remote device. This wait is applicable for operational state argument which are state with values Default: |
|
Description of Interface upto 240 characters. |
|
Interface link status. If the value is True the interface state will be enabled, else if value is False interface will be in disable (shutdown) state. Choices:
|
|
Set maximum transmission unit size in bytes of transmit packet for the interface given in |
|
Name of the Interface to be configured on remote device. The name of interface should be in expanded format and not abbreviated. |
|
Check the operational state of given interface The following suboptions are available. |
|
LLDP neighbor host for given interface |
|
LLDP neighbor port to which given interface |
|
Deprecated Starting with Ansible 2.5 we recommend using Starting with Ansible 2.6 we recommend using 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. |
|
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 |
|
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 Choices:
|
|
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. |
|
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 |
|
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: |
|
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 |
|
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. |
|
Configures the transport connection to use when connecting to the remote device. Choices:
|
|
If Choices:
|
|
Configures the transport to use SSL if set to Choices:
|
|
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 |
|
If Choices:
|
|
Receiver rate in bits per second (bps) for the interface given in This is state check parameter only. Supports conditionals, see Conditionals in Networking Modules |
|
This option configures autoneg and speed/duplex/flowcontrol for the interface given in |
|
State of the Interface configuration, Choices:
|
|
Transmit rate in bits per second (bps) for the interface given in This is state check parameter only. Supports conditionals, see Conditionals in Networking Modules |
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: configure interface
arista.eos.eos_interface:
name: ethernet1
description: test-interface
speed: 100full
mtu: 512
- name: remove interface
arista.eos.eos_interface:
name: ethernet1
state: absent
- name: make interface up
arista.eos.eos_interface:
name: ethernet1
enabled: true
- name: make interface down
arista.eos.eos_interface:
name: ethernet1
enabled: false
- name: Check intent arguments
arista.eos.eos_interface:
name: ethernet1
state: up
tx_rate: ge(0)
rx_rate: le(0)
- name: Check neighbors intent arguments
arista.eos.eos_interface:
name: ethernet1
neighbors:
- port: eth0
host: netdev
- name: Configure interface in disabled state and check if the operational state is
disabled or not
arista.eos.eos_interface:
name: ethernet1
enabled: false
state: down
- name: Add interface using aggregate
arista.eos.eos_interface:
aggregate:
- {name: ethernet1, mtu: 256, description: test-interface-1}
- {name: ethernet2, mtu: 516, description: test-interface-2}
speed: 100full
state: present
- name: Delete interface using aggregate
arista.eos.eos_interface:
aggregate:
- name: loopback9
- name: loopback10
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: |
Status
This module will be removed in a major release after 2022-06-01. [deprecated]
For more information see DEPRECATED.