Aruba Central icon

Aruba Central

Interact with the Aruba Central API

Actions95

Client → Get Unified Clients

AI-generated

Overview

This node operation interacts with the Aruba Central API to retrieve unified client information from the monitoring domain. It is useful for network administrators who want to monitor and analyze client devices connected to their network, including wireless and wired clients. Practical examples include fetching a list of connected wireless clients over the last 3 hours or retrieving detailed client data filtered by site, group, or device serial number.

Use Case Examples

  1. Retrieve all connected wireless clients in the last 3 hours.
  2. Get up to 50 wired clients that failed to connect within the last day.
  3. Filter clients by site or label to analyze specific network segments.

Properties

Name Meaning
Domain Specifies the domain of the Aruba Central API to use, defaulting to 'monitoring' for client operations.
Return All Whether to return all results or only up to a given limit.
Limit Maximum number of results to return or page size when returning all results.
Client Type Type of client to retrieve, either wireless or wired.
Client Status Status of clients to retrieve, such as connected or failed to connect (wireless only).
Timerange Time range for unified client information, e.g., 3 hours, 1 day, 1 week, etc.
Additional Fields Optional filters and parameters to refine the client data retrieval, such as group, swarm ID, label, site, network, cluster ID, serial number, band, stack ID, OS type, fields to return, sorting, usage display, manufacturer info, and signal details.

Output

JSON

  • clientList - Array of unified client objects retrieved from Aruba Central API, containing client details based on the specified filters and parameters.

Dependencies

  • Aruba Central API with OAuth2 authentication

Troubleshooting

  • Ensure the OAuth2 API credentials are correctly configured and valid to avoid authentication errors.
  • If the node returns an empty list, verify that the filters and parameters (such as client type, status, and timerange) are correctly set and that clients exist matching those criteria.
  • Errors related to unsupported parameters (e.g., 'Failed to Connect' status for wired clients) should be corrected by adjusting the input properties accordingly.

Links

Discussion