community.windows.win_firewall_rule 模块 – Windows 防火墙自动化

注意

此模块是 community.windows 集合 (版本 2.3.0) 的一部分。

如果您正在使用 ansible 包，则您可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install community.windows。

要在 playbook 中使用它，请指定：community.windows.win_firewall_rule。

概要 

允许您创建/删除/更新防火墙规则。

参数 

参数	注释
action 字符串	对该规则适用的项目执行的操作。创建新规则时默认为 `allow`。选项 `"allow"` `"block"`
description 字符串	防火墙规则的描述。
direction 字符串	此规则是针对入站流量还是出站流量。创建新规则时默认为 `in`。选项 `"in"` `"out"`
enabled 别名：enable 布尔值	此防火墙规则是启用还是禁用。创建新规则时默认为 `true`。选项 `false` `true`
group 字符串	规则的组名。如果未指定 name，则模块将为此组中的所有规则设置防火墙选项。
icmp_type_code 列表 / 元素=字符串	规则的 ICMP 类型和代码。仅当 protocol 为 `icmpv4` 或 `icmpv6` 时有效。每个条目都遵循 `type:code` 格式，其中 `type` 是类型编号，`code` 是该类型的代码编号，或 `` 代表所有代码。将值设置为 `` 以将规则应用于所有 ICMP 类型代码。有关 ICMP 类型及其适用的代码列表，请参见 https://www.iana.org/assignments/icmp-parameters/icmp-parameters.xhtml。
localip 字符串	此规则适用的本地 IP 地址。设置为 `any` 以应用于所有本地 IP 地址。创建新规则时默认为 `any`。
localport 字符串	此规则适用的本地端口。设置为 `any` 以应用于所有本地端口。创建新规则时默认为 `any`。必须设置 protocol
name 字符串	规则的显示名称。除非指定了 group，否则这是必需的。
profiles 别名：profile 列表 / 元素=字符串	此规则适用的配置文件。创建新规则时默认为 `domain,private,public`。
program 字符串	此规则适用的程序。设置为 `any` 以应用于所有程序。创建新规则时默认为 `any`。
protocol 字符串	此规则适用的协议。设置为 `any` 以应用于所有服务。创建新规则时默认为 `any`。
remoteip 字符串	此规则适用的远程 IP 地址/范围。设置为 `any` 以应用于所有远程 IP 地址。创建新规则时默认为 `any`。
remoteport 字符串	此规则适用的远程端口。设置为 `any` 以应用于所有远程端口。创建新规则时默认为 `any`。必须设置 protocol
service 字符串	此规则适用的服务。设置为 `any` 以应用于所有服务。创建新规则时默认为 `any`。
state 字符串	是否应添加或删除此规则。选项 `"absent"` `"present"` ← (默认)

备注 

注意

多个防火墙规则可以共享相同的 *name*，如果有多个匹配项，则模块将为每个匹配规则设置用户定义的选项。

另请参见 

另请参见

community.windows.win_firewall: 启用或禁用 Windows 防火墙。

示例 

- name: Firewall rule to allow SMTP on TCP port 25
  community.windows.win_firewall_rule:
    name: SMTP
    localport: 25
    action: allow
    direction: in
    protocol: tcp
    state: present
    enabled: true

- name: Firewall rule to allow RDP on TCP port 3389
  community.windows.win_firewall_rule:
    name: Remote Desktop
    localport: 3389
    action: allow
    direction: in
    protocol: tcp
    profiles: private
    state: present
    enabled: true

- name: Firewall rule to be created for application group
  community.windows.win_firewall_rule:
    name: SMTP
    group: application
    localport: 25
    action: allow
    direction: in
    protocol: tcp
    state: present
    enabled: true

- name: Enable all the Firewall rules in application group
  win_firewall_rule:
    group: application
    enabled: true

- name: Firewall rule to allow port range
  community.windows.win_firewall_rule:
    name: Sample port range
    localport: 5000-5010
    action: allow
    direction: in
    protocol: tcp
    state: present
    enabled: true

- name: Firewall rule to allow ICMP v4 echo (ping)
  community.windows.win_firewall_rule:
    name: ICMP Allow incoming V4 echo request
    enabled: true
    state: present
    profiles: private
    action: allow
    direction: in
    protocol: icmpv4
    icmp_type_code:
      - '8:*'

- name: Firewall rule to alloc ICMP v4 on all type codes
  community.windows.win_firewall_rule:
    name: ICMP Allow incoming V4 echo request
    enabled: true
    state: present
    profiles: private
    action: allow
    direction: in
    protocol: icmpv4
    icmp_type_code: '*'

作者

Artem Zinenko (@ar7z1)
Timothy Vandenbrande (@TimothyVandenbrande)