Vsan Cluster Power System Perform Cluster Power Action

Vsan Cluster Power System Perform Cluster Power Action

Execute cluster power off or power on action.

When it's called from VC, it will acts as cluster level API to perform the cluster power action. When it's called from host, if it's an orchestration host, it will act the similar role of VC to orchestrate the cluster power worflow. Otherwise, it will execute specific host power actions such as power off according to spec

Required privileges: Host.Config.Power Host.Inventory.EditCluster

Request
URI
POST
https://{api_host}/sdk/vim25/{release}/vsan/VsanClusterPowerSystem/{moId}/PerformClusterPowerAction
COPY
Path Parameters
string
moId
Required

The unique identifier for the managed object to which the method attaches; the serialized managed object reference for a request has the form moType/moId, in this case VsanClusterPowerSystem/{moId}.

string
release
Required

The vSphere release schema. The current specification covers vSphere 9.0.0.0 APIs.


Request Body
PerformClusterPowerActionRequestType of type(s) application/json
Required
"PerformClusterPowerActionRequestType Object"
cluster
Required

The cluster where to take power action.

spec
Required

Indicate the detailed power action specification.

Authentication
This operation uses the following authentication methods.
Responses
200

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.

Returns MoRefTask of type(s) application/json
"MoRefTask Object"

500

InvalidArgument: Exception for invalid input arguments, for example, power off the cluster without powerOffReason.

VsanFault: Exception for generic vSAN related errors, for example, some hosts are disconnected when starting to power off.

Returns MethodFault of type(s) application/json
This response body class contains all of the following: InlineMethodFault0
"MethodFault Object"
faultCause
Optional

Fault which is the cause of this fault.

array of object
faultMessage
Optional

Message which has details about the error Message can also contain a key to message catalog which can be used to generate better localized messages.


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/sdk/vim25/{release}/vsan/VsanClusterPowerSystem/{moId}/PerformClusterPowerAction