You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

arista.eos.eos_static_route module – (deprecated, removed after 2022-06-01) Manage static IP routes on Arista EOS network devices

Note

This module is part of the arista.eos collection (version 3.1.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_static_route.

New in version 1.0.0: of arista.eos

DEPRECATED

Removed in

major release after 2022-06-01

Why

Updated modules with more functionality

Alternative

eos_static_routes

Synopsis

• This module provides declarative management of static IP routes on Arista EOS network devices.

Note

This module has a corresponding action plugin.

Parameters

Parameter	Comments
address aliases: prefix string	Network address with prefix of the static route.
admin_distance integer	Admin distance of the static route. Default: 1
aggregate list / elements=dictionary	List of static route definitions
address aliases: prefix string / required	Network address with prefix of the static route.
admin_distance integer	Admin distance of the static route.
next_hop string	Next hop IP of the static route.
state string	State of the static route configuration. Choices: present absent
vrf string	VRF for static route. Default: “default”
next_hop string	Next hop IP of the static route.
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)
state string	State of the static route configuration. Choices: present ← (default) absent
vrf string	VRF for static route. Default: “default”

Notes

Note

• Tested against Arista EOS 4.24.6F

• 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 static route
  arista.eos.eos_static_route:
    address: 10.0.2.0/24
    next_hop: 10.8.38.1
    admin_distance: 2
- name: delete static route
  arista.eos.eos_static_route:
    address: 10.0.2.0/24
    next_hop: 10.8.38.1
    state: absent
- name: configure static routes using aggregate
  arista.eos.eos_static_route:
    aggregate:
    - {address: 10.0.1.0/24, next_hop: 10.8.38.1}
    - {address: 10.0.3.0/24, next_hop: 10.8.38.1}
- name: Delete static route using aggregate
  arista.eos.eos_static_route:
    aggregate:
    - {address: 10.0.1.0/24, next_hop: 10.8.38.1}
    - {address: 10.0.3.0/24, next_hop: 10.8.38.1}
    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 Sample: [“ip route 10.0.2.0/24 10.8.38.1 3”, “no ip route 10.0.2.0/24 10.8.38.1”]

Status

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

• For more information see DEPRECATED.

Authors

• Trishna Guha (@trishnaguha)

Collection links

Issue Tracker Repository (Sources)