vSphere Web Services API
|
| Local Properties | Local Methods | |
| Managed Object Types | Data Object Types | All Properties | All Methods |
Managed Object - ComputeResource(vim.ComputeResource)
- Property of
- ComputeResourceEventArgument, FailToEnableSPBM, NoActiveHostInCluster, ResourcePool
- Parameter to
- InstallIoFilter_Task, QueryDisksUsingFilter, QueryIoFilterInfo, QueryIoFilterIssues, UninstallIoFilter_Task, UpgradeIoFilter_Task
- Returned by
- AddStandaloneHost_Task
- Extended by
- ClusterComputeResource
- Extends
- ManagedEntity
- See also
- ComputeResourceConfigInfo, ComputeResourceConfigSpec, ComputeResourceSummary, Datastore, EnvironmentBrowser, HostSystem, Network, ResourcePool
- Since
- 2.0
Managed Object Description
Represents a set of physical compute resources for a set of virtual machines.The base type ComputeResource, when instantiated by calling AddStandaloneHost_Task, represents a single host. The subclass ClusterComputeResource represents a cluster of hosts and adds distributed management features such as availability and resource scheduling.
A ComputeResource always has a root ResourcePool associated with it. Certain types of clusters such as those with VMware DRS enabled and standalone hosts (ESX Server 3) support the creation of ResourcePool hierarchies.
Properties
| Name | Type | Description |
|---|---|---|
| configManagerEnabled* P | xsd:boolean |
Flag indicating whether or not desired configuration
management platform is enabled on the compute resource.
This property can be set only at the time of creation or through the
EnableConfigurationManagement method.
Since vSphere API Release 8.0.0.0 |
| configurationEx | ComputeResourceConfigInfo |
Configuration of the compute resource; applies to both standalone hosts
and clusters. For a cluster this property will return a
ClusterConfigInfoEx object.
Since VI API 2.5 |
| datastore* P | ManagedObjectReference[]
to a Datastore[] |
The datastore property is the subset of datastore objects in the datacenter
available in this ComputeResource.
This property is computed as the aggregate set of datastores available from all
the hosts that are part of this compute resource.
|
| environmentBrowser* P | ManagedObjectReference
to a EnvironmentBrowser |
The environment browser object that identifies the environments that are supported
on this compute resource.
|
| host* P | ManagedObjectReference[]
to a HostSystem[] |
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.
|
| lifecycleManaged* P | xsd:boolean |
Flag indicating whether or not the lifecycle of the compute resource is
managed. Once it is enabled, it cannot be disabled.
This property can be set only at the time of creation or through the
EnableLifecycleManagement method.
Since vSphere API Release 6.9.1 |
| network* P | ManagedObjectReference[]
to a Network[] |
The subset of network objects available in the datacenter that is available in
this ComputeResource.
This property is computed as the aggregate set of networks available from all the
hosts that are part of this compute resource.
|
| resourcePool* P | ManagedObjectReference
to a ResourcePool |
Reference to root resource pool.
|
| summary | ComputeResourceSummary |
Basic runtime information about a compute resource. This information is used on
summary screens and in list views.
|
| Properties inherited from ManagedEntity | ||
| alarmActionsEnabled, configIssue, configStatus, customValue, declaredAlarmState, disabledMethod, effectiveRole, name, overallStatus, parent, permission, recentTask, tag, triggeredAlarmState | ||
| Properties inherited from ExtensibleManagedObject | ||
| availableField, value | ||
Methods
| Methods defined in this Managed Object |
|---|
| ReconfigureComputeResource_Task |
| Methods inherited from ManagedEntity |
| Destroy_Task, Reload, Rename_Task |
| Methods inherited from ExtensibleManagedObject |
| setCustomValue |
ReconfigureComputeResource_Task(reconfigureEx)
Change the compute resource configuration.- Required Privileges
- Host.Inventory.EditCluster
- Since
- VI API 2.5
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the ComputeResource used to make the method call. |
| spec | ComputeResourceConfigSpec |
A set of configuration changes to apply to the compute resource.
The specification can be a complete set of changes or a partial
set of changes, applied incrementally. When invoking
reconfigureEx on a cluster, this argument may be a
ClusterConfigSpecEx object.
Since VI API 2.5 |
| 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.
Since VI API 2.5 |
Return Value
| Type | Description |
|---|---|
| ManagedObjectReference
to a Task | This method returns a Task object with which to monitor the operation. |
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 | |
| Top of page | Local Properties | Local Methods | |
| Managed Object Types | Data Object Types | All Properties | All Methods |