oosVersion 2.1

iPerf

Use iPerf to measure network throughput

iPerf

iPerf measures throughput between two test endpoints: how much data can be transferred over time. The server waits for a connection, and the client starts the test. OOS can act as either endpoint.

Before testing, agree on the server IP address, port, and test method with the other endpoint’s administrator, and prepare an iPerf tool there. Tests generate network traffic, so choose a time that will not disrupt normal use.

iPerf page

Server Mode

Use this when the other endpoint will connect to OOS.

  1. Go to Diagnose > iPerf and select Server under mode.
  2. Set Server Port and Report Interval using the table below. Confirm that the client uses the same port.
  3. Click Start, then start the test from the client at the other endpoint.
  4. Review the test reports. When finished, click Stop to stop waiting for connections.
NameDescription
Server PortThe port on which the server listens and the client connects. Both ends must use the same port; the default is 5201.
Report IntervalHow often a report is generated. The default is 1 second; minutes or hours may also be used.

Client Mode

iPerf client mode

Use this when OOS will connect to an iPerf server at the other endpoint.

  1. Confirm that the other endpoint has started its iPerf server.
  2. Select Client under mode and enter the supplied Server Address and Server Port. The address in the screenshot is only an example; use your actual server address.
  3. Use the table below to choose Protocol, Interface, Transmit Mode, test duration, and other parameters. TCP and UDP are two ways to transmit data; agree on consistent test conditions with the other endpoint.
  4. Click Start. Review the reports to check for data transfer. Click Stop if you need to end the test early.

If no report appears or a connection error occurs, check that the server is running and that the address and port match. Use the same test conditions when comparing results.

NameDescription
Server AddressThe IP address of the host running the iPerf server.
Server PortThe shared client and server port; the default is 5201.
ProtocolSelect TCP or UDP. UDP requires additional bandwidth and packet-size settings.
InterfaceSelect the WAN interface on which to run iPerf.
UDP BandwidthTarget bandwidth; the UDP default is 128 KB/s, while TCP is unlimited.
UDP Packet SizeTarget UDP packet size; the default is 1470 bytes.
Transmit ModeSelect upload or download.
Test DurationHow long the test runs; the default is 10 seconds.
StreamsRun multiple streams to measure network performance.
Report IntervalHow often a report is generated. The default is 1 second; minutes or hours may also be used.