Host Vsan Health System Vsan Host Query Verify Network Settings

Host Vsan Health System Vsan Host Query Verify Network Settings

Queries all network settings required to perform a cluster wide network health check.

In addition, for all specified peers connectivity checks are performed, providing network health from the perspective of this ESXi host.

Required privileges: System.Read

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

string
release
Required

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

Request Body
VsanHostQueryVerifyNetworkSettingsRequestType of type(s) application/json
Required 
"VsanHostQueryVerifyNetworkSettingsRequestType Object"
array of string
peers
Optional

List of IP addresses of other hosts in the vSAN cluster. Used to perform connectivity checks.

array of string
ROBOStretchedClusterWitnesses
Optional

List of ROBO witness IPs. Used to info host that during the network connectivity check, the time out threshold should be different.

array of string
vMotionPeers
Optional

List of IP addresses of vMotion traffic enabled NICs excludes this host. Used to perform vMotion connectivity checks.

object
spec
Optional

The additional spec for querying the vSAN health, e.g., whether it should include the server vSAN datastore.

This structure may be used only with operations rendered under /vsan.

Authentication
This operation uses the following authentication methods.
Responses
200

Summarized network health related information from the perspective of this host.

Returns VsanNetworkHealthResult of type(s) application/json 
"VsanNetworkHealthResult Object"
host
Optional

Reference to host which ran the network health check

string
hostname
Optional

Hostname/IP of host which ran the network health check.

boolean
vsanVmknicPresent
Optional

Whether or not the host which ran the health check had a vSAN vmknic configured.

array of string
ipSubnets
Optional

The IP subnets of vSAN vmknics configured on the host in the form: a.b.c.d/x

boolean
issueFound
Optional

Any health issue found by the local host? Reason is contained in one of the other properties.

array of object
peerHealth
Optional

Health of peer network connectivity as seen by the host which ran the check.

array of object
vMotionHealth
Optional

Perform a connectivity check for vMotion between this host and others.

string
multicastConfig
Optional

IP addresses used for multicast by vSAN.

This is meant as an opaque string, not to be parsed and the format to be relied on. The format may change in the future. The basic format for the multicast config is "agent group multicast IP/master group multicast IP" and will be concatenated by ',' if there are multiple vSAN vmknics.

string
unicastConfig
Optional

IP addresses used for unicast by vSAN in the format of JSON.

boolean
inUnicast
Optional

Host is using unicast or not.

boolean
rdmaEnabled
Optional

True indicates the host has enabled RDMA for data traffic in Reliable Datagram Transport (RDT) protocol

string
rdtConnProtocol
Optional

The Reliable Datagram Transport (RDT) protocol used by host for vSAN data traffic.

vSAN supported RDT protocols include TCP, RoCEv1 and RoCEv2.

array of object
serverClusters
Optional

Information of server vSAN clusters.

array of object
externalPeerHealth
Optional

Perform a connectivity check for vSAN client network between this host and others when vSAN MAX client network is enabled.


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/HostVsanHealthSystem/{moId}/VsanHostQueryVerifyNetworkSettings
On This Page
V San Service Api Operations
POST
Host Vsan Health System Vsan Host Clomd Liveness
POST
Host Vsan Health System Vsan Host Cleanup Vmdk Load Test
Deprecated
POST
Host Vsan Health System Vsan Host Create Vm Health Test
POST
Host Vsan Health System Vsan Flash Scsi Controller Firmware Task
Deprecated
POST
Host Vsan Health System Vsan Get Hcl Info
POST
Host Vsan Health System Vsan Get Network Diagnostics Health Info
POST
Host Vsan Health System Vsan Get Proactive Rebalance Info
POST
Host Vsan Health System Vsan Host Prepare Vmdk Load Test
Deprecated
POST
Host Vsan Health System Vsan Host Query Adv Cfg
POST
Host Vsan Health System Vsan Host Query Check Limits
POST
Host Vsan Health System Vsan Host Query Encryption Health Summary
POST
Host Vsan Health System Vsan Host Query File Service Health Summary
POST
Host Vsan Health System Vsan Query Host EMM State
POST
Host Vsan Health System Vsan Host Query Host Info By Uuids
POST
Host Vsan Health System Vsan Host Query Object Health Summary
POST
Host Vsan Health System Vsan Host Query Physical Disk Health Summary
POST
Host Vsan Health System Vsan Host Query Run Iperf Client
POST
Host Vsan Health System Vsan Host Query Run Iperf Server
POST
Host Vsan Health System Vsan Host Query Smart Stats
POST
Host Vsan Health System Vsan Host Query Verify Network Settings
POST
Host Vsan Health System Vsan Host Query Health System Version
POST
Host Vsan Health System Vsan Host Repair Immediate Objects
POST
Host Vsan Health System Vsan Host Run Vmdk Load Test
Deprecated
POST
Host Vsan Health System Vsan Start Proactive Rebalance
POST
Host Vsan Health System Vsan Stop Proactive Rebalance
POST
Host Vsan Health System Vsan Wait For Vsan Health Generation Id Change