Running the iperf utility

If you have already run the iperf utility, a report file was generated with network performance diagnostics results. When you run the utility again, that report file is overwritten. You can download the previous report file if you want to keep it.

To run the iperf utility:

1. In the menu, go to the SD-WAN → CPE section.

   A table of CPE devices is displayed.

2. Click the CPE device on which you want to run the iperf utility.

   The settings area is displayed in the lower part of the page. You can expand the settings area to fill the entire page by clicking the expand icon . By default, the Configuration tab is selected, which displays general information about the CPE device. This tab also displays the table of Out-of-band management tasks being performed by the orchestrator.

3. Select the Utilities → Iperf tab.

   The iperf utility settings are displayed.

4. Specify the mode in which you want to use the iperf utility on the CPE device by selecting one of the following options:
   • Server to use the CPE device as an iperf server.
   • Client to use the CPE device as an iperf client.
5. If you chose the Server option, configure the iperf server:
   1. In the Port field, enter the TCP or UDP port number of the iperf server. Range of values: 1001 to 65,535. The default setting is 7777.
   2. In the Report interval (sec.) field, enter the interval in seconds for writing lines to the report file. Range of values: 0 to 60. The default setting is 3.
   3. If you do not want to create a report file with network performance diagnostics results, select the Do not report check box. This check box is cleared by default.
   4. Under Report format, select the format of the network performance diagnostics results in the report file:
      • Kbit/sec (default)
      • Mbit/sec
      • Kbyte/sec
      • Mbyte/sec
   5. In the Run server for (sec.) field, enter the duration in seconds for which you want the iperf server to run. Range of values: 60 to 3600. The default setting is 300.
6. If you chose the Client option, configure the iperf client:
   1. In the Server IP field, enter the IPv4 address of the iperf server to which you want the client to connect.
   2. In the Port field, enter the TCP or UDP port number of the iperf server to which you want the client to connect. Range of values: 1001 to 65,535. The default setting is 7777.
   3. In the Report interval (sec.) field, enter the interval in seconds for writing lines to the performance diagnostics report file. Range of values: 0 to 60. The default setting is 3.
   4. If you do not want to create a report file with network performance diagnostics results, select the Do not report check box. This check box is cleared by default.
   5. Under Report format, select the format of the network performance diagnostics results in the report file:
      • Kbit/sec (default)
      • Mbit/sec
      • Kbyte/sec
      • Mbyte/sec
   6. In the Run client for (sec.) field, enter the duration in seconds for which you want the iperf client to run. Range of values: 60 to 3600. The default setting is 60.
   7. Specify the port type of the iperf server by selecting one of the following options:
      • TCP (default).
      • UDP
   8. In the Client bitrate field, enter the bit rate of the iperf client in one of the following formats:
      • <bit rate in bits per second>

        For example, if you enter 10000, the bit rate is 10,000 bits per second.

      • <bit rate in kilobytes per second>k

        For example, if you enter 10k, the bit rate is 10 kbps.

      • <bit rate in kilobytes per second>K

        For example, if you enter 10K, the rate is 10 KB/s.

      • <bit rate in megabits per second>m

        For example, if you enter 10m, the bit rate is 10 Mbps.

      • <bit rate in megabytes per second>M

        For example, if you enter 10M, the bit rate is 10 MB/s.

   9. In the Test direction drop-down list, select the direction of traffic that you want to use for measuring network performance:
      • client-server to use the traffic that the iperf client sends to the server. Default value.
      • server-client to use the traffic that the iperf server sends to the client.
      • bidirectional to use traffic that the iperf client sends to the server as well as the traffic that the iperf server sends to the client.
   10. If necessary, in the TCP windows size, bytes field, enter the TCP window size in bytes. If you do not specify a value for this parameter, the TCP window size is automatically detected.
   11. If necessary, in the TCP MSS, bytes field, enter the maximum TCP segment size in bytes.
7. Click Run.

The iperf utility is run on the CPE device, and a report file with the network diagnostics results is generated.

To manage the report file, click Download results.