openstack.cloud.volume_info 模块 – 获取卷信息

注意

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

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

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

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

概要

  • 获取 OpenStack 中块存储的信息

要求

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

  • python >= 3.6

  • openstacksdk >= 1.0.0

参数

参数

注释

all_projects

布尔值

是否返回所有项目中的卷

选项

  • false

  • true

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

字符串

CA 证书捆绑包的路径，可用作验证 SSL API 请求的一部分。

client_cert

别名：cert

字符串

客户端证书的路径，用作 SSL 事务的一部分。

client_key

别名：key

字符串

客户端密钥的路径，用作 SSL 事务的一部分。

cloud

任意

要操作的命名云或云配置。如果 *cloud* 是字符串，则它引用在 OpenStack clouds.yaml 文件中定义的命名云配置。为 *auth* 和 *auth_type* 提供默认值。如果提供了 *auth* 或存在 OpenStack OS_* 环境变量，则不需要此参数。如果 *cloud* 是字典，则它包含完整的云配置，就像 clouds.yaml 的一部分一样。

details

布尔值

是否提供有关卷的附加信息

选项

  • false

  • true

interface

别名：endpoint_type

字符串

从服务目录中获取的端点 URL 类型。

选项

  • "admin"

  • "internal"

  • "public" ← (默认)

name

字符串

卷的名称

region_name

字符串

区域的名称。

sdk_log_level

字符串

OpenStackSDK 的日志级别

选项

  • "INFO" ← (默认)

  • "DEBUG"

sdk_log_path

字符串

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

status

字符串

卷的状态，以便您可以例如根据 available 进行筛选

timeout

整数

Ansible 应等待请求的资源多长时间。

默认值： 180

validate_certs

别名：verify

布尔值

是否应验证 SSL API 请求。

在 Ansible 2.3 之前，默认为 true。

选项

  • false

  • true

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/ 找到

示例

- openstack.cloud.volume_info:

- openstack.cloud.volume_info:
    name: myvolume

- openstack.cloud.volume_info:
    all_projects: true

- openstack.cloud.volume_info:
    all_projects: true
    details: false

返回值

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

键

描述

卷

列表 / 元素=字典

项目中的卷

返回值：始终

示例： [{"attachments": [], "availability_zone": "nova", "consistency_group_id": null, "created_at": "2017-11-15T10:51:19.000000", "description": "", "extended_replication_status": null, "group_id": "402ac6ed-527f-4781-8484-7ff4467e34f5", "host": null, "id": "103ac6ed-527f-4781-8484-7ff4467e34f5", "image_id": null, "is_bootable": true, "is_encrypted": false, "metadata": {"readonly": "False"}, "migration_id": null, "migration_status": null, "name": "", "project_id": "cab34702154a42fc96ed9403c691c76e", "replication_driver_data": null, "replication_status": "disabled", "scheduler_hints": {}, "size": 9, "snapshot_id": null, "source_volume_id": null, "status": "available", "updated_at": "2017-11-15T10:51:19.000000", "user_id": "ac303ed-527f-4781-8484-7ff4467e34f5", "volume_image_metadata": {"checksum": "a14e113deeee3a3392462f167ed28cb5", "container_format": "bare", "disk_format": "raw", "family": "centos-7", "image_id": "afcf3320-1bf8-4a9a-a24d-5abd639a6e33", "image_name": "CentOS-7-x86_64-GenericCloud-1708", "latest": "centos-7-latest", "min_disk": "0", "min_ram": "0", "official": "True", "official-image": "True", "size": "8589934592"}, "volume_type": null}]

附件

列表 / 元素=字符串

实例附件信息。如果此卷已附加到服务器实例，则附件列表包括附加服务器的 UUID、附件 UUID、附加主机的名称（如有）、卷 UUID、设备和设备 UUID。否则，此列表为空。

返回值：成功

可用区

字符串

可用区的名称。

返回值：成功

一致性组ID

字符串

一致性组的 UUID。

返回值：成功

创建时间

字符串

资源创建的日期和时间。

返回值：成功

描述

字符串

卷的描述。

返回值：成功

扩展复制状态

字符串

此卷上的扩展复制状态。

返回值：成功

组ID

字符串

组的 ID。

返回值：成功

主机

字符串

卷当前的后端。

返回值：成功

ID

字符串

卷的 UUID。

返回值：成功

镜像ID

字符串

卷基于的镜像

返回值：成功

是否可引导

字符串

启用或禁用可引导属性。您可以从可引导卷启动实例。

返回值：成功

是否已加密

布尔值

如果为 true，则此卷已加密。

返回值：成功

元数据

字典

元数据对象。包含一个或多个与卷关联的元数据键值对。

返回值：成功

迁移ID

字符串

此卷在后端上的卷名称基于的卷 ID。

返回值：成功

迁移状态

字符串

此卷迁移的状态（None 表示当前没有迁移正在进行）。

返回值：成功

name

字符串

卷名称。

返回值：成功

项目ID

字符串

卷所属的项目 ID。

返回值：成功

复制驱动程序数据

字符串

由复制驱动程序设置的数据

返回值：成功

复制状态

字符串

卷的复制状态。

返回值：成功

调度提示

字典

卷的调度提示

返回值：成功

大小

整数

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

返回值：成功

快照ID

字符串

要从现有快照创建卷，请指定卷快照的 UUID。卷在与快照相同的可用区中创建，大小与快照相同。

返回值：成功

源卷ID

字符串

源卷的 UUID。除非请求更大的大小，否则 API 将创建与源卷大小相同的新卷。

返回值：成功

status

字符串

卷状态。

返回值：成功

更新时间

字符串

资源更新的日期和时间。

返回值：成功

用户ID

字符串

用户的 UUID。

返回值：成功

卷镜像元数据

字典

镜像元数据条目的列表。仅包含为从镜像或从最初从镜像创建的卷的快照创建的卷。

返回值：成功

卷类型

字符串

卷关联的卷类型名称。

返回值：成功

作者

  • Sagi Shnaidman (@sshnaidm)