Data Object Description

ClusterDrsConfigInfo

All fields are optional. If you set the modify parameter to true when you call ReconfigureComputeResource_Task, an unset property has no effect on the existing property value in the cluster configuration on the Server. If you set the modify parameter to false when you reconfigure a cluster, the cluster configuration is reverted to the default values, then the new configuration values are applied.

Properties

Name	Type	Description
defaultVmBehavior*	DrsBehavior	Specifies the cluster-wide default DRS behavior for virtual machines. You can override the default behavior for a virtual machine by using the ClusterDrsVmConfigInfo object.
enabled*	xsd:boolean	Deprecated. as of vSphere API 7.0. To disable DRS load balancing, please use the lowest DRS aggressiveness level, setting vmotionRate to 5, and/or setting defaultVmBehavior to manual. The former only generates manadatory move recommendations, not load balancing recommendations. The latter only generates recommendations, without executing them. To remove all the child resource pools, please find the root resource pool ResourcePool, and destroy all its children DestroyChildren. Vice versa. Flag indicating whether or not DRS service is enabled.
enableVmBehaviorOverrides*	xsd:boolean	Flag that dictates whether DRS Behavior overrides for individual virtual machines (ClusterDrsVmConfigInfo) are enabled. The default value is `true`. When this flag is `true`, the ClusterConfigSpecEx.drsVmConfigSpec values override the defaultVmBehavior. When this flag is `false`, the defaultVmBehavior value applies to all virtual machines, with the following exception: in a cluster that has EVC disabled, you cannot override the virtual machine setting (drsVmConfigSpec) for Fault Tolerance virtual machines. *Since* vSphere API 4.0
option*	OptionValue[]	Advanced settings.
scaleDescendantsShares*	xsd:string	Specifies the scaling behavior of the shares of all resource pools in the cluster. See ResourceConfigSpecScaleSharesBehavior for possible values. If any scaling behavior other than vim.ResourceConfigSpec.ScaleSharesBehavior#disabled is specified, the system will scale the CPU and memory shares allocated to each resource pool with the total shares of all powered on virtual machines under each respective pool. The system will also use the SharesInfo set on each resource pool as a multiplier for the scale. Setting the scaleDescendantsShares on the cluster is equivalent to setting the scaleDescendantsShares on the root resource pool. *Since* vSphere API 7.0
vmotionRate*	xsd:int	Threshold for generated ClusterRecommendations. DRS generates only those recommendations that are above the specified vmotionRate. Ratings vary from 1 to 5. This setting applies to manual, partiallyAutomated, and fullyAutomated DRS clusters. See DrsBehavior.
Properties inherited from DynamicData
None

Name

Type

Description

defaultVmBehavior*

DrsBehavior

Specifies the cluster-wide default DRS behavior for virtual machines. You can override the default behavior for a virtual machine by using the ClusterDrsVmConfigInfo object.

enabled*

xsd:boolean

Deprecated. as of vSphere API 7.0. To disable DRS load balancing, please use the lowest DRS aggressiveness level, setting vmotionRate to 5, and/or setting defaultVmBehavior to manual. The former only generates manadatory move recommendations, not load balancing recommendations. The latter only generates recommendations, without executing them. To remove all the child resource pools, please find the root resource pool ResourcePool, and destroy all its children DestroyChildren. Vice versa.

Flag indicating whether or not DRS service is enabled.

enableVmBehaviorOverrides*

xsd:boolean

Flag that dictates whether DRS Behavior overrides for individual virtual machines (ClusterDrsVmConfigInfo) are enabled. The default value is true.

When this flag is true, the ClusterConfigSpecEx.drsVmConfigSpec values override the defaultVmBehavior.

When this flag is false, the defaultVmBehavior value applies to all virtual machines, with the following exception: in a cluster that has EVC disabled, you cannot override the virtual machine setting (drsVmConfigSpec) for Fault Tolerance virtual machines.

Since vSphere API 4.0

option*

OptionValue[]

Advanced settings.

scaleDescendantsShares*

xsd:string

Specifies the scaling behavior of the shares of all resource pools in the cluster. See ResourceConfigSpecScaleSharesBehavior for possible values. If any scaling behavior other than vim.ResourceConfigSpec.ScaleSharesBehavior#disabled is specified, the system will scale the CPU and memory shares allocated to each resource pool with the total shares of all powered on virtual machines under each respective pool. The system will also use the SharesInfo set on each resource pool as a multiplier for the scale. Setting the scaleDescendantsShares on the cluster is equivalent to setting the scaleDescendantsShares on the root resource pool.

Since vSphere API 7.0

vmotionRate*

xsd:int

Threshold for generated ClusterRecommendations. DRS generates only those recommendations that are above the specified vmotionRate. Ratings vary from 1 to 5. This setting applies to manual, partiallyAutomated, and fullyAutomated DRS clusters. See DrsBehavior.

Properties inherited from DynamicData

None

Need not be set

Show WSDL type definition

         <complexType xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="ClusterDrsConfigInfo">
            <complexContent>
               <extension base="vim25:DynamicData">
                  <sequence>
                     <element name="enabled" type="xsd:boolean" minOccurs="0"/>
                     <element name="enableVmBehaviorOverrides" type="xsd:boolean" minOccurs="0"/>
                     <element name="defaultVmBehavior" type="vim25:DrsBehavior" minOccurs="0"/>
                     <element name="vmotionRate" type="xsd:int" minOccurs="0"/>
                     <element name="scaleDescendantsShares" type="xsd:string" minOccurs="0"/>
                     <element name="option" type="vim25:OptionValue" minOccurs="0" maxOccurs="unbounded"/>
                  </sequence>
               </extension>
            </complexContent>
         </complexType>

Data Object - ClusterDrsConfigInfo(vim.cluster.DrsConfigInfo)

Data Object Description