W3cubDocs

/Ansible

community.general.hwc_evs_disk – Creates a resource of Evs/Disk in Huawei Cloud

Note

This plugin is part of the community.general collection (version 3.8.1).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.general.

To use it in a playbook, specify: community.general.hwc_evs_disk.

New in version 0.2.0: of community.general

Synopsis

  • block storage management.

Requirements

The below requirements are needed on the host that executes this module.

  • keystoneauth1 >= 3.6.0

Parameters

Parameter Choices/Defaults Comments
availability_zone
string / required
Specifies the AZ where you want to create the disk.
backup_id
string
Specifies the ID of the backup that can be used to create a disk. This parameter is mandatory when you use a backup to create the disk.
description
string
Specifies the disk description. The value can contain a maximum of 255 bytes.
domain
string / required
The name of the Domain to scope to (Identity v3). (currently only domain names are supported, and not domain IDs).
enable_full_clone
boolean
    Choices:
  • no
  • yes
If the disk is created from a snapshot and linked cloning needs to be used, set this parameter to True.
enable_scsi
boolean
    Choices:
  • no
  • yes
If this parameter is set to True, the disk device type will be SCSI, which allows ECS OSs to directly access underlying storage media. SCSI reservation command is supported. If this parameter is set to False, the disk device type will be VBD, which supports only simple SCSI read/write commands.
If parameter enable_share is set to True and this parameter is not specified, shared SCSI disks are created. SCSI EVS disks cannot be created from backups, which means that this parameter cannot be True if backup_id has been specified.
enable_share
boolean
    Choices:
  • no
  • yes
Specifies whether the disk is shareable. The default value is False.
encryption_id
string
Specifies the encryption ID. The length of it fixes at 36 bytes.
enterprise_project_id
string
Specifies the enterprise project ID. This ID is associated with the disk during the disk creation. If it is not specified, the disk is bound to the default enterprise project.
id
string
The id of resource to be managed.
identity_endpoint
string / required
The Identity authentication URL.
image_id
string
Specifies the image ID. If this parameter is specified, the disk is created from an image. BMS system disks cannot be created from BMS images.
name
string / required
Specifies the disk name. The value can contain a maximum of 255 bytes.
password
string / required
The password to login with.
project
string / required
The name of the Tenant (Identity v2) or Project (Identity v3). (currently only project names are supported, and not project IDs).
region
string
The region to which the project belongs.
size
integer
Specifies the disk size, in GB. Its values are as follows, System disk 1 GB to 1024 GB, Data disk 10 GB to 32768 GB. This parameter is mandatory when you create an empty disk or use an image or a snapshot to create a disk. If you use an image or a snapshot to create a disk, the disk size must be greater than or equal to the image or snapshot size. This parameter is optional when you use a backup to create a disk. If this parameter is not specified, the disk size is equal to the backup size.
snapshot_id
string
Specifies the snapshot ID. If this parameter is specified, the disk is created from a snapshot.
state
string
    Choices:
  • present
  • absent
Whether the given object should exist in Huaweicloud Cloud.
timeouts
dictionary
The timeouts for each operations.
create
string
Default:
"30m"
The timeouts for create operation.
delete
string
Default:
"30m"
The timeouts for delete operation.
update
string
Default:
"30m"
The timeouts for update operation.
user
string / required
The user name to login with (currently only user names are supported, and not user IDs).
volume_type
string / required
Specifies the disk type. Currently, the value can be SSD, SAS, or SATA.
SSD specifies the ultra-high I/O disk type.
SAS specifies the high I/O disk type.
SATA specifies the common I/O disk type.
If the specified disk type is not available in the AZ, the disk will fail to create. If the EVS disk is created from a snapshot, the volume_type field must be the same as that of the snapshot's source disk.

Notes

Note

  • For authentication, you can set identity_endpoint using the ANSIBLE_HWC_IDENTITY_ENDPOINT env variable.
  • For authentication, you can set user using the ANSIBLE_HWC_USER env variable.
  • For authentication, you can set password using the ANSIBLE_HWC_PASSWORD env variable.
  • For authentication, you can set domain using the ANSIBLE_HWC_DOMAIN env variable.
  • For authentication, you can set project using the ANSIBLE_HWC_PROJECT env variable.
  • For authentication, you can set region using the ANSIBLE_HWC_REGION env variable.
  • Environment variables values will only be used if the playbook values are not set.

Examples

# 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

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
attachments
complex
success
Specifies the disk attachment information.

attached_at
string
success
Specifies the time when the disk was attached. Time format is 'UTC YYYY-MM-DDTHH:MM:SS'.

attachment_id
string
success
Specifies the ID of the attachment information.

device
string
success
Specifies the device name.

server_id
string
success
Specifies the ID of the server to which the disk is attached.

availability_zone
string
success
Specifies the AZ where you want to create the disk.

backup_id
string
success
Specifies the ID of the backup that can be used to create a disk. This parameter is mandatory when you use a backup to create the disk.

backup_policy_id
string
success
Specifies the backup policy ID.

created_at
string
success
Specifies the time when the disk was created. Time format is 'UTC YYYY-MM-DDTHH:MM:SS'.

description
string
success
Specifies the disk description. The value can contain a maximum of 255 bytes.

enable_full_clone
boolean
success
If the disk is created from a snapshot and linked cloning needs to be used, set this parameter to True.

enable_scsi
boolean
success
If this parameter is set to True, the disk device type will be SCSI, which allows ECS OSs to directly access underlying storage media. SCSI reservation command is supported. If this parameter is set to False, the disk device type will be VBD, which supports only simple SCSI read/write commands.
If parameter enable_share is set to True and this parameter is not specified, shared SCSI disks are created. SCSI EVS disks cannot be created from backups, which means that this parameter cannot be True if backup_id has been specified.

enable_share
boolean
success
Specifies whether the disk is shareable. The default value is False.

encryption_id
string
success
Specifies the encryption ID. The length of it fixes at 36 bytes.

enterprise_project_id
string
success
Specifies the enterprise project ID. This ID is associated with the disk during the disk creation. If it is not specified, the disk is bound to the default enterprise project.

image_id
string
success
Specifies the image ID. If this parameter is specified, the disk is created from an image. BMS system disks cannot be created from BMS images.

is_bootable
boolean
success
Specifies whether the disk is bootable.

is_readonly
boolean
success
Specifies whether the disk is read-only or read/write. True indicates that the disk is read-only. False indicates that the disk is read/write.

name
string
success
Specifies the disk name. The value can contain a maximum of 255 bytes.

size
integer
success
Specifies the disk size, in GB. Its values are as follows, System disk 1 GB to 1024 GB, Data disk 10 GB to 32768 GB. This parameter is mandatory when you create an empty disk or use an image or a snapshot to create a disk. If you use an image or a snapshot to create a disk, the disk size must be greater than or equal to the image or snapshot size. This parameter is optional when you use a backup to create a disk. If this parameter is not specified, the disk size is equal to the backup size.

snapshot_id
string
success
Specifies the snapshot ID. If this parameter is specified, the disk is created from a snapshot.

source_volume_id
string
success
Specifies the source disk ID. This parameter has a value if the disk is created from a source disk.

status
string
success
Specifies the disk status.

tags
dictionary
success
Specifies the disk tags.

volume_type
string
success
Specifies the disk type. Currently, the value can be SSD, SAS, or SATA.
SSD specifies the ultra-high I/O disk type.
SAS specifies the high I/O disk type.
SATA specifies the common I/O disk type.
If the specified disk type is not available in the AZ, the disk will fail to create. If the EVS disk is created from a snapshot, the volume_type field must be the same as that of the snapshot's source disk.



Authors

  • Huawei Inc. (@huaweicloud)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/hwc_evs_disk_module.html