community.network.icx_static_route module – Manage static IP routes on Ruckus ICX 7000 series switches
Note
This module is part of the community.network collection (version 4.0.2).
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 community.network
.
To use it in a playbook, specify: community.network.icx_static_route
.
Synopsis
This module provides declarative management of static IP routes on Ruckus ICX network devices.
Parameters
Parameter |
Comments |
---|---|
Admin distance of the static route. Range is 1 to 255. |
|
List of static route definitions. |
|
Admin distance of the static route. Range is 1 to 255. |
|
Check running configuration. This can be set as environment variable. Module will use environment variable value(default:True), unless it is overridden, by specifying it as module parameter. Choices:
|
|
Network prefix mask of the static route. |
|
Next hop IP of the static route. |
|
Network prefix of the static route. |
|
State of the static route configuration. Choices:
|
|
Check running configuration. This can be set as environment variable. Module will use environment variable value(default:True), unless it is overridden, by specifying it as module parameter. Choices:
|
|
Network prefix mask of the static route. |
|
Next hop IP of the static route. |
|
Network prefix of the static route. |
|
Purge routes not defined in the aggregate parameter. Choices:
|
|
State of the static route configuration. Choices:
|
Notes
Note
Tested against ICX 10.1.
For information on using ICX platform, see the ICX OS Platform Options guide.
Examples
- name: Configure static route
community.network.icx_static_route:
prefix: 192.168.2.0/24
next_hop: 10.0.0.1
- name: Remove configuration
community.network.icx_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
community.network.icx_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
community.network.icx_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 |
Description |
---|---|
The list of configuration mode commands to send to the device Returned: always Sample: |