v1

latestOpenAPI 3.0.02026-07-243339471.1 MB

Gateways

Initiate a Iperf test on a Gateway

Starts an asynchronous Iperf test on the specified Gateway.

post/network-troubleshooting/v1/gateways/{serial-number}/iperf

serial-numberstring required

Serial number of the target device

iperfServerAddressstring required

IP Address Required

portinteger

The TCP port (range: 1-65535)

durationinteger

Transmission time in seconds (10-120)

parallelinteger

omitinteger

includeReverseboolean

Include Reverse

vlanInterfacestring

protocol'tcp' | 'udp'

includeRawOutputboolean

Whether to include raw output in the response.

Accepted. The operation has been successfully initiated. The response includes the location to track the operation's status.

locationstring uri-reference

The relative URL path to query the status and result of the asynchronous operation.

status'INITIATED'

The initial status of the operation.

startTimestring date-time

ISO 8601 timestamp indicating when the operation was initiated.