Package com.vmware.vim25.mo

Class ClusterComputeResource

java.lang.Object

com.vmware.vim25.mo.ManagedObject

com.vmware.vim25.mo.ExtensibleManagedObject

com.vmware.vim25.mo.ManagedEntity

com.vmware.vim25.mo.ComputeResource

com.vmware.vim25.mo.ClusterComputeResource

public class ClusterComputeResource
extends ComputeResource

Constructor Summary

Constructors

Constructor	Description
ClusterComputeResource(ServerConnection serverConnection, ManagedObjectReference mor)

Method Summary

Modifier and Type	Method	Description
void	abandonHciWorkflow()
Task	addHost_Task(HostConnectSpec spec, boolean asConnected, ResourcePool resourcePool)
Task	addHost_Task(HostConnectSpec spec, boolean asConnected, ResourcePool resourcePool, String license)
void	applyRecommendation(String key)
void	cancelRecommendation(String key)
ClusterEnterMaintenanceResult	clusterEnterMaintenanceMode(HostSystem[] hosts, OptionValue[] option)
ClusterEnterMaintenanceResult	clusterEnterMaintenanceMode(HostSystem[] host, OptionValue[] option, ClusterComputeResourceMaintenanceInfo info)
Task	configureHCI_Task(ClusterComputeResourceHCIConfigSpec clusterSpec, ClusterComputeResourceHostConfigurationInput[] hostInputs)
ClusterEVCManager	evcManager()
Task	extendHCI_Task(ClusterComputeResourceHostConfigurationInput[] hostInputs, SDDCBase vSanConfigSpec)
ClusterRuleInfo[]	findRulesForVm(VirtualMachine vm)	Finds all enabled and disabled VM-VM Affinity and Anti-Affinity rules, involving the given Virtual Machine.
ClusterActionHistory[]	getActionHistory()
ClusterConfigInfo	getConfiguration()
ClusterDrsFaults[]	getDrsFault()
ClusterDrsRecommendation[]	getDrsRecommendation()
ClusterComputeResourceHCIConfigInfo	getHciConfig()
ClusterDrsMigration[]	getMigrationHistory()
ClusterRecommendation[]	getRecommendation()
ClusterResourceUsageSummary	getResourceUsage()	This API can be invoked to get the current CPU, memory and storage usage in the cluster.
ClusterComputeResourceSummary	getSummaryEx()
Datastore[]	getSystemVMsRestrictedDatastores()
Task	moveHostInto_Task(HostSystem host, ResourcePool resourcePool)
Task	moveInto_Task(HostSystem[] hosts)
PlacementResult	placeVm(PlacementSpec placementSpec)	This method returns a PlacementResult object.
ClusterHostRecommendation[]	recommendHostsForVm(VirtualMachine vm, ResourcePool pool)
Task	reconfigureCluster_Task(ClusterConfigSpec spec, boolean modify)
void	refreshRecommendation()
ClusterDasAdvancedRuntimeInfo	retrieveDasAdvancedRuntimeInfo()
void	setCryptoMode(String cryptoMode, ClusterComputeResourceCryptoModePolicy policy)
Task	stampAllRulesWithUuid_Task()
ClusterComputeResourceValidationResultBase[]	validateHCIConfiguration(ClusterComputeResourceHCIConfigSpec hciConfigSpec, HostSystem[] hosts)

Methods inherited from class com.vmware.vim25.mo.ComputeResource

disableNetworkBoot_Task, enableNetworkBoot_Task, getConfigManagerEnabled, getConfigurationEx, getDatastore, getEnvironmentBrowser, getHost, getLifecycleManaged, getNetwork, getNetworkBootMode, getNetworks, getResourcePool, getSummary, reconfigureComputeResource_Task

Methods inherited from class com.vmware.vim25.mo.ManagedEntity

destroy_Task, getAlarmActionEabled, getConfigIssue, getConfigStatus, getCustomValue, getDeclaredAlarmState, getDisabledMethod, getEffectiveRole, getName, getOverallStatus, getParent, getPermission, getRecentTasks, getTag, getTriggeredAlarmState, reload, rename_Task

Methods inherited from class com.vmware.vim25.mo.ExtensibleManagedObject

getAvailableField, getValues, setCustomValue

Methods inherited from class com.vmware.vim25.mo.ManagedObject

convertMors, getCurrentProperty, getDatastores, getFilter, getHosts, getManagedObject, getManagedObjects, getManagedObjects, getMOR, getNetworks, getPropertiesByPaths, getPropertyByPath, getResourcePools, getScheduledTasks, getServerConnection, getTasks, getViews, getVimService, getVms, retrieveObjectProperties, setCachedProperty, setMOR, setServerConnection, toString, waitForValues

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

ClusterComputeResource

public ClusterComputeResource(ServerConnection serverConnection,
 ManagedObjectReference mor)

Method Details

getActionHistory

public ClusterActionHistory[] getActionHistory()

getConfiguration

public ClusterConfigInfo getConfiguration()

getDrsFault

public ClusterDrsFaults[] getDrsFault()

getDrsRecommendation

public ClusterDrsRecommendation[] getDrsRecommendation()

getHciConfig

public ClusterComputeResourceHCIConfigInfo getHciConfig()

getMigrationHistory

public ClusterDrsMigration[] getMigrationHistory()

getRecommendation

public ClusterRecommendation[] getRecommendation()

getSummaryEx

public ClusterComputeResourceSummary getSummaryEx()

abandonHciWorkflow

public void abandonHciWorkflow()
                        throws InvalidState,
RuntimeFault,
RemoteException

Throws:

InvalidState

RuntimeFault

RemoteException

addHost_Task

public Task addHost_Task(HostConnectSpec spec,
 boolean asConnected,
 ResourcePool resourcePool,
 String license)
                  throws DuplicateName,
HostConnectFault,
InvalidLogin,
RuntimeFault,
RemoteException

Throws:

DuplicateName

HostConnectFault

InvalidLogin

RuntimeFault

RemoteException

applyRecommendation

public void applyRecommendation(String key)
                         throws RuntimeFault,
RemoteException

Throws:

RuntimeFault

RemoteException

cancelRecommendation

public void cancelRecommendation(String key)
                          throws RuntimeFault,
RemoteException

Throws:

RuntimeFault

RemoteException

configureHCI_Task

public Task configureHCI_Task(ClusterComputeResourceHCIConfigSpec clusterSpec,
 ClusterComputeResourceHostConfigurationInput[] hostInputs)
                       throws RuntimeFault,
RemoteException

Throws:

RuntimeFault

RemoteException

clusterEnterMaintenanceMode

public ClusterEnterMaintenanceResult clusterEnterMaintenanceMode(HostSystem[] host,
 OptionValue[] option,
 ClusterComputeResourceMaintenanceInfo info)
                                                          throws RuntimeFault,
RemoteException

Throws:

RuntimeFault

RemoteException

evcManager

public ClusterEVCManager evcManager()
                             throws RuntimeFault,
RemoteException

Throws:

RuntimeFault

RemoteException

extendHCI_Task

public Task extendHCI_Task(ClusterComputeResourceHostConfigurationInput[] hostInputs,
 SDDCBase vSanConfigSpec)
                    throws RuntimeFault,
RemoteException

Throws:

RuntimeFault

RemoteException

getSystemVMsRestrictedDatastores

public Datastore[] getSystemVMsRestrictedDatastores()
                                             throws RuntimeFault,
RemoteException

Throws:

RuntimeFault

RemoteException

reconfigureCluster_Task

public Task reconfigureCluster_Task(ClusterConfigSpec spec,
 boolean modify)
                             throws RuntimeFault,
RemoteException

Throws:

RuntimeFault

RemoteException

refreshRecommendation

public void refreshRecommendation()
                           throws RuntimeFault,
RemoteException

Throws:

RuntimeFault

RemoteException

setCryptoMode

public void setCryptoMode(String cryptoMode,
 ClusterComputeResourceCryptoModePolicy policy)
                   throws InvalidArgument,
InvalidRequest,
RuntimeFault,
RemoteException

Throws:

InvalidArgument

InvalidRequest

RuntimeFault

RemoteException

stampAllRulesWithUuid_Task

public Task stampAllRulesWithUuid_Task()
                                throws RuntimeFault,
RemoteException

Throws:

RuntimeFault

RemoteException

validateHCIConfiguration

public ClusterComputeResourceValidationResultBase[] validateHCIConfiguration(ClusterComputeResourceHCIConfigSpec hciConfigSpec,
 HostSystem[] hosts)
                                                                      throws InvalidState,
RuntimeFault,
RemoteException

Throws:

InvalidState

RuntimeFault

RemoteException

addHost_Task

public Task addHost_Task(HostConnectSpec spec,
 boolean asConnected,
 ResourcePool resourcePool)
                  throws InvalidLogin,
HostConnectFault,
RuntimeFault,
RemoteException

Throws:

InvalidLogin

HostConnectFault

RuntimeFault

RemoteException

clusterEnterMaintenanceMode

public ClusterEnterMaintenanceResult clusterEnterMaintenanceMode(HostSystem[] hosts,
 OptionValue[] option)
                                                          throws RuntimeFault,
RemoteException

Throws:

RuntimeFault

RemoteException

Since:

SDK5.0

moveHostInto_Task

public Task moveHostInto_Task(HostSystem host,
 ResourcePool resourcePool)
                       throws TooManyHosts,
InvalidState,
RuntimeFault,
RemoteException

Throws:

TooManyHosts

InvalidState

RuntimeFault

RemoteException

moveInto_Task

public Task moveInto_Task(HostSystem[] hosts)
                   throws TooManyHosts,
DuplicateName,
InvalidState,
RuntimeFault,
RemoteException

Throws:

TooManyHosts

DuplicateName

InvalidState

RuntimeFault

RemoteException

recommendHostsForVm

public ClusterHostRecommendation[] recommendHostsForVm(VirtualMachine vm,
 ResourcePool pool)
                                                throws RuntimeFault,
RemoteException

Throws:

RuntimeFault

RemoteException

retrieveDasAdvancedRuntimeInfo

public ClusterDasAdvancedRuntimeInfo retrieveDasAdvancedRuntimeInfo()
                                                             throws RuntimeFault,
RemoteException

Throws:

RuntimeFault

RemoteException

Since:

4.0

findRulesForVm

public ClusterRuleInfo[] findRulesForVm(VirtualMachine vm)
                                 throws RuntimeFault,
RemoteException

Finds all enabled and disabled VM-VM Affinity and Anti-Affinity rules, involving the given Virtual Machine.

Parameters:

vm - The vm whose rules need to be looked up.

Returns:

Array of rule info

Throws:

RuntimeFault

RemoteException

Since:

6.0

getResourceUsage

public ClusterResourceUsageSummary getResourceUsage()
                                             throws RuntimeFault,
RemoteException

This API can be invoked to get the current CPU, memory and storage usage in the cluster.

Returns:

An instance of ClusterResourceUsageSummary

Throws:

RuntimeFault

RemoteException

Since:

6.0

placeVm

public PlacementResult placeVm(PlacementSpec placementSpec)
                        throws InvalidArgument,
InvalidState,
RuntimeFault,
RemoteException

This method returns a PlacementResult object. This API can be invoked to ask DRS for a set of recommendations for moving a virtual machine and its virtual disks into a cluster.

Parameters:

placementSpec - Specification for placing a virtual machine and its virtual disks

Returns:

PlacementResult

Throws:

InvalidArgument

InvalidState

RuntimeFault

RemoteException

Since:

6.0