Search

Class VcClusterComputeResource

Extends VcComputeResource
The VcClusterComputeResource data object aggregates the compute resources of associated VcHostSystem 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 VcFolder.VcFolder method to create an instance of this object.

Attributes

Name Type Description
actionHistory VcClusterActionHistory[] The set of actions that have been performed recently.
alarmActionsEnabled boolean Whether alarm actions are enabled for this entity. True if enabled; false otherwise.
availableField VcCustomFieldDef[] List of custom field definitions that are valid for the object's type. The fields are sorted by <a href="VcCustomFieldDef.html#name">VcCustomFieldDef</a>.
configIssue VcEvent[] Current configuration issues that have been detected for this entity. Typically, these issues have already been logged as events. The entity stores these events as long as they are still current. The <a href="VcManagedEntity.html#configStatus">VcManagedEntity</a> property provides an overall status based on these events.
configStatus VcManagedEntityStatus The configStatus indicates whether or not the system has detected a configuration issue involving this entity. For example, it might have detected a duplicate IP address or MAC address, or a host in a cluster might be out of compliance. The meanings of the configStatus values are: <ul> <li>red: A problem has been detected involving the entity. <li>yellow: A problem is about to occur or a transient condition has occurred (For example, reconfigure fail-over policy). <li>green: No configuration issues have been detected. <li>gray: The configuration status of the entity is not being monitored. </ul> A green status indicates only that a problem has not been detected; it is not a guarantee that the entity is problem-free. <p> The <a href="VcManagedEntity.html#configIssue">VcManagedEntity</a> property contains a list of the problems that have been detected. 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.
configuration VcClusterConfigInfo Configuration of the cluster. <br/><i>As of VI API 2.5, use <a href="VcComputeResource.html#configurationEx">VcComputeResource</a>, which is a <a href="VcClusterConfigInfoEx.html">VcClusterConfigInfoEx</a> data object..</i>
configurationEx VcComputeResourceConfigInfo Configuration of the compute resource; applies to both standalone hosts and clusters. For a cluster this property will return a <a href="VcClusterConfigInfoEx.html">VcClusterConfigInfoEx</a> object.
customValue VcCustomFieldValue[] Custom field values.
datastore VcDatastore[] The datastore property is the subset of datastore objects in the datacenter available in this ComputeResource. <p> This property is computed as the aggregate set of datastores available from all the hosts that are part of this compute resource.
declaredAlarmState VcAlarmState[] A set of alarm states for alarms that apply to this managed entity. The set includes alarms defined on this entity and alarms inherited from the parent entity, or from any ancestors in the inventory hierarchy. <p> Alarms are inherited if they can be triggered by this entity or its descendants. This set does not include alarms that are defined on descendants of this entity.
disabledMethod String[] List of operations that are disabled, given the current runtime state of the entity. For example, a power-on operation always fails if a virtual machine is already powered on. This list can be used by clients to enable or disable operations in a graphical user interface. <p> Note: This list is determined by the current runtime state of an entity, not by its permissions. <p> This list may include the following operations for a HostSystem: <ul> <li><a href="VcHostSystem.html#enterMaintenanceMode">VcHostSystem</a> <li><a href="VcHostSystem.html#exitMaintenanceMode">VcHostSystem</a> <li><a href="VcHostSystem.html#reboot">VcHostSystem</a> <li><a href="VcHostSystem.html#shutdown">VcHostSystem</a> <li><a href="VcHostSystem.html#reconnect">VcHostSystem</a> <li><a href="VcHostSystem.html#disconnect">VcHostSystem</a> </ul> <p> This list may include the following operations for a VirtualMachine: <ul> <li><a href="VcVirtualMachine.html#answer">VcVirtualMachine</a> <li><a href="VcManagedEntity.html#rename">VcManagedEntity</a> <li><a href="VcVirtualMachine.html#clone">VcVirtualMachine</a> <li><a href="VcVirtualMachine.html#powerOff">VcVirtualMachine</a> <li><a href="VcVirtualMachine.html#powerOn">VcVirtualMachine</a> <li><a href="VcVirtualMachine.html#suspend">VcVirtualMachine</a> <li><a href="VcVirtualMachine.html#reset">VcVirtualMachine</a> <li><a href="VcVirtualMachine.html#reconfigure">VcVirtualMachine</a> <li><a href="VcVirtualMachine.html#relocate">VcVirtualMachine</a> <li><a href="VcVirtualMachine.html#migrate">VcVirtualMachine</a> <li><a href="VcVirtualMachine.html#customize">VcVirtualMachine</a> <li><a href="VcVirtualMachine.html#shutdownGuest">VcVirtualMachine</a> <li><a href="VcVirtualMachine.html#standbyGuest">VcVirtualMachine</a> <li><a href="VcVirtualMachine.html#rebootGuest">VcVirtualMachine</a> <li><a href="VcVirtualMachine.html#createSnapshot">VcVirtualMachine</a> <li><a href="VcVirtualMachine.html#removeAllSnapshots">VcVirtualMachine</a> <li><a href="VcVirtualMachine.html#revertToCurrentSnapshot">VcVirtualMachine</a> <li><a href="VcVirtualMachine.html#markAsTemplate">VcVirtualMachine</a> <li><a href="VcVirtualMachine.html#markAsVirtualMachine">VcVirtualMachine</a> <li><a href="VcVirtualMachine.html#resetGuestInformation">VcVirtualMachine</a> <li><a href="VcVirtualMachine.html#mountToolsInstaller">VcVirtualMachine</a> <li><a href="VcVirtualMachine.html#unmountToolsInstaller">VcVirtualMachine</a> <li><a href="VcManagedEntity.html#destroy">VcManagedEntity</a> <li><a href="VcVirtualMachine.html#upgradeVirtualHardware">VcVirtualMachine</a> <li><a href="VcVirtualMachine.html#exportVm">VcVirtualMachine</a> </ul> <p> This list may include the following operations for a ResourcePool: <ul> <li><a href="VcResourcePool.html#importVApp">VcResourcePool</a> <li><a href="VcResourcePool.html#createVm">VcResourcePool</a> <li><a href="VcResourcePool.html#updateConfig">VcResourcePool</a> <li><a href="VcFolder.html#createVm">VcFolder</a> <li><a href="VcManagedEntity.html#destroy">VcManagedEntity</a> <li><a href="VcManagedEntity.html#rename">VcManagedEntity</a> </ul> This list may include the following operations for a VirtualApp: <ul> <li><a href="VcManagedEntity.html#destroy">VcManagedEntity</a> <li><a href="VcVirtualApp.html#clone">VcVirtualApp</a> <li><a href="VcVirtualApp.html#unregister">VcVirtualApp</a> <li><a href="VcVirtualApp.html#exportVApp">VcVirtualApp</a> <li><a href="VcVirtualApp.html#powerOn">VcVirtualApp</a> <li><a href="VcVirtualApp.html#powerOff">VcVirtualApp</a> <li><a href="VcVirtualApp.html#updateVAppConfig">VcVirtualApp</a> </ul> <p> 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.
drsFault VcClusterDrsFaults[] 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.
drsRecommendation VcClusterDrsRecommendation[] 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. <br/><i>As of VI API 2.5, use <a href="VcClusterComputeResource.html#recommendation">VcClusterComputeResource</a>. 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.</i>
effectiveRole Number[] Access rights the current session has to this entity.
environmentBrowser VcEnvironmentBrowser The environment browser object that identifies the environments that are supported on this compute resource.
host VcHostSystem[] List of hosts that are part of this compute resource. If the compute resource is a standalone type, then this list contains just one element.
id String returns the id of this ManagedObject
migrationHistory VcClusterDrsMigration[] The set of migration decisions that have recently been performed. <p> This list is populated only when DRS is in automatic mode.
name String Name of this entity, unique relative to its parent. <p> Any / (slash), \ (backslash), character used in this name element will be escaped. Similarly, any % (percent) character used in this name element will be escaped, unless it is used to start an escape sequence. A slash is escaped as %2F or %2f. A backslash is escaped as %5C or %5c, and a percent is escaped as %25.
network VcNetwork[] The subset of network objects available in the datacenter that is available in this ComputeResource. <p> This property is computed as the aggregate set of networks available from all the hosts that are part of this compute resource.
network_DistributedVirtualPortgroup DistributedVirtualPortgroup[] Filtered attribute 'network' with only DistributedVirtualPortgroup objects
network_Network Network[] Filtered attribute 'network' with only Network objects
overallStatus VcManagedEntityStatus General health of this managed entity. The overall status of the managed entity is computed as the worst status among its alarms and the configuration issues detected on the entity. The status is reported as one of the following values: <ul> <li>red: The entity has alarms or configuration issues with a red status. <li>yellow: The entity does not have alarms or configuration issues with a red status, and has at least one with a yellow status. <li>green: The entity does not have alarms or configuration issues with a red or yellow status, and has at least one with a green status. <li>gray: All of the entity's alarms have a gray status and the configuration status of the entity is not being monitored. </ul> 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.
parent VcManagedEntity Parent of this entity. <p> This value is null for the root object and for <a href="VcVirtualMachine.html">VcVirtualMachine</a> objects that are part of a <a href="VcVirtualApp.html">VcVirtualApp</a>.
permission VcPermission[] List of permissions defined for this entity.
recentTask VcTask[] The set of recent tasks operating on this managed entity. This is a subset of <a href="VcTaskManager.html#recentTask">VcTaskManager</a> belong to this entity. A task in this list could be in one of the four states: pending, running, success or error. <p> This property can be used to deduce intermediate power states for a virtual machine entity. For example, if the current powerState is "poweredOn" and there is a running task performing the "suspend" operation, then the virtual machine's intermediate state might be described as "suspending." <p> Most tasks (such as power operations) obtain exclusive access to the virtual machine, so it is unusual for this list to contain more than one running task. One exception, however, is the task of cloning a virtual machine. 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.
recommendation VcClusterRecommendation[] 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.
reference VcManagedObjectReference returns the ManagedObjectReference of this ManagedObject
resourcePool VcResourcePool Reference to root resource pool.
resourcePool_ResourcePool ResourcePool[] Filtered attribute 'resourcePool' with only ResourcePool objects
resourcePool_VirtualApp VirtualApp[] Filtered attribute 'resourcePool' with only VirtualApp objects
sdkConnection VcSdkConnection returns the parent SdkConnection
summary VcComputeResourceSummary Basic runtime information about a compute resource. This information is used on summary screens and in list views.
tag VcTag[] The set of tags associated with this managed entity. Experimental. Subject to change.
triggeredAlarmState VcAlarmState[] A set of alarm states for alarms triggered by this entity or by its descendants. <p> Triggered alarms are propagated up the inventory hierarchy so that a user can readily tell when a descendant has triggered an alarm. 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.
value VcCustomFieldValue[] List of custom field values. Each value uses a key to associate an instance of a <a href="VcCustomFieldStringValue.html">VcCustomFieldStringValue</a> with a custom field definition.
vimHost VcSdkConnection returns the parent SdkConnection (deprecated)
vimType String returns the type of this ManagedObject

Methods

Name Returns
VcClusterComputeResource(com.vmware.vmo.plugin.vi4.model.IVimObjectFactory , VcManagedObjectReference , String ) constructor
addHost_Task(VcHostConnectSpec spec, boolean asConnected, VcResourcePool resourcePool, String license) VcTask
applyRecommendation(String key) void
cancelRecommendation(String key) void
clusterEnterMaintenanceMode(VcHostSystem[] host, VcOptionValue[] option) VcClusterEnterMaintenanceResult
createTrigger(Number timeout, String filter, String condition, String filterToSync) Trigger
destroy_Task() VcTask
findRulesForVm(VcVirtualMachine ) VcClusterRuleInfo[]
moveHostInto_Task(VcHostSystem host, VcResourcePool resourcePool) VcTask
moveInto_Task(VcHostSystem[] host) VcTask
recommendHostsForVm(VcVirtualMachine vm, VcResourcePool pool) VcClusterHostRecommendation[]
reconfigureCluster_Task(VcClusterConfigSpec spec, boolean modify) VcTask
reconfigureComputeResource_Task(VcComputeResourceConfigSpec spec, boolean modify) VcTask
refreshRecommendation() void
reload() void
rename_Task(String newName) VcTask
retrieveDasAdvancedRuntimeInfo() VcClusterDasAdvancedRuntimeInfo
setCustomValue(String key, String value) void
stampAllRulesWithUuid_Task() VcTask

Returned by

Method Returns
VcFolder.createCluster(String name, VcClusterConfigSpec spec) VcClusterComputeResource
VcFolder.createClusterEx(String name, VcClusterConfigSpecEx spec) VcClusterComputeResource
VcPlugin.getAllClusterComputeResources(String[] additionalPropertyFilters, String query) VcClusterComputeResource[]
VcSdkConnection.getAllClusterComputeResources(String[] additionalPropertyFilters, String query) VcClusterComputeResource[]
VcStoragePod.createCluster(String name, VcClusterConfigSpec spec) VcClusterComputeResource
VcStoragePod.createClusterEx(String name, VcClusterConfigSpecEx spec) VcClusterComputeResource

Referenced in

None