hetzner.hcloud.firewall_info 模块 – 收集关于 Hetzner Cloud 防火墙的信息。

注意

此模块是 hetzner.hcloud 集合（版本 4.2.2）的一部分。

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

要安装它，请使用：ansible-galaxy collection install hetzner.hcloud。您需要其他要求才能使用此模块，请参阅要求了解详细信息。

要在 Playbook 中使用它，请指定：hetzner.hcloud.firewall_info。

概要 

收集有关 Hetzner Cloud 防火墙的事实。

别名：hcloud_firewall_info

要求 

在执行此模块的主机上需要满足以下要求。

python-dateutil >= 2.7.5
requests >=2.20

参数 

参数	注释
api_endpoint 别名：endpoint 字符串	Hetzner Cloud 的 API 端点。您还可以通过使用 `HCLOUD_ENDPOINT` 环境变量来设置此选项。默认值：`"https://api.hetzner.cloud/v1"`
api_token 字符串 / 必需	Hetzner Cloud 的 API 令牌。您还可以通过使用 `HCLOUD_TOKEN` 环境变量来设置此选项。
id 整数	您要获取的防火墙的 ID。如果提供的 ID 无效，该模块将失败。
label_selector 字符串	您要获取的防火墙的标签选择器。
name 字符串	您要获取的防火墙的名称。

另请参阅 

另请参阅

Hetzner Cloud API 的文档: Hetzner Cloud API 的完整参考。

示例 

- name: Gather hcloud Firewall infos
  hetzner.hcloud.firewall_info:
  register: output

- name: Print the gathered infos
  debug:
    var: output

返回值 

常见的返回值记录在此处，以下是此模块特有的字段

键	描述
hcloud_firewall_info 列表 / 元素=字典	防火墙列表。返回值：总是
applied_to 列表 / 元素=字典	应用防火墙的资源列表。返回值：总是
applied_to_resources 列表 / 元素=字典	应用防火墙标签选择器的资源列表。返回值：如果`hcloud_firewall_info[].applied_to[].type=label_selector`
server 整数	服务器的 ID。返回值：成功示例：`12345`
type 字符串	引用的资源类型。返回值：成功只能返回 `"server"` 示例：`"server"`
label_selector 字符串	标签选择器值。返回值：成功示例：`"env=prod"`
server 整数	服务器的 ID。返回值：成功示例：`12345`
type 字符串	资源的类型。返回值：成功只能返回 `"server"` `"label_selector"` 示例：`"label_selector"`
id 整数	防火墙的数字标识符。返回值：总是示例：`1937415`
labels 字典	用户定义的标签（键值对）。返回值：总是
name 字符串	防火墙的名称。返回值：总是示例：`"my-firewall"`
rules 列表 / 元素=字典	防火墙包含的规则列表。返回值：总是
description 字符串	此规则的用户定义描述。返回值：总是示例：`"allow http from anywhere"`
destination_ips 列表 / 元素=字符串	此规则中允许的目标 CIDR 列表。返回值：总是示例：`[]`
direction 字符串	防火墙规则的方向。返回值：总是示例：`"in"`
port 字符串	此规则允许的端口或端口范围。返回值：如果`hcloud_firewall_info[].rules[].protocol=tcp`或`hcloud_firewall_info[].rules[].protocol=udp` 示例：`"80"`
protocol 字符串	防火墙规则的协议。返回值：总是示例：`"tcp"`
source_ips 列表 / 元素=字符串	此规则中允许的源 CIDR 列表。返回值：总是示例：`["0.0.0.0/0", "::/0"]`

作者

Jonas Lammler (@jooola)