VMware Cloud Director API - Disk

VMware Cloud Director API - Disk

DiskType

Element:
Disk
Type:
DiskType
Namespace:
http://www.vmware.com/vcloud/v1.5
Description:
Represents an independent disk.
Since:
5.1
Schema:
disk.xsd
Media type(s):
application/vnd.vmware.vcloud.disk+xml
application/vnd.vmware.vcloud.disk+json
Extends:
ResourceEntityType
XML Representation:
<Disk xmlns="http://www.vmware.com/vcloud/v1.5" href="xs:anyURI" type="xs:string" id="xs:string" operationKey="xs:string"
        name="xs:string" status="xs:int" sizeMb="xs:long" encrypted="xs:boolean"
        busType="xs:string" busSubType="xs:string" shareable="xs:boolean" sharingType="xs:string"
        uuid="xs:string">
    <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
            rel="xs:string" model="xs:string"/>
    <Description> xs:string </Description>
    <Tasks>
        <Task href="xs:anyURI" type="xs:string" id="xs:string" operationKey="xs:string"
                name="xs:string" status="xs:string" operation="xs:string" operationName="xs:string"
                serviceNamespace="xs:string" startTime="xs:dateTime" endTime="xs:dateTime" expiryTime="xs:dateTime"
                cancelRequested="xs:boolean">
            <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                    rel="xs:string" model="xs:string"/>
            <Description> xs:string </Description>
            <Tasks> TasksInProgressType </Tasks>
            <Owner href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
            <Error stackTrace="xs:string" message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string"
                    vendorSpecificErrorCode="xs:string">
                <TenantError message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string" vendorSpecificErrorCode="xs:string"/>
            </Error>
            <User href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
            <Organization href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
            <Progress> xs:int </Progress>
            <Params> ... </Params>
            <Details> xs:string </Details>
            <VcTaskList>
                <VcTask name="xs:string" moref="xs:string" status="xs:string" description="xs:string"
                        errorMessage="xs:string" objectName="xs:string" objectType="xs:string" objectMoref="xs:string"
                        virtualCenterID="xs:string" startTime="xs:dateTime" endTime="xs:dateTime"/>
            </VcTaskList>
            <Result>
                <ResultContent> ... </ResultContent>
                <ResultReference href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
            </Result>
        </Task>
    </Tasks>
    <Files>
        <File href="xs:anyURI" type="xs:string" id="xs:string" operationKey="xs:string"
                name="xs:string" size="xs:long" bytesTransferred="xs:long" checksum="xs:normalizedString">
            <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                    rel="xs:string" model="xs:string"/>
            <Description> xs:string </Description>
            <Tasks>
                <Task href="xs:anyURI" type="xs:string" id="xs:string" operationKey="xs:string"
                        name="xs:string" status="xs:string" operation="xs:string" operationName="xs:string"
                        serviceNamespace="xs:string" startTime="xs:dateTime" endTime="xs:dateTime" expiryTime="xs:dateTime"
                        cancelRequested="xs:boolean">
                    <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                            rel="xs:string" model="xs:string"/>
                    <Description> xs:string </Description>
                    <Tasks> TasksInProgressType </Tasks>
                    <Owner href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
                    <Error stackTrace="xs:string" message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string"
                            vendorSpecificErrorCode="xs:string">
                        <TenantError message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string" vendorSpecificErrorCode="xs:string"/>
                    </Error>
                    <User href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
                    <Organization href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
                    <Progress> xs:int </Progress>
                    <Params> ... </Params>
                    <Details> xs:string </Details>
                    <VcTaskList>
                        <VcTask name="xs:string" moref="xs:string" status="xs:string" description="xs:string"
                                errorMessage="xs:string" objectName="xs:string" objectType="xs:string" objectMoref="xs:string"
                                virtualCenterID="xs:string" startTime="xs:dateTime" endTime="xs:dateTime"/>
                    </VcTaskList>
                    <Result>
                        <ResultContent> ... </ResultContent>
                        <ResultReference href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
                    </Result>
                </Task>
            </Tasks>
        </File>
    </Files>
    <StorageProfile href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
    <Owner href="xs:anyURI" type="xs:string">
        <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                rel="xs:string" model="xs:string"/>
        <User href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
    </Owner>
    <IopsAllocation>
        <Reservation> xs:long </Reservation>
        <Limit> xs:long </Limit>
        <SharesLevel> ResourceSharesLevelType </SharesLevel>
        <Shares> xs:int </Shares>
    </IopsAllocation>
</Disk>

Attributes

Attribute Type Required Modifiable Since Deprecated Description
href anyURI No always 5.1 The URI of the entity.
type string No always 5.1 The MIME type of the entity.
id string No none 5.1 The entity identifier, expressed in URN format. The value of this attribute uniquely identifies the entity, persists for the life of the entity, and is never reused.
operationKey string No create 5.1 Optional unique identifier to support idempotent semantics for create and delete operations.
name string Yes always 5.1 The name of the entity.
status int No none 5.1 Creation status of the resource entity.
sizeMb long No none 33.0 Size of the disk in MB.
encrypted boolean No none 34.0 True if disk is encrypted. This is a read-only attribute.
busType string No none 5.1 Disk bus type expressed as a number. One of:
5 IDE bus
6 SCSI bus (default)
20 SATA bus
20 NVME bus

You must supply this attribute in an update request, but you cannot change its value after the object has been created.
busSubType string No none 5.1 Disk bus subtype expressed as a string. One of:
"" (null)  IDE, requires busType 5
buslogic  BusLogic Parallel SCSI controller, requires busType 6
lsilogic  LSI Logic Parallel SCSI controller, requires busType 6
lsilogicsas  LSI Logic SAS SCSI controller, requires busType 6
VirtualSCSI  Paravirtual SCSI controller, requires busType 6
vmware.sata.ahci  SATA controller, requires busType 20
vmware.nvme.controller  NVME controller, requires busType 20

You must supply this attribute in an update request, but you cannot change its value after the object has been created.
shareable boolean No none 35.0 36.0 This attribute is immutable; used for create only. If set true, a shareable disk is created. Shareable and controllerSharing are mutually exclusive. This attribute is deprecated; use sharingType instead.
sharingType string No none 36.0 This attribute is immutable; used for create only. This is the sharing type expressed as a string. This attribute can only have values defined by DiskSharingType. One of:
None  Non shared disk(default)
DiskSharing  Disk level shared disk
ControllerSharing  Controller level shared disk

uuid string No none 36.0 The UUID of this named disk's device backing. This is a read-only value.

Elements

Element Type Required Modifiable Since Deprecated Description
Description string No always 5.1 Optional description.
Files FilesListType No none 5.1 Represents a list of files to be transferred (uploaded or downloaded). Each File in the list is part of the ResourceEntity.
IopsAllocation IopsResourceType No always 37.0 IOPS allocated to the disk
Link LinkType No none 5.1 A reference to an entity or operation associated with this object.
Owner OwnerType No none 5.1 The owner of the disk.
StorageProfile ReferenceType No always 5.1 Storage profile of the disk.
Tasks TasksInProgressType No none 5.1 A list of queued, running, or recently completed tasks associated with this entity.
VCloudExtension VCloudExtensionType No always 5.1 An optional extension element that can contain an arbitrary number of elements and attributes. Not related to extension services.

Operations

CRUD Operation Description Since Deprecated
create POST /vdc/{id}/disk Create a disk. 5.1
read GET /disk/{id} Retrieve a disk. 5.1
update PUT /disk/{id} Update the name, description, iops, size and storage class of a disk. 5.1
delete DELETE /disk/{id} Delete a disk. 5.1