VMware Cloud Director API - VMWAllocationPoolVdcTemplateSpecificationType
VMWAllocationPoolVdcTemplateSpecificationType
- Type:
- VMWAllocationPoolVdcTemplateSpecificationType
- Namespace:
- http://www.vmware.com/vcloud/extension/v1.5
- Description:
- Specification for a VDC template using the AllocationPool allocation model.
- Since:
- 5.7
- Schema:
- vmwextensions.xsd
- Media type(s):
- None
- Extends:
- VMWVdcTemplateSpecificationType
- XML Representation:
-
<VMWAllocationPoolVdcTemplateSpecificationType xmlns="http://www.vmware.com/vcloud/extension/v1.5" xmlns:vcloud_v1.5="http://www.vmware.com/vcloud/v1.5">
<NicQuota> xs:int </NicQuota>
<VmQuota> xs:int </VmQuota>
<ProvisionedNetworkQuota> xs:int </ProvisionedNetworkQuota>
<vcloud_v1.5:GatewayConfiguration>
<vcloud_v1.5:Gateway href="xs:anyURI" type="xs:string" id="xs:string" operationKey="xs:string"
name="xs:string" status="xs:int">
<vcloud_v1.5:Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
rel="xs:string" model="xs:string"/>
<Description> xs:string </Description>
<vcloud_v1.5:Tasks>
<vcloud_v1.5: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">
<vcloud_v1.5:Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
rel="xs:string" model="xs:string"/>
<Description> xs:string </Description>
<vcloud_v1.5:Tasks> vcloud_v1.5:TasksInProgressType </vcloud_v1.5:Tasks>
<vcloud_v1.5:Owner href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
<vcloud_v1.5:Error stackTrace="xs:string" message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string"
vendorSpecificErrorCode="xs:string">
<vcloud_v1.5:TenantError message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string" vendorSpecificErrorCode="xs:string"/>
</vcloud_v1.5:Error>
<vcloud_v1.5:User href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
<vcloud_v1.5:Organization href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
<Progress> xs:int </Progress>
<Params> ... </Params>
<Details> xs:string </Details>
<vcloud_v1.5:VcTaskList>
<vcloud_v1.5: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"/>
</vcloud_v1.5:VcTaskList>
<vcloud_v1.5:Result>
<ResultContent> ... </ResultContent>
<vcloud_v1.5:ResultReference href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
</vcloud_v1.5:Result>
</vcloud_v1.5:Task>
</vcloud_v1.5:Tasks>
<vcloud_v1.5:GatewayBackingRef>
<gatewayId> xs:string </gatewayId>
<vcloud_v1.5:VCRef id="xs:string" type="xs:string" name="xs:string"/>
</vcloud_v1.5:GatewayBackingRef>
<vcloud_v1.5:EdgeGatewayType> vcloud_v1.5:EdgeGatewayType </vcloud_v1.5:EdgeGatewayType>
<vcloud_v1.5:Configuration>
<BackwardCompatibilityMode> xs:boolean </BackwardCompatibilityMode>
<GatewayBackingConfig> xs:string </GatewayBackingConfig>
<vcloud_v1.5:GatewayInterfaces>
<vcloud_v1.5:GatewayInterface>
<Name> xs:string </Name>
<DisplayName> xs:string </DisplayName>
<vcloud_v1.5:Network href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
<InterfaceType> xs:string </InterfaceType>
<vcloud_v1.5:SubnetParticipation>
<vcloud_v1.5:Gateway> vcloud_v1.5:IpAddressType </vcloud_v1.5:Gateway>
<vcloud_v1.5:Netmask> vcloud_v1.5:IpAddressType </vcloud_v1.5:Netmask>
<SubnetPrefixLength> xs:int </SubnetPrefixLength>
<vcloud_v1.5:IpAddress> vcloud_v1.5:IpAddressType </vcloud_v1.5:IpAddress>
<vcloud_v1.5:IpRanges>
<vcloud_v1.5:IpRange>
<vcloud_v1.5:StartAddress> vcloud_v1.5:IpAddressType </vcloud_v1.5:StartAddress>
<vcloud_v1.5:EndAddress> vcloud_v1.5:IpAddressType </vcloud_v1.5:EndAddress>
</vcloud_v1.5:IpRange>
</vcloud_v1.5:IpRanges>
<UseForDefaultRoute> xs:boolean </UseForDefaultRoute>
<TotalIpCount> xs:int </TotalIpCount>
<AutoAllocateIpRanges> xs:boolean </AutoAllocateIpRanges>
</vcloud_v1.5: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>
</vcloud_v1.5:GatewayInterface>
</vcloud_v1.5:GatewayInterfaces>
<vcloud_v1.5:EdgeGatewayServiceConfiguration>
<vcloud_v1.5:NetworkService>
<IsEnabled> xs:boolean </IsEnabled>
</vcloud_v1.5:NetworkService>
</vcloud_v1.5:EdgeGatewayServiceConfiguration>
<HaEnabled> xs:boolean </HaEnabled>
<UseDefaultRouteForDnsRelay> xs:boolean </UseDefaultRouteForDnsRelay>
<vcloud_v1.5:SyslogServerSettings>
<vcloud_v1.5:TenantSyslogServerSettings>
<vcloud_v1.5:SyslogServerIp> vcloud_v1.5:IpAddressType </vcloud_v1.5:SyslogServerIp>
</vcloud_v1.5:TenantSyslogServerSettings>
</vcloud_v1.5:SyslogServerSettings>
<AdvancedNetworkingEnabled> xs:boolean </AdvancedNetworkingEnabled>
<DistributedRoutingEnabled> xs:boolean </DistributedRoutingEnabled>
<FipsModeEnabled> xs:boolean </FipsModeEnabled>
<vcloud_v1.5:EdgeClusterConfiguration>
<vcloud_v1.5:PrimaryEdgeCluster href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
<vcloud_v1.5:SecondaryEdgeCluster href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
</vcloud_v1.5:EdgeClusterConfiguration>
</vcloud_v1.5:Configuration>
</vcloud_v1.5:Gateway>
<vcloud_v1.5:Network href="xs:anyURI" type="xs:string" id="xs:string" operationKey="xs:string"
name="xs:string" status="xs:int">
<vcloud_v1.5:Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
rel="xs:string" model="xs:string"/>
<Description> xs:string </Description>
<vcloud_v1.5:Tasks>
<vcloud_v1.5: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">
<vcloud_v1.5:Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
rel="xs:string" model="xs:string"/>
<Description> xs:string </Description>
<vcloud_v1.5:Tasks> vcloud_v1.5:TasksInProgressType </vcloud_v1.5:Tasks>
<vcloud_v1.5:Owner href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
<vcloud_v1.5:Error stackTrace="xs:string" message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string"
vendorSpecificErrorCode="xs:string">
<vcloud_v1.5:TenantError message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string" vendorSpecificErrorCode="xs:string"/>
</vcloud_v1.5:Error>
<vcloud_v1.5:User href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
<vcloud_v1.5:Organization href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
<Progress> xs:int </Progress>
<Params> ... </Params>
<Details> xs:string </Details>
<vcloud_v1.5:VcTaskList>
<vcloud_v1.5: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"/>
</vcloud_v1.5:VcTaskList>
<vcloud_v1.5:Result>
<ResultContent> ... </ResultContent>
<vcloud_v1.5:ResultReference href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
</vcloud_v1.5:Result>
</vcloud_v1.5:Task>
</vcloud_v1.5:Tasks>
<vcloud_v1.5:Configuration>
<BackwardCompatibilityMode> xs:boolean </BackwardCompatibilityMode>
<vcloud_v1.5:IpScopes>
<vcloud_v1.5:IpScope>
<IsInherited> xs:boolean </IsInherited>
<vcloud_v1.5:Gateway> vcloud_v1.5:IpAddressType </vcloud_v1.5:Gateway>
<vcloud_v1.5:Netmask> vcloud_v1.5:IpAddressType </vcloud_v1.5:Netmask>
<SubnetPrefixLength> xs:int </SubnetPrefixLength>
<vcloud_v1.5:Dns1> vcloud_v1.5:IpAddressType </vcloud_v1.5:Dns1>
<vcloud_v1.5:Dns2> vcloud_v1.5:IpAddressType </vcloud_v1.5:Dns2>
<DnsSuffix> xs:string </DnsSuffix>
<IsEnabled> xs:boolean </IsEnabled>
<vcloud_v1.5:IpRanges>
<vcloud_v1.5:IpRange>
<vcloud_v1.5:StartAddress> vcloud_v1.5:IpAddressType </vcloud_v1.5:StartAddress>
<vcloud_v1.5:EndAddress> vcloud_v1.5:IpAddressType </vcloud_v1.5:EndAddress>
</vcloud_v1.5:IpRange>
</vcloud_v1.5:IpRanges>
<vcloud_v1.5:AllocatedIpAddresses>
<vcloud_v1.5:IpAddress> vcloud_v1.5:IpAddressType </vcloud_v1.5:IpAddress>
</vcloud_v1.5:AllocatedIpAddresses>
<vcloud_v1.5:SubAllocations href="xs:anyURI" type="xs:string">
<vcloud_v1.5:Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
rel="xs:string" model="xs:string"/>
<vcloud_v1.5:SubAllocation>
<vcloud_v1.5:EdgeGateway href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
<vcloud_v1.5:IpRanges>
<vcloud_v1.5:IpRange>
<vcloud_v1.5:StartAddress> vcloud_v1.5:IpAddressType </vcloud_v1.5:StartAddress>
<vcloud_v1.5:EndAddress> vcloud_v1.5:IpAddressType </vcloud_v1.5:EndAddress>
</vcloud_v1.5:IpRange>
</vcloud_v1.5:IpRanges>
</vcloud_v1.5:SubAllocation>
</vcloud_v1.5:SubAllocations>
</vcloud_v1.5:IpScope>
</vcloud_v1.5:IpScopes>
<vcloud_v1.5:ParentNetwork href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
<FenceMode> xs:string </FenceMode>
<RetainNetInfoAcrossDeployments> xs:boolean </RetainNetInfoAcrossDeployments>
<vcloud_v1.5:Features>
<vcloud_v1.5:NetworkService>
<IsEnabled> xs:boolean </IsEnabled>
</vcloud_v1.5:NetworkService>
</vcloud_v1.5:Features>
<vcloud_v1.5:SyslogServerSettings>
<vcloud_v1.5:SyslogServerIp1> vcloud_v1.5:IpAddressType </vcloud_v1.5:SyslogServerIp1>
<vcloud_v1.5:SyslogServerIp2> vcloud_v1.5:IpAddressType </vcloud_v1.5:SyslogServerIp2>
</vcloud_v1.5:SyslogServerSettings>
<vcloud_v1.5:RouterInfo>
<vcloud_v1.5:ExternalIp> vcloud_v1.5:IpAddressType </vcloud_v1.5:ExternalIp>
</vcloud_v1.5: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>
</vcloud_v1.5:Configuration>
<ProviderInfo> xs:string </ProviderInfo>
<vcloud_v1.5:EdgeGateway href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
<vcloud_v1.5:ServiceConfig>
<vcloud_v1.5:NetworkService>
<IsEnabled> xs:boolean </IsEnabled>
</vcloud_v1.5:NetworkService>
</vcloud_v1.5:ServiceConfig>
<IsShared> xs:boolean </IsShared>
<vcloud_v1.5:VimPortGroupRef>
<vcloud_v1.5:VimServerRef href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
<MoRef> xs:string </MoRef>
<VimObjectType> xs:string </VimObjectType>
</vcloud_v1.5:VimPortGroupRef>
</vcloud_v1.5:Network>
</vcloud_v1.5:GatewayConfiguration>
<vcloud_v1.5:StorageProfile href="xs:anyURI" type="xs:string" id="xs:string" operationKey="xs:string"
name="xs:string">
<vcloud_v1.5:Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
rel="xs:string" model="xs:string"/>
<Description> xs:string </Description>
<vcloud_v1.5:Tasks>
<vcloud_v1.5: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">
<vcloud_v1.5:Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
rel="xs:string" model="xs:string"/>
<Description> xs:string </Description>
<vcloud_v1.5:Tasks> vcloud_v1.5:TasksInProgressType </vcloud_v1.5:Tasks>
<vcloud_v1.5:Owner href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
<vcloud_v1.5:Error stackTrace="xs:string" message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string"
vendorSpecificErrorCode="xs:string">
<vcloud_v1.5:TenantError message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string" vendorSpecificErrorCode="xs:string"/>
</vcloud_v1.5:Error>
<vcloud_v1.5:User href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
<vcloud_v1.5:Organization href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
<Progress> xs:int </Progress>
<Params> ... </Params>
<Details> xs:string </Details>
<vcloud_v1.5:VcTaskList>
<vcloud_v1.5: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"/>
</vcloud_v1.5:VcTaskList>
<vcloud_v1.5:Result>
<ResultContent> ... </ResultContent>
<vcloud_v1.5:ResultReference href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
</vcloud_v1.5:Result>
</vcloud_v1.5:Task>
</vcloud_v1.5:Tasks>
<Enabled> xs:boolean </Enabled>
<Units> xs:string </Units>
<Limit> xs:long </Limit>
<Default> xs:boolean </Default>
<vcloud_v1.5: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>
</vcloud_v1.5:IopsSettings>
<InheritPvdcDefaultSettings> xs:boolean </InheritPvdcDefaultSettings>
<StorageUsedMB> xs:long </StorageUsedMB>
<IopsAllocated> xs:long </IopsAllocated>
</vcloud_v1.5:StorageProfile>
<IsElastic> xs:boolean </IsElastic>
<IncludeMemoryOverhead> xs:boolean </IncludeMemoryOverhead>
<ThinProvision> xs:boolean </ThinProvision>
<FastProvisioningEnabled> xs:boolean </FastProvisioningEnabled>
<vcloud_v1.5:NetworkPoolReference href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
<AutomaticNetworkPoolReference/>
<NetworkProfileConfiguration>
<vcloud_v1.5:PrimaryEdgeCluster href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
<vcloud_v1.5:SecondaryEdgeCluster href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
<vcloud_v1.5:ServicesEdgeCluster href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
</NetworkProfileConfiguration>
<CpuAllocationMhz> xs:long </CpuAllocationMhz>
<MemoryAllocationMB> xs:long </MemoryAllocationMB>
<CpuGuaranteedPercentage> xs:long </CpuGuaranteedPercentage>
<VCpuInMhz> xs:long </VCpuInMhz>
<MemoryGuaranteedPercentage> xs:long </MemoryGuaranteedPercentage>
<CpuAllocationMhz> xs:long </CpuAllocationMhz>
<MemoryAllocationMB> xs:long </MemoryAllocationMB>
<CpuGuaranteedPercentage> xs:long </CpuGuaranteedPercentage>
<VCpuInMhz> xs:long </VCpuInMhz>
<MemoryGuaranteedPercentage> xs:long </MemoryGuaranteedPercentage>
</VMWAllocationPoolVdcTemplateSpecificationType>
-
Elements
-
Element Type Required Modifiable Since Deprecated Description AutomaticNetworkPoolReference AutomaticNetworkPoolReferenceType No always 5.9 Indicates that the Provider VDC's automatically-created VXLAN network pool should be used. NetworkPoolReference must be empty if this element appears in the request. 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. FastProvisioningEnabled boolean No always 5.7 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. 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. NetworkPoolReference ReferenceType No always 5.7 Reference to a network pool in the Provider VDC. Must be empty if you specify AutomaticNetworkPoolReference. NetworkProfileConfiguration VdcTemplateNetworkProfileType No 5.7 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. ThinProvision boolean No always 5.7 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. VCpuInMhz 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. VCpuInMhz 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. 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.