win_route - Add or remove a static route
New in version 2.4.
Synopsis
- Add or remove a static route.
Parameters
| 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:
1
|
Metric used by the static route.
|
| state |
|
If
absent, it removes a network static route.
If present, it adds a network static route.
|
Notes
Note
- Works only with Windows 2012 R2 and newer.
Examples
---
- 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
Return Values
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
|
Status
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Maintenance
This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by the Ansible Community, see here.
Author
- Daniele Lazzari
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/win_route_module.html