Vsan Cluster Health System Vsan Query Cluster Capture Vsan Pcap

Vsan Cluster Health System Vsan Query Cluster Capture Vsan Pcap

Captures the vSAN cluster multicast network trace to ensure that all of hosts in the cluster can receive multicast packets

Required privileges: System.Read

Request
URI
POST
https://{api_host}/sdk/vim25/{release}/vsan/VsanClusterHealthSystem/{moId}/VsanQueryClusterCaptureVsanPcap
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
VsanQueryClusterCaptureVsanPcapRequestType of type(s) application/json
Required 
"VsanQueryClusterCaptureVsanPcapRequestType 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

integer As int32 As int32
duration
Required

Duration to watch for packets in second. 1 minute is recommended

array of object
vmknic
Optional

The map for host and the vmknic using for vSAN

boolean
includeRawPcap
Optional

True to include the raw pcap data in the result. Default is False

boolean
includeIgmp
Optional

True to include the IGMP network test data. Default is True

array of string
cmmdsMsgTypeFilter
Optional

The filter for vSAN message type. The network message whose type is not in the filter list will be ignored. All of the supported message types include "MASTER_HEARTBEAT", "MASTER_UPDATE" and "AGENT_HEARTBEAT".

array of integer
cmmdsPorts
Optional

The vSAN multicast ports. Unset will use the default vSAN multicast ports.

string
clusterUuid
Optional

The vSAN cluster UUID.

Authentication
This operation uses the following authentication methods.
Responses
200

The vSAN cluster multicast trace result

Returns VsanVsanClusterPcapResult of type(s) application/json 
"VsanVsanClusterPcapResult Object"
array of string
pkts
Optional

The multicast network trace packets in the json format with the keys including "seenBy" (the host list which can communicate with this host), "cmmdsMcastSeq" (the CMMDS multicast packet sequence number), "dstIp" (the multicast destination IP), "srcUuid" (the source host UUID), "sentBy" (the host IP sending the multicast packet), "timestamp", "srcPort" , "msgType"(the multicast packet message type), "srcIp", "clusterUuid" (the vSAN cluster UUID), "pktType" (the packet type) and "dstPort"

array of object
groups
Optional

The Pcap group result

array of string
issues
Optional

The issue list contains the potential mutlicast communication issue between two communication entities with plain string format"

array of object
hostResults
Optional

Per host result for the vSAN multicast connectivity test


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}/VsanQueryClusterCaptureVsanPcap
On This Page
V San Service Api Operations
POST
Vsan Cluster Health System Vsan Check Cluster Clomd Liveness
POST
Vsan Cluster Health System Vsan Cluster Get Hcl Info
POST
Vsan Cluster Health System Vsan Query Cluster Adv Cfg Sync
POST
Vsan Cluster Health System Vsan Query Cluster Capture Vsan Pcap
POST
Vsan Cluster Health System Vsan Query Cluster Check Limits
POST
Vsan Cluster Health System Vsan Query Cluster Create Vm Health Test
POST
Vsan Cluster Health System Vsan Query Cluster Health System Versions
POST
Vsan Cluster Health System Vsan Query Cluster Network Perf Test
POST
Vsan Cluster Health System Vsan Query Cluster Physical Disk Health Summary
POST
Vsan Cluster Health System Vsan Query Verify Cluster Network Settings
POST
Vsan Cluster Health System Vsan Repair Cluster Immediate Objects