vSAN Management API


Data Object - VsanClusterNetworkHealthResult(vim.cluster.VsanClusterNetworkHealthResult)

Property of
VsanClusterHealthSummary
Returned by
VsanQueryVerifyClusterNetworkSettings
Extends
DynamicData
See also
VsanClusterNetworkPartitionInfo, VsanNetworkHealthResult, VsanQueryResultHostInfo
Since
vSphere API Release 5.5

Data Object Description

Contains the vSAN cluster network health test result.

This structure aggregates network health information from all hosts in a vSAN cluster. It includes per-host network connectivity results, cluster-wide connectivity test outcomes, configuration consistency information, and flags indicating detected network issues. The structure provides comprehensive information about network health that can affect vSAN operations, including connectivity between hosts, network latency, vSAN vmknic presence, and network partition detection.

Properties

Name Type Description
clusterInRDMAMode*xsd:boolean

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.

Since vSAN 7.0U2
clusterInUnicastMode*xsd:boolean

True if all connected hosts in the cluster are in unicast mode, otherwise, return False. vSAN disabled hosts are excluded.

Since 6.6
hostLatencyCheckSuccess*xsd:boolean

True if the ping test for network latency using small-sized packets is successful between all connected hosts.
The network latency test fails when:
  • The ping latency between any two data hosts > 5ms or
  • The ping latency between a data site and a witness(non-ROBO) > 200ms or
  • The ping latency between a data site and a witness(ROBO) > 500ms

Since 6.6
hostResults*VsanNetworkHealthResult[]

Per-host network health test results in the vSAN cluster.

This field contains network health information for each host in the cluster, including connectivity test results, vmknic configuration, and any host-specific network issues detected.

hostsCommFailure*xsd:string[]

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

Disconnected or not-responding hosts are not included.

hostsDisconnected*xsd:string[]

The host name list which are disconnected from vCenter.
hostsInEsxMaintenanceMode*xsd:string[]

The host name list which are in the maintenance mode.
hostsInVsanMaintenanceMode*xsd:string[]

The host name list which are in the vSAN maintenance mode.
hostsWithVsanDisabled*xsd:string[]

The host name list which are disabled vSAN.

Disconnected or not-responding hosts are not included.

infoAboutUnexpectedHosts*VsanQueryResultHostInfo[]

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.

These unexpected hosts are those in the vSAN cluster but not in the VC cluster, excluding not-responding hosts.

issueFound*xsd:boolean

Indicates whether any vSAN cluster network health issue was found.

This field is set to true when any network health problems are detected in the cluster, for example:

  • Multiple partitions exist
  • vsanVmknicPresent is False
  • issueFound in hostResults is True for any host
  • Any ping test fails
  • The hostLatencyCheckSuccess test fails
  • Hosts are disconnected from or not-responding to vCenter
largePingTestSuccess*xsd:boolean

True if the network ping test with large package size (9000 bytes) is successful between all connected hosts. The ping test between any of two connected hosts fails when there are lost packets.
matchingIpSubnets*xsd:boolean

Deprecated. As of vSphere API 6.7.0 Update 1 release. This field is no longer used as vSAN supports hosts in different subnets when using unicast networking.

Indicates whether all hosts in the vSAN cluster are in the same network subnets.

This field is set to true when all hosts have vSAN vmknics configured in the same IP subnet. Hosts in different subnets may experience network connectivity issues depending on the network configuration.

matchingMulticastConfig*xsd:boolean

Indicates whether all hosts in the vSAN cluster have matching multicast configuration.

This field is set to true when all hosts in the cluster have consistent multicast configuration for vSAN traffic. Inconsistent multicast configuration can lead to network connectivity issues and vSAN communication problems.

As of vSphere API 6.7.0 Update 1 release. vSAN has moved from multicast to unicast networking. This field is no longer relevant for clusters using unicast mode. Use clusterInUnicastMode to determine the cluster's networking mode instead.

otherHostsInVsanCluster*xsd:string[]

The UUID list of hosts which are in the vSAN cluster but not found in the vCenter cluster, including VC disconnected hosts that are in the vSAN cluster but excluding vSAN-disabled hosts in the vCenter cluster.
partitions*VsanClusterNetworkPartitionInfo[]

A list of partitions, where each partition is a collection of host UUIDs representing a group of hosts that are network-connected and mutually reachable from a vSAN perspective.

In a healthy vSAN cluster, this list should contain exactly one partition to which all participating hosts belong. If hosts within the cluster lose communication with one another, the vSAN cluster is considered split, resulting in multiple partitions.

Hosts that are not-responding are grouped into a dedicated "unknown" partition. Note that hosts disconnected from VC and hosts in maintenance mode do not impact the vSAN partition and are still included in this partition list.

pingTestSuccess*xsd:boolean

True if the network ping test with small package size is successful between all connected hosts. The ping test between any of two connected hosts fails when there are lost packets.
potentialMulticastIssue*xsd:boolean

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.

As of vSphere API 6.7.0 Update 1 release. vSAN has moved from multicast to unicast networking. This field is no longer relevant for clusters using unicast mode. Use issueFound and examine the specific test results in hostResults to identify network issues instead.

vsanVmknicPresent*xsd:boolean

Indicates whether at least one vSAN vmknic is found on the hosts.

This field is set to true if each connected host in the vSAN cluster has at least one vSAN vmknic configured.

Properties inherited from DynamicData
None
*Need not be set
Show WSDL type definition