summaryrefslogtreecommitdiff
path: root/lib/ansible/modules/extras/windows/win_firewall_rule.py
diff options
context:
space:
mode:
Diffstat (limited to 'lib/ansible/modules/extras/windows/win_firewall_rule.py')
-rw-r--r--lib/ansible/modules/extras/windows/win_firewall_rule.py123
1 files changed, 123 insertions, 0 deletions
diff --git a/lib/ansible/modules/extras/windows/win_firewall_rule.py b/lib/ansible/modules/extras/windows/win_firewall_rule.py
new file mode 100644
index 0000000000..3ed0f7e3e7
--- /dev/null
+++ b/lib/ansible/modules/extras/windows/win_firewall_rule.py
@@ -0,0 +1,123 @@
+#!/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/>.
+
+DOCUMENTATION = '''
+---
+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:
+ enable:
+ description:
+ - is this firewall rule enabled or disabled
+ default: true
+ required: false
+ state:
+ description:
+ - should this rule be added or removed
+ default: "present"
+ required: true
+ choices: ['present', 'absent']
+ name:
+ description:
+ - the rules name
+ default: null
+ required: true
+ direction:
+ description:
+ - is this rule for inbound or outbound trafic
+ default: null
+ required: true
+ choices: ['in', 'out']
+ action:
+ description:
+ - what to do with the items this rule is for
+ default: null
+ required: true
+ choices: ['allow', 'block', 'bypass']
+ description:
+ description:
+ - description for the firewall rule
+ default: null
+ required: false
+ localip:
+ description:
+ - the local ip address this rule applies to
+ default: 'any'
+ required: false
+ remoteip:
+ description:
+ - the remote ip address/range this rule applies to
+ default: 'any'
+ required: false
+ localport:
+ description:
+ - the local port this rule applies to
+ default: 'any'
+ required: false
+ remoteport:
+ description:
+ - the remote port this rule applies to
+ default: 'any'
+ required: false
+ program:
+ description:
+ - the program this rule applies to
+ default: null
+ required: false
+ service:
+ description:
+ - the service this rule applies to
+ default: 'any'
+ required: false
+ protocol:
+ description:
+ - the protocol this rule applies to
+ default: 'any'
+ required: false
+ profile:
+ description:
+ - the profile this rule applies to, e.g. Domain,Private,Public
+ default: 'any'
+ required: false
+ force:
+ description:
+ - Enforces the change if a rule with different values exists
+ default: false
+ required: false
+
+
+'''
+
+EXAMPLES = '''
+- name: Firewall rule to allow smtp on TCP port 25
+ action: win_firewall_rule
+ args:
+ name: smtp
+ enable: yes
+ state: present
+ localport: 25
+ action: allow
+ direction: In
+ protocol: TCP
+
+'''