New in version 2.4.
| parameter | required | default | choices | comments |
|---|---|---|---|---|
| destination | yes | Destination IP address in CIDR format (ip address/prefix length) | ||
| gateway | no | The gateway used by the static route. If gateway is not provided it will be set to 0.0.0.0. | ||
| metric | no | 1 | Metric used by the static route. | |
| state | no | present | If present, it adds a network static route. If absent, it removes a network static route. |
---
- 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 Return Values, the following are the fields unique to this module:
| name | description | returned | type | sample |
|---|---|---|---|---|
| output | A message describing the task result. | always | string | Route added |
Note
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.
© 2012–2017 Michael DeHaan
© 2017 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/win_route_module.html