📘
Source Code
You can find the source code and documentation for this workflow, as well as several others, by visiting our central-python-workflows GitHub repository !

Ping and iPerf Troubleshooting Workflow

This script automates network troubleshooting tasks using the new HPE Aruba Networking Central APIs. The workflow performs comprehensive connectivity testing by executing ping tests and iPerf bandwidth tests on gateway devices to validate network performance and connectivity. This script only demonstrates a small set of troubleshooting tests/APIs that are available with new HPE Aruba Network Central, for a full comprehensive list of the test/functions visit our Pycentralv2 library or checkout our API Reference on our Developer Hub!

Benefits

This troubleshooting workflow demonstrates:

Automated Diagnostics: Streamlines network troubleshooting through API automation
Comprehensive Testing: Combines connectivity and performance validation in a single workflow
Centralized Management: Leverages new HPE Aruba Networking Central's unified API platform
Scalable Operations: Enables testing across multiple devices with minimal manual intervention
Rich Output: Provides detailed raw output for in-depth analysis and reporting

🚧
This script uses a beta version of the pycentral library and is designed for new HPE Aruba Networking Central, which is also in Public Preview. Expect potential changes and updates to the API and functionality

Workflow Steps

The troubleshooting workflow performs the following operations:

Device Discovery: Locates devices in the Central inventory using serial numbers
Ping Test Execution: Runs connectivity tests to specified destinations
iPerf Test Execution: Performs bandwidth tests against designated iPerf servers (Gateway devices only)
Results Processing: Formats and displays comprehensive test results with raw output

📘
NOTE
The iPerf test is only supported on Gateway devices and may take upwards of 1 minute to execute completely.

Prerequisites

pycentral - New Central's API client library (beta version v2.0a8 or later)
API credentials for new HPE Aruba Networking Central (JSON or YAML format)
Gateway devices onboarded to Central and online
Valid ping destinations (e.g., public DNS servers, internal network resources)
Accessible iPerf servers for bandwidth testing

Setup

Create a virtual environment (recommended):

python -m venv env
source env/bin/activate  # On Windows: env\Scripts\activate

Clone the central-python-workflows and change into this workflow's repository:

git clone https://github.com/aruba/central-python-workflows.git

cd central-python-workflows/troubleshooting-workflow/

Install required packages:
```
pip install -r requirements.txt
```

Input Files

Credentials File

Contains Central API credentials in JSON or YAML format.

Example (YAML):

new_central:
    # Either `base_url` or `cluster_name` should be provided:
    #
    # base_url: <central-api-base-url>
    # cluster_name: <central-cluster-name>
    client_id: <central-client-id>
    client_secret: <central-client-secret>

Workflow Variables File

The workflows_variables.yaml file defines the devices and test parameters for the troubleshooting workflow.

Structure:

devices:
  - serial: <device-serial-number>
    name: <device-friendly-name>
    ping_destination: <ip-address-or-hostname>
    iperf_server: <iperf-server-ip-address>

Variable Descriptions:

serial: The serial number of the Gateway device in Central (required)
name: Friendly name for identification purposes (optional, used for logging)
ping_destination: Target IP address or hostname for connectivity testing (e.g., 8.8.8.8, internal server)
iperf_server: IP address of the iPerf server for bandwidth testing (must be accessible from the Gateway)

Example Configuration:

devices:
  - serial: DL0006931
    name: BO-BLR-GTW02
    ping_destination: 8.8.8.8
    iperf_server: 154.81.51.4
  - serial: DL0006932
    name: BO-BLR-GTW03
    ping_destination: 1.1.1.1
    iperf_server: 192.168.1.100

👍
Tip
To obtain your API credentials, please refer to: Generating and Managing Access Tokens and to locate the cluster_name (E.g. US-WEST-5) or base_url (E.g. https://us5.api.central.arubanetworks.com) of your Central cluster refer to API Gateway Base URLs on our Developer Hub.

Usage

Run the script with the required arguments:

python ping_iperf_troubleshooting.py -c account_credentials.yaml -vars workflows_variables.yaml

Command-line Arguments:

-c, --account_credentials: Path to the account credentials YAML file (required)
-vars, --workflow_variables: Path to the workflow variables YAML file (required)

Sample Output

Running ping test on device DL0006931 to 8.8.8.8
============================================================
PING TEST RESULTS FOR DEVICE: DL0006931
============================================================

! - Success  . - Failure  D - Duplicate Response
Press 'q' to abort.
Sending 5, 92-byte ICMP Echos to 8.8.8.8, timeout is 2 seconds:
!!!!!
Success rate is 100 percent (5/5), round-trip min/avg/max = 6.923/6.9694/7.017 ms


============================================================

Starting iperf test...
============================================================
PING TEST RESULTS FOR DEVICE: DL0006931
============================================================

Perf-test: Finished

Aug 12 11:45:27 2025
iperf 3.0.11
Linux BO-BLR-GTW02 2.6.32.11 #87317 SMP PREEMPT Wed Jul 5 17:52:04 UTC 2023 mips64 unknown
Time: Tue, 12 Aug 2025 18:45:27 GMT
Connecting to host 154.81.51.4, port 5201
      Cookie: BO-BLR-GTW02.1755024327.058856.4043f
      TCP MSS: 1368 (default)
[  6] local 10.97.55.243 port 41348 connected to 154.81.51.4 port 5201
Starting Test: protocol: TCP, 1 streams, 131072 byte blocks, omitting 0 seconds, 10 second test
[ ID] Interval           Transfer     Bandwidth       Retr  Cwnd
[  6]   0.00-1.00   sec  82.8 KBytes   678 Kbits/sec    0   28.1 KBytes
[  6]   1.00-2.00   sec  1.25 MBytes  10.5 Mbits/sec    0    458 KBytes
[  6]   2.00-3.00   sec  3.91 MBytes  32.8 Mbits/sec    1   1.28 MBytes
[  6]   3.00-4.00   sec  0.00 Bytes  0.00 bits/sec   10   4.01 KBytes
[  6]   4.00-5.00   sec  0.00 Bytes  0.00 bits/sec   29   13.4 KBytes
[  6]   5.00-6.00   sec  0.00 Bytes  0.00 bits/sec   30   6.68 KBytes
[  6]   6.00-7.00   sec  0.00 Bytes  0.00 bits/sec   42   16.0 KBytes
[  6]   7.00-8.00   sec  0.00 Bytes  0.00 bits/sec    7   5.34 KBytes
[  6]   8.00-9.00   sec  0.00 Bytes  0.00 bits/sec   28   9.35 KBytes
[  6]   9.00-10.00  sec  0.00 Bytes  0.00 bits/sec   34   12.0 KBytes
- - - - - - - - - - - - - - - - - - - - - - - - -
Test Complete. Summary Results:
[ ID] Interval           Transfer     Bandwidth       Retr
[  6]   0.00-10.00  sec  5.24 MBytes  4.39 Mbits/sec  181             sender
[  6]   0.00-10.00  sec  2.62 MBytes  2.20 Mbits/sec                  receiver
CPU Utilization: local/sender 3.8% (1.0%u/2.9%s), remote/receiver 0.0% (0.0%u/0.0%s)

iperf Done.

============================================================

Limitations

iPerf testing is only supported on Gateway device types
iPerf tests may take upwards of 1 minute to complete
This script is designed for new HPE Aruba Networking Central, which is currently in Public Preview
The pycentral library used is also in beta and subject to changes

Ping & iPerf Troubleshooting Test

📘
Source Code

Ping and iPerf Troubleshooting Workflow

Benefits

🚧

Workflow Steps

📘
NOTE

Prerequisites

Setup

Input Files

Credentials File

Workflow Variables File

👍
Tip

Usage

Sample Output

Limitations

📘Source Code

Ping and iPerf Troubleshooting Workflow

Benefits

🚧

Workflow Steps

📘NOTE

Prerequisites

Setup

Input Files

Credentials File

Workflow Variables File

👍Tip

Usage

Sample Output

Limitations

📘
Source Code

📘
NOTE

👍
Tip