community.windows.win_route – Add or remove a static route¶
Note
This plugin is part of the community.windows collection (version 1.3.0).
To install it use: ansible-galaxy collection install community.windows
.
To use it in a playbook, specify: community.windows.win_route
.
Parameters¶
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)