Managed Object - FailoverClusterConfigurator

Property of
ServiceContent
See also
NodeDeploymentSpec, PassiveNodeDeploymentSpec, SourceNodeSpec, VchaClusterConfigInfo, VchaClusterConfigSpec, VchaClusterDeploymentSpec, VchaClusterNetworkSpec
Since
vSphere API 6.5


Managed Object Description

Properties

Name Type Description
disabledConfigureMethod*xsd:string[]


*May not be present

Methods

Methods defined in this Managed Object
configureVcha_Task, createPassiveNode_Task, createWitnessNode_Task, deployVcha_Task, destroyVcha_Task, getVchaConfig, prepareVcha_Task

configureVcha_Task

Required Privileges
Global.VCServer

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the FailoverClusterConfigurator used to make the method call.
configSpec PVchaClusterConfigSpec

Since vSphere API 6.5
P Required privilege: configSpec

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



createPassiveNode_Task

Required Privileges
Global.VCServer

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the FailoverClusterConfigurator used to make the method call.
passiveDeploymentSpec PPassiveNodeDeploymentSpec

Since vSphere API 6.5
sourceVcSpec PSourceNodeSpec

Since vSphere API 6.5
PRequired privilege - see tooltip for details

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



createWitnessNode_Task

Required Privileges
Global.VCServer

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the FailoverClusterConfigurator used to make the method call.
witnessDeploymentSpec PNodeDeploymentSpec

Since vSphere API 6.5
sourceVcSpec PSourceNodeSpec

Since vSphere API 6.5
PRequired privilege - see tooltip for details

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



deployVcha_Task

Required Privileges
Global.VCServer

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the FailoverClusterConfigurator used to make the method call.
deploymentSpec PVchaClusterDeploymentSpec

Since vSphere API 6.5
P Required privilege: deploymentSpec

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



destroyVcha_Task

Required Privileges
Global.VCServer

Parameters

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

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



getVchaConfig

Required Privileges
System.Read

Parameters

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

Return Value

Type Description
VchaClusterConfigInfo

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



prepareVcha_Task

Required Privileges
Global.VCServer

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the FailoverClusterConfigurator used to make the method call.
networkSpec PVchaClusterNetworkSpec

Since vSphere API 6.5
P Required privilege: networkSpec

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