VdcType

Element:

Vdc

Type:

VdcType

Namespace:

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

Description:

Represents the user view of an organization vDC.

Since:

0.9

Schema:

vdc.xsd

Media type(s):

application/vnd.vmware.vcloud.vdc+xml

Extends:

EntityType

XML Representation:

<Vdc 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">
    <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" 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"/>
            <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>
            <Result>
                <ResultContent> ... </ResultContent>
            </Result>
        </Task>
    </Tasks>
    <AllocationModel> xs:string </AllocationModel>
    <ComputeCapacity>
        <Cpu>
            <Units> xs:string </Units>
            <Allocated> xs:long </Allocated>
            <Limit> xs:long </Limit>
            <Reserved> xs:long </Reserved>
            <Used> xs:long </Used>
            <Overhead> xs:long </Overhead>
        </Cpu>
        <Memory>
            <Units> xs:string </Units>
            <Allocated> xs:long </Allocated>
            <Limit> xs:long </Limit>
            <Reserved> xs:long </Reserved>
            <Used> xs:long </Used>
            <Overhead> xs:long </Overhead>
        </Memory>
    </ComputeCapacity>
    <ResourceEntities>
        <ResourceEntity href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                status="xs:int"/>
    </ResourceEntities>
    <AvailableNetworks>
        <Network href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
    </AvailableNetworks>
    <Capabilities>
        <SupportedHardwareVersions>
            <SupportedHardwareVersion> SupportedHardwareVersionType </SupportedHardwareVersion>
        </SupportedHardwareVersions>
    </Capabilities>
    <NicQuota> xs:int </NicQuota>
    <NetworkQuota> xs:int </NetworkQuota>
    <UsedNetworkCount> xs:int </UsedNetworkCount>
    <VmQuota> xs:int </VmQuota>
    <IsEnabled> xs:boolean </IsEnabled>
    <VdcStorageProfiles>
        <VdcStorageProfile href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
    </VdcStorageProfiles>
    <VCpuInMhz2> xs:long </VCpuInMhz2>
</Vdc>

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.
status	int	No	none	0.9	Creation status of the vDC. One of: 0 (The vDC is still being created) 1 (The vDC is ready) -1 (There was an error while creating the vDC).

Elements

Element	Type	Required	Modifiable	Since	Description
AllocationModel	string	No	always	0.9	The allocation model used by this vDC. One of: AllocationVApp (Pay as you go. Resources are committed to a vDC only when vApps are created in it. When you use this allocation model, any Limit values you specify for Memory and CPU are ignored on create and returned as 0 on retrieve.) AllocationPool (Only a percentage of the resources you allocate are committed to the organization vDC.) ReservationPool (All the resources you allocate are committed as a pool to the organization vDC. vApps in vDCs that support this allocation model can specify values for resource and limit.)
AvailableNetworks	AvailableNetworksType	No	none	0.9	Read-only list of organization vDC networks in this vDC.
Capabilities	CapabilitiesType	No	none	0.9	Read-only list of VM hardware capabilities supported in this vDC.
ComputeCapacity	ComputeCapacityType	No	always	0.9	The compute capacity allocated to this vDC.
Description	string	No	always	0.9	Optional description.
IsEnabled	boolean	No	always	0.9	True if this vDC is enabled for use. Read-only in the user view. Modifiable in the admin view.
Link	LinkType	No	none	0.9	A reference to an entity or operation associated with this object.
NetworkQuota	int	No	always	0.9	Maximum number of network objects that can be deployed in this vDC. Defaults to 0, which specifies an unlimited number.
NicQuota	int	No	always	0.9	Maximum number of virtual NICs allowed in this vDC. Defaults to 0, which specifies an unlimited number.
ResourceEntities	ResourceEntitiesType	No	none	0.9	Read-only list of resource entities in this vDC.
Tasks	TasksInProgressType	No	none	0.9	A list of queued, running, or recently completed tasks associated with this entity.
UsedNetworkCount	int	No	always	5.1	Number of networks in use for/by this vDC.
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.
VCpuInMhz2	long	No	always	5.7	Specifies the clock frequency, in Megahertz, for any virtual CPU that is allocated to a VM. A VM with 2 vCPUs will consume twice as much of this value. Ignored for ReservationPool. Required when AllocationModel is AllocationVApp or AllocationPool, and may not be less than 256 MHz. Defaults to 1000 MHz if the element is empty or missing.
VdcStorageProfiles	VdcStorageProfilesType	No	none	5.1	Storage profiles supported in this vDC.
VmQuota	int	No	always	0.9	The quota of VMs that can be created in this vDC. Includes VMs in both vApps and vApp templates, deployed, or otherwise. Defaults to 0, which specifies an unlimited number.

Operations

CRUD	Operation	Description	Since	Deprecated
read	GET /vdc/{id}	Retrieve a vDC.	0.9
update	PUT /vdc/{id}	Modify the name and/or description of an organization vDC.	5.7
delete	DELETE /vdc/{id}	Delete an organization vDC.	5.7
action	POST /vdc/{id}/action/captureVApp	Create a vApp template from a vApp.	0.9	Since 5.5
action	POST /vdc/{id}/action/cloneVApp	Create a copy of a vApp.	0.9
action	POST /vdc/{id}/action/cloneVAppTemplate	Create a copy of a vApp template.	0.9
action	POST /vdc/{id}/action/composeVApp	Compose a vApp from existing virtual machines.	0.9
action	POST /vdc/{id}/action/instantiateOvf	Instantiate a vApp or VM from an OVF	5.5
action	POST /vdc/{id}/action/instantiateVAppTemplate	Create a vApp from a vApp template	0.9
action	POST /vdc/{id}/action/uploadVAppTemplate	Upload an OVF package to create a vApp template	0.9	Since 5.5