vultr.cloud.reserved_ip 模块 – 管理 Vultr 上的预留 IP

注意

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

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

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

要在 playbook 中使用它，请指定：vultr.cloud.reserved_ip。

vultr.cloud 1.0.0 中的新功能

概要 

创建、附加、分离和删除预留 IP。

参数 

参数	注释
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`
instance_id 字符串	应将预留 IP 附加到的实例的 ID。与 instance_name 互斥。
instance_name 字符串	应将预留 IP 附加到的实例的名称。与 instance_id 互斥。
ip_type 字符串 / 必需	IP 的类型。选项 `"v4"` `"v6"`
标签别名：name 字符串 / 必需	预留 IP 的标签。
region 字符串 / 必需	预留 IP 将与之相关的区域。
state 字符串	预留 IP 的状态。选项 `"present"` ← (默认) `"absent"`
validate_certs 布尔值	验证 Vultr API 的 SSL 证书。选项 `假` `true` ← (默认)

备注 

注意

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

示例 

- name: Ensure a reserved IP present and attached to an instance
  vultr.cloud.reserved_ip:
    label: my attached IP
    region: ewr
    ip_type: v4
    instance_name: web-01

- name: Ensure a reserved IP is detached
  vultr.cloud.reserved_ip:
    label: my reserved IP
    region: ewr
    ip_type: v4
    instance_id: ""

- name: Ensure a reserved IP is absent
  vultr.cloud.reserved_ip:
    label: my attached IP
    region: ewr
    ip_type: v4
    state: absent

返回值 

通用返回值记录在此处，以下是此模块独有的字段

键	描述
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_reserved_ip 字典	来自 Vultr API 的响应。返回：成功
id 字符串	预留 IP 的 ID。返回：成功示例： `"cb676a46-66fd-4dfb-b839-443f2e6c0b60"`
instance_id 字符串	预留 IP 附加到的实例的 ID。返回：成功示例： `"cb676a46-66fd-4dfb-b839-443f2e6c0b"`
ip_type 字符串	预留 IP 的类型。返回：成功示例： `"v4"`
label 字符串	预留 IP 的名称。返回：成功示例： `"example.com"`
region 字符串	预留 IP 与之相关的区域。返回：成功示例： `"ewr"`
subnet 字符串	预留 IP 的子网。返回：成功示例： `"v4"`
subnet_size 整数	预留 IP 的子网大小。返回：成功示例： `32`

作者

René Moser (@resmo)