openstack.cloud.volume 模块 – 创建/删除 Cinder 卷

注意

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

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

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

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

概要 

创建或删除 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 参数的内容。
availability_zone 字符串	可用区。
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 字符串	描述卷的字符串
image 字符串	用于从卷启动的镜像名称或 ID 与 snapshot 和 volume 互斥
interface 别名：endpoint_type 字符串	要从服务目录中获取的端点 URL 类型。选择 `"admin"` `"internal"` `"public"` ← (默认)
is_bootable 别名：bootable 布尔值	卷的可启动标志。选择 `false` ← (默认) `true`
is_multiattach 布尔值	卷是否可共享。要使此卷可以附加到多个服务器，请将 is_multiattach 设置为 `true`。请注意，对多附加卷的支持取决于正在使用的卷类型。 Cinder 的 is_multiattach 默认值为 `false`。选择 `false` `true`
metadata 字典	卷的元数据
name 别名：display_name 字符串 / 必需	卷的名称
region_name 字符串	区域的名称。
scheduler_hints 字典	以字典形式传递给卷 API 的调度程序提示
sdk_log_level 字符串	OpenStackSDK 的日志级别选择 `"INFO"` ← (默认) `"DEBUG"`
sdk_log_path 字符串	OpenStackSDK 的日志文件的路径。如果为空，则不写入日志
size 整数	卷的大小（以 GB 为单位）。当 state 参数为“present”时，此参数是必需的。
snapshot 别名：snapshot_id 字符串	要从中创建的卷快照名称或 ID 与 image 和 volume 互斥
state 字符串	资源应该是存在还是不存在。选择 `"present"` ← (默认) `"absent"`
timeout 整数	Ansible 应等待请求的资源多长时间。默认值: `180`
validate_certs 别名：verify 布尔值	是否应验证 SSL API 请求。在 Ansible 2.3 之前，此项默认为 `true`。选择 `false` `true`
volume 字符串	要从中创建的卷名称或 ID 与 image 和 snapshot 互斥
volume_type 字符串	卷的卷类型
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/

示例 

# Creates a new volume
- name: create 40g test volume
  openstack.cloud.volume:
    state: present
    cloud: mordred
    availability_zone: az2
    size: 40
    name: test_volume
    scheduler_hints:
      same_host: 243e8d3c-8f47-4a61-93d6-7215c344b0c0

返回值 

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

键	描述
volume 字典	Cinder 对卷对象的表示返回：总是
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，则此卷已加密。返回：成功
is_multiattach 布尔值	此卷是否可以挂载到多个服务器。返回：成功
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 字符串	卷的关联卷类型名称。返回：成功

作者

OpenStack Ansible SIG