mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-25 03:41:25 -07:00
d958440bcb
* win_firewall_rule: Small idempotency fix This PR includes the following changes: - an idempotency fix when `profile: any` - better difference output to debug idempotency issues - documentation fixes (remove `required: false`) - Parameter handling fixes - RDP example that matches default RDP rule - Renamed parameter 'enable' to 'enabled' (kept alias) - Renamed parameter 'profile' to 'profiles' (kept alias) * Rewrite module completely The logic is still intact, but various changes with a single goal: - Make the module idempotent - Implement check-mode - Implement diff-mode - Adapted integration tests This fixes #18807 and #23455. * Change casing to lowercase * Improve the logic wrt. diff
126 lines
3.6 KiB
Python
126 lines
3.6 KiB
Python
#!/usr/bin/env python
|
|
|
|
# (c) 2014, Timothy Vandenbrande <timothy.vandenbrande@gmail.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/>.
|
|
|
|
ANSIBLE_METADATA = {'metadata_version': '1.0',
|
|
'status': ['preview'],
|
|
'supported_by': 'community'}
|
|
|
|
|
|
DOCUMENTATION = r'''
|
|
---
|
|
module: win_firewall_rule
|
|
version_added: "2.0"
|
|
author: Timothy Vandenbrande
|
|
short_description: Windows firewall automation
|
|
description:
|
|
- Allows you to create/remove/update firewall rules
|
|
options:
|
|
enabled:
|
|
description:
|
|
- Is this firewall rule enabled or disabled
|
|
default: 'yes'
|
|
choices: [ 'no', 'yes' ]
|
|
aliases: [ 'enable' ]
|
|
state:
|
|
description:
|
|
- Should this rule be added or removed
|
|
default: "present"
|
|
choices: ['present', 'absent']
|
|
name:
|
|
description:
|
|
- The rules name
|
|
required: true
|
|
direction:
|
|
description:
|
|
- Is this rule for inbound or outbound traffic
|
|
required: true
|
|
choices: ['in', 'out']
|
|
action:
|
|
description:
|
|
- What to do with the items this rule is for
|
|
required: true
|
|
choices: ['allow', 'block', 'bypass']
|
|
description:
|
|
description:
|
|
- Description for the firewall rule
|
|
localip:
|
|
description:
|
|
- The local ip address this rule applies to
|
|
default: 'any'
|
|
remoteip:
|
|
description:
|
|
- The remote ip address/range this rule applies to
|
|
default: 'any'
|
|
localport:
|
|
description:
|
|
- The local port this rule applies to
|
|
remoteport:
|
|
description:
|
|
- The remote port this rule applies to
|
|
program:
|
|
description:
|
|
- The program this rule applies to
|
|
service:
|
|
description:
|
|
- The service this rule applies to
|
|
protocol:
|
|
description:
|
|
- The protocol this rule applies to
|
|
default: 'any'
|
|
profiles:
|
|
description:
|
|
- The profile this rule applies to
|
|
default: 'domain,private,public'
|
|
aliases: [ 'profile' ]
|
|
force:
|
|
description:
|
|
- Replace any existing rule by removing it first.
|
|
default: 'no'
|
|
choices: [ 'no', 'yes' ]
|
|
notes:
|
|
- The implementation uses C(netsh advfirewall) underneath, a pure-Powershell
|
|
reimplementation would be more powerful.
|
|
- Modifying existing firewall rules is not possible, the module does allow
|
|
replacing complete rules based on name, but that works by removing the
|
|
existing rule completely, and recreating it with provided information
|
|
(when using C(force)).
|
|
'''
|
|
|
|
EXAMPLES = r'''
|
|
- name: Firewall rule to allow SMTP on TCP port 25
|
|
win_firewall_rule:
|
|
name: SMTP
|
|
localport: 25
|
|
action: allow
|
|
direction: in
|
|
protocol: tcp
|
|
state: present
|
|
enabled: yes
|
|
|
|
- name: Firewall rule to allow RDP on TCP port 3389
|
|
win_firewall_rule:
|
|
name: Remote Desktop
|
|
localport: 3389
|
|
action: allow
|
|
direction: in
|
|
protocol: tcp
|
|
profiles: private
|
|
state: present
|
|
enabled: yes
|
|
'''
|