Vsan Vc Cluster Health System Vsan Query Vc Cluster Network Perf Test

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

For multicast performance, the test is done by picking one host as the sender, and having all other hosts be receivers. For unicast performance, the test is done by having all hosts form a circular list, and every host in the list will be sending packets to the next host, while receiving packets from the previous host at the same time. For multicast test, the status in test result will be:

red if the speed is less than 20 MB/s
yellow if the speed is between 20MB/s and 50MB/s
green if the speed is larger than 50MB/s

For unicast test, the status in test result will be:

red if the speed is 0 Mb/s
yellow if the speed is less than 850 Mb/s
green if the speed is larger than or equal to 850 Mb/s

Note: Calling this API requires vCenter and all the connected hosts to support the same network performance testing capability(multicast or unicast). As vSAN is moving from multicast to unicast, only the unicast test method is supported since vSphere 6.7 Update 1 release. This API will return "Not Supported" in case the test method is not currently supported by this cluster. User could query VsanGetCapabilities() API to check whether the cluster supports the unicast network performance test. The test is supported if the 'netperftest' capability can be found on the vCenter and all the hosts in this cluster. This API is intended for network bandwidth diagnostics in the environment with no production workloads. It is not designed for network bandwidth monitoring with production workloads as it might impact the actual network utilization during the test.

Request

URI

POST

https://{api_host}/sdk/vim25/{release}/vsan/VsanVcClusterHealthSystem/{moId}/VsanQueryVcClusterNetworkPerfTest

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 VsanVcClusterHealthSystem/{moId}.

string

release

Required

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

Request Body

VsanQueryVcClusterNetworkPerfTestRequestType of type(s) application/json

Required

"VsanQueryVcClusterNetworkPerfTestRequestType Object"

cluster

Required

The target cluster

Required privileges: System.Read

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 of the Network Performance test. Default is 15 seconds if not set.

Authentication

This operation uses the following authentication methods.

Session

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

NotFound: If the host can not be contacted to perform the operation.

NotSupported: If run multicast in vSphere 6.7 above version.

Returns MethodFault of type(s) application/json

This response body class contains all of the following: InlineMethodFault0

"MethodFault Object"

faultCause

Optional

Fault which is the cause of this fault.

array of object

faultMessage

Optional

Message which has details about the error Message can also contain a key to message catalog which can be used to generate better localized messages.

Code Samples

COPY

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

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

V San Service Api Operations