New in version 2.4.
Parameter | Choices/Defaults | Comments |
---|---|---|
admin_distance
-
|
Admin distance of the static route.
|
|
aggregate
-
|
List of static route definitions
|
|
mask
-
/ required
|
Network prefix mask of the static route.
|
|
next_hop
-
/ required
|
Next hop IP of the static route.
|
|
prefix
-
/ required
|
Network prefix of the static route.
|
|
purge
-
|
Default: no
|
Purge static routes not defined in the aggregate parameter.
|
state
-
|
|
State of the static route configuration.
|
- name: configure static route
net_static_route:
prefix: 192.168.2.0
mask: 255.255.255.0
next_hop: 10.0.0.1
- name: remove configuration
net_static_route:
prefix: 192.168.2.0
mask: 255.255.255.0
next_hop: 10.0.0.1
state: absent
- name: configure aggregates of static routes
net_static_route:
aggregate:
- { prefix: 192.168.2.0, mask 255.255.255.0, next_hop: 10.0.0.1 }
- { prefix: 192.168.3.0, mask 255.255.255.0, next_hop: 10.0.2.1 }
- name: Remove static route collections
net_static_route:
aggregate:
- { prefix: 172.24.1.0/24, next_hop: 192.168.42.64 }
- { prefix: 172.24.3.0/24, next_hop: 192.168.42.64 }
state: absent
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 192.168.2.0/24 10.0.0.1']
|
More information about Red Hat’s support of this module is available from this Red Hat Knowledge Base article.
Hint
If you notice any issues in this documentation you can edit this document to improve it.