Managed Object - ClusterComputeResource

Property of: ClusterEVCManager, PlacementRankResult, PlacementRankSpec, StorageDrsPlacementRankVmSpec
Parameter to: BatchAddHostsToCluster_Task, PerformVsanUpgrade_Task, PerformVsanUpgradePreflightCheck, QueryUnmonitoredHosts, QueryVsanUpgradeStatus, ResolveInstallationErrorsOnCluster_Task
Returned by: CreateCluster, CreateClusterEx
Extends: ComputeResource
See also: ClusterActionHistory, ClusterComputeResourceClusterConfigResult, ClusterComputeResourceHCIConfigInfo, ClusterComputeResourceHCIConfigSpec, ClusterComputeResourceHostConfigurationInput, ClusterComputeResourceSummary, ClusterComputeResourceValidationResultBase, ClusterConfigInfo, ClusterConfigSpec, ClusterDasAdvancedRuntimeInfo, ClusterDrsFaults, ClusterDrsMigration, ClusterDrsRecommendation, ClusterEnterMaintenanceResult, ClusterEVCManager, ClusterHostRecommendation, ClusterRecommendation, ClusterResourceUsageSummary, ClusterRuleInfo, Datastore, HostConnectSpec, HostSystem, OptionValue, PlacementResult, PlacementSpec, ResourcePool, SDDCBase, VirtualMachine
Since: null

Managed Object Description

Properties

Name	Type	Description
actionHistory*	ClusterActionHistory[]	*Since* VI API 2.5
configuration	ClusterConfigInfo
drsFault* P	ClusterDrsFaults[]	*Since* vSphere API 4.0
drsRecommendation*	ClusterDrsRecommendation[]
hciConfig*	ClusterComputeResourceHCIConfigInfo	*Since* vSphere API 6.7.1
migrationHistory*	ClusterDrsMigration[]
recommendation* P	ClusterRecommendation[]	*Since* VI API 2.5
summaryEx	ClusterComputeResourceSummary	*Since* vSphere API 7.0.1.1
Properties inherited from ComputeResource
configManagerEnabled, configurationEx, datastore, environmentBrowser, host, lifecycleManaged, 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
AbandonHciWorkflow, AddHost_Task, ApplyRecommendation, CancelRecommendation, ClusterEnterMaintenanceMode, ConfigureHCI_Task, EvcManager, ExtendHCI_Task, FindRulesForVm, GetResourceUsage, GetSystemVMsRestrictedDatastores, MoveHostInto_Task, MoveInto_Task, PlaceVm, RecommendHostsForVm, ReconfigureCluster_Task, RefreshRecommendation, RetrieveDasAdvancedRuntimeInfo, SetCryptoMode, StampAllRulesWithUuid_Task, ValidateHCIConfiguration
Methods inherited from ComputeResource
ReconfigureComputeResource_Task
Methods inherited from ManagedEntity
Destroy_Task, Reload, Rename_Task
Methods inherited from ExtensibleManagedObject
setCustomValue

AbandonHciWorkflow

Required Privileges: Host.Inventory.EditCluster
Since: vSphere API 6.7.1

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
InvalidState
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

AddHost_Task

Required Privileges: Host.Inventory.AddHostToCluster

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the ClusterComputeResource used to make the method call.
spec P	HostConnectSpec	*Since* null
asConnected P	xsd:boolean	*Since* null
resourcePool* P	ManagedObjectReference to a ResourcePool	*Since* null
license* P	xsd:string	*Since* null

*Need not be set PRequired privilege - see tooltip for details

Return Value

Type	Description
ManagedObjectReference to a ConverterTask

Faults

Type	Description
DuplicateName
HostConnectFault
InvalidLogin
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

ApplyRecommendation

Required Privileges: None

Parameters

Name

Type

Description

_this

ManagedObjectReference

A reference to the ClusterComputeResource used to make the method call.

key P

xsd:string

Since null

P Required privilege: key

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

CancelRecommendation

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 P

xsd:string

Since vSphere API 4.1

P Required privilege: key

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

ClusterEnterMaintenanceMode

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[]

Since vSphere API 5.0

option* P

OptionValue[]

Since vSphere API 5.0

*Need not be set PRequired privilege - see tooltip for details

Return Value

Type	Description
ClusterEnterMaintenanceResult

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

ConfigureHCI_Task

Required Privileges: None
Since: vSphere API 6.7.1

Parameters

Name

Type

Description

_this

ManagedObjectReference

A reference to the ClusterComputeResource used to make the method call.

clusterSpec P

ClusterComputeResourceHCIConfigSpec

Since vSphere API 6.7.1

hostInputs* P

ClusterComputeResourceHostConfigurationInput[]

Since vSphere API 6.7.1

*Need not be set PRequired privilege - see tooltip for details

Return Value

Type	Description
ManagedObjectReference to a ConverterTask

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

EvcManager

Required Privileges: System.Read
Since: vSphere API 6.0

Parameters

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

Return Value

Type	Description
ManagedObjectReference to a ClusterEVCManager

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

ExtendHCI_Task

Required Privileges: None
Since: vSphere API 6.7.1

Parameters

Name

Type

Description

_this

ManagedObjectReference

A reference to the ClusterComputeResource used to make the method call.

hostInputs* P

ClusterComputeResourceHostConfigurationInput[]

Since vSphere API 6.7.1

vSanConfigSpec* P

SDDCBase

Since vSphere API 6.7.1

*Need not be set PRequired privilege - see tooltip for details

Return Value

Type	Description
ManagedObjectReference to a ConverterTask

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

FindRulesForVm

Required Privileges: System.View
Since: vSphere API 6.0

Parameters

Name

Type

Description

_this

ManagedObjectReference

A reference to the ClusterComputeResource used to make the method call.

vm P

ManagedObjectReference
to a VirtualMachine

Since vSphere API 6.0

P Required privilege: vm

Return Value

Type	Description
ClusterRuleInfo[]

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

GetResourceUsage

Required Privileges: System.Read
Since: vSphere API 6.0

Parameters

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

Return Value

Type	Description
ClusterResourceUsageSummary

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

GetSystemVMsRestrictedDatastores

Required Privileges: System.View
Since: vSphere API 7.0.3.0

Parameters

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

Return Value

Type	Description
ManagedObjectReference[] to a Datastore[]

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

MoveHostInto_Task

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

Since null

resourcePool* P

ManagedObjectReference
to a ResourcePool

Since null

*Need not be set PRequired privilege - see tooltip for details

Return Value

Type	Description
ManagedObjectReference to a ConverterTask

Faults

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

Events

Type
None

MoveInto_Task

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[]

Since null

P Required privilege: host

Return Value

Type	Description
ManagedObjectReference to a ConverterTask

Faults

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

Events

Type
None

PlaceVm

Required Privileges: System.View
Since: vSphere API 6.0

Parameters

Name

Type

Description

_this

ManagedObjectReference

A reference to the ClusterComputeResource used to make the method call.

placementSpec P

PlacementSpec

Since vSphere API 6.0

P Required privilege: placementSpec

Return Value

Type	Description
PlacementResult

Faults

Type	Description
InvalidState
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

RecommendHostsForVm

Deprecated.

Required Privileges: System.Read

Parameters

Name

Type

Description

_this

ManagedObjectReference

A reference to the ClusterComputeResource used to make the method call.

vm P

ManagedObjectReference
to a VirtualMachine

Since null

pool* P

ManagedObjectReference
to a ResourcePool

Since null

*Need not be set PRequired privilege - see tooltip for details

Return Value

Type	Description
ClusterHostRecommendation[]

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

ReconfigureCluster_Task

Deprecated.

Required Privileges: Host.Inventory.EditCluster

Parameters

Name

Type

Description

_this

ManagedObjectReference

A reference to the ClusterComputeResource used to make the method call.

spec P

ClusterConfigSpec

Since null

modify P

xsd:boolean

Since null

PRequired privilege - see tooltip for details

Return Value

Type	Description
ManagedObjectReference to a ConverterTask

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

RefreshRecommendation

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

RetrieveDasAdvancedRuntimeInfo

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

SetCryptoMode

Required Privileges: Cryptographer.RegisterHost
Since: vSphere API 7.0

Parameters

Name

Type

Description

_this

ManagedObjectReference

A reference to the ClusterComputeResource used to make the method call.

cryptoMode P

xsd:string

Since vSphere API 7.0

P Required privilege: cryptoMode

Return Value

Type	Description
None

Faults

Type	Description
InvalidArgument
InvalidRequest
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

StampAllRulesWithUuid_Task

Required Privileges: Host.Inventory.EditCluster
Since: vSphere API 6.0

Parameters

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

Return Value

Type	Description
ManagedObjectReference to a ConverterTask

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

ValidateHCIConfiguration

Required Privileges: System.Read
Since: vSphere API 6.7.1

Parameters

Name

Type

Description

_this

ManagedObjectReference

A reference to the ClusterComputeResource used to make the method call.

hciConfigSpec* P

ClusterComputeResourceHCIConfigSpec

Since vSphere API 6.7.1

hosts* P

ManagedObjectReference[]
to a HostSystem[]

Since vSphere API 6.7.1

*Need not be set PRequired privilege - see tooltip for details

Return Value

Type	Description
ClusterComputeResourceValidationResultBase[]

Faults

Type	Description
InvalidState
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