openstack.cloud.server_volume 模块 – 从 OpenStack 虚拟机附加/分离卷

注意

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

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

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

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

概要

  • 从 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 的一个部分中一样。

device

字符串

您要附加的设备。默认为自动查找设备名称。

interface

别名：endpoint_type

字符串

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

选择

  • "admin"

  • "internal"

  • "public" ←（默认）

region_name

字符串

区域的名称。

sdk_log_level

字符串

OpenStackSDK 的日志级别

选择

  • "INFO" ←（默认）

  • "DEBUG"

sdk_log_path

字符串

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

server

字符串 / 必需

您要将卷附加到的服务器的名称或 ID

state

字符串

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

选择

  • "present" ←（默认）

  • "absent"

timeout

整数

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

默认值： 180

validate_certs

别名：verify

布尔值

是否应验证 SSL API 请求。

在 Ansible 2.3 之前，此值默认为 true。

选择

  • false

  • true

volume

字符串 / 必需

您要附加到服务器的卷的名称或 ID

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: Attaches a volume to a compute host
  openstack.cloud.server_volume:
    state: present
    cloud: mordred
    server: Mysql-server
    volume: mysql-data
    device: /dev/vdb

返回值

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

键

描述

volume

字典

刚刚附加的卷

返回：当 state 为 present 时成功返回

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

字符串

卷的关联卷类型名称。

返回：成功

作者

  • OpenStack Ansible SIG