New in version 2.4.
Parameter |
Choices/Defaults |
Comments |
---|---|---|
destination
required |
|
Destination IP address in CIDR format (ip address/prefix length)
|
gateway
|
|
The gateway used by the static route.
If
gateway is not provided it will be set to 0.0.0.0 . |
metric
|
Default:
yes
|
Metric used by the static route.
|
state
|
Default:
present
|
If present, it adds a network static route. If absent, it removes a network static route.
|
Note
---
- name: Add a network static route
win_route:
destination: 192.168.2.10/32
gateway: 192.168.1.1
metric: 1
state: present
- name: Remove a network static route
win_route:
destination: 192.168.2.10/32
state: absent
Common return values are documented here, the following are the fields unique to this module:
Key |
Returned |
Description |
---|---|---|
output
string
|
always |
A message describing the task result.
Sample:
Route added
|
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Hint
If you notice any issues in this documentation you can edit this document to improve it.