Try SpotterRemoved in 2.13
Reason:Updated modules released with more functionality | Alternative:eos_interfaces
Manage Interface on Arista EOS network devices
| "added in version" 2.5 of ansible.builtin"
Authors: Ganesh Nalawade (@ganeshrn)
deprecated | supported by network
pipInstall with pip install ansible==2.9.17
This module provides declarative management of Interfaces on Arista EOS network devices.
- 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
mtu:
description:
- Set maximum transmission unit size in bytes of transmit packet for the interface
given in C(name) option.
type: str
name:
description:
- Name of the Interface to be configured on remote device. The name of interface should
be in expanded format and not abbreviated.
required: true
type: str
delay:
default: 10
description:
- Time in seconds to wait before checking for the operational state on remote device.
This wait is applicable for operational state argument which are I(state) with values
C(up)/C(down), I(tx_rate) and I(rx_rate).
type: int
speed:
description:
- This option configures autoneg and speed/duplex/flowcontrol for the interface given
in C(name) option.
type: str
state:
choices:
- present
- absent
- up
- down
default: present
description:
- State of the Interface configuration, C(up) means present and operationally up and
C(down) means present and operationally C(down)
type: str
enabled:
default: true
description:
- Interface link status. If the value is I(True) the interface state will be enabled,
else if value is I(False) interface will be in disable (shutdown) state.
type: bool
rx_rate:
description:
- Receiver rate in bits per second (bps) for the interface given in C(name) option.
- This is state check parameter only.
- Supports conditionals, see L(Conditionals in Networking Modules,../network/user_guide/network_working_with_command_output.html)
type: str
tx_rate:
description:
- Transmit rate in bits per second (bps) for the interface given in C(name) option.
- This is state check parameter only.
- Supports conditionals, see L(Conditionals in Networking Modules,../network/user_guide/network_working_with_command_output.html)
type: str
provider:
description:
- B(Deprecated)
- 'Starting with Ansible 2.5 we recommend using C(connection: network_cli).'
- 'Starting with Ansible 2.6 we recommend using C(connection: httpapi) for eAPI.'
- This option will be removed in a release after 2022-06-01.
- For more information please see the L(EOS Platform Options guide, ../network/user_guide/platform_eos.html).
- HORIZONTALLINE
- A dict object containing connection details.
suboptions:
auth_pass:
description:
- Specifies the password to use if required to enter privileged mode on the remote
device. If I(authorize) is false, then this argument does nothing. If the value
is not specified in the task, the value of environment variable C(ANSIBLE_NET_AUTH_PASS)
will be used instead.
type: str
authorize:
default: false
description:
- 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 C(ANSIBLE_NET_AUTHORIZE) will be used instead.
type: bool
host:
description:
- 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.
type: str
password:
description:
- Specifies the password to use to authenticate the connection to the remote device. This
is a common argument used for either I(cli) or I(eapi) transports. If the value
is not specified in the task, the value of environment variable C(ANSIBLE_NET_PASSWORD)
will be used instead.
type: str
port:
default: 0
description:
- Specifies the port to use when building the connection to the remote device. This
value applies to either I(cli) or I(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).
type: int
ssh_keyfile:
description:
- Specifies the SSH keyfile to use to authenticate the connection to the remote
device. This argument is only used for I(cli) transports. If the value is not
specified in the task, the value of environment variable C(ANSIBLE_NET_SSH_KEYFILE)
will be used instead.
type: path
timeout:
description:
- 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.
type: int
transport:
choices:
- cli
- eapi
default: cli
description:
- Configures the transport connection to use when connecting to the remote device.
type: str
use_proxy:
default: true
description:
- If C(no), the environment variables C(http_proxy) and C(https_proxy) will be
ignored.
type: bool
use_ssl:
default: true
description:
- Configures the I(transport) to use SSL if set to C(yes) only when the C(transport=eapi). If
the transport argument is not eapi, this value is ignored.
type: bool
username:
description:
- 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 C(ANSIBLE_NET_USERNAME) will
be used instead.
type: str
validate_certs:
default: true
description:
- If C(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.
type: bool
type: dict
aggregate:
description:
- List of Interfaces definitions. Each of the entry in aggregate list should define
name of interface C(name) and other options as required.
type: list
neighbors:
description:
- Check the operational state of given interface C(name) for LLDP neighbor.
- The following suboptions are available.
suboptions:
host:
description:
- LLDP neighbor host for given interface C(name).
port:
description:
- LLDP neighbor port to which given interface C(name) is connected.
type: list
description:
description:
- Description of Interface upto 240 characters.
type: str
commands:
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:
- interface ethernet1
- description test-interface
- speed 100full
- mtu 512
type: list