This resource type represents a volume on VMware vCenter. It extends the type OS::Cinder::Volume.

The blueprint uses the core properties and extended properties, if any, from this resource type. Review and configure the applicable heat resources that apply to your configuration information.

In the blueprint designer, you can configure the properties that the following table includes. Properties are listed as either core or extended. Each type of property is located in separate sections of the heat resource that you can view in the blueprint designer. You set the core properties in the properties section and set the extended properties in the metadata section of the blueprint.

Table 1. Properties
Name Type Required Core or extended Description
availability_zone String False Core The availability zone in which to create the volume.
backup_id String False Core If specified, the backup from which to create the volume.
datastore String False Extended The datastore to put the volume in.
description String False Core A description of the volume.
image String False Core The name or ID of the image from which to create the volume.
imageRef String False Core The ID of the image from which to create the volume.
iops Integer False Extended The number of I/O operations per second (IOPS) that the volume supports. Use with vol type io1.
metadata Map False Core Key/value pairs to associate with the volume.
name String False Core A name used to distinguish the volume.
scheduler_hints Map False Core Arbitrary key-value pairs specified by the client to help the Cinder scheduler creating a volume.
size Integer False Core The size of the volume in GB. On update only increase in size is supported.
snapshot_id String False Core The snapshot from which to create the volume.
source_volid String False Core The volume to use as a source.
volume_type String False Core The type of volume to use. The volume type is mapped to a specific back end.
Table 2. Attributes
Name Description
attachments The list of attachments of the volume.
availability_zone The availability zone in which the volume is located.
bootable A Boolean value that indicates if the volume can be booted or not.
created_at The time stamp that indicates volume creation.
create_time The time that this volume was created.
display_description The description of the volume.
display_name The name of this volume.
encrypted The value is true if this volume is encrypted.
id The ID of this volume.
iops The I/O operations that this volume can support.
metadata The key/value pairs that are associated with the volume.
metadata_values The key/value pairs that are associated with the volume in raw dict form.
region The region of this volume.
size The size of the volume in GB.
snapshot_id The snapshot the volume was created from, if any.
source_volid The volume that is used as source, if any.
status The current status of the volume.
type The type of this volume.
volume_type The type of the volume mapping to a back end, if any.
zone The availability zone of this volume.