Patch iperf

Update iperf configuration in Edge

patch

Update the iperf configuration on the Edge, you need to specify the required value for ‘iperf_version.’ The valid options are ‘iperf’ (which handles UDP) and ‘iperf3’ (which handles TCP), along with the port number. If no port is specified, the default ports are 5001 for iperf and 5201 for iperf3. Note: After applying the Patch, use the GET API to verify that the service has started successfully.

Authorizations
Path parameters
edgeIpstring · enumRequired

The IP address of the edge

Possible values:
Body
one ofOptional
or
Responses
200
sample response body
application/json
patch
PATCH /api/v1/edge/{edgeIp}/iperf HTTP/1.1
Host: api.monogoto.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 43

{
  "iperf_version": "iperf",
  "iperf_port": 5001
}
200

sample response body

{ 
  "output": "iperf / iperf3 ran successfully. Verify iperf / iperf3 process is started using GET API",
  "status": "ok"
}

Last updated

Was this helpful?