Vim Cluster Vsan Vc Stretched Cluster System APIs

Vim Cluster Vsan Vc Stretched Cluster System APIs

vSAN stretched Cluster is a specific configuration implemented in environments where disaster/downtime avoidance is a key requirement.

vSAN stretched Clusters with Witness Host refers to a deployment where a user sets up a vSAN cluster with 2 active/active sites with numbers of ESXi hosts between the two sites. The sites are connected via a high bandwidth/low latency link. The third site hosting the vSAN Witness Host is connected to both of the active/active data-sites. This connectivity can be via low bandwidth/high latency links. Each site is configured as a vSAN Fault Domain. The nomenclature used to describe a vSAN stretched Cluster configuration is X+Y+Z, where X is the number of ESXi hosts at data site A, Y is the number of ESXi hosts at data site B, and Z is the number of witness hosts at site C. Data sites are where virtual machines are deployed. The maximum configuration is 15+15+1 (31 nodes).
vSAN Remote Office / Branch Office Deployment, aka ROBO cluster, is a specific deployment of vSAN stretched cluster. A two-node vSAN cluster, and a vSphere vSAN witness host appliance as witness, forms a vSAN ROBO cluster. Copies of vSAN objects that make up a virtual machine are typically stored in two physical nodes, if one of the physical nodes is offline, it is still possible for virtual machines to run using the files located on another physical node. In the case where the hosts in a two-node cluster are unable to communicate across the network, the witness serves as a "tie-breaker" to achieve a quorum and enables the cluster to restart virtual machines impacted by an outage. Details to deploy a vSAN stretched cluster, please reference to API VSANVcConvertToStretchedCluster, and for ROBO cluster, please assign witness appliance to parameter 'witnessHost', and each physical host stands for a Fault Domain.
VsanVcStretchedClusterSystem is used to configure and manage vSAN stretched cluster. The ManagedEntity can be accessed through MOID of vsan-stretched-cluster-system, through vSAN service at vCenter server side.

Operations
POST
Vim Cluster Vsan Vc Stretched Cluster System VSAN Vc Add Witness Host
Add a host as witness host to vSAN cluster to re-enable vSAN stretched cluster.
POST
Vim Cluster Vsan Vc Stretched Cluster System Vsan Vc Add Witness Host For Clusters
This API is used to convert a batch of traditional vSAN clusters into vSAN stretched clusters sharing the same witness host.
POST
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.
POST
Vim Cluster Vsan Vc Stretched Cluster System VSAN Vc Get Preferred Fault Domain
Query configuration of preferred Fault Domain of specified cluster.
POST
Vim Cluster Vsan Vc Stretched Cluster System VSAN Vc Get Witness Hosts
Query witness host configuration of specified cluster.
POST
Vim Cluster Vsan Vc Stretched Cluster System VSAN Vc Is Witness Host
Check whether specified host is a witness host.
POST
Vim Cluster Vsan Vc Stretched Cluster System VSAN Is Witness Virtual Appliance
Return whether the host is a virtual appliance witness host for stretched cluster Witness host can be a VM deployed from vSAN witness server OVF, the VM added to vCenter datacenter as a ESXi host, and has no difference with other ESXi host in a stretched cluster, but the VM host can only used as witness host, UI need to know if the witness host is a virtual appliance, using this API can tell the host is a virtual appliance or not.
POST
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.
POST
Vim Cluster Vsan Vc Stretched Cluster System Query Shared Witness Cluster Info
Query cluster runtime information for each cluster associated to given witness host.
POST
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.
POST
Vim Cluster Vsan Vc Stretched Cluster System Vsan Vc Replace Witness Host For Clusters
Replace witness host for all specified vSAN stretched clusters.
POST
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.
POST
Vim Cluster Vsan Vc Stretched Cluster System VSAN Vc Set Preferred Fault Domain
Set preferred Fault Domain for a vSAN stretched cluster.