ngine_io.cloudstack.cs_vmsnapshot 模块 – 管理基于 Apache CloudStack 云的虚拟机快照。

注意

此模块是 ngine_io.cloudstack 集合 (版本 2.5.0) 的一部分。

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

要安装它，请使用：ansible-galaxy collection install ngine_io.cloudstack。您需要其他要求才能使用此模块，有关详细信息，请参阅要求。

要在 playbook 中使用它，请指定：ngine_io.cloudstack.cs_vmsnapshot。

ngine_io.cloudstack 0.1.0 中的新增功能

概要 

创建、删除和从快照还原虚拟机。

要求 

执行此模块的主机需要以下要求。

python >= 2.6
cs >= 0.9.0

参数 

参数	注释
account 字符串	虚拟机快照相关的账户。
api_http_method 字符串	用于查询 API 端点的 HTTP 方法。如果未给出，则考虑 `CLOUDSTACK_METHOD` 环境变量。选项 `"get"` ← (默认) `"post"`
api_key 字符串 / 必需	CloudStack API 的 API 密钥。如果未给出，则考虑 `CLOUDSTACK_KEY` 环境变量。
api_secret 字符串 / 必需	CloudStack API 的密钥。如果未设置，则考虑 `CLOUDSTACK_SECRET` 环境变量。
api_timeout 整数	HTTP 超时（秒）。如果未给出，则考虑 `CLOUDSTACK_TIMEOUT` 环境变量。默认值： `10`
api_url 字符串 / 必需	CloudStack API 的 URL，例如 https://cloud.example.com/client/api。如果未给出，则考虑 `CLOUDSTACK_ENDPOINT` 环境变量。
api_verify_ssl_cert 字符串	验证 CA 权威证书文件。如果未给出，则考虑 `CLOUDSTACK_VERIFY` 环境变量。
description 字符串	快照的描述。
domain 字符串	虚拟机快照相关的域。
name 别名：display_name 字符串 / 必需	快照的唯一名称。在 CloudStack 中称为显示名称。
poll_async 布尔值	轮询异步作业，直到作业完成。选项 `false` `true` ← (默认)
project 字符串	分配给虚拟机的项目的名称。
snapshot_memory 布尔值	如果设置为 true，则快照内存。选项 `false` ← (默认) `true`
state 字符串	快照的状态。选项 `"present"` ← (默认) `"absent"` `"revert"`
tags 别名：tag 列表 / 元素=字典	标签列表。标签是具有键 key 和 value 的字典列表。要删除所有标签，请设置空列表，例如 tags: []。
validate_certs 布尔值 ngine_io.cloudstack 2.4.0 中新增	如果 `false`，则不会验证 SSL 证书。如果未给出，则考虑 `CLOUDSTACK_DANGEROUS_NO_TLS_VERIFY` 环境变量。这仅应在使用自签名证书的个人控制站点上使用。选项 `false` `true` ← (默认)
vm 字符串 / 必需	虚拟机的名称。
zone 字符串 / 必需	虚拟机所在的区域名称。如果没有设置。

注释 

注意

有关 cloudstack 模块的详细指南，请参阅 CloudStack 云指南。
此模块支持检查模式。

示例 

- name: Create a VM snapshot of disk and memory before an upgrade
  ngine_io.cloudstack.cs_vmsnapshot:
    name: Snapshot before upgrade
    vm: web-01
    zone: zone01
    snapshot_memory: yes

- name: Revert a VM to a snapshot after a failed upgrade
  ngine_io.cloudstack.cs_vmsnapshot:
    name: Snapshot before upgrade
    vm: web-01
    zone: zone01
    state: revert

- name: Remove a VM snapshot after successful upgrade
  ngine_io.cloudstack.cs_vmsnapshot:
    name: Snapshot before upgrade
    vm: web-01
    zone: zone01
    state: absent

返回值 

常见的返回值已记录在此处，以下是此模块特有的字段

键	描述
account 字符串	虚拟机快照相关的账户。返回：成功示例： `"example account"`
created 字符串	快照的日期。返回：成功示例： `"2015-03-29T14:57:06+0200"`
current 布尔值	如果快照是当前的，则为 true 返回：成功示例： `true`
description 字符串	虚拟机快照的描述返回：成功示例： `"snapshot brought to you by Ansible"`
display_name 字符串	快照的显示名称。返回：成功示例： `"snapshot before update"`
domain 字符串	虚拟机快照相关的域。返回：成功示例： `"example domain"`
id 字符串	快照的 UUID。返回：成功示例： `"a6f7a5fc-43f8-11e5-a151-feff819cdc9f"`
name 字符串	快照的名称。返回：成功示例： `"snapshot before update"`
project 字符串	虚拟机快照相关的项目的名称。返回：成功示例： `"Production"`
state 字符串	虚拟机快照的状态返回：成功示例： `"Allocated"`
类型字符串	虚拟机快照类型返回：成功示例： `"DiskAndMemory"`

作者

René Moser (@resmo)