mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-25 20:01:25 -07:00
d863027159
* Windows: Add missing parameter types and doc fixes This PR includes: - Adding missing parameter types - Various documentation fixes * Update lib/ansible/modules/windows/win_copy.py Co-Authored-By: dagwieers <dag@wieers.com> * Update lib/ansible/modules/windows/win_credential.py Co-Authored-By: dagwieers <dag@wieers.com> * Update lib/ansible/modules/windows/win_domain_computer.py Co-Authored-By: dagwieers <dag@wieers.com> * Update lib/ansible/modules/windows/win_domain_user.py Co-Authored-By: dagwieers <dag@wieers.com> * Update lib/ansible/modules/windows/win_environment.py Co-Authored-By: dagwieers <dag@wieers.com> * Update lib/ansible/modules/windows/win_psexec.py Co-Authored-By: dagwieers <dag@wieers.com> * Update lib/ansible/modules/windows/win_uri.py Co-Authored-By: dagwieers <dag@wieers.com> * Update lib/ansible/modules/windows/win_wait_for.py Co-Authored-By: dagwieers <dag@wieers.com> * Ensure docstrings are raw strings
70 lines
1.7 KiB
Python
70 lines
1.7 KiB
Python
#!/usr/bin/python
|
|
# -*- coding: utf-8 -*-
|
|
|
|
# Copyright: (c) 2017, Daniele Lazzari <lazzari@mailup.com>
|
|
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
|
|
# This is a windows documentation stub. Actual code lives in the .ps1
|
|
# file of the same name.
|
|
|
|
ANSIBLE_METADATA = {'metadata_version': '1.1',
|
|
'status': ['preview'],
|
|
'supported_by': 'community'}
|
|
|
|
DOCUMENTATION = r'''
|
|
---
|
|
module: win_route
|
|
version_added: "2.4"
|
|
short_description: Add or remove a static route
|
|
description:
|
|
- Add or remove a static route.
|
|
options:
|
|
destination:
|
|
description:
|
|
- Destination IP address in CIDR format (ip address/prefix length).
|
|
type: str
|
|
required: yes
|
|
gateway:
|
|
description:
|
|
- The gateway used by the static route.
|
|
- If C(gateway) is not provided it will be set to C(0.0.0.0).
|
|
type: str
|
|
metric:
|
|
description:
|
|
- Metric used by the static route.
|
|
type: int
|
|
default: 1
|
|
state:
|
|
description:
|
|
- If C(absent), it removes a network static route.
|
|
- If C(present), it adds a network static route.
|
|
type: str
|
|
choices: [ absent, present ]
|
|
default: present
|
|
notes:
|
|
- Works only with Windows 2012 R2 and newer.
|
|
author:
|
|
- Daniele Lazzari (@dlazz)
|
|
'''
|
|
|
|
EXAMPLES = r'''
|
|
---
|
|
- 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 = r'''
|
|
output:
|
|
description: A message describing the task result.
|
|
returned: always
|
|
type: str
|
|
sample: "Route added"
|
|
'''
|