vultr.cloud.snapshot_info 模块 – 收集有关 Vultr 快照的信息

注意

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

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

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

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

vultr.cloud 1.7.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` ← (默认)

注释 

注意

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

示例 

- name: Gather Vultr snapshots information
  vultr.cloud.snapshot_info:
  register: result

- name: Print the gathered information
  ansible.builtin.debug:
    var: result.vultr_snapshot_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_snapshot_info 列表 / 元素=字符串	来自 Vultr API 的响应，作为列表。已返回：成功
app_id 整数	应用程序的 ID。已返回：成功示例： `0`
compressed_size 整数	快照的压缩大小。已返回：成功示例： `949678560`
date_created 字符串	创建快照的日期。已返回：成功示例： `"2020-10-10T01:56:20+00:00"`
description 字符串	快照的描述。已返回：成功示例： `"my vpc"`
id 字符串	快照的 ID。已返回：成功示例： `"cb676a46-66fd-4dfb-b839-443f2e6c0b60"`
os_id 整数	操作系统的 ID。已返回：成功示例： `215`
size 整数	快照的大小。已返回：成功示例： `42949672960`
status 字符串	快照的状态。已返回：成功示例： `"complete"`

作者

René Moser (@resmo)