VMware Cloud Director API - CreateVdcParams

VMware Cloud Director API - CreateVdcParams

CreateVdcParamsType

Element:
CreateVdcParams
Type:
CreateVdcParamsType
Namespace:
http://www.vmware.com/vcloud/v1.5
Description:
Parameters for creating an organization vDC.
Since:
5.1
Schema:
providerVdc.xsd
Media type(s):
application/vnd.vmware.admin.createVdcParams+json
application/vnd.vmware.admin.createVdcParams+xml
Extends:
ParamsType
XML Representation:
<CreateVdcParams xmlns="http://www.vmware.com/vcloud/v1.5" xmlns:extension_v1.5="http://www.vmware.com/vcloud/extension/v1.5" name="xs:string">
    <Description> xs:string </Description>
    <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>
            <ReservationUsed> xs:long </ReservationUsed>
        </Cpu>
        <Memory>
            <Units> xs:string </Units>
            <Allocated> xs:long </Allocated>
            <Limit> xs:long </Limit>
            <Reserved> xs:long </Reserved>
            <Used> xs:long </Used>
            <ReservationUsed> xs:long </ReservationUsed>
        </Memory>
    </ComputeCapacity>
    <NicQuota> xs:int </NicQuota>
    <NetworkQuota> xs:int </NetworkQuota>
    <VmQuota> xs:int </VmQuota>
    <IsEnabled> xs:boolean </IsEnabled>
    <VdcStorageProfile>
        <Enabled> xs:boolean </Enabled>
        <Units> xs:string </Units>
        <Limit> xs:long </Limit>
        <Default> xs:boolean </Default>
        <IopsSettings>
            <Enabled> xs:boolean </Enabled>
            <DiskIopsMax> xs:long </DiskIopsMax>
            <DiskIopsDefault> xs:long </DiskIopsDefault>
            <StorageProfileIopsLimit> xs:long </StorageProfileIopsLimit>
            <DiskIopsPerGbMax> xs:long </DiskIopsPerGbMax>
            <IgnoreIopsPlacement> xs:boolean </IgnoreIopsPlacement>
        </IopsSettings>
        <InheritPvdcDefaultSettings> xs:boolean </InheritPvdcDefaultSettings>
        <ProviderVdcStorageProfile href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
    </VdcStorageProfile>
    <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"/>
    <extension_v1.5:ResourcePoolRefs>
        <extension_v1.5:VimObjectRef>
            <VimServerRef href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
            <MoRef> xs:string </MoRef>
            <VimObjectType> xs:string </VimObjectType>
        </extension_v1.5:VimObjectRef>
    </extension_v1.5:ResourcePoolRefs>
    <UsesFastProvisioning> xs:boolean </UsesFastProvisioning>
    <OverCommitAllowed> xs:boolean </OverCommitAllowed>
    <VmDiscoveryEnabled> xs:boolean </VmDiscoveryEnabled>
    <DefaultComputePolicy href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
    <MaxComputePolicy href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
    <IsElastic> xs:boolean </IsElastic>
    <IncludeMemoryOverhead> xs:boolean </IncludeMemoryOverhead>
    <VappNetworkStandbyEnabled> xs:boolean </VappNetworkStandbyEnabled>
    <VappNatTypeReflexiveEnabled> xs:boolean </VappNatTypeReflexiveEnabled>
    <NetworkingTenancyEnabled> xs:boolean </NetworkingTenancyEnabled>
</CreateVdcParams>

Attributes

Attribute Type Required Modifiable Since Deprecated Description
name string No always 5.1 Typically used to name or identify the subject of the request. For example, the name of the object being created or modified.

Elements

Element Type Required Modifiable Since Deprecated Description
AllocationModel string Yes always 5.1 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.)
FLEX (A generic type of VDC where all the settings are in full control of the creator.)
ComputeCapacity ComputeCapacityType Yes always 5.1 The compute capacity allocated to this vDC.
DefaultComputePolicy ReferenceType No none 32.0 Default vDC compute policy in this vDC. It is mandatory for FLEX type of VDCs.
Description string No always 5.1 Optional description.
IncludeMemoryOverhead boolean No always 32.0 Set to true to indicate if the FLEX vDC is to include memory overhead into its accounting for admission control. This is an optional field and is useful only for FLEX vDC creation.
IsElastic boolean No always 32.0 Set to true to indicate if the FLEX vDC is to be elastic. This is an optional field and is useful only for FLEX vDC creation.
IsEnabled boolean No always 5.1 True if this vDC is enabled for use by the organization vDCs. A vDC is always enabled on creation.
IsThinProvision boolean No always 5.1 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.
MaxComputePolicy ReferenceType No none 32.0 Maximum compute policy in this vDC. If not specified then the default policy would also be considered as maximum policy.
NetworkPoolReference ReferenceType No always 5.1 Reference to a network pool in the Provider vDC. Required if this vDC will contain routed or isolated networks.
NetworkQuota int No always 5.1 Maximum number of network objects that can be deployed in this vDC. Defaults to 0, which means no networks can be deployed.
NetworkingTenancyEnabled boolean No always 38.1 Whether this Org VDC is within a NSX Project. If not set, this value defaults to the Org Networking Setting for NSX Tenancy, but will only be enabled if the Provider VDC supports NSX Tenancy. If enabled, the network pool is configured automatically and cannot be manually specified.
NicQuota int No always 5.1 Maximum number of virtual NICs allowed in this vDC. Defaults to 0, which specifies an unlimited number.
OverCommitAllowed boolean No always 5.5 Set to false to disallow creation of the VDC if the AllocationModel is AllocationPool or ReservationPool and the ComputeCapacity you specified is greater than what the backing Provider VDC can supply. Defaults to true if empty or missing.
ProviderVdcReference ReferenceType Yes always 5.1 A reference to the Provider vDC from which this organization vDC is provisioned.
ResourceGuaranteedCpu double No always 5.1 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.
ResourceGuaranteedMemory double No always 5.1 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.
ResourcePoolRefs VimObjectRefsType No none 22.0 Optional list of additional resource pools to back this Organization vDC. Specified resource pools must be backed by different clusters, and must not back an existing Organization vDC.
UsesFastProvisioning boolean No always 5.1 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.
VCloudExtension VCloudExtensionType No always 5.1 An optional extension element that can contain an arbitrary number of elements and attributes. Not related to extension services.
VCpuInMhz long No always 5.1 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. As of API version 5.7 this element became redundant with the "VCpuInMhz2" element in VdcType. Both elements are set to the same value in responses. However, on requests this element's value is the one that's used.
VappNatTypeReflexiveEnabled boolean No always 38.0 Whether vApp network NAT rules will be created using reflexive NAT or SNAT/DNAT. True means vApp network NAT rules will use reflexive NAT. False means they will use a pair of SNAT and DNAT rules. If not set, this value defaults to false.
VappNetworkStandbyEnabled boolean No always 38.0 Whether vApp networks have Standby Relocation enabled in NSX-T. True means Standby Relocation in NSX-T is enabled in case of edge node failure. False means it is not enabled. Not required, default is false.
VdcStorageProfile VdcStorageProfileParamsType Yes none 5.1 Storage profiles supported by this vDC.
VmDiscoveryEnabled boolean No always 27.0 True if discovery of vCenter VMs is enabled for resource pools backing this vDC. If left unspecified, the actual behaviour depends on enablement at the organization level and at the system level.
VmQuota int No always 5.1 The maximum number of VMs that can be created in this vDC. Includes deployed and undeployed VMs in vApps and vApp templates. Defaults to 0, which specifies an unlimited number.

Operations

CRUD Operation Description Since Deprecated
as input POST /admin/org/{id}/vdcsparams Creates an organization vDC. 5.1