Vim Cluster Vsan Vc Stretched Cluster System VSAN Vc Convert To Stretched Cluster

This API is used to convert a traditional vSAN cluster to vSAN stretched cluster.

It will help to:

Configure vSAN cluster into two sites through vSAN Fault Domain setting;
Add witness host and configure unicast communication at cluster wide;
Setup preferred Fault Domain;
Create vSAN disk group on witness host if auto-claim is not enabled on witness host;

Relative to API VSANVcAddWitnessHost, it not only takes care of setting up witness host, but also help on vSAN sites configuration, to guarantee the vSAN cluster works in stretched mode. vSAN cluster already works in stretched mode, is not supported by this API.

Request

URI

POST

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

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

VSANVcConvertToStretchedClusterRequestType of type(s) application/json

Required

"VSANVcConvertToStretchedClusterRequestType Object"

cluster

Required

The target cluster to be converted; It is expected to enable vSAN, but not a vSAN stretched cluster;

Required privileges: Host.Inventory.EditCluster

faultDomainConfig

Required

The mapping between Fault Domain and vSAN hosts reside in target cluster, to decide how to configure vSAN cluster into two sites;

witnessHost

Required

The witness host to be added into vSAN cluster. This host must be connected and managed by the same vCenter server, and cannot be a part of target cluster;

string

preferredFd

Required

The name of preferred Fault Domain;

diskMapping

Optional

The diskMapping to be created on witness host. If disk claim is configured as auto-mode on witness host, this parameter is not required.

storagePoolSpec

Optional

The specification to add disks to vSAN storage pool. This parameter cannot be set together with diskMapping param.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

vim.Task

Returns MoRefTask of type(s) application/json

"MoRefTask Object"

500

InvalidState: If any host in target cluster is not connected to vCenter server;

InvalidArgument: If below issues exist:

target cluster doesn't enable vSAN;
witness host resides in target cluster;
neither IPv4 nor IPv6 is properly configured for vSAN traffic on all hosts in target cluster;
target cluster is already a vSAN stretched cluster;
both diskMapping and storagePoolSpec are specified;

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}/VSANVcConvertToStretchedCluster

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