Vim Cluster Vsan Vc Stretched Cluster System Vsan Vc Add Witness Host For Clusters

This API is used to convert a batch of traditional vSAN clusters into vSAN stretched clusters sharing the same witness host.

Relative to API VSANVcConvertToStretchedCluster , it takes care of witness host reconfiguration, and the stretched cluster system in each cluster may be configured:

Configure vSAN cluster into two sites through the specified vSAN Fault Domain setting;
Setup preferred Fault Domain through the specified preferredFault Domain setting;

Clusters that are already working in stretched mode are not supported. If the configuration of one or more clusters fails, the remaining successful operations will not be rolled back because this is a batch operation for multiple clusters.

Request

URI

POST

https://{api_host}/sdk/vim25/{release}/vsan/VimClusterVsanVcStretchedClusterSystem/{moId}/VsanVcAddWitnessHostForClusters

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

string

release

Required

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

Request Body

VsanVcAddWitnessHostForClustersRequestType of type(s) application/json

Required

"VsanVcAddWitnessHostForClustersRequestType Object"

configSpec

Required

The mapping between target witness host config and target clusters's config(configSpec.clusters), to decide how to configure target clusters to work in stretched mode.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

vim.Task

Returns MoRefTask of type(s) application/json

"MoRefTask Object"

500

InvalidArgument: If below issues exist:

Target witness doesn't support sharing to multiple clusters, but does provide more than one cluster;
Target witness and clusters do not meet the number limit requirements for components;
One or more of target clusters doesn't enable vSAN;
witness host resides in one or more target clusters;
neither IPv4 nor IPv6 is properly configured for vSAN traffic on all hosts in target clusters;

NotEnoughLicenses: If any host in target clusters doesn't have vSAN stretched cluster license;

NotSupported: If this API is not supported on current platform.

VsanFault: If any unexpected runtime fault is met.

Returns MethodFault of type(s) application/json

This response body class contains all of the following: InlineMethodFault0

"MethodFault Object"

faultCause

Optional

Fault which is the cause of this fault.

array of object

faultMessage

Optional

Message which has details about the error Message can also contain a key to message catalog which can be used to generate better localized messages.

Code Samples

COPY

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

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

V San Service Api Operations

POST

Vim Cluster Vsan Vc Stretched Cluster System VSAN Vc Add Witness Host