VCloud

Element:
VCloud
Type:
VCloudType
Namespace:
http://www.vmware.com/vcloud/v1.5
Description:
Top level container representing the cloud from the administrator's point of view. Contains Organizations and provider vDCs.
Since:
0.9
Schema:
vCloudEntities.xsd
Media type(s):
application/vnd.vmware.admin.vcloud+xml
Extends:
EntityType
XML Representation:
<VCloud xmlns="http://www.vmware.com/vcloud/v1.5" href="xs:anyURI" type="xs:string" name="xs:string" id="xs:string">
    <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
            rel="xs:string"/>
    <Description> xs:string </Description>
    <Tasks>
        <Task href="xs:anyURI" type="xs:string" name="xs:string" id="xs:string"
                status="xs:string" operation="xs:string" operationName="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"/>
            <Description> xs:string </Description>
            <Tasks> TasksInProgressType </Tasks>
            <Owner href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
            <Error message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string" vendorSpecificErrorCode="xs:string"
                    stackTrace="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>
        </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 Contains the URI to the entity.
type string No always 0.9 Contains the type of the entity.
name string Yes always 0.9 The name 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.

Elements

Element Type Occurrence Modifiable Since Description
VCloudExtension VCloudExtensionType 0..* always 0.9 An optional extension element that can contain an arbitrary number of elements and attributes.
Link LinkType 0..* none 0.9 Optional link to an entity or operation associated with this object.
Description string 0..1 always 0.9 Optional description.
Tasks TasksInProgressType 0..1 none 0.9 A list of queued, running, or recently completed tasks associated with this entity.
OrganizationReferences OrganizationReferencesType 0..1 none 0.9 Container for references to AdminOrg objects in the vCloud.
ProviderVdcReferences ProviderVdcReferencesType 0..1 none 0.9 A container for references to ProviderVdc objects in the vCloud.
RightReferences RightReferencesType 0..1 none 0.9 A container for references to Right objects in the vCloud.
RoleReferences RoleReferencesType 0..1 none 0.9 A container for references to Role objects in the vCloud.
Networks NetworksType 0..1 none 0.9 A container for references to ExternalNetwork objects in the vCloud.

Operations

CRUD Operation Description Since
read GET /admin/ Retrieves the top level entity for the Admin API. 0.9