Vim Cluster Vsan Vc Stretched Cluster System Query Shared Witness Cluster Info

Vim Cluster Vsan Vc Stretched Cluster System Query Shared Witness Cluster Info

Query cluster runtime information for each cluster associated to given witness host.

Required privileges: System.Read

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

Witness host managed entity.

boolean
skipComponentsCount
Optional

Skip setting in the result the number of components for each cluster on the given witness host. This can fail if the host is disconnected, set to true to avoid failure and retrieve other information in the result.

Authentication
This operation uses the following authentication methods.
Responses
200

List of ClusterRuntimeInfo to present each cluster's information.

[
    "ClusterRuntimeInfo Object"
]
array of ClusterRuntimeInfo
Optional

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