eos_interface – Manage Interface on Arista EOS network devices
eos_interface – Manage Interface on Arista EOS network devices
New in version 2.5.
Synopsis
- This module provides declarative management of Interfaces on Arista EOS network devices.
Parameters
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
aggregate - |
List of Interfaces definitions. Each of the entry in aggregate list should define name of interface | ||
auth_pass - |
Deprecated Starting with Ansible 2.5 we recommend using This option is only required if you are using eAPI. For more information please see the EOS Platform Options guide. 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 | ||
authorize boolean |
|
Deprecated Starting with Ansible 2.5 we recommend using This option is only required if you are using eAPI. For more information please see the EOS Platform Options guide. 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 | |
delay - |
Default: 10 |
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 | |
description - |
Description of Interface upto 240 characters. | ||
enabled - |
Default: "yes" |
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. | |
mtu - |
Set maximum transmission unit size in bytes of transmit packet for the interface given in | ||
name - / required |
Name of the Interface to be configured on remote device. The name of interface should be in expanded format and not abbreviated. | ||
neighbors - |
Check the operational state of given interface The following suboptions are available. | ||
host - |
LLDP neighbor host for given interface | ||
port - |
LLDP neighbor port to which given interface | ||
provider - |
Deprecated Starting with Ansible 2.5 we recommend using This option is only required if you are using eAPI. For more information please see the EOS Platform Options guide. A dict object containing connection details. | ||
auth_pass - |
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 | ||
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 | |
host - / required |
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 - |
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 | ||
port - |
Default: "0 (use common port)" |
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). | |
ssh_keyfile - |
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 | ||
timeout - |
Default: 10 |
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 - / required |
|
Configures the transport connection to use when connecting to the remote device. | |
use_proxy boolean added in 2.5 |
|
If | |
use_ssl boolean |
|
Configures the transport to use SSL if set to true only when the | |
username - |
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 | ||
validate_certs boolean |
|
If | |
rx_rate - |
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 | ||
speed - |
This option configures autoneg and speed/duplex/flowcontrol for the interface given in | ||
state - |
|
State of the Interface configuration, | |
tx_rate - |
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 EOS 4.15
- For information on using CLI, eAPI and privileged mode see the EOS Platform Options guide
- For more information on using Ansible to manage network devices see the Ansible Network Guide
- For more information on using Ansible to manage Arista EOS devices see the Arista integration page.
Examples
- name: configure interface
eos_interface:
name: ethernet1
description: test-interface
speed: 100full
mtu: 512
- name: remove interface
eos_interface:
name: ethernet1
state: absent
- name: make interface up
eos_interface:
name: ethernet1
enabled: True
- name: make interface down
eos_interface:
name: ethernet1
enabled: False
- name: Check intent arguments
eos_interface:
name: ethernet1
state: up
tx_rate: ge(0)
rx_rate: le(0)
- name: Check neighbors intent arguments
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
eos_interface:
name: ethernet1
enabled: False
state: down
- name: Add interface using aggregate
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
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 | Returned | Description |
---|---|---|
commands list |
always, except for the platforms that use Netconf transport to manage the device. |
The list of configuration mode commands to send to the device.
Sample: ['interface ethernet1', 'description test-interface', 'speed 100full', 'mtu 512'] |
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
- Ganesh Nalawade (@ganeshrn)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/eos_interface_module.html