mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
89 lines
2.2 KiB
Python
89 lines
2.2 KiB
Python
#!/usr/bin/python
|
|
# -*- coding: utf-8 -*-
|
|
|
|
# (c) 2017, Michael Eaton <meaton@iforium.com>
|
|
#
|
|
# This file is part of Ansible
|
|
#
|
|
# Ansible is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU General Public License as published by
|
|
# the Free Software Foundation, either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# Ansible is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
# 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_firewall
|
|
version_added: '2.4'
|
|
short_description: Enable or disable the Windows Firewall
|
|
description:
|
|
- Enable or Disable Windows Firewall profiles.
|
|
options:
|
|
profiles:
|
|
description:
|
|
- Specify one or more profiles to change.
|
|
choices:
|
|
- Domain
|
|
- Private
|
|
- Public
|
|
default: [Domain, Private, Public]
|
|
state:
|
|
description:
|
|
- Set state of firewall for given profile.
|
|
choices:
|
|
- enabled
|
|
- disabled
|
|
requirements:
|
|
- This module requires Windows Management Framework 5 or later.
|
|
author: Michael Eaton (@MichaelEaton83)
|
|
'''
|
|
|
|
EXAMPLES = r'''
|
|
- name: Enable firewall for Domain, Public and Private profiles
|
|
win_firewall:
|
|
state: enabled
|
|
profiles:
|
|
- Domain
|
|
- Private
|
|
- Public
|
|
tags: enable_firewall
|
|
|
|
- name: Disable Domain firewall
|
|
win_firewall:
|
|
state: disabled
|
|
profiles:
|
|
- Domain
|
|
tags: disable_firewall
|
|
'''
|
|
|
|
RETURN = r'''
|
|
enabled:
|
|
description: current firewall status for chosen profile (after any potential change)
|
|
returned: always
|
|
type: bool
|
|
sample: true
|
|
profiles:
|
|
description: chosen profile
|
|
returned: always
|
|
type: string
|
|
sample: Domain
|
|
state:
|
|
description: desired state of the given firewall profile(s)
|
|
returned: always
|
|
type: list
|
|
sample: enabled
|
|
'''
|