ngine_io.cloudstack.cs_snapshot_policy 模块 – 管理基于 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_snapshot_policy。

ngine_io.cloudstack 0.1.0 中的新增功能

概要 

创建、更新和删除卷快照策略。

要求 

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

python >= 2.6
cs >= 0.9.0

参数 

参数	注释
帐户字符串	卷所属的帐户。
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` 环境变量。
device_id 整数	卷所附加的虚拟机上的设备 ID。仅当 VM 具有多个 DATADISK 卷时，才会考虑此项。
域字符串	卷所属的域。
interval_type 别名：interval 字符串	快照的间隔。选择 `"hourly"` `"daily"` ←（默认） `"weekly"` `"monthly"`
max_snaps 别名：max 整数	最大快照数。默认值： `8`
项目字符串	卷所属的项目的名称。
schedule 字符串	快照计划的时间。如果 state=present，则为必需项。 interval_type=HOURLY 的格式：`MM` interval_type=DAILY 的格式：`MM:HH` interval_type=WEEKLY 的格式：`MM:HH:DD (1-7`) interval_type=MONTHLY 的格式：`MM:HH:DD (1-28`)
state 字符串	快照策略的状态。选择 `"present"` ←（默认） `"absent"`
time_zone 别名：timezone 字符串	为此命令指定时区。默认值： `"UTC"`
validate_certs 布尔值在 ngine_io.cloudstack 2.4.0 中添加	如果 `false`，则不会验证 SSL 证书。如果未给出，则考虑 `CLOUDSTACK_DANGEROUS_NO_TLS_VERIFY` 环境变量。这仅应在个人控制的使用自签名证书的站点上使用。选择 `false` `true` ←（默认）
vm 字符串	用于从中选择卷的实例名称。如果虚拟机有 DATADISK 和 ROOT 卷，请使用 volume_type。如果 volume_type=DATADISK，并且虚拟机有多个 DATADISK 卷，则还需要使用 device_id。 volume 或 vm 至少需要一个。
卷字符串	卷的名称。 volume 或 vm 至少需要一个。
volume_type 字符串	卷的类型。选择 `"DATADISK"` `"ROOT"`
vpc 字符串	实例部署所在的 vpc 的名称。

备注 

注意

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

示例 

- name: ensure a snapshot policy daily at 1h00 UTC
  ngine_io.cloudstack.cs_snapshot_policy:
    volume: ROOT-478
    schedule: '00:1'
    max_snaps: 3

- name: ensure a snapshot policy daily at 1h00 UTC on the second DATADISK of VM web-01
  ngine_io.cloudstack.cs_snapshot_policy:
    vm: web-01
    volume_type: DATADISK
    device_id: 2
    schedule: '00:1'
    max_snaps: 3

- name: ensure a snapshot policy hourly at minute 5 UTC
  ngine_io.cloudstack.cs_snapshot_policy:
    volume: ROOT-478
    schedule: '5'
    interval_type: hourly
    max_snaps: 1

- name: ensure a snapshot policy weekly on Sunday at 05h00, TZ Europe/Zurich
  ngine_io.cloudstack.cs_snapshot_policy:
    volume: ROOT-478
    schedule: '00:5:1'
    interval_type: weekly
    max_snaps: 1
    time_zone: 'Europe/Zurich'

- name: ensure a snapshot policy is absent
  ngine_io.cloudstack.cs_snapshot_policy:
    volume: ROOT-478
    interval_type: hourly
    state: absent

返回值 

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

键	描述
帐户字符串	卷所属的帐户。返回：成功示例： `"example account"`
域字符串	卷所属的域。返回：成功示例： `"example domain"`
id 字符串	快照策略的 UUID。返回：成功示例： `"a6f7a5fc-43f8-11e5-a151-feff819cdc9f"`
interval_type 字符串	快照策略的间隔类型。返回：成功示例： `"daily"`
max_snaps 整数	保留的最大快照数。返回：成功示例： `10`
项目字符串	卷所属的项目名称。返回：成功示例： `"Production"`
schedule 字符串	快照策略的计划。返回：成功
time_zone 字符串	快照策略的时区。返回：成功示例： `"Etc/UTC"`
卷字符串	快照策略的卷。返回：成功示例： `"Etc/UTC"`
zone 字符串	卷所属区域的名称。返回：成功示例： `"ch-gva-2"`

作者

René Moser (@resmo)