Aruba Central icon

Aruba Central

Interact with the Aruba Central API

Actions95

Switch → Switch Bandwidth Usage

AI-generated

Overview

This node interacts with the Aruba Central API to retrieve switch bandwidth usage data within the monitoring domain. It allows filtering the switches by group, label, serial number, or stack ID, and supports specifying a time range for the data retrieval. This is useful for network administrators who want to monitor bandwidth usage on specific switches or groups of switches over a defined period.

Use Case Examples

  1. Monitoring bandwidth usage of a specific switch by its serial number over the last 3 hours.
  2. Retrieving bandwidth data for all switches in a particular group within a custom time range.

Properties

Name Meaning
Domain Specifies the domain of the Aruba Central API to use, defaulting to 'monitoring' for bandwidth usage.
Filter Type Determines how to filter the switches for bandwidth usage data (by group, label, serial, or stack ID).
Group Group name to filter switches by (shown only if filter type is 'group').
Label Label name to filter switches by (shown only if filter type is 'label').
Serial Serial number of the switch to filter by (shown only if filter type is 'serial').
Stack ID Stack ID of the switch to filter by (shown only if filter type is 'stack_id').
From Start time for data retrieval; defaults to current time minus 3 hours if not specified.
To End time for data retrieval; defaults to current time if not specified.

Output

JSON

  • bandwidthUsage - Array of bandwidth usage data for the filtered switches within the specified time range.

Dependencies

  • Aruba Central API with OAuth2 authentication

Troubleshooting

  • Ensure the OAuth2 credentials for Aruba Central API are correctly configured and valid.
  • Verify that the filter parameters (group, label, serial, stack ID) match existing switches in the Aruba Central environment.
  • Check that the time range specified is valid and that the 'from' timestamp is before the 'to' timestamp.
  • Common error messages may include authentication failures, invalid filter parameters, or API rate limits being exceeded. Resolving these involves checking credentials, input values, and possibly retrying after some time.

Links

Discussion