openstack.cloud.volume_snapshot 模块 – 创建/删除 Cinder 卷快照

注意

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

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

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

要在 playbook 中使用它，请指定：openstack.cloud.volume_snapshot。

概要 

创建或删除 cinder 块存储卷快照

要求 

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

python >= 3.6
openstacksdk >= 1.0.0

参数 

参数	注释
api_timeout 整数	套接字层在 API 调用超时之前应等待多长时间。如果省略此项，则不会将任何内容传递给请求库。
auth 字典	包含云的身份验证插件策略所需的身份验证信息的字典。对于默认的 password 插件，这将包含 auth_url、username、password、project_name 和任何关于域的信息（例如，如果云支持它们，则包含 user_domain_name 或 project_domain_name）。对于其他插件，此参数需要包含该身份验证插件所需的任何参数。如果提供了命名云或存在 OpenStack OS_* 环境变量，则不需要此参数。
auth_type 字符串	要使用的身份验证插件的名称。如果云使用密码身份验证以外的其他身份验证，则应在此处指示插件的名称，并相应地更新 auth 参数的内容。
ca_cert 别名：cacert 字符串	可用于验证 SSL API 请求的 CA 证书捆绑包的路径。
client_cert 别名：cert 字符串	用作 SSL 事务一部分的客户端证书的路径。
client_key 别名：key 字符串	用作 SSL 事务一部分的客户端密钥的路径。
cloud 任何	要操作的命名云或云配置。如果 cloud 是一个字符串，它引用 OpenStack clouds.yaml 文件中定义的命名云配置。为 auth 和 auth_type 提供默认值。如果提供了 auth 或存在 OpenStack OS_* 环境变量，则不需要此参数。如果 cloud 是一个字典，它包含一个完整的云配置，就像 clouds.yaml 的一个部分一样。
description 别名：display_description 字符串	描述快照的字符串
force 布尔值	允许或禁止在卷连接到实例时创建卷的快照。选项 `false` ← (默认) `true`
interface 别名：endpoint_type 字符串	要从服务目录中获取的端点 URL 类型。选项 `"admin"` `"internal"` `"public"` ← (默认)
name 别名：display_name 字符串 / 必填	快照的名称
region_name 字符串	区域的名称。
sdk_log_level 字符串	OpenStackSDK 的日志级别选项 `"INFO"` ← (默认) `"DEBUG"`
sdk_log_path 字符串	OpenStackSDK 的日志文件的路径。如果为空，则不写入日志
state 字符串	快照应该是 `present` 还是 `absent`。选项 `"present"` ← (默认) `"absent"`
timeout 整数	Ansible 应等待请求的资源多长时间。默认： `180`
validate_certs 别名：verify 布尔值	是否应验证 SSL API 请求。在 Ansible 2.3 之前，默认为 `true`。选项 `false` `true`
volume 字符串	从中创建快照的卷名称或 ID。当 state 为 `present` 时必需。
wait 布尔值	Ansible 是否应等待直到请求的资源完成。选项 `false` `true` ← (默认)

说明 

注意

尚未实现更新现有卷快照。
可以使用标准的 OpenStack 环境变量，例如 OS_USERNAME，而不是提供显式值。
身份验证信息由 openstacksdk 驱动，这意味着值可以来自 /etc/ansible/openstack.yaml、/etc/openstack/clouds.yaml 或 ~/.config/openstack/clouds.yaml 中的 yaml 配置文件，然后来自标准环境变量，最后来自 playbook 中的显式参数。有关更多信息，请访问 https://docs.openstack.org/openstacksdk/

示例 

- name: create snapshot
  openstack.cloud.volume_snapshot:
    state: present
    cloud: mordred
    name: test_snapshot
    volume: test_volume
- name: delete snapshot
  openstack.cloud.volume_snapshot:
    state: absent
    cloud: mordred
    name: test_snapshot
    volume: test_volume

返回值 

此处记录了常见的返回值此处，以下是此模块独有的字段

键	描述
snapshot 字典	与 `volume_snapshot` 相同，为了向后兼容而保留。返回：当 `state=present` 成功时
volume_snapshot 字典	快照实例返回：成功
created_at 字符串	快照创建时间。返回：成功
description 字符串	快照描述。返回：成功
id 字符串	唯一的 UUID。返回：成功示例： `"39007a7e-ee4f-4d13-8283-b4da2e037c69"`
is_forced 布尔值	指示是否创建快照，即使卷已附加。返回：成功
元数据字典	快照元数据。返回：成功
名称字符串	快照名称。返回：成功
进度字符串	快照当前的完成百分比。返回：成功
项目ID 字符串	此快照关联的项目 ID。返回：成功
大小整数	卷的大小，单位为 GB。返回：成功
状态字符串	快照状态。返回：成功
更新时间字符串	快照更新时间。返回：成功
卷ID 字符串	卷 ID。返回：成功

作者

OpenStack Ansible SIG