AdminVdc

Element:

AdminVdc

Type:

AdminVdcType

Namespace:

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

Description:

Provides an administrative view of a vDC. Includes all members of the Vdc element, and adds several elements that can be viewed and modified only by administrators.

Since:

0.9

Schema:

providerVdc.xsd

Media type(s):

application/vnd.vmware.admin.vdc+xml

Extends:

VdcType

XML Representation:

<AdminVdc xmlns="http://www.vmware.com/vcloud/v1.5" href="xs:anyURI" type="xs:string" name="xs:string" id="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" 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>
    <AllocationModel> xs:string </AllocationModel>
    <StorageCapacity>
        <Units> xs:string </Units>
        <Allocated> xs:long </Allocated>
        <Limit> xs:long </Limit>
        <Used> xs:long </Used>
        <Overhead> xs:long </Overhead>
    </StorageCapacity>
    <ComputeCapacity>
        <Cpu>
            <Units> xs:string </Units>
            <Allocated> xs:long </Allocated>
            <Limit> xs:long </Limit>
            <Used> xs:long </Used>
            <Overhead> xs:long </Overhead>
        </Cpu>
        <Memory>
            <Units> xs:string </Units>
            <Allocated> xs:long </Allocated>
            <Limit> xs:long </Limit>
            <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>
    <VmQuota> xs:int </VmQuota>
    <IsEnabled> xs:boolean </IsEnabled>
    <ResourceGuaranteedMemory> xs:double </ResourceGuaranteedMemory>
    <ResourceGuaranteedCpu> xs:double </ResourceGuaranteedCpu>
    <VCpuInMhz> xs:long </VCpuInMhz>
    <IsThinProvision> xs:boolean </IsThinProvision>
    <NetworkPoolReference href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
    <ProviderVdcReference href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
    <UsesFastProvisioning> xs:boolean </UsesFastProvisioning>
</AdminVdc>

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.
status	int	No	none	0.9	Creation status of vDC could be: READY(1) if it is ready for use NOT_READY(0) if it is in process of creation FAILED_CREATION(-1) in case of creation error

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.
AllocationModel	string	1	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.)
StorageCapacity	CapacityWithUsageType	1	always	0.9	The storage capacity allocated to this vDC.
ComputeCapacity	ComputeCapacityType	1	always	0.9	The compute capacity allocated to this vDC.
ResourceEntities	ResourceEntitiesType	0..1	none	0.9	Read only list of resource entities in this vDC.
AvailableNetworks	AvailableNetworksType	0..1	none	0.9	Read only list of available networks accessible from this vDC.
Capabilities	CapabilitiesType	0..1	none	0.9	Read only list of supported VM hardware capabilities for this vDC.
NicQuota	int	1	always	0.9	Maximum number of virtual NICs allowed in this vDC. Defaults to 0, which specifies an unlimited number.
NetworkQuota	int	1	always	0.9	Maximum number of network objects that can be deployed in this vDC. Defaults to 0, which specifies an unlimited number.
VmQuota	int	0..1	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.
IsEnabled	boolean	0..1	always	0.9	Flag to indicates if this vDC is enabled for use or not, default value is true.
ResourceGuaranteedMemory	double	0..1	always	1.0	Percentage of allocated memory resources guaranteed to vApps deployed in this vDC. For example, if this value is 0.75, then 75% of allocated resources are guaranteed. Required when AllocationModel is AllocationVApp or AllocationPool. Value defaults to 1.0 if the element is empty. Indicates how much VMs memory can be squeezed under the pay-per-vApp model. A factor of 1 means that a VM is guaranteed to get the resources it wants. A factor of 0.75 for example, means that only 75% of the resources are guaranteed.
ResourceGuaranteedCpu	double	0..1	always	1.0	Percentage of allocated CPU resources guaranteed to vApps deployed in this vDC. For example, if this value is 0.75, then 75% of allocated resources are guaranteed. Required when AllocationModel is AllocationVApp or AllocationPool. Value defaults to 1.0 if the element is empty. Indicates how much VMs CPU can be squeezed under the pay-per-vApp model. A factor of 1 means that a VM is guaranteed to get the resources it wants. A factor of 0.75 for example, means that only 75% of the resources are guaranteed.
VCpuInMhz	long	0..1	always	1.0	This is the cpu rating for any virtual CPU that is allocted to a VM in a AllocationVApp vDC. This is a clock frequency, in Megahertz, for each virtual CPU core provisioned from this vDC.
IsThinProvision	boolean	0..1	always	0.9	Boolean to request thin provisioning. Request will be honored only if the underlying datastore supports it. Thin provisioning saves storage space by committing it on demand. This allows over-allocation of storage.
NetworkPoolReference	ReferenceType	0..1	always	0.9	Reference to a network pool in the provider vDC.
ProviderVdcReference	ReferenceType	0..1	always	0.9	A reference to the ProviderVdc from which this vDC is provisioned.
UsesFastProvisioning	boolean	0..1	always	0.9	Boolean to request fast provisioning. Request will be honored only if the underlying datastore supports it. Fast provisioning can reduce the time it takes to create virtual machines by using vSphere linked clones. If you disable fast provisioning, all provisioning operations will result in full clones.

Operations

CRUD	Operation	Description	Since
create	POST /admin/org/{id}/vdcs	Creates a virtual data center in an organization.	0.9
read	GET /admin/vdc/{id}	Retrieves an admin view of virtual data center.	0.9
update	PUT /admin/vdc/{id}	Modifies a Virtual Data Center.	0.9
delete	DELETE /admin/vdc/{id}	Deletes a Virtual Data Center.	0.9
action	POST /admin/vdc/{id}/action/disable	Disables a Virtual Data Center.	1.0
action	POST /admin/vdc/{id}/action/enable	Enables a Virtual Data Center.	1.0