vultr.cloud.firewall_rule_info 模块 – 收集 Vultr 防火墙规则信息

注意

此模块是 vultr.cloud 集合 (版本 1.13.0) 的一部分。

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

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

要在剧本中使用它，请指定： vultr.cloud.firewall_rule_info。

vultr.cloud 1.0.0 中的新增功能

概要 

收集可用的防火墙规则信息。

参数 

参数	注释
api_endpoint 字符串	API 端点 URL（不包含尾部斜杠）。回退环境变量 `VULTR_API_ENDPOINT`。默认值： `"https://api.vultr.com/v2"`
api_key 字符串 / 必需	Vultr API 的 API 密钥。回退环境变量 `VULTR_API_KEY`。
api_retries 整数	如果 Vultr API 返回 HTTP 错误代码（例如 - 429 请求过多 - 500 内部服务器错误 - 504 网关超时），则重试次数。回退环境变量 `VULTR_API_RETRIES`。默认值： `5`
api_retry_max_delay 整数	重试指数退避延迟（秒），最大延迟值（秒）。回退环境变量 `VULTR_API_RETRY_MAX_DELAY`。默认值： `12`
api_timeout 整数	Vultr API 的 HTTP 超时。回退环境变量 `VULTR_API_TIMEOUT`。默认值： `180`
group 字符串 / 必需	防火墙组的名称。
validate_certs 布尔值	验证 Vultr API 的 SSL 证书。选项 `false` `true` ← (默认)

注释 

注意

另请参阅 https://www.vultr.com/api/ 上的 API 文档。

示例 

- name: Gather Vultr firewall rule information
  vultr.cloud.firewall_rule_info:
    group: my group
  register: result

- name: Print the gathered information
  ansible.builtin.debug:
    var: result.vultr_firewall_rule_info

返回值 

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

键	描述
vultr_api 字典	来自 Vultr API 的响应，并进行了一些添加/修改。返回：成功
api_endpoint 字符串	用于 API 请求的端点。返回：成功示例： `"https://api.vultr.com/v2"`
api_retries 整数	API 请求的最大重试次数。返回：成功示例： `5`
api_retry_max_delay 整数	重试之间指数退避延迟（秒），直到达到此最大延迟值。返回：成功示例： `12`
api_timeout 整数	用于 API 请求的超时。返回：成功示例： `60`
vultr_firewall_rule_info 列表 / 元素=字符串	来自 Vultr API 的响应，以列表形式。返回：成功
action 字符串	防火墙规则的操作。返回：成功示例： `"accept"`
id 整数	防火墙规则的 ID。返回：成功示例： `1`
ip_type 字符串	防火墙规则的 IP 类型。返回：成功示例： `"v4"`
notes 字符串	提供的防火墙规则描述。返回：成功示例： `"my rule"`
port 字符串	防火墙规则的端口或端口范围。返回：成功示例： `"80"`
protocol 字符串	防火墙规则的协议。返回：成功示例： `"tcp"`
source 字符串	防火墙规则的源字符串。返回：成功示例： `"cloudflare"`
subnet 字符串	防火墙规则的子网。返回：成功示例： `"0.0.0.0"`
subnet_size 整数	防火墙规则的子网大小。返回：成功示例： `0`

作者

René Moser (@resmo)