eos_static_route – Manage static IP routes on Arista EOS network devices

New in version 2.5.

Synopsis

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

Parameters

Parameter Choices/Defaults Comments
address
- / required
Network address with prefix of the static route.

aliases: prefix
admin_distance
-
Default:
1
Admin distance of the static route.
aggregate
-
List of static route definitions
auth_pass
-
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.
next_hop
- / required
Next hop IP of the static route.
provider
-
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
-
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
- / 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 ANSIBLE_NET_PASSWORD will be used instead.
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 ANSIBLE_NET_SSH_KEYFILE will be used instead.
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
    Choices:
  • eapi
  • cli ←
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 true only when the transport=eapi. If the transport argument is not eapi, this value is ignored.
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 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 static route configuration.

Notes

Note

Examples

- name: configure static route
  eos_static_route:
    address: 10.0.2.0/24
    next_hop: 10.8.38.1
    admin_distance: 2
- name: delete static route
  eos_static_route:
    address: 10.0.2.0/24
    next_hop: 10.8.38.1
    state: absent
- name: configure static routes using aggregate
  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
  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 Returned Description
commands
list
 always
The list of configuration mode commands to send to the device

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

Red Hat Support

More information about Red Hat’s support of this module is available from this Red Hat Knowledge Base article.

Authors

  • Trishna Guha (@trishnaguha)

Hint

If you notice any issues in this documentation you can edit this document to improve it.