eos_interface – Manage Interface on Arista EOS network devices¶
New in version 2.5.
DEPRECATED¶
| Removed in Ansible: | |
|---|---|
| version: 2.13 | |
| Why: | Updated modules released with more functionality | 
| Alternative: | eos_interfaces | 
Parameters¶
| Parameter | Choices/Defaults | Comments | |
|---|---|---|---|
| aggregate 
                    list
                                                                 | List of Interfaces definitions. Each of the entry in aggregate list should define name of interface  nameand other options as required. | ||
| auth_pass 
                    string
                                                                 | Deprecated Starting with Ansible 2.5 we recommend using  connection: network_cliandbecome: yeswithbecome_pass.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  ANSIBLE_NET_AUTH_PASSwill be used instead. | ||
| authorize 
                    boolean
                                                                 | 
 | Deprecated Starting with Ansible 2.5 we recommend using  connection: network_cliandbecome: yes.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  ANSIBLE_NET_AUTHORIZEwill be used instead. | |
| delay 
                    integer
                                                                 | 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  up/down, tx_rate and rx_rate. | |
| 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. | |
| mtu 
                    string
                                                                 | Set maximum transmission unit size in bytes of transmit packet for the interface given in  nameoption. | ||
| 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
                                                                 | Check the operational state of given interface  namefor LLDP neighbor.The following suboptions are available. | ||
| host 
                    -
                                                                 | LLDP neighbor host for given interface  name. | ||
| port 
                    -
                                                                 | LLDP neighbor port to which given interface  nameis connected. | ||
| provider 
                    dictionary
                                                                 | Deprecated Starting with Ansible 2.5 we recommend using  connection: network_cli.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 
                    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_PASSwill 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_AUTHORIZEwill be used instead. | |
| host 
                    string
                                             / 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 
                    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_PASSWORDwill be used instead. | ||
| port 
                    integer
                                                                 | Default: 0 | 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 
                    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_KEYFILEwill 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
                                             / required                     | 
 | Configures the transport connection to use when connecting to the remote device. | |
| use_proxy 
                    boolean
                                                                 added in 2.5 | 
 | If  no, the environment variableshttp_proxyandhttps_proxywill be ignored. | |
| use_ssl 
                    boolean
                                                                 | 
 | Configures the transport to use SSL if set to  yesonly when thetransport=eapi.  If the transport argument is not eapi, this value is ignored. | |
| 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_USERNAMEwill 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. | |
| rx_rate 
                    string
                                                                 | Receiver rate in bits per second (bps) for the interface given in  nameoption.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  nameoption. | ||
| state 
                    string
                                                                 | 
 | State of the Interface configuration,  upmeans present and operationally up anddownmeans present and operationallydown | |
| tx_rate 
                    string
                                                                 | Transmit rate in bits per second (bps) for the interface given in  nameoption.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:
Status¶
- This module will be removed in version 2.13. [deprecated]
- For more information see DEPRECATED.
Authors¶
- Ganesh Nalawade (@ganeshrn)
Hint
If you notice any issues in this documentation, you can edit this document to improve it.
