Vim Cluster Vsan Vc Stretched Cluster System Query Shared Witness Compatibility

Vim Cluster Vsan Vc Stretched Cluster System Query Shared Witness Compatibility

Query whether a given host could be used as shared witness for a group of specified ROBO clusters.

Result data would contain compatibility check result for both sharedWitnessHost and roboClusters. For sharedWitnessHost, it will check following items. 1) Check whether given host is a witness host. 2) Check whether this witness host has shared witness capability. 3) Check whether clusters count would exceed per shared witness host's limit. For roboClusters, it will check following items. 1) For a vSAN not enabled cluster, check whether it could be a candidate of ROBO cluster (cluster which has 2 hosts). 2) For a vSAN enabled cluster, check whether it is a ROBO cluster (stretched cluster which has 2 hosts). 3) For a ROBO cluster, check whether its component limit exceeds current shared witness host's component count limitation for individual cluster.

Required privileges: System.Read

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

A host entity which would be used as a shared witness host.

array of object
roboClusters
Required

A list of ROBO clusters which would use sharedWitnessHost as their witness.

Authentication
This operation uses the following authentication methods.
Responses
200

SharedWitnessCompatibilityResult to present compatibility check result of given shared witness host and robo cluster list.

Returns VSANSharedWitnessCompatibilityResult of type(s) application/json 
"VSANSharedWitnessCompatibilityResult Object"
witnessHostCompatibility
Required

Represent whether given shared witness host could be attached to all specified ROBO clusters.

array of object
roboClusterCompatibility
Optional

Represent whether each given ROBO cluster could support using target shared witness host as its witness.


500

VsanFault: If any unexpected runtime fault is met.

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

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