win_route - Add or remove a static route.

New in version 2.4.

Synopsis
Options
Examples
Return Values
Notes
- Status

Synopsis

Add or remove a static route.

Options

parameter	required	default	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.

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 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

Notes

Note

Works only with Windows 2012 R2 and newer.

Status

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–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/win_route_module.html