Aruba Central icon

Aruba Central

Interact with the Aruba Central API

Actions95

Client → Get Bandwidth Usage

AI-generated

Overview

This node interacts with the Aruba Central API to retrieve bandwidth usage data for clients within the specified domain, particularly under the 'monitoring' domain. It is useful for network administrators who want to monitor client bandwidth usage filtered by various parameters such as Mobility Controller serial number, switch stack ID, switch serial, or client MAC address.

Use Case Examples

  1. A network admin wants to get bandwidth usage statistics for clients connected to a specific Mobility Controller by providing the controller's serial number.
  2. Filtering bandwidth usage data for clients connected to a particular switch by specifying the switch's serial number or stack ID.

Properties

Name Meaning
Domain Specifies the domain of the Aruba Central API to interact with, defaulting to 'monitoring' for bandwidth usage operations.
Additional Fields Optional filters to refine the bandwidth usage query, including Mobility Controller serial number, switch stack ID, switch serial, and client MAC address.

Output

JSON

  • bandwidthUsage - Bandwidth usage data for clients retrieved from Aruba Central API
  • error - Error message if the operation fails and continueOnFail is enabled

Dependencies

  • Aruba Central API with OAuth2 authentication

Troubleshooting

  • Common issues include authentication failures due to invalid or expired OAuth2 tokens. Ensure the API credentials are correctly configured.
  • Incorrect or missing filter parameters may result in empty or incomplete data. Verify the filter values such as cluster_id, stack_id, serial, and macaddr are accurate.
  • Network connectivity issues to Aruba Central API can cause request failures. Check network settings and API endpoint accessibility.

Links

Discussion