Managed Object - FailoverClusterManager

Property of
ServiceContent
See also
VchaClusterHealth
Since
vSphere API 6.5


Managed Object Description

Properties

Name Type Description
disabledClusterMethod* Pxsd:string[]


*May not be presentP Required privilege: System.Read

Methods

Methods defined in this Managed Object
getClusterMode, GetVchaClusterHealth, initiateFailover_Task, setClusterMode_Task

getClusterMode

Required Privileges
System.Read

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the FailoverClusterManager used to make the method call.

Return Value

Type Description
xsd:string

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



GetVchaClusterHealth

Required Privileges
System.Read

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the FailoverClusterManager used to make the method call.

Return Value

Type Description
VchaClusterHealth

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



initiateFailover_Task

Required Privileges
Global.VCServer

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the FailoverClusterManager used to make the method call.
planned Pxsd:boolean

Since vSphere API 6.5
P Required privilege: planned

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



setClusterMode_Task

Required Privileges
Global.VCServer

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the FailoverClusterManager used to make the method call.
mode Pxsd:string

Since vSphere API 6.5
P Required privilege: mode

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None