ansible / ansible.builtin / v2.6.20 / module / eos_static_route Manage static IP routes on Arista EOS network devices | "added in version" 2.5 of ansible.builtin" Authors: Trishna Guha (@trishnaguha) preview | supported by networkansible.builtin.eos_static_route (v2.6.20) — module
pip
Install with pip install ansible==2.6.20
This module provides declarative management of static IP routes on Arista EOS network devices.
- 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
state: choices: - present - absent default: present description: - State of the static route configuration. address: aliases: - prefix description: - Network address with prefix of the static route. required: true next_hop: description: - Next hop IP of the static route. required: true provider: description: - B(Deprecated) - 'Starting with Ansible 2.5 we recommend using C(connection: network_cli).' - This option is only required if you are using eAPI. - 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. required: true 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. required: true 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 version_added: '2.5' version_added_collection: arista.eos 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 static route definitions admin_distance: default: 1 description: - Admin distance of the static route.
commands: description: 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 type: list