vultr.cloud.instance_info 模块 – 获取 Vultr 实例信息

注意

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

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

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

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

vultr.cloud 1.5.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
label 别名：name 字符串	实例名称。
region 字符串	按区域筛选实例。
validate_certs 布尔值	验证 Vultr API 的 SSL 证书。 选项 false true ← (默认)

备注

注意

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

示例

- name: Get Vultr instance infos of region ams
  vultr.cloud.instance_info:
    region: ams

- name: Get Vultr instance infos of a single host
  vultr.cloud.instance_info:
    label: myhost

- name: Get all Vultr instance infos
  vultr.cloud.instance_info:
  register: results

- name: Print the gathered infos
  ansible.builtin.debug:
    var: results.vultr_instance_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_instance_info 列表 / 元素=字符串	来自 Vultr API 的响应，作为列表。 返回：可用
allowed_bandwidth 整数	实例的允许带宽。 返回：成功 示例： 1000
app_id 整数	实例的应用程序 ID。 返回：成功 示例： 37
date_created 字符串	创建实例的日期。 返回：成功 示例： "2020-10-10T01:56:20+00:00"
disk 整数	实例的磁盘大小。 返回：成功 示例： 25
features 列表 / 元素=字符串	实例的功能。 返回：成功 示例： ["ddos_protection", "ipv6", "auto_backups"]
firewall_group_id 字符串	实例的防火墙组 ID。 返回：成功 示例： ""
gateway_v4 字符串	网关 IPv4。 返回：成功 示例： "95.179.188.1"
hostname 字符串	实例的主机名。 返回：成功 示例： "vultr.guest"
id 字符串	实例的 ID。 返回：成功 示例： "cb676a46-66fd-4dfb-b839-443f2e6c0b60"
image_id 字符串	实例的镜像 ID。 返回：成功 示例： ""
internal_ip 字符串	实例的内部 IP。 返回：成功 示例： ""
kvm 字符串	实例的 KVM。 返回：成功 示例： "https://my.vultr.com/subs/vps/novnc/api.php?data=..."
label 字符串	实例的标签。 返回：成功 示例： "my instance"
main_ip 字符串	实例的 IPv4。 返回：成功 示例： "95.179.189.95"
netmask_v4 字符串	实例的 IPv4 子网掩码。 返回：成功 示例： "255.255.254.0"
os 字符串	实例的操作系统。 返回：成功 示例： "Application"
os_id 整数	实例的操作系统ID。 返回：成功 示例： 186
plan 字符串	实例的套餐。 返回：成功 示例： "vc2-1c-1gb"
power_status 字符串	实例的电源状态。 返回：成功 示例： "running"
ram 整数	实例的RAM（以MB为单位）。 返回：成功 示例： 1024
region 字符串	实例部署所在的区域。 返回：成功 示例： "ews"
server_status 字符串	实例的服务器状态。 返回：成功 示例： "installingbooting"
status 字符串	关于实例部署的状态。 返回：成功 示例： "active"
tags 列表 / 元素=字符串	实例的标签。 返回：成功 示例： ["my-tag"]
user_data 字符串	实例的Base64编码用户数据（cloud init）。 返回：成功 示例： "I2Nsb3VkLWNvbmZpZwpwYWNrYWdlczoKICAtIGh0b3AK"
v6_main_ip 字符串	实例的IPv6地址。 返回：成功 示例： ""
v6_network 字符串	实例的IPv6网络。 返回：成功 示例： ""
v6_network_size 整数	实例的IPv6网络大小。 返回：成功 示例： 0
vcpu_count 整数	实例的vCPU数量。 返回：成功 示例： 1

作者

• René Moser (@resmo)

资源链接

• 问题追踪器
• 代码仓库