Aruba Central icon

Aruba Central

Interact with the Aruba Central API

Actions95

Switch → Ports Bandwidth Usage for CX Switch

AI-generated

Overview

This node interacts with the Aruba Central API to retrieve bandwidth usage data for ports on a CX switch. It is useful for network administrators who want to monitor the bandwidth consumption of specific switch ports over a defined time range. For example, it can be used to analyze traffic patterns, identify bandwidth bottlenecks, or monitor uplink port usage on a CX switch.

Use Case Examples

  1. A network admin wants to monitor bandwidth usage on a specific CX switch port over the last 3 hours to troubleshoot network congestion.
  2. An IT team needs to generate reports on uplink port bandwidth usage for capacity planning.

Properties

Name Meaning
Domain Specifies the domain of the Aruba Central API to use, such as monitoring, configuration, or inventory. For this operation, the domain is set to 'monitoring'.
Serial The serial number of the CX switch to retrieve port bandwidth usage data for.
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.
Additional Fields Optional filters and settings for the query, including filtering by specific port and whether to show usage for uplink ports only.

Output

JSON

  • port - The port identifier on the CX switch.
  • bandwidthUsage - Bandwidth usage data for the specified port over the requested time range.
  • timestamp - Timestamp of the bandwidth usage data point.

Dependencies

  • Requires an Aruba Central API OAuth2 credential for authentication.

Troubleshooting

  • Ensure the serial number provided is correct and corresponds to a CX switch managed by Aruba Central.
  • Verify that the OAuth2 credentials for Aruba Central API are valid and have the necessary permissions for the monitoring domain.
  • If no data is returned, check the time range specified and ensure the switch has reported data for that period.
  • Common error messages may include authentication failures, invalid parameters, or network connectivity issues. Resolving these typically involves verifying credentials, input parameters, and network access.

Discussion