Host Vsan Health System Vsan Host Query Run Iperf Server

Host Vsan Health System Vsan Host Query Run Iperf Server

Run the network performance test server side program to act as the receiver to receive the packet from sender.

Required privileges: System.Read

Request
URI
POST
https://{api_host}/sdk/vim25/{release}/vsan/HostVsanHealthSystem/{moId}/VsanHostQueryRunIperfServer
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
VsanHostQueryRunIperfServerRequestType of type(s) application/json
Required 
"VsanHostQueryRunIperfServerRequestType Object"
boolean
multicast
Required

True to test mutlicast network performance. False to test unicast network performance.

string
serverIp
Optional

The server IP binding to in the test

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.
Responses
200

The network performance test result

Returns VsanNetworkLoadTestResult of type(s) application/json 
"VsanNetworkLoadTestResult Object"
string
hostname
Required

The host name

string
status
Optional

The host network load test status.

For multicast, the status will be in red if the speed is less than 20 MB/s, the status will be yellow if the speed is between 20MB/s and 50MB/s and it's green if the speed is larger than 50MB/s; For unicast, the status will be red if the speed is 0 Mb/s, and yellow if the speed is less than 850 Mb/s, the status will be green if the speed is larger than or equal to 850 Mb/s.

boolean
client
Required

True indicates the host will act as the sender to send the network packets to other host(s) in the network performance test

integer As int64 As int64
bandwidthBps
Required

If the host acts as the sender, it's the value for the maximum achievable bandwidth and if the host acts as the receiver, it's the value for the actual network bandwidth in byte per second in the test

integer As int64 As int64
totalBytes
Required

The total received or sent packet bytes in the network performance test

integer As int64 As int64
lostDatagrams
Optional

The number of lost datagrams in the network performance test.

This value will only be set for the host acting as receiver

integer As int64 As int64
lossPct
Optional

The percentage for the lost datagrams in the network performance test.

This value will only be set for the host acting as receiver

integer As int64 As int64
sentDatagrams
Optional

The total number of sending datagrams in the network performance test.

This value will only be set for the host acting as receiver

number As float As float
jitterMs
Optional

The network packet jitter in millisecond in the network performance test.

It shows the average packet latency between sender and receiver. This value will only be set for the host acting as receiver


500

Failure

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/HostVsanHealthSystem/{moId}/VsanHostQueryRunIperfServer
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