---
title: "Initiate a Iperf test on a Gateway"
method: POST
path: "/network-troubleshooting/v1/gateways/{serial-number}/iperf"
tags: ["Gateways"]
---

# Initiate a Iperf test on a Gateway

`POST /network-troubleshooting/v1/gateways/{serial-number}/iperf`

Starts an asynchronous Iperf test on the specified Gateway.

## Path parameters

- `serial-number` string, required

## Request body

- IperfMcRequest
  - `iperfServerAddress` string, required — IP Address Required
  - `port` integer — The TCP port (range: 1-65535)
  - `duration` integer — Transmission time in seconds (10-120)
  - `parallel` integer
  - `omit` integer
  - `includeReverse` boolean — Include Reverse
  - `vlanInterface` string
  - `protocol` 'tcp' | 'udp'
  - `includeRawOutput` boolean — Whether to include raw output in the response.

## Response `202`

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

- AsyncOperationStatus
  - `location` string, uri-reference — The relative URL path to query the status and result of the asynchronous operation.
  - `status` 'INITIATED' — The initial status of the operation.
  - `startTime` string, date-time — ISO 8601 timestamp indicating when the operation was initiated.

## Other responses

- `400` — Bad Request. Validation errors in the request body or parameters, or invalid parameters for the specific device.
- `401` — Unauthorized. Authentication credentials are required or invalid.
- `403` — Forbidden: Access is denied.
- `404` — Not Found. The device with the specified serial number was not found.
- `409` — Conflict. The device is currently offline.
- `429` — Too Many Requests. The user has sent too many requests in a given amount of time.
- `500` — Internal Server Error. An unexpected error occurred on the server.

---

[API](https://skmtc.dev/arubanetworks/apis/authorization.md) · [All operations](https://skmtc.dev/arubanetworks/apis/authorization/llms.txt) · [OpenAPI document](https://skmtc.dev/arubanetworks/apis/authorization/revisions/74c95058b11f?raw)