ansible.netcommon.net_static_route module – (deprecated, removed after 2022-06-01) Manage static IP routes on network appliances (routers, switches et. al.)
Note
This module is part of the ansible.netcommon collection (version 2.6.1).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install ansible.netcommon
.
To use it in a playbook, specify: ansible.netcommon.net_static_route
.
New in version 1.0.0: of ansible.netcommon
DEPRECATED
- Removed in
major release after 2022-06-01
- Why
Updated modules released with more functionality
- Alternative
Use platform-specific “[netos]_static_route” module
Synopsis
This module provides declarative management of static IP routes on network appliances (routers, switches et. al.).
Note
This module has a corresponding action plugin.
Parameters
Parameter |
Comments |
---|---|
Admin distance of the static route. |
|
List of static route definitions |
|
Network prefix mask of the static route. |
|
Next hop IP of the static route. |
|
Network prefix of the static route. |
|
Purge static routes not defined in the aggregate parameter. Default: “no” |
|
State of the static route configuration. Choices:
|
Notes
Note
This module is supported on
ansible_network_os
network platforms. See the Network Platform Options for details.
Examples
- name: configure static route
ansible.netcommon.net_static_route:
prefix: 192.168.2.0
mask: 255.255.255.0
next_hop: 10.0.0.1
- name: remove configuration
ansible.netcommon.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
ansible.netcommon.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
ansible.netcommon.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
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The list of configuration mode commands to send to the device Returned: always Sample: [“ip route 192.168.2.0/24 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)