cisco / cisco.ios / 3.3.2 / module / ios_static_route
Removed in None
Reason:Newer and updated modules released with more functionality. | Alternative:ios_static_routes
(deprecated, removed after 2022-06-01) Manage static IP routes on Cisco IOS network devices
| "added in version" 1.0.0 of cisco.ios"
Authors: Ricardo Carrillo Cruz (@rcarrillocruz)
This plugin has a corresponding action plugin.
Install with ansible-galaxy collection install cisco.ios:==3.3.2
collections: - name: cisco.ios version: 3.3.2
This module provides declarative management of static IP routes on Cisco IOS network devices.
- name: configure static route cisco.ios.ios_static_route: prefix: 192.168.2.0 mask: 255.255.255.0 next_hop: 10.0.0.1
- name: configure black hole in vrf blue depending on tracked item 10 cisco.ios.ios_static_route: prefix: 192.168.2.0 mask: 255.255.255.0 vrf: blue interface: null0 track: 10
- name: configure ultimate route with name and tag cisco.ios.ios_static_route: prefix: 192.168.2.0 mask: 255.255.255.0 interface: GigabitEthernet1 name: hello world tag: 100
- name: remove configuration cisco.ios.ios_static_route: prefix: 192.168.2.0 mask: 255.255.255.0 next_hop: 10.0.0.1 state: absent
- name: Add static route aggregates cisco.ios.ios_static_route: aggregate: - {prefix: 172.16.32.0, mask: 255.255.255.0, next_hop: 10.0.0.8} - {prefix: 172.16.33.0, mask: 255.255.255.0, next_hop: 10.0.0.8}
- name: Remove static route aggregates cisco.ios.ios_static_route: aggregate: - {prefix: 172.16.32.0, mask: 255.255.255.0, next_hop: 10.0.0.8} - {prefix: 172.16.33.0, mask: 255.255.255.0, next_hop: 10.0.0.8} state: absent
tag: description: - Set tag of the static route. type: str vrf: description: - VRF of the static route. type: str mask: description: - Network prefix mask of the static route. type: str name: aliases: - description description: - Name of the static route type: str state: choices: - present - absent default: present description: - State of the static route configuration. type: str track: description: - Tracked item to depend on for the static route. type: str prefix: description: - Network prefix of the static route. type: str next_hop: description: - Next hop IP of the static route. type: str provider: description: - B(Deprecated) - 'Starting with Ansible 2.5 we recommend using C(connection: network_cli).' - For more information please see the U(https://docs.ansible.com/ansible/latest/network/user_guide/platform_ios.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 value is used to authenticate the SSH session. 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: description: - Specifies the port to use when building the connection to the remote device. type: int ssh_keyfile: description: - Specifies the SSH key to use to authenticate the connection to the remote device. This value is the path to the key used to authenticate the SSH session. 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 username: description: - Configures the username to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_USERNAME) will be used instead. type: str type: dict aggregate: description: List of static route definitions. elements: dict suboptions: admin_distance: description: - Admin distance of the static route. type: str interface: description: - Interface of the static route. type: str mask: description: - Network prefix mask of the static route. type: str name: aliases: - description description: - Name of the static route type: str next_hop: description: - Next hop IP of the static route. type: str prefix: description: - Network prefix of the static route. required: true type: str state: choices: - present - absent description: - State of the static route configuration. type: str tag: description: - Set tag of the static route. type: str track: description: - Tracked item to depend on for the static route. type: str vrf: description: - VRF of the static route. type: str type: list interface: description: - Interface of the static route. type: str admin_distance: description: - Admin distance of the static route. type: str
commands: description: The list of configuration mode commands to send to the device returned: always sample: - ip route 192.168.2.0 255.255.255.0 10.0.0.1 type: list