| Local Methods | ||
Managed Object Types | Data Object Types | All Properties | All Methods |
Properties
Name | Type | Description |
---|---|---|
None |
Methods
Methods defined in this Managed Object |
---|
PerformClusterPowerAction, QueryClusterPowerContext, UpdateClusterPowerStatus |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VsanClusterPowerSystem used to make the method call. |
cluster P | ManagedObjectReference
to a ComputeResource |
The cluster where to take power action.
Since vSAN API vSAN 7.0U3 |
spec P | PerformClusterPowerActionSpec |
Indicate the detailed power action specification.
Since vSAN API vSAN 7.0U3 |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a Task | A task object tracking the power action. In case there is something wrong, the task would contain the detailed error message and the error steps. |
Faults
Type | Description |
---|---|
InvalidArgument | Exception for invalid input arguments, for example, power off the cluster without powerOffReason. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
VsanFault | Exception for generic vSAN related errors, for example, some hosts are disconnected when starting to power off. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VsanClusterPowerSystem used to make the method call. |
cluster P | ManagedObjectReference
to a ComputeResource |
The cluster which to query ClusterPowerContext.
Since vSAN API vSAN 7.0U3 |
Return Value
Type | Description |
---|---|
ClusterPowerContext | ClusterPowerContext |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VsanClusterPowerSystem used to make the method call. |
cluster P | ManagedObjectReference
to a ComputeResource |
The cluster which to update the power status.
Since vSAN API vSAN 7.0U3 |
status P | xsd:string |
The target status needs to be set.
Since vSAN API vSAN 7.0U3 |
Return Value
Type | Description |
---|---|
xsd:boolean | A boolean indicates success or not. |
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. |
VsanFault | Exception for generic vSAN related errors, for example, trying to update the power status when there is a running power action task. |
Events
Type | |
---|---|
None |
Top of page | Local Methods | ||
Managed Object Types | Data Object Types | All Properties | All Methods |