| Local Properties | ||
Managed Object Types | Data Object Types | All Properties | All Methods |
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.
Use the properties defined for this object to configure the following services:
When it chooses a failover host, HA selects a host that is compatible with the virtual machine and that can support resource allocation for that virtual machine so that service level guarantees remain intact. HA does not consider hosts that are in maintenance mode, standby mode, or which are disconnected from the vCenter Server. When a host powers on or becomes available again, HA is reenabled on that host, so it becomes available for failover again. VMware recommends that you configure hosts and virtual machines so that all virtual machines can run on all hosts in the cluster. This will maximize the chances of restarting a VM after a failure.
HA also restarts a virtual machine after a guest operating system failure. In this case, the virtual machine health monitoring service detects the guest failure, and HA restarts the virtual machine on the same host. The service monitors heartbeats from the VmTools service and optionally heartbeats that are generated by a third-party application monitor. See ClusterVmToolsMonitoringSettings and ClusterDasConfigInfo.vmMonitoring.
To enable HA for a cluster, set the
ClusterDasConfigInfo.enabled
property to true
and the
ClusterDasConfigInfo.hostMonitoring
property to enabled.
(The vSphere API uses the substring "das" in object, property,
and method names for HA.1)
To enable DRS for a cluster, set the
ClusterDrsConfigInfo.enabled
property to true
.
To enable DPM for a cluster, set the
ClusterDpmConfigInfo.enabled
property to true
.
true
for vsanConfig.
To enable InfraUpdateHA for a cluster, set the
ClusterInfraUpdateHaConfigInfo.enabled property to
true
.
To enable ProactiveDRS for a cluster, set the
ClusterProactiveDrsConfigInfo.enabled property to
true
.
The HA, DRS, and DPM services are integrated with the FT (Fault Tolerance) and EVC (Enhanced vMotion Compatibility) services. Use the CreateSecondaryVM_Task method to establish fault tolerance for a virtual machine. Use the vSphere Client to configure EVC. The HA, DRS, DPM, FT, and EVC services interact under the following circumstances.
das.maxFtVmsPerHost
to the desired number or to zero to disable.
When admission control is disabled, failover resource constraints are not passed on to DRS and DPM. The constraints are not enforced.
If EVC is disabled, vCenter automatically creates overrides to disable DRS for FT primary/secondary pairs in the cluster. vCenter will still use DRS to place a secondary virtual machine when it powers on. Attempts to remove the overrides or to enable DRS operations will fail.
Properties
Name | Type | Description |
---|---|---|
dasConfig* | ClusterDasConfigInfo |
HA configuration; includes default settings for virtual machines.
|
dasVmConfigSpec* | ClusterDasVmConfigSpec[] |
HA configuration for individual virtual machines.
The entries in this array override the cluster default
settings
(ClusterDasConfigInfo.defaultVmSettings).
You cannot specify an HA override for a secondary FT virtual
machine. The secondary virtual machine will inherit whatever
settings apply to its primary virtual machine. If you
include an entry for a secondary, the reconfigure method
will throw the fault
CannotChangeHaSettingsForFtSecondary.
|
dpmConfig* | ClusterDpmConfigInfo |
DPM configuration; includes default settings for hosts.
|
dpmHostConfigSpec* | ClusterDpmHostConfigSpec[] |
DPM configuration for individual hosts.
The entries in this array override the cluster default
settings
(ClusterDpmConfigInfo.defaultDpmBehavior).
|
drsConfig* | ClusterDrsConfigInfo |
DRS configuration; includes default settings for virtual machines.
|
drsVmConfigSpec* | ClusterDrsVmConfigSpec[] |
DRS configuration for individual virtual machines.
The entries in this array override the cluster default
settings
(ClusterDrsConfigInfo.defaultVmBehavior).
You cannot specify a DRS override for a secondary FT virtual
machine. The secondary virtual machine will inherit whatever
setting applies to its primary virtual machine. If you
include an entry for a secondary, the reconfigure method
will throw the fault
CannotChangeDrsBehaviorForFtSecondary.
|
groupSpec* | ClusterGroupSpec[] |
Cluster-wide group configuration.
The array contains one or more group specification objects.
A group specification object contains a virtual machine group
(ClusterVmGroup) or a host group (ClusterHostGroup).
Groups can be related; see ClusterVmHostRuleInfo.
Since vSphere API 4.1 |
infraUpdateHaConfig* | ClusterInfraUpdateHaConfigInfo |
InfraUpdateHA configuration.
Since vSphere API 6.5 |
orchestration* | ClusterOrchestrationInfo |
Cluster configuration of VM orchestration.
Since vSphere API 6.5 |
proactiveDrsConfig* | ClusterProactiveDrsConfigInfo |
ProactiveDrs configuration.
Since vSphere API 6.5 |
rulesSpec* | ClusterRuleSpec[] |
Cluster affinity and anti-affinity rule configuration.
|
vmOrchestrationSpec* | ClusterVmOrchestrationSpec[] |
List of specific VM configurations that apply during cluster wide
VM orchestration. Each entry applies to one virtual machine, and
overrides the cluster default settings.
Since vSphere API 6.5 |
vsanConfig* | VsanClusterConfigInfo |
VSAN configuration; includes default settings for hosts.
Since vSphere API 5.5 |
vsanHostConfigSpec* | VsanHostConfigInfo[] |
VSAN configuration for individual hosts.
The entries in this array override the cluster default settings
as specified in VsanClusterConfigInfo.
Since vSphere API 5.5 |
Properties inherited from ComputeResourceConfigSpec | ||
defaultHardwareVersionKey, spbmEnabled, vmSwapPlacement | ||
Properties inherited from DynamicData | ||
None |
Top of page | Local Properties | ||
Managed Object Types | Data Object Types | All Properties | All Methods |