Module for configuring Windows Firewall using netsh
salt.modules.win_firewall.add_rule(name, localport, protocol=u'tcp', action=u'allow', dir=u'in', remoteip=u'any')¶New in version 2015.5.0.
Add a new inbound or outbound rule to the firewall policy
| Parameters: |
|
|---|---|
| Returns: | True if successful |
| Return type: | bool |
| Raises: |
|
CLI Example:
salt '*' firewall.add_rule 'test' '8080' 'tcp'
salt '*' firewall.add_rule 'test' '1' 'icmpv4'
salt '*' firewall.add_rule 'test_remote_ip' '8000' 'tcp' 'allow' 'in' '192.168.0.1'
salt.modules.win_firewall.delete_rule(name=None, localport=None, protocol=None, dir=None, remoteip=None)¶New in version 2015.8.0.
Delete an existing firewall rule identified by name and optionally by ports, protocols, direction, and remote IP.
| Parameters: |
|
|---|---|
| Returns: | True if successful |
| Return type: | bool |
| Raises: |
|
CLI Example:
# Delete incoming tcp port 8080 in the rule named 'test'
salt '*' firewall.delete_rule 'test' '8080' 'tcp' 'in'
# Delete the incoming tcp port 8000 from 192.168.0.1 in the rule named
# 'test_remote_ip`
salt '*' firewall.delete_rule 'test_remote_ip' '8000' 'tcp' 'in' '192.168.0.1'
# Delete all rules for local port 80:
salt '*' firewall.delete_rule all 80 tcp
# Delete a rule called 'allow80':
salt '*' firewall.delete_rule allow80
salt.modules.win_firewall.disable(profile=u'allprofiles')¶Disable firewall profile
| Parameters: | profile (Optional[str]) – The name of the profile to disable. Default is
|
|---|---|
| Returns: | True if successful |
| Return type: | bool |
| Raises: | CommandExecutionError – If the command fails |
CLI Example:
salt '*' firewall.disable
salt.modules.win_firewall.enable(profile=u'allprofiles')¶New in version 2015.5.0.
Enable firewall profile
| Parameters: | profile (Optional[str]) – The name of the profile to enable. Default is
|
|---|---|
| Returns: | True if successful |
| Return type: | bool |
| Raises: | CommandExecutionError – If the command fails |
CLI Example:
salt '*' firewall.enable
salt.modules.win_firewall.get_config()¶Get the status of all the firewall profiles
| Returns: | A dictionary of all profiles on the system |
|---|---|
| Return type: | dict |
| Raises: | CommandExecutionError – If the command fails |
CLI Example:
salt '*' firewall.get_config
salt.modules.win_firewall.get_rule(name=u'all')¶New in version 2015.5.0.
Display all matching rules as specified by name
| Parameters: | name (Optional[str]) – The full name of the rule. all will return all
rules. Default is all |
|---|---|
| Returns: | A dictionary of all rules or rules that match the name exactly |
| Return type: | dict |
| Raises: | CommandExecutionError – If the command fails |
CLI Example:
salt '*' firewall.get_rule 'MyAppPort'
salt.modules.win_firewall.rule_exists(name)¶New in version 2016.11.6.
Checks if a firewall rule exists in the firewall policy
| Parameters: | name (str) – The name of the rule |
|---|---|
| Returns: | True if exists, otherwise False |
| Return type: | bool |
CLI Example:
# Is there a rule named RemoteDesktop
salt '*' firewall.rule_exists RemoteDesktop