Failover Cluster Configurator Configure Vcha 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, setClusterMode_Task 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.

Required privileges: Global.VCServer

Request

URI

POST

https://{api_host}/sdk/vim25/{release}/FailoverClusterConfigurator/{moId}/configureVcha_Task

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 FailoverClusterConfigurator/{moId}.

string

release

Required

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

Request Body

configureVchaRequestType of type(s) application/json

Required

"configureVchaRequestType Object"

configSpec

Required

contains the configuration for the cluster

Authentication

This operation uses the following authentication methods.

Session

Responses

200

This method returns a Task object with which to monitor the progress of the operation.

Returns MoRefTask of type(s) application/json

"MoRefTask Object"

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/sdk/vim25/{release}/FailoverClusterConfigurator/{moId}/configureVcha_Task

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Virtual Infrastructure Operations

POST

Failover Cluster Configurator Configure Vcha Task

POST