Managed Object - VsanClusterPowerSystem(vim.cluster.VsanClusterPowerSystem)

See also: ClusterPowerContext, ComputeResource, PerformClusterPowerActionSpec, Task
Since: vSAN API vSAN 7.0U3

Managed Object Description

This managed object type provides the service interface for vsan cluster power action. i.e. power off a whole cluster, query current cluster power context, power on the cluster, etc. The vSAN cluster power system will be supported in both of VC and ESXi host. When the ManagedEntity is accessed with MOID of 'vsan-cluster-power-system' through vSAN service at vCenter server, it acts as cluster-level APIs. When it accessed with MOID of 'ha-vsan-power-system' through vSAN service at ESXi host side, its scope is only limited to that host.

Properties

Name	Type	Description
None

Methods

Methods defined in this Managed Object
PerformClusterPowerAction, QueryClusterPowerContext, UpdateClusterPowerStatus

PerformClusterPowerAction(performClusterPowerAction)

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

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VsanClusterPowerSystem used to make the method call.
cluster	ManagedObjectReference to a ComputeResource	The cluster where to take power action. *Since* vSAN API vSAN 7.0U3
spec	PerformClusterPowerActionSpec	Indicate the detailed power action specification. *Since* vSAN API vSAN 7.0U3

Name

Type

Description

_this

ManagedObjectReference

A reference to the VsanClusterPowerSystem used to make the method call.

cluster

ManagedObjectReference
to a ComputeResource

The cluster where to take power action.

Since vSAN API vSAN 7.0U3

spec

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

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="PerformClusterPowerAction" type="vsan:PerformClusterPowerActionRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="PerformClusterPowerActionResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vsan:ManagedObjectReference"/>
                     </sequence>
                  </complexType>
               </element>

QueryClusterPowerContext(queryClusterPowerContext)

Query the ClusterPowerContext.

Required Privileges: 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

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

P Required privilege: System.Read

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

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="QueryClusterPowerContext" type="vsan:QueryClusterPowerContextRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="QueryClusterPowerContextResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vsan:ClusterPowerContext"/>
                     </sequence>
                  </complexType>
               </element>

UpdateClusterPowerStatus(updateClusterPowerStatus)

Update the current cluster power status.

Required Privileges: 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	xsd:string	The target status needs to be set. *Since* vSAN API vSAN 7.0U3

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

xsd:string

The target status needs to be set.

Since vSAN API vSAN 7.0U3

P Required privilege: Host.Inventory.EditCluster

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

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="UpdateClusterPowerStatus" type="vsan:UpdateClusterPowerStatusRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="UpdateClusterPowerStatusResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="xsd:boolean"/>
                     </sequence>
                  </complexType>
               </element>

vSAN Management API

Managed Object - VsanClusterPowerSystem(vim.cluster.VsanClusterPowerSystem)

Managed Object Description

PerformClusterPowerAction(performClusterPowerAction)

QueryClusterPowerContext(queryClusterPowerContext)

UpdateClusterPowerStatus(updateClusterPowerStatus)