Vim Cluster Vsan Vc Stretched Cluster System VSAN Vc Retrieve Stretched Cluster Vc Capability

Vim Cluster Vsan Vc Stretched Cluster System VSAN Vc Retrieve Stretched Cluster Vc Capability

Query hosts' capabilities of supporting vSAN stretched cluster, which reside in specified cluster, to decide whether specified cluster supports vSAN stretched cluster feature.

It could be used for any cluster, but only when all hosts reside in target cluster can support vSAN stretched cluster, it can be converted to vSAN stretched cluster.

Request
URI
POST
https://{api_host}/sdk/vim25/{release}/vsan/VimClusterVsanVcStretchedClusterSystem/{moId}/VSANVcRetrieveStretchedClusterVcCapability
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
VSANVcRetrieveStretchedClusterVcCapabilityRequestType of type(s) application/json
Required 
"VSANVcRetrieveStretchedClusterVcCapabilityRequestType Object"
cluster
Required

The target cluster to query;

Required privileges: System.Read

boolean
verifyAllConnected
Optional

Whether to ignore disconnected hosts. If it is set to true, vim.fault.InvalidState will be met if any host in target cluster is disconnected; if it is set to false, disconnected hosts will be ignored. Default value is false. But a cluster with disconnected hosts cannot be converted to vSAN stretched cluster;

Authentication
This operation uses the following authentication methods.
Responses
200

List of VSANStretchedClusterCapability, to present whether each host can support vSAN stretched cluster.

[
    "VimClusterVSANStretchedClusterCapability Object"
]
array of VimClusterVSANStretchedClusterCapability
Optional

500

InvalidState: If any host in target cluster is not connected to vCenter server and verifyAllConnected is set to true;

VsanFault: If any unexpected runtime fault is met.

Returns VimFault of type(s) application/json
This response body class contains all of the following: InlineVimFault0 
"VimFault Object"

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/sdk/vim25/{release}/vsan/VimClusterVsanVcStretchedClusterSystem/{moId}/VSANVcRetrieveStretchedClusterVcCapability
On This Page
V San Service Api Operations
POST
Vim Cluster Vsan Vc Stretched Cluster System VSAN Vc Add Witness Host
POST
Vim Cluster Vsan Vc Stretched Cluster System Vsan Vc Add Witness Host For Clusters
POST
Vim Cluster Vsan Vc Stretched Cluster System VSAN Vc Convert To Stretched Cluster
POST
Vim Cluster Vsan Vc Stretched Cluster System VSAN Vc Get Preferred Fault Domain
POST
Vim Cluster Vsan Vc Stretched Cluster System VSAN Vc Get Witness Hosts
POST
Vim Cluster Vsan Vc Stretched Cluster System VSAN Vc Is Witness Host
POST
Vim Cluster Vsan Vc Stretched Cluster System VSAN Is Witness Virtual Appliance
POST
Vim Cluster Vsan Vc Stretched Cluster System Query Shared Witness Compatibility
POST
Vim Cluster Vsan Vc Stretched Cluster System Query Shared Witness Cluster Info
POST
Vim Cluster Vsan Vc Stretched Cluster System VSAN Vc Remove Witness Host
POST
Vim Cluster Vsan Vc Stretched Cluster System Vsan Vc Replace Witness Host For Clusters
POST
Vim Cluster Vsan Vc Stretched Cluster System VSAN Vc Retrieve Stretched Cluster Vc Capability
POST
Vim Cluster Vsan Vc Stretched Cluster System VSAN Vc Set Preferred Fault Domain