Vsan Cluster Health System Vsan Query Verify Cluster Network Settings

Vsan Cluster Health System Vsan Query Verify Cluster Network Settings

Queries the vSAN cluster network setting and connectivity health status

Required privileges: System.Read

Request
URI
POST
https://{api_host}/sdk/vim25/{release}/vsan/VsanClusterHealthSystem/{moId}/VsanQueryVerifyClusterNetworkSettings
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 VsanClusterHealthSystem/{moId}.

string
release
Required

The vSphere release schema. The current specification covers vSphere 9.0.0.0 APIs.


Request Body
Required
"VsanQueryVerifyClusterNetworkSettingsRequestType Object"
array of string
hosts
Required

The vSAN hosts

string
esxRootPassword
Required

The root password for the host. The password should be the same for all of hosts in the vSAN cluster

Authentication
This operation uses the following authentication methods.
Responses
200

The vSAN cluster network health result

Returns VsanClusterNetworkHealthResult of type(s) application/json
"VsanClusterNetworkHealthResult Object"
array of object
hostResults
Optional

Per host network health test result in the vSAN cluster

boolean
issueFound
Optional

Whether any vSAN cluster network health issue was found

boolean
vsanVmknicPresent
Optional

True if at least one vSAN vmknic is found on the hosts

boolean
matchingMulticastConfig
Optional

True if all of hosts in the vSAN cluster have matched multicast configuration

boolean
matchingIpSubnets
Optional

Deprecated as of vSphere API 6.7.0 Update 1 release.

True if all of hosts in the vSAN cluster are in the same network subnets

boolean
pingTestSuccess
Optional

True if the network ping test with small package size is succeed from all of hosts to all other hosts.

The ping test will fail when the ping test between any of two hosts has lost packet

boolean
largePingTestSuccess
Optional

True if the network ping test with large package size (9000 bytes) is succeed from all of hosts to all other hosts.

The ping test will fail when the ping test between any of two hosts has lost packet

boolean
hostLatencyCheckSuccess
Optional

True if the network latency check via ping small package size is succeed from all of hosts to all other hosts.

The network latency test will fail when the ping test between any of two hosts max latency over 200 ms.

boolean
potentialMulticastIssue
Optional

True if the vSAN cluster has potential multicast issue if any one of the checks fails including if there is vSAN partition, any ping test fails, if the vSAN multicast configuration matches among all of hosts and if there is at lease one vSAN vmknic present for all of hosts.

array of string
otherHostsInVsanCluster
Optional

The hosts UUID list which are in the vSAN cluster but cannot find in the vCenter cluster.

array of object
partitions
Optional

The vSAN cluster partition information.

array of string
hostsWithVsanDisabled
Optional

The host name list which are disabled vSAN.

array of string
hostsDisconnected
Optional

The host name list which are disconnected from vCenter.

array of string
hostsCommFailure
Optional

The host name list on which the vSAN service cannot cannot communicate with the vSAN service in vCenter.

array of string
hostsInEsxMaintenanceMode
Optional

The host name list which are in the maintenance mode.

array of string
hostsInVsanMaintenanceMode
Optional

The host name list which are in the vSAN maintenance mode.

array of object
infoAboutUnexpectedHosts
Optional

Any additional information about hosts in otherHostsInVsanCluster field will be captured here.

If there is no additional info available, then the host will not be listed here.

boolean
clusterInUnicastMode
Optional

Cluster is using unicast or not.

Only all host in the cluster are in unicast mode, will the cluster be identified as using unicast.

boolean
clusterInRDMAMode
Optional

True indicates Cluster has enabled RDMA for data traffic among host.

Only when all hosts in the cluster are enabled RDMA and use RoCEv2 protocol for data traffic, the cluster will be considered as RDMA mode.


500

Failure

Returns NotFound of type(s) application/json
"NotFound Object"

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/sdk/vim25/{release}/vsan/VsanClusterHealthSystem/{moId}/VsanQueryVerifyClusterNetworkSettings