vultr.cloud.vpc2_info 模块 – 收集有关 Vultr VPCs 2.0 的信息

注意

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

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

要安装它,请使用: ansible-galaxy collection install vultr.cloud

要在剧本中使用它,请指定: vultr.cloud.vpc2_info

vultr.cloud 1.9.0 中的新增功能

概要

  • 收集有关可用 VPCs 2.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

validate_certs

布尔值

验证 Vultr API 的 SSL 证书。

选项

  • false

  • true ← (默认)

备注

注意

示例

- name: Gather Vultr VPCs 2.0 information
  vultr.cloud.vpc2_info:
  register: result

- name: Print the gathered information
  ansible.builtin.debug:
    var: result.vultr_vpc2_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_vpc2_info

列表 / 元素=字符串

来自 Vultr API 的响应,作为列表。

返回:成功

date_created

字符串

创建 VPC 的日期。

返回:成功

示例: "2023-08-20T19:39:20+00:00"

description

字符串

VPC 的描述。

返回:成功

示例: "my vpc"

id

字符串

VPC 的 ID。

返回:成功

示例: "cb676a46-66fd-4dfb-b839-443f2e6c0b60"

ip_block

字符串

VPC 的子网。

返回:成功

示例: "10.99.1.0"

prefix_length

整数

CIDR 表示法中网络掩码的位数。

返回:成功

示例: 24

region

字符串

VPC 所在的区域。

返回:成功

示例: "ewr"

作者

  • René Moser (@resmo)