Vsan Cluster Health System Vsan Query Cluster Network Perf Test

Vsan Cluster Health System Vsan Query Cluster Network Perf Test

Queries the vSAN network performance and checks if it meets the bandwidth requirements.

Required privileges: System.Read

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

boolean
multicast
Required

True to test vSAN multicast network performance. False to test vSAN unicast network performance.

integer As int32 As int32
durationSec
Optional

The duration time for the Network Performance test. Default is 15 seconds if not set.

Authentication
This operation uses the following authentication methods.
Responses
200

The vSAN cluster network performance test result

Returns VsanClusterNetworkLoadTestResult of type(s) application/json 
"VsanClusterNetworkLoadTestResult Object"
clusterResult
Required

The overall vSAN cluster result for multicast performance test

array of object
hostResults
Optional

The multicast performance test result for each of host


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}/VsanQueryClusterNetworkPerfTest
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