Aruba Central icon

Aruba Central

Interact with the Aruba Central API

Actions95

Gateway → Get Uplink Bandwidth Usage

AI-generated

Overview

This node interacts with the Aruba Central API to retrieve uplink bandwidth usage data for a specified gateway device. It is useful for network administrators who want to monitor the bandwidth consumption of gateway uplinks over various time intervals and filter by specific uplink IDs or time ranges. For example, it can be used to analyze network traffic patterns or troubleshoot bandwidth issues on a gateway device.

Use Case Examples

  1. Retrieve uplink bandwidth usage for a gateway with a specific serial number over the last 5 minutes.
  2. Filter uplink bandwidth data by uplink ID to monitor a particular uplink's performance.
  3. Get bandwidth usage data for a gateway over a custom time range using epoch timestamps.

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 bandwidth usage for.
Additional Fields Optional filters for the bandwidth usage query, including uplink ID, interval, and time range (from and to timestamps).

Output

JSON

  • bandwidthUsage - Array of uplink bandwidth usage data points returned from the Aruba Central API, including metrics such as bandwidth consumption over the specified interval.

Dependencies

  • Aruba Central API with OAuth2 authentication

Troubleshooting

  • Ensure the gateway serial number is correct and the device is registered in Aruba Central.
  • Verify that the OAuth2 credentials for Aruba Central API are valid and have the necessary permissions.
  • Check that the timestamps provided (if any) are valid epoch seconds and that the 'from' timestamp is earlier than the 'to' timestamp.
  • If the node returns an error, enabling 'continueOnFail' allows the workflow to proceed with error details in the output.

Discussion