Data Object Description

For a ResourcePool, the ResourceAllocationInfo object describes both the guaranteed amount of the resource (reservation) and whether or not it is expandable (expandableReservation). If expandableReservation is true, then the resource pool can grow its reservation dynamically by borrowing unreserved resources from its parent resource pool. For the methods CreateResourcePool, CreateVApp and ImportVApp, you must provide values for all properties except overheadLimit; they are not optional. (Currently, overheadLimit is for vCenter Server use only.)

If the limit is configured, it must be greater than or equal to the reservation.

Properties

Name	Type	Description
expandableReservation*	xsd:boolean	In a resource pool with an expandable reservation, the reservation on a resource pool can grow beyond the specified value, if the parent resource pool has unreserved resources. A non-expandable reservation is called a fixed reservation. This property is ignored for virtual machines.
limit*	xsd:long	The utilization of a virtual machine/resource pool will not exceed this limit, even if there are available resources. This is typically used to ensure a consistent performance of virtual machines / resource pools independent of available resources. If set to -1, then there is no fixed limit on resource usage (only bounded by available resources and shares). Units are MB for memory, MHz for CPU.
overheadLimit*	xsd:long	The maximum allowed overhead memory. For a powered on virtual machine, the overhead memory reservation cannot be larger than its overheadLimit. This property is only applicable to powered on virtual machines and is not persisted across reboots. This property is not applicable for resource pools. If set to -1, then there is no limit on reservation. Units are MB. Note: For vCenter Server use only. Not available for other clients at this time. The server will throw an exception if you attempt to set this property. *Since* VI API 2.5
reservation*	xsd:long	Amount of resource that is guaranteed available to the virtual machine or resource pool. Reserved resources are not wasted if they are not used. If the utilization is less than the reservation, the resources can be utilized by other running virtual machines. Units are MB for memory, MHz for CPU.
shares*	SharesInfo	Memory shares are used in case of resource contention.
Properties inherited from DynamicData
dynamicProperty, dynamicType

Name

Type

Description

expandableReservation*

xsd:boolean

In a resource pool with an expandable reservation, the reservation on a resource pool can grow beyond the specified value, if the parent resource pool has unreserved resources. A non-expandable reservation is called a fixed reservation. This property is ignored for virtual machines.

limit*

xsd:long

The utilization of a virtual machine/resource pool will not exceed this limit, even if there are available resources. This is typically used to ensure a consistent performance of virtual machines / resource pools independent of available resources. If set to -1, then there is no fixed limit on resource usage (only bounded by available resources and shares). Units are MB for memory, MHz for CPU.

overheadLimit*

xsd:long

The maximum allowed overhead memory. For a powered on virtual machine, the overhead memory reservation cannot be larger than its overheadLimit. This property is only applicable to powered on virtual machines and is not persisted across reboots. This property is not applicable for resource pools. If set to -1, then there is no limit on reservation. Units are MB.

Note: For vCenter Server use only. Not available for other clients at this time. The server will throw an exception if you attempt to set this property.

Since VI API 2.5

reservation*

xsd:long

Amount of resource that is guaranteed available to the virtual machine or resource pool. Reserved resources are not wasted if they are not used. If the utilization is less than the reservation, the resources can be utilized by other running virtual machines. Units are MB for memory, MHz for CPU.

shares*

SharesInfo

Memory shares are used in case of resource contention.

Properties inherited from DynamicData

dynamicProperty, dynamicType

Need not be set

Show WSDL type definition

         <complexType xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="ResourceAllocationInfo">
            <complexContent>
               <extension base="vim25:DynamicData">
                  <sequence>
                     <element name="reservation" type="xsd:long" minOccurs="0"/>
                     <element name="expandableReservation" type="xsd:boolean" minOccurs="0"/>
                     <element name="limit" type="xsd:long" minOccurs="0"/>
                     <element name="shares" type="vim25:SharesInfo" minOccurs="0"/>
                     <element name="overheadLimit" type="xsd:long" minOccurs="0"/>
                  </sequence>
               </extension>
            </complexContent>
         </complexType>

Data Object - ResourceAllocationInfo

Data Object Description