Docs4dev
Docs
ansible / 2.6 / modules / win_firewall_module.html

win_firewall - Enable or disable the Windows Firewall

New in version 2.4.

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
profiles
    Choices:
  • Domain ←
  • Private ←
  • Public ←
Default:
["Domain", "Private", "Public"]
Specify one or more profiles to change.
state
    Choices:
  • enabled
  • disabled
Set state of firewall for given profile.

Examples

- 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 Values

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

Key Returned Description
enabled
bool
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

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance

This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Community, see here.

Author

  • Michael Eaton (@if-meaton)

Hint

If you notice any issues in this documentation you can edit this document to improve it.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/win_firewall_module.html