VMware Cloud Director API - Datastore

DatastoreType

Element:

Datastore

Type:

DatastoreType

Namespace:

http://www.vmware.com/vcloud/extension/v1.5

Description:

Represents datastore object.

Since:

1.5

Schema:

vmwextensions.xsd

Media type(s):

application/vnd.vmware.admin.datastore+json
application/vnd.vmware.admin.datastore+xml

Extends:

EntityType

XML Representation:

<Datastore xmlns="http://www.vmware.com/vcloud/extension/v1.5" xmlns:vcloud_v1.5="http://www.vmware.com/vcloud/v1.5" href="xs:anyURI" type="xs:string" id="xs:string" operationKey="xs:string"
        name="xs:string">
    <vcloud_v1.5:Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
            rel="xs:string" model="xs:string"/>
    <Description> xs:string </Description>
    <vcloud_v1.5:Tasks>
        <vcloud_v1.5: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">
            <vcloud_v1.5:Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                    rel="xs:string" model="xs:string"/>
            <Description> xs:string </Description>
            <vcloud_v1.5:Tasks> vcloud_v1.5:TasksInProgressType </vcloud_v1.5:Tasks>
            <vcloud_v1.5:Owner href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
            <vcloud_v1.5:Error stackTrace="xs:string" message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string"
                    vendorSpecificErrorCode="xs:string">
                <vcloud_v1.5:TenantError message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string" vendorSpecificErrorCode="xs:string"/>
            </vcloud_v1.5:Error>
            <vcloud_v1.5:User href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
            <vcloud_v1.5:Organization href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
            <Progress> xs:int </Progress>
            <Params> ... </Params>
            <Details> xs:string </Details>
            <vcloud_v1.5:VcTaskList>
                <vcloud_v1.5: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"/>
            </vcloud_v1.5:VcTaskList>
            <vcloud_v1.5:Result>
                <ResultContent> ... </ResultContent>
                <vcloud_v1.5:ResultReference href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
            </vcloud_v1.5:Result>
        </vcloud_v1.5:Task>
    </vcloud_v1.5:Tasks>
    <VimObjectRef>
        <vcloud_v1.5:VimServerRef href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
        <MoRef> xs:string </MoRef>
        <VimObjectType> xs:string </VimObjectType>
    </VimObjectRef>
    <Enabled> xs:boolean </Enabled>
    <Busy> xs:boolean </Busy>
    <VAAIForFpEnabled> xs:boolean </VAAIForFpEnabled>
    <ThresholdYellowGb> DatastoreType/ThresholdYellowGb </ThresholdYellowGb>
    <ThresholdRedGb> DatastoreType/ThresholdRedGb </ThresholdRedGb>
    <SystemMessages> xs:string </SystemMessages>
    <DatastoreFsType> xs:string </DatastoreFsType>
    <VcDisplayName> xs:string </VcDisplayName>
    <MountHost> xs:string </MountHost>
    <MountDirectory> xs:string </MountDirectory>
    <TotalCapacityMb> xs:double </TotalCapacityMb>
    <TotalCapacityGb> xs:double </TotalCapacityGb>
    <UsedCapacityMb> xs:double </UsedCapacityMb>
    <UsedCapacityGb> xs:double </UsedCapacityGb>
    <UsedCapacityPercent> xs:double </UsedCapacityPercent>
    <ProvisionedSpaceMb> xs:double </ProvisionedSpaceMb>
    <ProvisionedSpaceGb> xs:double </ProvisionedSpaceGb>
    <RequestedStorageMb> xs:double </RequestedStorageMb>
    <RequestedStorageGb> xs:double </RequestedStorageGb>
    <vimPropertyPageUrl> xs:string </vimPropertyPageUrl>
    <Members>
        <VimObjectRef>
            <vcloud_v1.5:VimServerRef href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
            <MoRef> xs:string </MoRef>
            <VimObjectType> xs:string </VimObjectType>
        </VimObjectRef>
    </Members>
    <Distributed> xs:boolean </Distributed>
    <DistributionHealth> xs:string </DistributionHealth>
</Datastore>

Attributes

Attribute	Type	Required	Modifiable	Since	Description
href	anyURI	No	always	1.5	The URI of the entity.
type	string	No	always	1.5	The MIME type of the entity.
id	string	No	none	1.5	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	1.5	The name of the entity.

Elements

Element	Type	Required	Modifiable	Since	Description
Busy	boolean	No	none	1.5	Indicates whether the datastore is busy.
DatastoreFsType	string	No	none	1.5	Filesystem type of the datastore.
Description	string	No	always	1.5	Optional description.
Distributed	boolean	No	none	39.0	Read-only field that is true if this datastore has been marked as distributed in VCenter server. A distributed datastore is expected to have peers in other sites that are kept in sync via some external mechanism and can be leveraged to facilitate sharing of catalog contents.
DistributionHealth	string	No	none	39.0	Read-only field that represents the health of the distribution. One of "Healthy" or "Degraded." Distribution health of a datastore is degraded if any peer site's heartbeat is not detected on this datastore in the last X minutes. Where X is a configurable property and defaults to 5 minutes.
Enabled	boolean	No		1.5	Indicates whether the datastore is enabled.
Link	LinkType	No	none	1.5	A reference to an entity or operation associated with this object.
Members	VimObjectRefsType	No	none	5.1	Member datastores of a datastore cluster. Standalone datastore has empty collection.
MountDirectory	string	No	none	1.5	Datastore mountpoint.
MountHost	string	No	none	1.5	Datastore mount host.
ProvisionedSpaceGb	double	No	none	1.5	Provisioned capacity, in GB, of the datastore.
ProvisionedSpaceMb	double	No	none	1.5	Provisioned capacity, in MB, of the datastore.
RequestedStorageGb	double	No	none	1.5	Requested storage, in GB, for all the vCloud Director VMs on the datastore.
RequestedStorageMb	double	No	none	1.5	Requested storage, in MB, for all the vCloud Director VMs on the datastore.
SystemMessages	string	No	none	1.5	System messages for the datastore.
Tasks	TasksInProgressType	No	none	1.5	A list of queued, running, or recently completed tasks associated with this entity.
ThresholdRedGb	DatastoreType/ThresholdRedGb	Yes	always	1.5	Minimum free space, in GB, to trigger a red status for the datastore.
ThresholdYellowGb	DatastoreType/ThresholdYellowGb	Yes	always	1.5	Minimum free space, in GB, to trigger a yellow status for the datastore.
TotalCapacityGb	double	No	none	1.5	Total capacity, in GB, of the datastore.
TotalCapacityMb	double	No	none	1.5	Total capacity, in MB, of the datastore.
UsedCapacityGb	double	No	none	1.5	Used capacity, in GB, of the datastore.
UsedCapacityMb	double	No	none	1.5	Used capacity, in MB, of the datastore.
UsedCapacityPercent	double	No	none	1.5	Used capacity of the datastore, as a percentage.
VAAIForFpEnabled	boolean	No	always	5.1	Indicates whether the VAAI native snapshots for Fast Provisioning is enabled.
VCloudExtension	VCloudExtensionType	No	always	1.5	An optional extension element that can contain an arbitrary number of elements and attributes. Not related to extension services.
VcDisplayName	string	No	none	1.5	vCenter display name of the datastore.
VimObjectRef	VimObjectRefType (extension/v1.5)	No	none	1.5	The VIM object reference to this datastore.
vimPropertyPageUrl	string	No	none	1.5	URL to the VIM property page of the datastore host.

Operations

CRUD	Operation	Description	Since
create	POST /admin/extension/datastore/{id}/action/disable	Disable a datastore.	1.5
create	POST /admin/extension/datastore/{id}/action/enable	Enable a datastore.	1.5
read	GET /admin/extension/datastore/{id}	Retrieve a datastore.	1.5
update	PUT /admin/extension/datastore/{id}	Update datastore properties, including name, description, and low disk space thresholds.	1.5