community.general.hwc_evs_disk 模块 – 在华为云中创建 Evs/Disk 资源

注意

此模块是 community.general 集合 (版本 10.1.0) 的一部分。

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

要安装它,请使用:ansible-galaxy collection install community.general。您需要其他要求才能使用此模块,请参阅 要求 获取详细信息。

要在 playbook 中使用它,请指定:community.general.hwc_evs_disk

community.general 0.2.0 中的新增功能

概要

  • 块存储管理。

要求

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

  • keystoneauth1 >= 3.6.0

参数

参数

注释

availability_zone

字符串 / 必需

指定要创建磁盘的可用区。

backup_id

字符串

指定可用于创建磁盘的备份的 ID。当您使用备份创建磁盘时,此参数是必需的。

description

字符串

指定磁盘描述。该值最多可以包含 255 个字节。

domain

字符串 / 必需

要限定范围到的域的名称 (Identity v3)。

目前仅支持域名称,不支持域 ID。

enable_full_clone

布尔值

如果磁盘是从快照创建的并且需要使用链接克隆,请将此参数设置为 True。

选项

  • false

  • true

enable_scsi

布尔值

如果将此参数设置为 True,则磁盘设备类型将为 SCSI,这允许 ECS 操作系统直接访问底层存储介质。支持 SCSI 保留命令。如果将此参数设置为 False,则磁盘设备类型将为 VBD,它仅支持简单的 SCSI 读/写命令。

如果参数 enable_share 设置为 True 且未指定此参数,则会创建共享 SCSI 磁盘。不能从备份创建 SCSI EVS 磁盘,这意味着如果已指定 backup_id,则此参数不能为 True。

选项

  • false

  • true

enable_share

布尔值

指定磁盘是否可共享。默认值为 False。

选项

  • false

  • true

encryption_id

字符串

指定加密 ID。其长度固定为 36 个字节。

enterprise_project_id

字符串

指定企业项目 ID。此 ID 在磁盘创建期间与磁盘关联。如果未指定,则磁盘将绑定到默认企业项目。

id

字符串

要管理的资源的 ID。

identity_endpoint

字符串 / 必需

身份认证 URL。

image_id

字符串

指定映像 ID。如果指定此参数,则会从映像创建磁盘。不能从 BMS 映像创建 BMS 系统磁盘。

name

字符串 / 必需

指定磁盘名称。该值最多可以包含 255 个字节。

password

字符串 / 必需

登录密码。

project

字符串 / 必需

租户 (Identity v2) 或项目 (Identity v3) 的名称。

目前仅支持项目名称,不支持项目 ID。

region

字符串

项目所属的区域。

size

整数

指定磁盘大小(以 GB 为单位)。其值为:系统磁盘 1 GB 到 1024 GB,数据磁盘 10 GB 到 32768 GB。当您创建空磁盘或使用映像或快照创建磁盘时,此参数是必需的。如果您使用映像或快照创建磁盘,则磁盘大小必须大于或等于映像或快照大小。当您使用备份创建磁盘时,此参数是可选的。如果未指定此参数,则磁盘大小等于备份大小。

snapshot_id

字符串

指定快照 ID。如果指定此参数,则会从快照创建磁盘。

state

字符串

给定对象是否应该存在于华为云中。

选项

  • "present" ← (默认)

  • "absent"

timeouts

字典

每个操作的超时时间。

默认值: {}

创建

字符串

创建操作的超时时间。

默认值: "30m"

删除

字符串

删除操作的超时时间。

默认值: "30m"

更新

字符串

更新操作的超时时间。

默认值: "30m"

用户

字符串 / 必需

登录使用的用户名。

目前仅支持用户名,不支持用户ID。

volume_type

字符串 / 必需

指定磁盘类型。目前,值可以是SSD、SAS或SATA。

SSD指定超高I/O磁盘类型。

SAS指定高I/O磁盘类型。

SATA指定普通I/O磁盘类型。

如果指定的磁盘类型在可用区中不可用,则磁盘创建将失败。如果EVS磁盘是从快照创建的,则volume_type字段必须与快照源磁盘的相同。

属性

属性

支持

描述

check_mode

支持:完全支持

可以在check_mode下运行,并在不修改目标的情况下返回更改状态预测。

diff_mode

支持:不支持

在diff模式下,将返回有关已更改内容(或可能需要在check_mode中更改的内容)的详细信息。

备注

注意

  • 对于身份验证,您可以使用ANSIBLE_HWC_IDENTITY_ENDPOINT环境变量设置identity_endpoint。

  • 对于身份验证,您可以使用ANSIBLE_HWC_USER环境变量设置用户。

  • 对于身份验证,您可以使用ANSIBLE_HWC_PASSWORD环境变量设置密码。

  • 对于身份验证,您可以使用ANSIBLE_HWC_DOMAIN环境变量设置域。

  • 对于身份验证,您可以使用ANSIBLE_HWC_PROJECT环境变量设置项目。

  • 对于身份验证,您可以使用ANSIBLE_HWC_REGION环境变量设置区域。

  • 只有在未设置剧本值时,才会使用环境变量值。

示例

# test create disk
- name: Create a disk
  community.general.hwc_evs_disk:
    availability_zone: "cn-north-1a"
    name: "ansible_evs_disk_test"
    volume_type: "SATA"
    size: 10

返回值

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

描述

attachments

复杂

指定磁盘附加信息。

返回:成功

attached_at

字符串

指定磁盘附加时间。“UTC YYYY-MM-DDTHH:MM:SS”格式的时间。

返回:成功

attachment_id

字符串

指定附加信息的ID。

返回:成功

device

字符串

指定设备名称。

返回:成功

server_id

字符串

指定附加磁盘的服务器ID。

返回:成功

availability_zone

字符串

指定要创建磁盘的可用区。

返回:成功

backup_id

字符串

指定可用于创建磁盘的备份的 ID。当您使用备份创建磁盘时,此参数是必需的。

返回:成功

backup_policy_id

字符串

指定备份策略ID。

返回:成功

created_at

字符串

指定磁盘创建时间。“UTC YYYY-MM-DDTHH:MM:SS”格式的时间。

返回:成功

description

字符串

指定磁盘描述。该值最多可以包含 255 个字节。

返回:成功

enable_full_clone

布尔值

如果磁盘是从快照创建的并且需要使用链接克隆,请将此参数设置为 True。

返回:成功

enable_scsi

布尔值

如果将此参数设置为 True,则磁盘设备类型将为 SCSI,这允许 ECS 操作系统直接访问底层存储介质。支持 SCSI 保留命令。如果将此参数设置为 False,则磁盘设备类型将为 VBD,它仅支持简单的 SCSI 读/写命令。

如果参数 enable_share 设置为 True 且未指定此参数,则会创建共享 SCSI 磁盘。不能从备份创建 SCSI EVS 磁盘,这意味着如果已指定 backup_id,则此参数不能为 True。

返回:成功

enable_share

布尔值

指定磁盘是否可共享。默认值为 False。

返回:成功

encryption_id

字符串

指定加密 ID。其长度固定为 36 个字节。

返回:成功

enterprise_project_id

字符串

指定企业项目 ID。此 ID 在磁盘创建期间与磁盘关联。如果未指定,则磁盘将绑定到默认企业项目。

返回:成功

image_id

字符串

指定映像 ID。如果指定此参数,则会从映像创建磁盘。不能从 BMS 映像创建 BMS 系统磁盘。

返回:成功

is_bootable

布尔值

指定磁盘是否可引导。

返回:成功

is_readonly

布尔值

指定磁盘是只读还是读写。True表示磁盘为只读。False表示磁盘为读写。

返回:成功

name

字符串

指定磁盘名称。该值最多可以包含 255 个字节。

返回:成功

size

整数

指定磁盘大小(以 GB 为单位)。其值为:系统磁盘 1 GB 到 1024 GB,数据磁盘 10 GB 到 32768 GB。当您创建空磁盘或使用映像或快照创建磁盘时,此参数是必需的。如果您使用映像或快照创建磁盘,则磁盘大小必须大于或等于映像或快照大小。当您使用备份创建磁盘时,此参数是可选的。如果未指定此参数,则磁盘大小等于备份大小。

返回:成功

snapshot_id

字符串

指定快照 ID。如果指定此参数,则会从快照创建磁盘。

返回:成功

source_volume_id

字符串

指定源磁盘ID。如果磁盘是从源磁盘创建的,则此参数有值。

返回:成功

status

字符串

指定磁盘状态。

返回:成功

tags

字典

指定磁盘标签。

返回:成功

volume_type

字符串

指定磁盘类型。目前,值可以是SSD、SAS或SATA。

SSD指定超高I/O磁盘类型。

SAS指定高I/O磁盘类型。

SATA指定普通I/O磁盘类型。

如果指定的磁盘类型在可用区中不可用,则磁盘创建将失败。如果EVS磁盘是从快照创建的,则volume_type字段必须与快照源磁盘的相同。

返回:成功

作者

  • 华为公司 (@huaweicloud)