W3cubDocs

/Ansible

ansible.windows.win_route module – Add or remove a static route

Note

This module is part of the ansible.windows collection (version 2.8.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 ansible.windows.

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

New in ansible.windows 2.7.0

Synopsis

  • Add or remove a static route.

Parameters

Parameter

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.

Default: "0.0.0.0"

metric

integer

Metric used by the static route.

Default: 1

state

string

If absent, it removes a network static route.

If present, it adds a network static route.

Choices:

  • "absent"
  • "present" ← (default)

Notes

Note

  • Works only with Windows 2012 R2 and newer.

Examples

---
- name: Add a network static route
  ansible.windows.win_route:
    destination: 192.168.2.10/32
    gateway: 192.168.1.1
    metric: 1
    state: present

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

Description

msg

string

A message describing the task result.

Returned: always

Sample: "Route added"

Authors

  • Amit Weinstock (@amitosw15)

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/ansible/windows/win_route_module.html