Aruba Central icon

Aruba Central

Interact with the Aruba Central API

Actions95

Access Point → Get Bandwidth_usage

AI-generated

Overview

This node interacts with the Aruba Central API to retrieve bandwidth usage data for Access Points within the specified domain, particularly under the 'monitoring' domain. It is useful for network administrators who want to monitor bandwidth consumption on their access points, filter data by various parameters such as AP serial number, cluster ID, interval, band, radio number, ethernet interface index, and network name. Practical examples include tracking bandwidth usage over different time intervals or filtering usage data for specific access points or network segments.

Use Case Examples

  1. A network admin wants to monitor bandwidth usage of a specific AP by its serial number over the last hour.
  2. Filtering bandwidth data by band (2.4, 5, or 6 GHz) for a particular AP to analyze wireless traffic distribution.
  3. Retrieving bandwidth usage aggregated over a week for all APs in a specific cluster.

Properties

Name Meaning
Domain Specifies the domain of the Aruba Central API to use, defaulting to 'monitoring' for bandwidth usage operations.
Additional Fields Optional filters to refine the bandwidth usage query, including AP serial, cluster ID, interval, band, radio number, ethernet interface index, and network name.

Output

JSON

  • bandwidth_usage - The bandwidth usage data retrieved from the Aruba Central API for the specified Access Point and filters.

Dependencies

  • Aruba Central API with OAuth2 authentication

Troubleshooting

  • Ensure the OAuth2 credentials for Aruba Central API are correctly configured and valid.
  • Verify that the domain is set to 'monitoring' when performing the Get Bandwidth_usage operation for Access Points.
  • Check that the serial number and other filters are correctly formatted and valid according to Aruba Central API requirements.
  • Common error messages may include authentication failures, invalid parameter errors, or API rate limits. Resolving these involves checking credentials, parameter values, and possibly retrying after some time.

Links

Discussion