vultr.cloud.snapshot 模块 – 管理 Vultr 上的快照

注意

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

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

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

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

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`
description 别名：name 字符串 / 必需	快照的描述。
instance 字符串	要从中获取快照的实例的描述或 ID。与 url 互斥。如果 state=present，则需要 instance 或 url。
state 字符串	快照的状态。选项 `"present"` ← (默认) `"absent"`
url 字符串	要上传的快照图像 (RAW) 的 URL。与 instance 互斥。如果 state=present，则需要 instance 或 url。
validate_certs 布尔值	验证 Vultr API 的 SSL 证书。选项 `false` `true` ← (默认)

注释 

注意

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

示例 

- name: Ensure a snapshot is present
  vultr.cloud.snapshot:
    description: my snapshot of my instance
    instance: my instance

- name: Ensure a snapshot is present
  vultr.cloud.snapshot:
    description: debian 11 generic
    url: https://cloud.debian.org/images/cloud/bullseye/latest/debian-11-generic-amd64.raw

- name: Ensure a snapshot is absent
  vultr.cloud.snapshot:
    description: my snapshot of my instance
    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_snapshot 字典	来自 Vultr API 的响应。返回：成功
app_id 整数	应用的 ID。返回：成功示例： `0`
compressed_size 整数	快照的压缩大小。返回：成功示例： `949678560`
date_created 字符串	创建快照的日期。返回：成功示例: `"2020-10-10T01:56:20+00:00"`
描述字符串	快照的描述。返回：成功示例: `"my vpc"`
id 字符串	快照的ID。返回：成功示例: `"cb676a46-66fd-4dfb-b839-443f2e6c0b60"`
os_id 整数	操作系统的ID。返回：成功示例: `215`
size 整数	快照的大小。返回：成功示例: `42949672960`
status 字符串	快照的状态。返回：成功示例: `"complete"`

作者

René Moser (@resmo)