iPerf3 Integration in Unleashed

iPerf3 is a third-party open-source speed measurement tool, widely used to measure network performance and maximum achievable throughput by sending traffic between one host and another.
To provide an overview of a feature and its benefits. May require several Concept topics to keep content in short, manageable, and reusable chunks of content.

The intention of this new template is to outline the information that you will need to collect from SMEs and provide to readers.

NOTE: Feature Configuration / Troubleshooting are *not* part of the Feature Concept template. These templates are likely to be part of seperate task/reference templates (to be developed).

General Notes for Concept Topics:
  • Optional sections are to be used with discretion based on the feature characteristics.

Overview

iPerf3 effectively tests on higher performance Wi-Fi chips and inspects bandwidth issues between two endpoints.

iPerf3 implementation in RUCKUS Unleashed:

  • A station connects with an AP through Wi-Fi
  • A dedicated Master AP or Master AP connects with a member AP by Mesh or Ethernet
This section is required. Providing detailed and accurate information in the feature overview is crucial as it helps users understand the functionality, benefits, and usage of the feature. Moreover, it ensures consistency in communication across all platforms, enhancing user experience and product perception.
  • What is the name of the feature? (What do users call the feature? If the feature is referred to by an acronym, what is the acronym expansion? What is the formal name to be used in documentation?)
    Note: Typically, the name is used as part of the section titles, such as the overview title and the configuration section titles.
  • Where does the feature fit within our taxonomy? (What are the taxonomy group and sub-group? This information is important for categorizing the feature documentation and incorporating it into the existing document sets.)
  • What standard or standards govern the feature? (Sometimes needed.)
  • Is the feature a new feature or an enhancement to an existing feature?
  • Does the feature replace another feature?
  • What does the feature do? (General description)
  • How does the feature benefit the user?
  • What set of terms do the writer and reader need to know to understand the feature and its use?
  • How does the feature work? (Detailed description, if needed.)

Requirements

  • As a station, Windows and MAC OS devices must install the iPerf3 tool.
  • As a station, Android and iOS devices must install the RUCKUS Unleashed Mobile App (UMA) integrated with the iPerf3 tool.
  • Ensure you have access to both the systems that you want to test for network performance testing.
  • Ensure that any firewalls in your network allow traffic on the port that iPerf3 uses (the default is 5201).
This section is required. Including this section, even when there is no impact, lets SMEs and customers know that the associated information was not forgotten.

If there are no requirements, use the following default wording:

This feature has no special hardware or software requirements for feature enablement or usage.

If there are requirements, include the applicable below points (depending on product line):

  • What releases support the feature?
    Note: Typically, this is not documented in the configuration guides; however, we need to know where to include the information.
  • What hardware models support the feature?
  • Does the feature require specific modules?
  • Does the feature run only on certain ports?
  • Does the feature have special memory requirements?
  • In an integrated system, can the feature be managed or configured from another device? What are the related release and system requirements?
  • Does the feature introduce new user requirements?
  • Does the feature introduce physical or location-based requirements?

Considerations

iPerf3 in RUCKUS Unleashed handles only TCP streams.

This section is required. Including this section, even when there is no impact, lets SMEs and customers know that the associated information was not forgotten.

If there are no considerations, use the following default wording:

This feature has no special considerations or limitations pertaining to feature enablement or usage.

If there are considerations, include the applicable below points (depending on product line).

Note: A separate section on Limitations may sometimes be needed.
  • Does the feature replace an existing feature?
  • Does the feature work only with a certain protocol or with a limited set of protocols?
  • Is the feature meant to be used in combination with another feature or a set of features?
  • Is the feature incompatible with any features?
  • What happens when the feature is enabled?
  • What happens when the feature is disabled?
  • Does enabling/disabling the feature enable/disable another feature?
  • What system behavior changes, if any, does the feature introduce?
  • Are performance issues associated with the feature? How can these be mitigated?

Best Practices

This feature has no special recommendations for feature enablement or usage.

This section is required. Including this section, even when there is no impact, lets SMEs and customers know that the associated information was not forgotten.

If there are no best practices (recommendations), use the following default wording:

This feature has no special recommendations for feature enablement or usage.

If there are considerations, include the applicable below points (depending on product line).

  • Brief list of RUCKUS recommendations on product use to optimize performance.

Prerequisites

  • Supported in RUCKUS Unleashed 200.16 and later versions.
  • Install the iPerf3 tool in the devices on which you want to perform network performance test.
This section is required. Including this section, even when there is no impact, lets SMEs and customers know that the associated information was not forgotten.

If there are no prerequisites, use the following default wording:

This feature has no prerequisites to feature enablement or usage.

If there are prerequisites, include the applicable below points (depending on product line).

Note: This section is sometimes part of a general overview and sometimes part of a configuration overview.
  • What are the task prerequisites that the user must ensure are met,for configuration? (For example, must you be running certain protocols, or must you configure other features first?)
Parent topic: Running a Speed Performance Test on a Wireless Client