arista.eos.eos_interface – (deprecated, removed after 2022-06-01) Manage Interface on Arista EOS network devices

Note

This plugin is part of the arista.eos collection (version 2.2.0).

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 version 1.0.0: of arista.eos

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.

Note

This module has a corresponding action plugin.

Parameters

Parameter

Comments

aggregate

list / elements=dictionary

List of Interfaces definitions. Each of the entry in aggregate list should define name of interface name and other options as required.

delay

integer

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 up/down, tx_rate and rx_rate.

Default: 10

description

string

Description of Interface upto 240 characters.

enabled

boolean

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:

  • no

  • yes

mtu

string

Set maximum transmission unit size in bytes of transmit packet for the interface given in name option.

name

string / required

Name of the Interface to be configured on remote device. The name of interface should be in expanded format and not abbreviated.

neighbors

list / elements=dictionary

Check the operational state of given interface name for LLDP neighbor.

The following suboptions are available.

host

string

LLDP neighbor host for given interface name.

port

string

LLDP neighbor port to which given interface name is connected.

rx_rate

string

Receiver rate in bits per second (bps) for the interface given in name option.

This is state check parameter only.

Supports conditionals, see Conditionals in Networking Modules

speed

string

This option configures autoneg and speed/duplex/flowcontrol for the interface given in name option.

state

string

State of the Interface configuration, up means present and operationally up and down means present and operationally down

Choices:

  • present

  • absent

  • up

  • down

tx_rate

string

Transmit rate in bits per second (bps) for the interface given in name option.

This is state check parameter only.

Supports conditionals, see Conditionals in Networking Modules

delay

integer

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 up/down, tx_rate and rx_rate.

Default: 10

description

string

Description of Interface upto 240 characters.

enabled

boolean

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:

  • no

  • yes ← (default)

mtu

string

Set maximum transmission unit size in bytes of transmit packet for the interface given in name option.

name

string

Name of the Interface to be configured on remote device. The name of interface should be in expanded format and not abbreviated.

neighbors

list / elements=dictionary

Check the operational state of given interface name for LLDP neighbor.

The following suboptions are available.

host

string

LLDP neighbor host for given interface name.

port

string

LLDP neighbor port to which given interface name is connected.

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:

  • no ← (default)

  • yes

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:

  • no

  • yes ← (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:

  • no

  • yes ← (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:

  • no

  • yes ← (default)

rx_rate

string

Receiver rate in bits per second (bps) for the interface given in name option.

This is state check parameter only.

Supports conditionals, see Conditionals in Networking Modules

speed

string

This option configures autoneg and speed/duplex/flowcontrol for the interface given in name option.

state

string

State of the Interface configuration, up means present and operationally up and down means present and operationally down

Choices:

  • present ← (default)

  • absent

  • up

  • down

tx_rate

string

Transmit rate in bits per second (bps) for the interface given in name option.

This is state check parameter only.

Supports conditionals, see Conditionals in Networking Modules

Notes

Note

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

commands

list / elements=string

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 ethernet1”, “description test-interface”, “speed 100full”, “mtu 512”]

Status

  • This module will be removed in a major release after 2022-06-01. [deprecated]

  • For more information see DEPRECATED.

Authors

  • Ganesh Nalawade (@ganeshrn)