cisco.ios.ios_static_route – (deprecated, removed after 2022-06-01) Manage static IP routes on Cisco IOS network devices¶
Note
This plugin is part of the cisco.ios collection (version 1.3.0).
To install it use: ansible-galaxy collection install cisco.ios
.
To use it in a playbook, specify: cisco.ios.ios_static_route
.
New in version 1.0.0: of cisco.ios
DEPRECATED¶
- Removed in
major release after 2022-06-01
- Why
Newer and updated modules released with more functionality.
- Alternative
ios_static_routes
Synopsis¶
This module provides declarative management of static IP routes on Cisco IOS network devices.
Note
This module has a corresponding action plugin.
Parameters¶
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
admin_distance
string
|
Admin distance of the static route.
|
||
aggregate
list
/ elements=dictionary
|
List of static route definitions.
|
||
admin_distance
string
|
Admin distance of the static route.
|
||
interface
string
|
Interface of the static route.
|
||
mask
string
|
Network prefix mask of the static route.
|
||
name
string
|
Name of the static route
aliases: description |
||
next_hop
string
|
Next hop IP of the static route.
|
||
prefix
string
/ required
|
Network prefix of the static route.
|
||
state
string
|
|
State of the static route configuration.
|
|
tag
string
|
Set tag of the static route.
|
||
track
string
|
Tracked item to depend on for the static route.
|
||
vrf
string
|
VRF of the static route.
|
||
interface
string
|
Interface of the static route.
|
||
mask
string
|
Network prefix mask of the static route.
|
||
name
string
|
Name of the static route
aliases: description |
||
next_hop
string
|
Next hop IP of the static route.
|
||
prefix
string
|
Network prefix of the static route.
|
||
provider
dictionary
|
Deprecated
Starting with Ansible 2.5 we recommend using
connection: network_cli .For more information please see the IOS 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. |
|
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 value is used to authenticate the SSH session. 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.
|
||
ssh_keyfile
path
|
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
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.
|
||
username
string
|
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
ANSIBLE_NET_USERNAME will be used instead. |
||
state
string
|
|
State of the static route configuration.
|
|
tag
string
|
Set tag of the static route.
|
||
track
string
|
Tracked item to depend on for the static route.
|
||
vrf
string
|
VRF of the static route.
|
Notes¶
Note
Tested against IOS 15.6
For more information on using Ansible to manage network devices see the Ansible Network Guide
For more information on using Ansible to manage Cisco devices see the Cisco integration page.
Examples¶
- 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
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
commands
list
/ elements=string
|
always |
The list of configuration mode commands to send to the device
Sample:
['ip route 192.168.2.0 255.255.255.0 10.0.0.1']
|
Status¶
This module will be removed in a major release after 2022-06-01. [deprecated]
For more information see DEPRECATED.
Authors¶
Ricardo Carrillo Cruz (@rcarrillocruz)