Scripting Object - VcFailoverClusterConfigurator

Scripting-object corresponding to
FailoverClusterConfigurator
Attribute of
VcServiceContent

Scripting Object Description

FailoverClusterConfigurator provides operations to create and configure a vCenter High Availability Cluster (VCHA Cluster). A VCHA Cluster consists of three VMs. One is the Active vCenter VM that serves client requests. Second is the Passive VM that is identical to the Active vCenter VM in terms of resources and capabilities. Passive VM constantly receives updates from Active VM and takes over the role of Active vCenter VM in the event of failover. Third is the Witness VM that acts as a quorum VM in a VCHA Cluster. Sole purpose of Witness VM is to avoid classic split-brain problem in a VCHA Cluster. A VCHA Cluster can be deployed in two possible ways - 1. Automatic deployment - Configuration (described below) inputs for each node in a VCHA Cluster is provided by the user. A Deployment workflow is used that automatically deploys Passive and Witness VM and configures each node to form a VCHA Cluster. 2. Manual deployment - User provisions and creates Passive and Witness VMs and uses Configuration workflow to configure Active, Passive and Witness VM to form a VCHA Cluster. Passive and Witness VMs must be created using the VM-Clone operation with Active VM as the source.

Attributes

Name Type Description
disabledConfigureMethodString []

@since vSphere API 6.5
idString

@since Unknown
morefVcManagedObjectReference

returns the ManagedObjectReference of this ManagedObject @since Unknown
sdkConnectionVcSdkConnection

@since Unknown
sdkIdString

@since Unknown
typeStringDeprecated.

Returns the name for the this managed object's vim type @since Unknown
vchaConfigVcVchaClusterConfigInfo

Returns the configuration information for each node that is part of the VCHA Cluster. @since vSphere API 6.5
vimHostVcSdkConnection

@since Unknown
vimIdString

@since Unknown
vimTypeString

@since Unknown

Methods

Methods defined in this Scripting Object
_getRef, configureVcha_Task, createPassiveNode_Task, createTrigger, createWitnessNode_Task, deployVcha_Task, destroyVcha_Task

deployVcha_Task

Deploys and Configures VCHA on the local vCenter as a single API. This deployment operation automatically provisions and creates a Passive and a Witness node followed by configuring each node such that a 3 node VCHA Cluster is formed. After configuration, the VCHA Cluster is enabled on a best effort basis, but if this operation does not succeed, {@link vim.vcha.FailoverClusterManager#setClusterMode} must be called to enable it. State replication or failover is not allowed until the VCHA Cluster is enabled. The current vCenter Server continues to serve client requests during and after the deployment. If the activeVcNetworkConfig spec if filled in, the cluster network will be created and configured. No changes will be made if the cluster network is already configured. @since vSphere API 6.5

Parameters

NameTypeDescription
arg0VcVchaClusterDeploymentSpec


Return Value

Type Description
VcTask

_getRef

@since Unknown

Parameters

NameTypeDescription
None

Return Value

Type Description
VcManagedObjectReference

createTrigger

@since Unknown

Parameters

NameTypeDescription
timeoutNumber

filterString

conditionString

filterToSyncString


Return Value

Type Description
Trigger

createPassiveNode_Task

Creates a Passive node in a degraded VCHA Cluster with node location information and pre-existing VCHA Cluster configuration from the Active node. @since vSphere API 6.5

Parameters

NameTypeDescription
arg0VcPassiveNodeDeploymentSpec

arg1VcSourceNodeSpec


Return Value

Type Description
VcTask

destroyVcha_Task

Destroys the VCHA cluster setup and removes all VCHA specific configuration from the VCVA appliance. The active node in the cluster continues to run as a standalone VCVA appliance after the destroy operation has been performed. This operation is allowed under the following circumstances: - VCHA cluster is disabled - The node is in an isolated state - VCHA Deploy/Configure has failed @since vSphere API 6.5

Parameters

NameTypeDescription
None

Return Value

Type Description
VcTask

configureVcha_Task

Configure VCHA on the local vCenter Server. This operation configures the VC appliance with VCHA specific inputs and uses already deployed Passive and Witness nodes to set up the VCHA cluster. After configuration, the VCHA Cluster is enabled on a best effort basis, but if this operation does not succeed, {@link vim.vcha.FailoverClusterManager#setClusterMode} must be called to enable it. State replication or failover is not allowed until the VCHA Cluster is enabled. The current vCenter Server continues to serve client requests during and after the configuration. @since vSphere API 6.5

Parameters

NameTypeDescription
arg0VcVchaClusterConfigSpec


Return Value

Type Description
VcTask

createWitnessNode_Task

Creates a Witness node in a degraded VCHA Cluster with node location information and pre-existing VCHA Cluster configuration from the Active node. @since vSphere API 6.5

Parameters

NameTypeDescription
arg0VcNodeDeploymentSpec

arg1VcSourceNodeSpec


Return Value

Type Description
VcTask