community.windows.win_route – Add or remove a static route

Note

This plugin is part of the community.windows collection (version 1.9.0).

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

To use it in a playbook, specify: community.windows.win_route.

Synopsis

  • Add or remove a static route.

Parameters

Parameter Choices/Defaults Comments
destination
string / required
Destination IP address in CIDR format (ip address/prefix length).
gateway
string
The gateway used by the static route.
If gateway is not provided it will be set to 0.0.0.0.
metric
integer
Default:
1
Metric used by the static route.
state
string
    Choices:
  • absent
  • present ←
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
  community.windows.win_route:
    destination: 192.168.2.10/32
    gateway: 192.168.1.1
    metric: 1
    state: present

- name: Remove a network static route
  community.windows.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


Authors

  • Daniele Lazzari (@dlazz)