VMware Cloud Director API - VCloud

VCloudType

Element:

VCloud

Type:

VCloudType

Namespace:

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

Description:

Represents the admin view of a cloud.

Since:

0.9

Schema:

vCloudEntities.xsd

Media type(s):

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

Extends:

EntityType

XML Representation:

<VCloud xmlns="http://www.vmware.com/vcloud/v1.5" href="xs:anyURI" type="xs:string" id="xs:string" operationKey="xs:string"
        name="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>
    <OrganizationReferences>
        <OrganizationReference href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
    </OrganizationReferences>
    <ProviderVdcReferences>
        <ProviderVdcReference href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
    </ProviderVdcReferences>
    <RightReferences>
        <RightReference href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
    </RightReferences>
    <RoleReferences>
        <RoleReference href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
    </RoleReferences>
    <Networks>
        <Network href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
    </Networks>
</VCloud>

Attributes

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

Elements

Element	Type	Required	Modifiable	Since	Deprecated	Description
Description	string	No	always	0.9		Optional description.
Link	LinkType	No	none	0.9		A reference to an entity or operation associated with this object.
Networks	NetworksType	No	none	0.9		A container for references to ExternalNetwork objects in the system.
OrganizationReferences	OrganizationReferencesType	No	none	0.9		Container for references to AdminOrg objects in the system.
ProviderVdcReferences	ProviderVdcReferencesType	No	none	0.9		A container for references to ProviderVdc objects in the system.
RightReferences	RightReferencesType	No	none	0.9	33.0	A container for references to Right objects in the system.
RoleReferences	RoleReferencesType	No	none	0.9	33.0	A container for references to Role objects in the system.
Tasks	TasksInProgressType	No	none	0.9		A list of queued, running, or recently completed tasks associated with this entity.
VCloudExtension	VCloudExtensionType	No	always	0.9		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
read	GET /admin/	Retrieve an administrative view of a cloud.	0.9