ansible-later/testenv/lib/python2.7/site-packages/ansible/modules/windows/win_route.py
2019-04-23 13:04:27 +02:00

68 lines
1.6 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)
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).
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.
choices: [ absent, present ]
default: present
notes:
- Works only with Windows 2012 R2 and newer.
author:
- Daniele Lazzari
'''
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: string
sample: "Route added"
'''