VMware Cloud Director API - VdcStorageProfile

VMware Cloud Director API - VdcStorageProfile


Represents a storage profile in an organization vDC.
Media type(s):
XML Representation:
<VdcStorageProfile xmlns="http://www.vmware.com/vcloud/v1.5" href="xs:anyURI" type="xs:string" id="xs:string" operationKey="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>
        <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"
            <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"
                <TenantError message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string" vendorSpecificErrorCode="xs:string"/>
            <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>
                <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"/>
                <ResultContent> ... </ResultContent>
                <ResultReference href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
    <Enabled> xs:boolean </Enabled>
    <Units> xs:string </Units>
    <Limit> xs:long </Limit>
    <Default> xs:boolean </Default>
        <Enabled> xs:boolean </Enabled>
        <DiskIopsMax> xs:long </DiskIopsMax>
        <DiskIopsDefault> xs:long </DiskIopsDefault>
        <StorageProfileIopsLimit> xs:long </StorageProfileIopsLimit>
        <DiskIopsPerGbMax> xs:long </DiskIopsPerGbMax>
        <IgnoreIopsPlacement> xs:boolean </IgnoreIopsPlacement>
    <InheritPvdcDefaultSettings> xs:boolean </InheritPvdcDefaultSettings>
    <StorageUsedMB> xs:long </StorageUsedMB>
    <IopsAllocated> xs:long </IopsAllocated>


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.


Element Type Required Modifiable Since Deprecated Description
Default boolean Yes always 5.1 True if this is default storage profile for this vDC. The default storage profile is used when an object that can specify a storage profile is created with no storage profile specified.
Description string No always 5.1 Optional description.
Enabled boolean No always 5.1 True if this storage profile is enabled for use in the vDC.
InheritPvdcDefaultSettings boolean No always 35.0 True if this Org VDC storage profile should inherit the default settings of the parent PVDC storage profile.
IopsAllocated long No none 9.0 Total IOPS currently allocated to this storage profile
IopsSettings VdcStorageProfileIopsSettingsType No always 9.0 When NOT provided, disk storage placement ignores IOPs considerations; otherwise, this element holds all the disk IOPs related settings, including a subordinate Enabled flag. When that flag is false, disk provisioning using this profile will behave identically as if this element was not provided in the first place.
Limit long Yes always 5.1 Maximum number of storage bytes (scaled by Units) allocated for this profile. A value of 0 is understood to mean "maximum possible."
Link LinkType No none 5.1 A reference to an entity or operation associated with this object.
StorageUsedMB long No none 9.0 Storage used, in Megabytes, by the storage profile
Tasks TasksInProgressType No none 5.1 A list of queued, running, or recently completed tasks associated with this entity.
Units string Yes always 5.1 Scale used to define Limit. NOTE: currently, only "MB" is allowed.
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.


CRUD Operation Description Since Deprecated
create POST /vdcStorageProfile/{id}/action/makeDefault
read GET /vdcStorageProfile/{id} Returns storage class referred by the Id.