Aruba Central icon

Aruba Central

Interact with the Aruba Central API

Actions95

Client → Get Top N Clients

AI-generated

Overview

This node interacts with the Aruba Central API to retrieve the top N clients based on specified criteria within the 'Client' resource and 'Get Top N Clients' operation. It is useful for network administrators who want to monitor client activity and performance in their network environment, particularly within the monitoring domain of Aruba Central. For example, it can be used to fetch the top clients connected to network devices, filtered by parameters such as Mobility Controller serial number or Switch stack ID, and limited to a specified count.

Use Case Examples

  1. A network admin wants to see the top 10 clients connected to a specific Mobility Controller to analyze network usage.
  2. An IT team needs to monitor the top 5 clients on a particular switch stack to troubleshoot network performance issues.

Properties

Name Meaning
Domain Specifies the domain of the Aruba Central API to use, such as monitoring, configuration, or firmware. For this operation, the default and required domain is 'monitoring'.
Cluster_id Optional filter to specify the Mobility Controller serial number to narrow down the clients retrieved.
Stack_id Optional filter to specify the Switch stack ID to narrow down the clients retrieved.
Count Specifies the number of top clients to retrieve. Defaults to 5 if not set, with a maximum of 100.

Output

JSON

  • clientId - Unique identifier of the client.
  • clientName - Name of the client device.
  • connectionDetails - Details about the client's network connection.
  • usageStats - Statistics related to the client's network usage.

Dependencies

  • Aruba Central API with OAuth2 authentication

Troubleshooting

  • Common issues include invalid or missing OAuth2 credentials, resulting in authentication errors.
  • Incorrect domain or resource parameters may cause the API call to fail or return no data.
  • Setting the 'Count' parameter outside the allowed range (0 or greater than 100) may cause errors or unexpected results.

Discussion