eos_l3_interface – Manage L3 interfaces on Arista EOS network devices¶

New in version 2.5.

DEPRECATED
Synopsis
Parameters
Notes
Examples
Return Values
Status

DEPRECATED ¶

Removed in Ansible:
	version: 2.13
Why:	Updated modules released with more functionality
Alternative:	eos_l3_interfaces

Synopsis ¶

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

Parameters ¶

Parameter		Choices/Defaults	Comments
aggregate -			List of L3 interfaces definitions. Each of the entry in aggregate list should define name of interface `name` and a optional `ipv4` or `ipv6` address.
auth_pass string			Deprecated Starting with Ansible 2.5 we recommend using `connection: network_cli` and `become: yes` with `become_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_PASS` will be used instead.
authorize boolean		Choices: no ← yes	Deprecated Starting with Ansible 2.5 we recommend using `connection: network_cli` and `become: 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_AUTHORIZE` will be used instead.
ipv4 -			IPv4 address to be set for the L3 interface mentioned in name option. The address format is <ipv4 address>/<mask>, the mask is number in range 0-32 eg. 192.168.0.1/24
ipv6 -			IPv6 address to be set for the L3 interface mentioned in name option. The address format is <ipv6 address>/<mask>, the mask is number in range 0-128 eg. fd5d:12c9:2201:1::1/64
name -			Name of the L3 interface to be configured eg. ethernet1
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_PASS` will be used instead.
	authorize boolean	Choices: no ← yes	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.
	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_PASSWORD` will 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_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 / required	Choices: cli ← eapi	Configures the transport connection to use when connecting to the remote device.
	use_proxy boolean added in 2.5	Choices: no yes ←	If `no`, the environment variables `http_proxy` and `https_proxy` will be ignored.
	use_ssl boolean	Choices: no yes ←	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.
	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	Choices: no yes ←	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.
state -		Choices: present ← absent	State of the L3 interface configuration. It indicates if the configuration should be present or absent on remote device.

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: Remove ethernet1 IPv4 and IPv6 address
  eos_l3_interface:
    name: ethernet1
    state: absent

- name: Set ethernet1 IPv4 address
  eos_l3_interface:
    name: ethernet1
    ipv4: 192.168.0.1/24

- name: Set ethernet1 IPv6 address
  eos_l3_interface:
    name: ethernet1
    ipv6: "fd5d:12c9:2201:1::1/64"

- name: Set interface Vlan1 (SVI) IPv4 address
  eos_l3_interface:
    name: Vlan1
    ipv4: 192.168.0.5/24

- name: Set IP addresses on aggregate
  eos_l3_interface:
    aggregate:
      - { name: ethernet1, ipv4: 192.168.2.10/24 }
      - { name: ethernet1, ipv4: 192.168.3.10/24, ipv6: "fd5d:12c9:2201:1::1/64" }

- name: Remove IP addresses on aggregate
  eos_l3_interface:
    aggregate:
      - { name: ethernet1, ipv4: 192.168.2.10/24 }
      - { name: ethernet1, ipv4: 192.168.3.10/24, ipv6: "fd5d:12c9:2201:1::1/64" }
    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', 'ip address 192.168.0.1/24', 'ipv6 address fd5d:12c9:2201:1::1/64']

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.

eos_l3_interface – Manage L3 interfaces on Arista EOS network devices¶

DEPRECATED¶

Synopsis¶

Parameters¶

Notes¶

Examples¶

Return Values¶

Status¶