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

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

Remove witness host from the vSAN stretched cluster to disable vSAN stretched cluster.

Detailed changes will happen on target cluster:

  1. vSAN on witness host will be disabled;
  2. Unicast agent setting will be removed from all data hosts in specified vSAN stretched cluster;

Original Fault Domains for both two sites will be kept, and vSAN is still enabled on all data hosts.

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

The target cluster to disable;

Required privileges: Host.Inventory.RemoveHostFromCluster

witnessHost
Optional

Witness host to remove;

string
witnessAddress
Optional

The IP address of witness host used as unicast agent.

Authentication
This operation uses the following authentication methods.
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:

  1. target cluster doesn't enable vSAN;
  2. witness host is specified but doesn't match the in-use configuration;
  3. target cluster is not vSAN stretched cluster;

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