Cluster Compute Resource APIs

Cluster Compute Resource APIs

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.

Operations

Cluster Compute Resource Abandon Hci Workflow

Opt out of the HCI workflow.

Cluster Compute Resource Add Host Task

Adds a host to the cluster.

Cluster Compute Resource Apply Recommendation

Applies a recommendation from the drsRecommendation or the recommendation list.

Cluster Compute Resource Cancel Recommendation

Cancels a recommendation.

Cluster Compute Resource Cluster Enter Maintenance Mode

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.

Cluster Compute Resource Configure HCI Task

Configures the cluster.

Cluster Compute Resource Destroy Task

Destroys this object, deleting its contents and removing it from its parent folder (if any).

Cluster Compute Resource Evc Manager

A managed object that controls Enhanced vMotion Compatibility mode for this cluster.

Cluster Compute Resource Extend HCI Task

Extend an existing HCI cluster.

Cluster Compute Resource Find Rules For Vm

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

Cluster Compute Resource Get Action History

The set of actions that have been performed recently.

Cluster Compute Resource Get Alarm Actions Enabled

Whether alarm actions are enabled for this entity.

Cluster Compute Resource Get Available Field

List of custom field definitions that are valid for the object's type.

Cluster Compute Resource Get Config Issue

Current configuration issues that have been detected for this entity.

Cluster Compute Resource Get Config Manager Enabled

Flag indicating whether or not desired configuration management platform is enabled on the compute resource.

Cluster Compute Resource Get Config Status

The configStatus indicates whether or not the system has detected a configuration issue involving this entity.

Cluster Compute Resource Get Configuration

Configuration of the cluster.

Cluster Compute Resource Get Configuration Ex

Configuration of the compute resource; applies to both standalone hosts and clusters.

Cluster Compute Resource Get Custom Value

Custom field values.

Cluster Compute Resource Get Datastore

The datastore property is the subset of datastore objects in the datacenter available in this ComputeResource.

Cluster Compute Resource Get Declared Alarm State

A set of alarm states for alarms that apply to this managed entity.

Cluster Compute Resource Get Disabled Method

List of operations that are disabled, given the current runtime state of the entity.

Cluster Compute Resource Get Drs Fault

A collection of the DRS faults generated in the last DRS invocation.

Cluster Compute Resource Get Drs Recommendation

If DRS is enabled, this returns the set of recommended migrations from the DRS module.

Cluster Compute Resource Get Effective Role

Access rights the current session has to this entity.

Cluster Compute Resource Get Environment Browser

The environment browser object that identifies the environments that are supported on this compute resource.

Cluster Compute Resource Get Hci Config

This is applicable to clusters which are configured using the HCI workflow and contains data related to the workflow and specification.

Cluster Compute Resource Get Host

List of hosts that are part of this compute resource.

Cluster Compute Resource Get Lifecycle Managed

Flag indicating whether or not the lifecycle of the compute resource is managed.

Cluster Compute Resource Get Migration History

The set of migration decisions that have recently been performed.

Cluster Compute Resource Get Name

Name of this entity, unique relative to its parent.

Cluster Compute Resource Get Network

The subset of network objects available in the datacenter that is available in this ComputeResource.

Cluster Compute Resource Get Overall Status

General health of this managed entity.

Cluster Compute Resource Get Parent

Parent of this entity.

Cluster Compute Resource Get Permission

List of permissions defined for this entity.

Cluster Compute Resource Get Recent Task

The set of recent tasks operating on this managed entity.

Cluster Compute Resource Get Recommendation

List of recommended actions for the cluster.

Cluster Compute Resource Get Resource Pool

Reference to root resource pool.

Cluster Compute Resource Get Resource Usage

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

Cluster Compute Resource Get Summary

Basic runtime information about a compute resource.

Cluster Compute Resource Get Summary Ex

The cluster summary.

Cluster Compute Resource Get System V Ms Restricted Datastores

Retrieve all the datastores that are either listed in *ClusterSystemVMsConfigInfo.notAllowedDatastores* or are tagged with a category from *ClusterSystemVMsConfigInfo.dsTagCategoriesToExclude*.

Cluster Compute Resource Get Tag

The set of tags associated with this managed entity.

Cluster Compute Resource Get Triggered Alarm State

A set of alarm states for alarms triggered by this entity or by its descendants.

Cluster Compute Resource Get Value

List of custom field values.

Cluster Compute Resource Move Host Into Task

Moves an existing host into a cluster.

Cluster Compute Resource Move Into Task

Moves an existing host into a cluster.

Cluster Compute Resource Place Vm

This method returns a *PlacementResult* object.

Cluster Compute Resource Recommend Hosts For Vm

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.

Cluster Compute Resource Reconfigure Cluster Task

Reconfigures a cluster.

Cluster Compute Resource Reconfigure Compute Resource Task

Change the compute resource configuration.

Cluster Compute Resource Refresh Recommendation

Make DRS invoke again and return a new list of recommendations.

Cluster Compute Resource Reload

Reload the entity state.

Cluster Compute Resource Rename Task

Renames this managed entity.

Cluster Compute Resource Retrieve Das Advanced Runtime Info

Retrieve DAS advanced runtime info for this cluster.

Cluster Compute Resource Set Crypto Mode

Set the desired encryption mode and host key for the cluster.

Cluster Compute Resource Set Custom Value

Assigns a value to a custom field.

Cluster Compute Resource Stamp All Rules With Uuid Task

Stamp all rules in the cluster with ruleUuid.

Cluster Compute Resource Validate HCI Configuration

Validate HCI configuration in pre-configure and post-configure use-cases.