openstack.cloud.volume_backup 模块 – 添加/删除卷备份

注意

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

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

要安装它，请使用：ansible-galaxy collection install openstack.cloud。您需要进一步的要求才能使用此模块，请参阅要求了解详细信息。

要在 Playbook 中使用它，请指定：openstack.cloud.volume_backup。

概要

  • 在 OpenStack 中添加或删除卷备份。

要求

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

  • python >= 3.6

  • openstacksdk >= 1.0.0

参数

参数

注释

api_timeout

整数

套接字层在 API 调用超时之前应等待多长时间。如果省略此项，则不会传递任何内容到 requests 库。

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" ← （默认）

is_incremental

别名：incremental

布尔值

备份模式

选项

  • false ← （默认）

  • true

metadata

字典

备份的元数据

name

别名：display_name

字符串 / 必需

必须给备份的名称

region_name

字符串

区域的名称。

sdk_log_level

字符串

OpenStackSDK 的日志级别

选项

  • "INFO" ← （默认）

  • "DEBUG"

sdk_log_path

字符串

OpenStackSDK 的日志文件的路径。如果为空，则不写入任何日志

snapshot

字符串

要备份的快照的名称或 ID。

state

字符串

资源应该存在还是不存在。

选项

  • "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 配置文件，然后来自标准环境变量，最后来自剧本中的显式参数。更多信息请访问 https://docs.openstack.org/openstacksdk/

示例

- name: Create backup
  openstack.cloud.volume_backup:
    name: test_volume_backup
    volume: "test_volume"

- name: Create backup from snapshot
  openstack.cloud.volume_backup:
    name: test_volume_backup
    snapshot: "test_snapshot"
    volume: "test_volume"

- name: Delete volume backup
  openstack.cloud.volume_backup:
    name: test_volume_backup
    state: absent

返回值

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

键

描述

backup

字典

与 volume_backup 相同，为保持向后兼容而保留。

返回： 当 state=present 成功时

volume_backup

字典

描述卷备份的字典。

返回： 当 state=present 成功时

availability_zone

字符串

备份可用区。

返回： 成功

container

字符串

容器名称。

返回： 成功

created_at

字符串

备份创建时间。

返回： 成功

data_timestamp

字符串

首次保存卷上数据的时间。如果是来自卷的备份，则它将与备份的 created_at 相同。如果是来自快照的备份，则它将与快照的 created_at 相同。

返回： 成功

description

字符串

备份描述。

返回： 成功

fail_reason

字符串

备份失败原因。

返回： 成功

force

布尔值

强制备份。

返回： 成功

has_dependent_backups

布尔值

如果此值为 true，则有其他备份依赖于此备份。

返回： 成功

id

字符串

唯一的 UUID。

返回： 成功

示例： "39007a7e-ee4f-4d13-8283-b4da2e037c69"

is_incremental

布尔值

备份增量属性。

返回： 成功

列表 / 元素=字符串

与此卷关联的链接列表。

返回： 成功

metadata

字典

备份元数据。

返回： 成功

name

字符串

备份名称。

返回： 成功

object_count

整数

备份对象计数。

返回： 成功

project_id

字符串

所属项目的 UUID。

返回： 成功

size

整数

卷的大小，以吉比字节 (GiB) 为单位。

返回： 成功

snapshot_id

字符串

快照 ID。

返回： 成功

status

字符串

备份状态。

返回： 成功

updated_at

字符串

备份更新时间。

返回： 成功

user_id

字符串

项目所有者的 UUID。

返回： 成功

volume_id

字符串

卷 ID。

返回： 成功

作者

  • OpenStack Ansible SIG