community.windows.win_firewall_module.rst

community.windows.win_firewall

Enable or disable the Windows Firewall

• Synopsis
• Requirements
• Parameters
• See Also
• Examples
• Return Values
• Status

Synopsis

• Enable or Disable Windows Firewall profiles.

Requirements

The below requirements are needed on the host that executes this module.

• This module requires Windows Management Framework 5 or later.

Parameters

Parameter	Choices/Defaults	Comments
inbound_action string added in 1.1.0	Choices: allow block not_configured	Set to allow or block inbound network traffic in the profile. not_configured is valid when configuring a GPO.
outbound_action string added in 1.1.0	Choices: allow block not_configured	Set to allow or block inbound network traffic in the profile. not_configured is valid when configuring a GPO.
profiles list	Choices: Domain ← Private ← Public ← Default: ["Domain", "Private", "Public"]	Specify one or more profiles to change.
state string	Choices: disabled enabled	Set state of firewall for given profile.

See Also

.. seealso::

   :ref:`community.windows.win_firewall_rule_module`
      The official documentation on the **community.windows.win_firewall_rule** module.

Examples

- name: Enable firewall for Domain, Public and Private profiles
  community.windows.win_firewall:
    state: enabled
    profiles:
    - Domain
    - Private
    - Public
  tags: enable_firewall

- name: Disable Domain firewall
  community.windows.win_firewall:
    state: disabled
    profiles:
    - Domain
  tags: disable_firewall

- name: Enable firewall for Domain profile and block outbound connections
  community.windows.win_firewall:
    profiles: Domain
    state: enabled
    outbound_action: block
  tags: block_connection

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
enabled boolean	always	Current firewall status for chosen profile (after any potential change). Sample: True
profiles string	always	Chosen profile. Sample: Domain
state list	always	Desired state of the given firewall profile(s). Sample: enabled

Status

Authors

• Michael Eaton (@michaeldeaton)