Aruba Central icon

Aruba Central

Interact with the Aruba Central API

Actions95

Gateway → Get Ports Bandwidth Usage

AI-generated

Overview

This node interacts with the Aruba Central API to retrieve bandwidth usage data for ports on a specified gateway device. It is useful for network administrators who want to monitor network traffic and bandwidth consumption on specific gateway ports over a defined time range.

Use Case Examples

  1. A network admin wants to monitor bandwidth usage on port GE0/0/1 of a gateway device with a specific serial number to troubleshoot network congestion.
  2. An IT team needs to gather bandwidth usage statistics from a gateway device for reporting and capacity planning.

Properties

Name Meaning
Domain Specifies the domain of the Aruba Central API to use, defaulting to 'monitoring' for network monitoring tasks.
Serial The serial number of the gateway device to query for port bandwidth usage.
Additional Fields Optional parameters to filter the bandwidth usage data, including 'From Timestamp' and 'To Timestamp' to specify the time range (epoch seconds), and 'Port' to filter by a specific port (e.g., GE0/0/1).

Output

JSON

  • port - The identifier of the port on the gateway device.
  • bandwidthUsage - The bandwidth usage data for the specified port, typically including metrics such as bytes sent and received.
  • timestamp - The timestamp for the bandwidth usage data point, usually in epoch seconds.

Dependencies

  • Requires an API key credential for Aruba Central OAuth2 authentication to access the Aruba Central API.

Troubleshooting

  • Common issues include invalid or missing serial number, resulting in no data returned or errors from the API.
  • Incorrect timestamps (from_timestamp or to_timestamp) may cause no data to be returned or API errors; ensure timestamps are in epoch seconds and logically ordered.
  • Network connectivity or authentication failures with Aruba Central API can cause errors; verify API credentials and network access.

Discussion