Managed Object - ClusterComputeResource

Returned by: CreateCluster, CreateClusterEx
Extends: ComputeResource
See also: ClusterActionHistory, ClusterConfigInfo, ClusterConfigSpec, ClusterDasAdvancedRuntimeInfo, ClusterDrsFaults, ClusterDrsMigration, ClusterDrsRecommendation, ClusterEnterMaintenanceResult, ClusterHostRecommendation, ClusterRecommendation, HostConnectSpec, HostSystem, OptionValue, ResourcePool, VirtualMachine

Managed Object Description

The ClusterComputeResource data object aggregates the compute resources of associated HostSystem objects into a single compute resource for use by virtual machines. The cluster services such as HA (High Availability), DRS (Distributed Resource Scheduling), and EVC (Enhanced vMotion Compatibility), enhance the utility of this single compute resource.

Use the Folder.CreateClusterEx method to create an instance of this object.

Properties

Name	Type	Description
actionHistory*	ClusterActionHistory[]	The set of actions that have been performed recently. *Since* VI API 2.5
configuration	ClusterConfigInfo	Deprecated. As of VI API 2.5, use configurationEx, which is a ClusterConfigInfoEx data object.. Configuration of the cluster.
drsFault* P	ClusterDrsFaults[]	A collection of the DRS faults generated in the last DRS invocation. Each element of the collection is the set of faults generated in one recommendation. DRS faults are generated when DRS tries to make recommendations for rule enforcement, power management, etc., and indexed in a tree structure with reason for recommendations and VM to migrate (optional) as the index keys. In releases after vSphere API 5.0, vSphere Servers might not generate property collector update notifications for this property. To obtain the latest value of the property, you can use PropertyCollector methods RetrievePropertiesEx or WaitForUpdatesEx. If you use the PropertyCollector.WaitForUpdatesEx method, specify an empty string for the version parameter. Any other version value will not produce any property values as no updates are generated. *Since* vSphere API 4.0
drsRecommendation*	ClusterDrsRecommendation[]	Deprecated. As of VI API 2.5, use recommendation. In releases after vSphere API 5.0, vSphere Servers might not generate property collector update notifications for this property. To obtain the latest value of the property, you can use PropertyCollector methods RetrievePropertiesEx or WaitForUpdatesEx. If you use the PropertyCollector.WaitForUpdatesEx method, specify an empty string for the version parameter. Any other version value will not produce any property values as no updates are generated. If DRS is enabled, this returns the set of recommended migrations from the DRS module. The current set of recommendations may be empty, since there may be no recommended migrations at this time, or it is possible that DRS is not enabled.
migrationHistory*	ClusterDrsMigration[]	The set of migration decisions that have recently been performed. This list is populated only when DRS is in automatic mode.
recommendation* P	ClusterRecommendation[]	List of recommended actions for the cluster. It is possible that the current set of recommendations may be empty, either due to not having any running dynamic recommendation generation module, or since there may be no recommended actions at this time. *Since* VI API 2.5
Properties inherited from ComputeResource
configurationEx, datastore, environmentBrowser, host, network, resourcePool, summary
Properties inherited from ManagedEntity
alarmActionsEnabled, configIssue, configStatus, customValue, declaredAlarmState, disabledMethod, effectiveRole, name, overallStatus, parent, permission, recentTask, tag, triggeredAlarmState
Properties inherited from ExtensibleManagedObject
availableField, value

*May not be presentP Required privilege: System.Read

Methods

Methods defined in this Managed Object
AddHost_Task, ApplyRecommendation, CancelRecommendation, ClusterEnterMaintenanceMode, MoveHostInto_Task, MoveInto_Task, RecommendHostsForVm, ReconfigureCluster_Task, RefreshRecommendation, RetrieveDasAdvancedRuntimeInfo
Methods inherited from ComputeResource
ReconfigureComputeResource_Task
Methods inherited from ManagedEntity
Destroy_Task, Reload, Rename_Task
Methods inherited from ExtensibleManagedObject
setCustomValue

AddHost_Task

Adds a host to the cluster. The hostname must be either an IP address, such as 192.168.0.1, or a DNS resolvable name. DNS names may be fully qualified names, such as host1.domain1.com, or a short name such as host1, providing host1 resolves to host1.domain1.com. The system uses DNS to resolve short names to fully qualified names. If the cluster supports nested resource pools and the user specifies the optional ResourcePool argument, then the host's root resource pool becomes the specified resource pool. The stand-alone host resource hierarchy is imported into the new nested resource pool.

If the cluster does not support nested resource pools, then the stand-alone host resource hierarchy is discarded and all virtual machines on the host are put under the cluster's root resource pool.

In addition to the Host.Inventory.AddHostToCluster and Resource.AssignVMToPool privileges, it requires System.View privilege on the VM folder that the VMs of the host will be placed on.

Required Privileges: Host.Inventory.AddHostToCluster

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the ClusterComputeResource used to make the method call.
spec	HostConnectSpec	Specifies the host name, port, and password for the host to be added.
asConnected	xsd:boolean	Flag to specify whether or not the host should be connected immediately after it is added. The host will not be added if a connection attempt is made and fails.
resourcePool* P	ManagedObjectReference to a ResourcePool	the resource pool for the root resource pool from the host.
license*	xsd:string	Provide a licenseKey or licenseKeyType. See LicenseManager *Since* vSphere API 4.0

*Need not be set P Required privilege: Resource.AssignVMToPool

Return Value

Type	Description
ManagedObjectReference to a Task	This method returns a Task object with which to monitor the operation. The info.result property in the Task contains the newly added HostSystem upon success.

Faults

Type	Description
AgentInstallFailed	Thrown if there is an error installing the VirtualCenter agent on the host.
AlreadyBeingManaged	Thrown if the host is already being managed by a VirtualCenter server.
AlreadyConnected	Thrown if asConnected is true and the host is already connected to VirtualCenter.
DuplicateName	Thrown if another host in the same cluster has the name.
HostConnectFault	Thrown if an error occurred when connecting to a host. Typically, a more specific subclass, such as AlreadyBeingManaged, is thrown.
InvalidLogin	Thrown if "asConnected" is specified but authentication with the new host fails.
NoHost	Thrown if the host cannot be contacted.
NotEnoughLicenses	Thrown if no licenses are available to add this host.
NotSupportedHost	Thrown if the host is running a software version that does not support clustering features. It may still be possible to add the host as a stand-alone host.
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
SSLVerifyFault	Thrown if the host certificate could not be authenticated
TooManyHosts	Thrown if no additional hosts can be added to the cluster.

Events

Type
None

ApplyRecommendation

Applies a recommendation from the drsRecommendation or the recommendation list. Each recommendation can be applied only once.

resource.applyRecommendation privilege is required if the recommendation is DRS migration or power management recommendations.

Required Privileges: Dynamic - See discussion above

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the ClusterComputeResource used to make the method call.
key	xsd:string	The key field of the DrsRecommendation or Recommendation.

Return Value

Type	Description
None

Faults

Type	Description
InvalidArgument	Thrown if the specified key refers to a non-existent or an already executed recommendation.
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="ApplyRecommendation" type="vim25:ApplyRecommendationRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="ApplyRecommendationResponse">
            <complexType/>
         </element>

CancelRecommendation

Cancels a recommendation. Currently only initial placement recommendations can be cancelled. Migration or power management recommendations cannot.

Required Privileges: System.Read
Since: vSphere API 4.1

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the ClusterComputeResource used to make the method call.
key	xsd:string	The key field of the Recommendation.

Return Value

Type	Description
None

Faults

Type	Description
InvalidArgument	Thrown if the specified key refers to a non-existent or an already executed recommendation.
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="CancelRecommendation" type="vim25:CancelRecommendationRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="CancelRecommendationResponse">
            <complexType/>
         </element>

ClusterEnterMaintenanceMode

The API takes a list of hosts in the cluster as input, and returns a list of hosts in "ClusterMaintenanceResult" that the server can successfully evacuate given the existing constraints in the cluster, such as HA, FT, Vmotion compatibility, reservations, affinity rules, etc. The client is allowed to pass all hosts in the cluster to the API, even though all of them cannot enter maintenance mode at the same time. The list returned from the API contains the largest number of hosts that the server can evacuate simultaneously. The client can then request to enter each host in the returned list into maintenance mode. The client can specify an integer "DemandCapacityRatioTarget" option in the "option" parameter. The allowed values of the option range from 40 to 200, and the default value is 100. This option controls how much resource overcommitment the server should make in consolidating the VMs onto fewer hosts. A value of 100 means the server will keep the same amount of powered-on capacity as the current VM demands. A value less than 100 means undercommitted resources. A value greater than 100 means overcommitted resources. The hosts are recommended based on the inventory at the time of the API invocation. It is not guaranteed that the actual enter-maintenance tasks on the hosts will succeed, if the inventory changes after the API returns, or if vmotions fail due to unexpected conditions. For possible exceptions thrown by the necessary relocate operations, see MigrateVM_Task.

Required Privileges: System.View
Since: vSphere API 5.0

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the ClusterComputeResource used to make the method call.
host P	ManagedObjectReference[] to a HostSystem[]	The array of hosts to put into maintenance mode.
option*	OptionValue[]	An array of OptionValue options for this query. The specified options override the advanced options in ClusterDrsConfigInfo.

*Need not be set P Required privilege: Host.Config.Maintenance

Return Value

Type	Description
ClusterEnterMaintenanceResult	A ClusterEnterMaintenanceResult object, which consists of an array of recommendations for hosts that can be evacuated and an array of faults for hosts that cannot be evacuated.

Faults

Type	Description
InvalidArgument	Thrown for unknown option keys or bad values.
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="ClusterEnterMaintenanceMode" type="vim25:ClusterEnterMaintenanceModeRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="ClusterEnterMaintenanceModeResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vim25:ClusterEnterMaintenanceResult"/>
               </sequence>
            </complexType>
         </element>

MoveHostInto_Task

Moves an existing host into a cluster. The host must be part of the same datacenter, and if the host is part of a cluster, the host must be in maintenance mode.

If the host is a stand-alone host, the stand-alone ComputeResource is removed as part of this operation.

All virtual machines associated with the host, regardless of whether or not they are running, are moved with the host into the cluster. If there are virtual machines that should not be moved, then migrate those virtual machines off the host before initiating this operation.

If the host is a stand-alone host, the cluster supports nested resource pools, and the user specifies the optional resourcePool argument, then the stand-alone host's root resource pool becomes the specified resource pool and the stand-alone host resource hierarchy is imported into the new nested resource pool. If the cluster does not support nested resource pools or the resourcePool argument is not specified, then the stand-alone host resource hierarchy is ignored.

Required Privileges: Host.Inventory.EditCluster

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the ClusterComputeResource used to make the method call.
host P	ManagedObjectReference to a HostSystem	The list of hosts to move into the cluster.
resourcePool*	ManagedObjectReference to a ResourcePool	The resource pool to match the root resource pool of stand-alone hosts. This argument has no effect if the host is part of a cluster.

*Need not be set P Required privilege: Host.Inventory.MoveHost

Return Value

Type	Description
ManagedObjectReference to a Task	This method returns a Task object with which to monitor the operation.

Faults

Type	Description
InvalidArgument	Thrown if the host is not a part of the same datacenter as the cluster or if the specified resource pool is not part of the cluster or if the source and destination clusters are the same.
InvalidState	Thrown if a host is already part of a cluster and is not in maintenance mode.
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
TooManyHosts	Thrown if no additional hosts can be added to the cluster.

Events

Type
None

MoveInto_Task

Moves an existing host into a cluster. The host must be part of the same datacenter, and if the host is part of a cluster, the host must be in maintenance mode.

If the host is part of a stand-alone ComputeResource, then the stand-alone ComputeResource is removed as part of this operation.

All virtual machines associated with a host, regardless of whether or not they are running, are moved with the host into the cluster. If there are virtual machines that should not be moved, then migrate those virtual machines off the host before initiating this operation.

For stand-alone hosts, the host resource pool hierarchy is discarded in this call. To preserve a host resource pools from a stand-alone host, call moveHostInt, specifying an optional resource pool. This operation is transactional only with respect to each individual host. Hosts in the set are moved sequentially and are committed, one at a time. If a failure is detected, then the method terminates with an exception. Since hosts are moved one at a time, if this operation fails while in the process of moving multiple hosts, some hosts are left unmoved.

In addition to the privileges mentioned, the user must also hold Host.Inventory.EditCluster on the host's source ComputeResource object.

Required Privileges: Host.Inventory.EditCluster

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the ClusterComputeResource used to make the method call.
host P	ManagedObjectReference[] to a HostSystem[]	The list of hosts to move into the cluster.

P Required privilege: Host.Inventory.MoveHost

Return Value

Type	Description
ManagedObjectReference to a Task	This method returns a Task object with which to monitor the operation.

Faults

Type	Description
DisallowedOperationOnFailoverHost	Thrown if the host is being moved from a cluster and was configured as a failover host in that cluster. See ClusterFailoverHostAdmissionControlPolicy.
DuplicateName	Thrown if the host is already in the cluster
InvalidArgument	Thrown if one of the hosts is not part of the same datacenter as the cluster.
InvalidState	Thrown if a host is already part of a cluster and is not in maintenance mode.
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
TooManyHosts	Thrown if no additional hosts can be added to the cluster.

Events

Type
None

RecommendHostsForVm

Deprecated. As of VI API 2.5, use PowerOnMultiVM_Task. RecommendHostsForVm cannot make any recommendations if DRS cannot find the specified host in the cluster. With PowerOnMultiVM_Task, DRS attempts to migrate virtual machines and power on hosts in standby mode, given the same conditions.

Gets a recommendation for where to power on, resume, revert from powered-off state to powered on state, or to migrate a specific virtual machine. If no host is found, an empty list is returned.

The type of operation is implied by the state of the virtual machine. Returned hosts are intended for power-on or resume if the virtual machine is powered-off or suspended. However, if the virtual machine is powered-on, the request is assumed to be for migrating a virtual machine into a DRS enabled cluster. In that case, the ResourcePool argument should be specified and the ResourcePool and the virtual machine cannot be in the same cluster.

Required Privileges: System.Read

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the ClusterComputeResource used to make the method call.
vm	ManagedObjectReference to a VirtualMachine	Specifies the virtual machine for which the user is requesting a recommendations.
pool*	ManagedObjectReference to a ResourcePool	Specifies the ResourcePool into which the virtual machine is to be migrated. If the virtual machine is powered-on, this argument must be specified and it is relevant only when the virtual machine is powered-on. This ResourcePool cannot be in the same cluster as the virtual machine.

*Need not be set

Return Value

Type	Description
ClusterHostRecommendation[]	An array of HostRecommendation ordered by their rating.

Faults

Type	Description
InvalidArgument	Thrown if the virtual machine is powered on and the optional ResourcePool argument is either not specified or is in the same cluster as the virtual machine.
NotSupported	Thrown if DRS is not enabled.
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="RecommendHostsForVm" type="vim25:RecommendHostsForVmRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="RecommendHostsForVmResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vim25:ClusterHostRecommendation" minOccurs="0" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>

ReconfigureCluster_Task

Deprecated. As of VI API 2.5, use ReconfigureComputeResource_Task.

Reconfigures a cluster.

Required Privileges: Host.Inventory.EditCluster

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the ClusterComputeResource used to make the method call.
spec	ClusterConfigSpec	A set of configuration changes to apply to the cluster. The specification can be a complete set of changes or a partial set of changes, applied incrementally.
modify	xsd:boolean	Flag to specify whether the specification ("spec") should be applied incrementally. If "modify" is false and the operation succeeds, then the configuration of the cluster matches the specification exactly; in this case any unset portions of the specification will result in unset or default portions of the configuration.

Return Value

Type	Description
ManagedObjectReference to a Task	This method returns a Task object with which to monitor the operation.

Faults

Type	Description
CannotDisableDrsOnClustersWithVApps	Thrown if DRS is being disabled and the cluster contains one or more vApps.
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

RefreshRecommendation

Make DRS invoke again and return a new list of recommendations. Concurrent "refresh" requests may be combined together and trigger only one DRS invocation.

The recommendations generated is stored at recommendation.

Required Privileges: Host.Inventory.EditCluster
Since: VI API 2.5

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the ClusterComputeResource used to make the method call.

Return Value

Type	Description
None

Faults

Type	Description
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="RefreshRecommendation" type="vim25:RefreshRecommendationRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="RefreshRecommendationResponse">
            <complexType/>
         </element>

RetrieveDasAdvancedRuntimeInfo

Retrieve DAS advanced runtime info for this cluster.

Required Privileges: System.Read
Since: vSphere API 4.0

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the ClusterComputeResource used to make the method call.

Return Value

Type	Description
ClusterDasAdvancedRuntimeInfo

Faults

Type	Description
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="RetrieveDasAdvancedRuntimeInfo" type="vim25:RetrieveDasAdvancedRuntimeInfoRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="RetrieveDasAdvancedRuntimeInfoResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vim25:ClusterDasAdvancedRuntimeInfo" minOccurs="0"/>
               </sequence>
            </complexType>
         </element>