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

字典

包含云的身份验证插件策略所需的身份验证信息的字典。对于默认的密码插件，这将包含 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 的某个部分一样。

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

返回值

通用返回值请参考这里，以下是此模块特有的字段

键

描述

volumes

列表 / 元素=字典

项目中的卷

返回值: 总是

示例: [{"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}]

attachments

列表 / 元素=字符串

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

返回值: 成功

availability_zone

字符串

可用区名称。

返回值: 成功

consistency_group_id

字符串

一致性组的 UUID。

返回值: 成功

created_at

字符串

资源创建的日期和时间。

返回值: 成功

description

字符串

卷描述。

返回值: 成功

extended_replication_status

字符串

此卷上的扩展复制状态。

返回值: 成功

group_id

字符串

组的 ID。

返回值: 成功

host

字符串

卷的当前后端。

返回值: 成功

id

字符串

卷的 UUID。

返回值: 成功

image_id

字符串

卷所基于的镜像

返回值: 成功

is_bootable

字符串

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

返回值: 成功

is_encrypted

布尔值

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

返回值: 成功

metadata

字典

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

返回值: 成功

migration_id

字符串

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

返回值: 成功

migration_status

字符串

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

返回值: 成功

name

字符串

卷名称。

返回值: 成功

project_id

字符串

卷所属的项目 ID。

返回值: 成功

replication_driver_data

字符串

复制驱动程序设置的数据

返回值: 成功

replication_status

字符串

卷复制状态。

返回值: 成功

scheduler_hints

字典

卷的调度程序提示

返回值: 成功

size

整数

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

返回值: 成功

snapshot_id

字符串

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

返回值: 成功

source_volume_id

字符串

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

返回值: 成功

status

字符串

卷状态。

返回值: 成功

updated_at

字符串

资源更新的日期和时间。

返回值: 成功

user_id

字符串

用户的 UUID。

返回值: 成功

volume_image_metadata

字典

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

返回值: 成功

volume_type

字符串

卷的关联卷类型名称。

返回值: 成功

作者

  • Sagi Shnaidman (@sshnaidm)