VMware Cloud Director API - ProviderVdc

VMware Cloud Director API - ProviderVdc

ProviderVdcType

Element:
ProviderVdc
Type:
ProviderVdcType
Namespace:
http://www.vmware.com/vcloud/v1.5
Description:
Represents a Provider vDC.
Since:
0.9
Schema:
providerVdc.xsd
Media type(s):
application/vnd.vmware.admin.providervdc+xml
application/vnd.vmware.admin.providervdc+json
Extends:
EntityType
XML Representation:
<ProviderVdc 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" 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>
    <ComputeCapacity>
        <Cpu>
            <Units> xs:string </Units>
            <Allocation> xs:long </Allocation>
            <Reserved> xs:long </Reserved>
            <Total> xs:long </Total>
            <Used> xs:long </Used>
            <Overhead> xs:long </Overhead>
        </Cpu>
        <Memory>
            <Units> xs:string </Units>
            <Allocation> xs:long </Allocation>
            <Reserved> xs:long </Reserved>
            <Total> xs:long </Total>
            <Used> xs:long </Used>
            <Overhead> xs:long </Overhead>
        </Memory>
        <IsElastic> xs:boolean </IsElastic>
        <IsHA> xs:boolean </IsHA>
    </ComputeCapacity>
    <AvailableNetworks>
        <Network href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
    </AvailableNetworks>
    <StorageProfiles>
        <ProviderVdcStorageProfile href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
    </StorageProfiles>
    <Capabilities>
        <SupportedHardwareVersions>
            <SupportedHardwareVersion name="xs:string" href="xs:anyURI" default="xs:boolean" type="xs:string"/>
        </SupportedHardwareVersions>
    </Capabilities>
    <Vdcs>
        <Vdc href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
    </Vdcs>
    <IsEnabled> xs:boolean </IsEnabled>
    <NetworkPoolReferences>
        <NetworkPoolReference href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
    </NetworkPoolReferences>
</ProviderVdc>

Attributes

Attribute Type Required Modifiable Since Deprecated 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 provider VDC. One of:
-1 (creation failed)
0 (not ready)
1 (ready)
2 (unknown)
3 (unrecognized)

Elements

Element Type Required Modifiable Since Deprecated Description
AvailableNetworks AvailableNetworksType No none 0.9 Read-only list of available networks.
Capabilities CapabilitiesType No none 0.9 Read-only list of virtual hardware versions supported by this Provider vDC.
ComputeCapacity RootComputeCapacityType No none 0.9 Read-only indicator of CPU and memory capacity.
Description string No always 0.9 Optional description.
IsEnabled boolean No always 0.9 True if this Provider vDC is enabled and can provide resources to organization vDCs. A Provider vDC is always enabled on creation.
Link LinkType No none 0.9 A reference to an entity or operation associated with this object.
NetworkPoolReferences NetworkPoolReferencesType No none 0.9 Read-only list of network pools used by this Provider vDC.
StorageProfiles ProviderVdcStorageProfilesType No none 5.1 Container for references to vSphere storage profiles available to this Provider vDC.
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.
Vdcs VdcsType No 0.9 38.0 Read-only list of organization vDCs backed by this Provider vDC.

Operations

CRUD Operation Description Since Deprecated
read GET /admin/providervdc/{id} Retrieve a provider vDC. 0.9