VMware Cloud Director API - AllocationVappVdcTemplateSpecificationType
AllocationVappVdcTemplateSpecificationType
- Type:
- AllocationVappVdcTemplateSpecificationType
- Namespace:
- http://www.vmware.com/vcloud/v1.5
- Description:
- Specification for a VDC template using the AllocationVApp allocation model.
- Since:
- 5.7
- Schema:
- vCloudEntities.xsd
- Media type(s):
- None
- Extends:
- FlexVdcTemplateSpecificationType
- XML Representation:
-
<AllocationVappVdcTemplateSpecificationType xmlns="http://www.vmware.com/vcloud/v1.5">
<NicQuota> xs:int </NicQuota>
<VmQuota> xs:int </VmQuota>
<ProvisionedNetworkQuota> xs:int </ProvisionedNetworkQuota>
<GatewayConfiguration>
<Gateway 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>
<GatewayBackingRef>
<gatewayId> xs:string </gatewayId>
<VCRef id="xs:string" type="xs:string" name="xs:string"/>
</GatewayBackingRef>
<EdgeGatewayType> EdgeGatewayType </EdgeGatewayType>
<Configuration>
<BackwardCompatibilityMode> xs:boolean </BackwardCompatibilityMode>
<GatewayBackingConfig> xs:string </GatewayBackingConfig>
<GatewayInterfaces>
<GatewayInterface>
<Name> xs:string </Name>
<DisplayName> xs:string </DisplayName>
<Network href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
<InterfaceType> xs:string </InterfaceType>
<SubnetParticipation>
<Gateway> IpAddressType </Gateway>
<Netmask> IpAddressType </Netmask>
<SubnetPrefixLength> xs:int </SubnetPrefixLength>
<IpAddress> IpAddressType </IpAddress>
<IpRanges>
<IpRange>
<StartAddress> IpAddressType </StartAddress>
<EndAddress> IpAddressType </EndAddress>
</IpRange>
</IpRanges>
<UseForDefaultRoute> xs:boolean </UseForDefaultRoute>
<TotalIpCount> xs:int </TotalIpCount>
<AutoAllocateIpRanges> xs:boolean </AutoAllocateIpRanges>
</SubnetParticipation>
<ApplyRateLimit> xs:boolean </ApplyRateLimit>
<InRateLimit> xs:double </InRateLimit>
<OutRateLimit> xs:double </OutRateLimit>
<UseForDefaultRoute> xs:boolean </UseForDefaultRoute>
<Connected> xs:boolean </Connected>
<QuickAddAllocatedIpCount> xs:int </QuickAddAllocatedIpCount>
<NetworkBackingType> xs:string </NetworkBackingType>
</GatewayInterface>
</GatewayInterfaces>
<EdgeGatewayServiceConfiguration>
<NetworkService>
<IsEnabled> xs:boolean </IsEnabled>
</NetworkService>
</EdgeGatewayServiceConfiguration>
<HaEnabled> xs:boolean </HaEnabled>
<UseDefaultRouteForDnsRelay> xs:boolean </UseDefaultRouteForDnsRelay>
<SyslogServerSettings>
<TenantSyslogServerSettings>
<SyslogServerIp> IpAddressType </SyslogServerIp>
</TenantSyslogServerSettings>
</SyslogServerSettings>
<AdvancedNetworkingEnabled> xs:boolean </AdvancedNetworkingEnabled>
<DistributedRoutingEnabled> xs:boolean </DistributedRoutingEnabled>
<FipsModeEnabled> xs:boolean </FipsModeEnabled>
<EdgeClusterConfiguration>
<PrimaryEdgeCluster href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
<SecondaryEdgeCluster href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
</EdgeClusterConfiguration>
</Configuration>
</Gateway>
<Network 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>
<Configuration>
<BackwardCompatibilityMode> xs:boolean </BackwardCompatibilityMode>
<IpScopes>
<IpScope>
<IsInherited> xs:boolean </IsInherited>
<Gateway> IpAddressType </Gateway>
<Netmask> IpAddressType </Netmask>
<SubnetPrefixLength> xs:int </SubnetPrefixLength>
<Dns1> IpAddressType </Dns1>
<Dns2> IpAddressType </Dns2>
<DnsSuffix> xs:string </DnsSuffix>
<IsEnabled> xs:boolean </IsEnabled>
<IpRanges>
<IpRange>
<StartAddress> IpAddressType </StartAddress>
<EndAddress> IpAddressType </EndAddress>
</IpRange>
</IpRanges>
<AllocatedIpAddresses>
<IpAddress> IpAddressType </IpAddress>
</AllocatedIpAddresses>
<SubAllocations href="xs:anyURI" type="xs:string">
<Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
rel="xs:string" model="xs:string"/>
<SubAllocation>
<EdgeGateway href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
<IpRanges>
<IpRange>
<StartAddress> IpAddressType </StartAddress>
<EndAddress> IpAddressType </EndAddress>
</IpRange>
</IpRanges>
</SubAllocation>
</SubAllocations>
</IpScope>
</IpScopes>
<ParentNetwork href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
<FenceMode> xs:string </FenceMode>
<RetainNetInfoAcrossDeployments> xs:boolean </RetainNetInfoAcrossDeployments>
<Features>
<NetworkService>
<IsEnabled> xs:boolean </IsEnabled>
</NetworkService>
</Features>
<SyslogServerSettings>
<SyslogServerIp1> IpAddressType </SyslogServerIp1>
<SyslogServerIp2> IpAddressType </SyslogServerIp2>
</SyslogServerSettings>
<RouterInfo>
<ExternalIp> IpAddressType </ExternalIp>
</RouterInfo>
<SubInterface> xs:boolean </SubInterface>
<DistributedInterface> xs:boolean </DistributedInterface>
<ServiceInterface> xs:boolean </ServiceInterface>
<GuestVlanAllowed> xs:boolean </GuestVlanAllowed>
<Connected> xs:boolean </Connected>
<DualStackNetwork> xs:boolean </DualStackNetwork>
</Configuration>
<ProviderInfo> xs:string </ProviderInfo>
<EdgeGateway href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
<ServiceConfig>
<NetworkService>
<IsEnabled> xs:boolean </IsEnabled>
</NetworkService>
</ServiceConfig>
<IsShared> xs:boolean </IsShared>
<VimPortGroupRef>
<VimServerRef href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
<MoRef> xs:string </MoRef>
<VimObjectType> xs:string </VimObjectType>
</VimPortGroupRef>
</Network>
</GatewayConfiguration>
<StorageProfile href="xs:anyURI" type="xs:string" id="xs:string" operationKey="xs:string"
name="xs:string">
<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>
<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>
<StorageUsedMB> xs:long </StorageUsedMB>
<IopsAllocated> xs:long </IopsAllocated>
</StorageProfile>
<IsElastic> xs:boolean </IsElastic>
<IncludeMemoryOverhead> xs:boolean </IncludeMemoryOverhead>
<CpuAllocationMhz> xs:long </CpuAllocationMhz>
<CpuLimitMhzPerVcpu> xs:long </CpuLimitMhzPerVcpu>
<CpuLimitMhz> xs:long </CpuLimitMhz>
<MemoryAllocationMB> xs:long </MemoryAllocationMB>
<MemoryLimitMb> xs:long </MemoryLimitMb>
<CpuGuaranteedPercentage> xs:long </CpuGuaranteedPercentage>
<MemoryGuaranteedPercentage> xs:long </MemoryGuaranteedPercentage>
<CpuAllocationMhz> xs:long </CpuAllocationMhz>
<CpuLimitMhzPerVcpu> xs:long </CpuLimitMhzPerVcpu>
<CpuLimitMhz> xs:long </CpuLimitMhz>
<MemoryAllocationMB> xs:long </MemoryAllocationMB>
<MemoryLimitMb> xs:long </MemoryLimitMb>
<CpuGuaranteedPercentage> xs:long </CpuGuaranteedPercentage>
<MemoryGuaranteedPercentage> xs:long </MemoryGuaranteedPercentage>
</AllocationVappVdcTemplateSpecificationType>
-
Elements
-
Element Type Required Modifiable Since Deprecated Description CpuAllocationMhz long No none 5.7 CPU allocation in Mhz CpuAllocationMhz long No none 5.7 CPU allocation in Mhz CpuGuaranteedPercentage long No always 5.7 Percentage of allocated CPU resources guaranteed to vApps deployed in this vDC. For example, if this value is 75, then 75% of allocated resources are guaranteed. Required when AllocationModel is AllocationVApp or AllocationPool. Value defaults to 100 if the element is empty. CpuGuaranteedPercentage long No always 5.7 Percentage of allocated CPU resources guaranteed to vApps deployed in this vDC. For example, if this value is 75, then 75% of allocated resources are guaranteed. Required when AllocationModel is AllocationVApp or AllocationPool. Value defaults to 100 if the element is empty. CpuLimitMhz long No none 35.2 CPU limit in Mhz CpuLimitMhz long No none 35.2 CPU limit in Mhz CpuLimitMhzPerVcpu long No none 5.7 vCPU speed in Mhz CpuLimitMhzPerVcpu long No none 5.7 vCPU speed in Mhz GatewayConfiguration VdcTemplateSpecificationGatewayConfigurationType No always 5.7 Defines a gateway and NAT Routed organization VDC network to be created. IncludeMemoryOverhead boolean No always 35.0 Set to true to indicate if the FLEX vDC is to include memory overhead into its accounting for admission control. This field can only be set on input for FLEX vDC templates and Allocation VApp vDC templates. However, this field will be returned properly when read. IsElastic boolean No always 35.0 Set to true to indicate if the FLEX vDC is to be elastic. This field can only be set on input for FLEX vDC templates and Allocation VApp vDC templates. However, this field will be returned properly when read. MemoryAllocationMB long No none 5.7 Memory allocation in MB MemoryAllocationMB long No none 5.7 Memory allocation in MB MemoryGuaranteedPercentage long No always 5.7 Percentage of allocated memory resources guaranteed to vApps deployed in this vDC. For example, if this value is 75, then 75% of allocated resources are guaranteed. Required when AllocationModel is AllocationVApp or AllocationPool. Value defaults to 100 if the element is empty. MemoryGuaranteedPercentage long No always 5.7 Percentage of allocated memory resources guaranteed to vApps deployed in this vDC. For example, if this value is 75, then 75% of allocated resources are guaranteed. Required when AllocationModel is AllocationVApp or AllocationPool. Value defaults to 100 if the element is empty. MemoryLimitMb long No none 35.2 Memory limit in Mb MemoryLimitMb long No none 35.2 Memory limit in Mb NicQuota int Yes always 5.7 Maximum number of virtual NICs allowed in this vDC. Defaults to 0, which specifies an unlimited number. ProvisionedNetworkQuota int Yes always 5.7 Maximum number of network objects that can be deployed in this VDC. Defaults to 0, which means no networks can be deployed. StorageProfile VdcStorageProfileType Yes always 5.7 A set of name of Storage Profiles, with corresponding limit value, that all Provider VDCs must have, and that are selected at the time of VDC Template instantiation. VmQuota int No always 5.7 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.