Aruba Central Next Gen icon

Aruba Central Next Gen

Consume Aruba Central Next Gen API

Actions408

Client → Get All Clients

AI-generated

Overview

This node operation retrieves a list of clients from the Aruba Central Next Gen API within the Monitoring domain. It is useful for network administrators who want to monitor client devices connected to their network, filter clients by various criteria such as site ID, site name, serial number, connection type, status, WLAN name, VLAN ID, tunnel type, and role, and sort or paginate the results. For example, an admin can fetch all wireless clients connected to a specific site within a given time range to analyze network usage or troubleshoot connectivity issues.

Use Case Examples

  1. Fetch all clients connected to a specific site within the last 3 hours.
  2. Retrieve up to 100 clients filtered by connection type 'Wireless' and status 'Connected'.
  3. Get all clients sorted by client name in ascending order.

Properties

Name Meaning
Debug Mode Whether to enable detailed debug logs for troubleshooting.
Domain API domain to interact with, set to 'monitoring' for client operations.
Return All Whether to return all results or only up to a given limit.
Limit Max number of results to return (max 1000).
Site ID Filter clients by site ID.
Site Name Filter clients by site name.
Serial Number Filter by the serial number of the connected device.
Time Range Time range for client data (defaults to last 3 hours; interval must be ≤ 1 month).
Filters OData v4.0 filter criteria (supports only AND conjunction) to filter clients by connection type, status, WLAN name, VLAN ID, tunnel type, and role.
Sort Sort field followed by asc or desc. Supported fields include clientName, status, clientConnectionType, macAddress, ipv4, ipv6, connectedDeviceSerial, connectedTo, lastSeenAt, port, role, wlanName, vlanId, tunnelType, tunnelId, connectedAt.
Pagination Pagination option with next page cursor value returned by a previous request.

Output

JSON

  • clientId - Unique identifier of the client.
  • clientName - Name of the client device.
  • macAddress - MAC address of the client device.
  • ipv4 - IPv4 address of the client.
  • ipv6 - IPv6 address of the client.
  • status - Connection status of the client (e.g., Connected, Disconnected).
  • connectionType - Type of connection (Wired or Wireless).
  • siteId - Identifier of the site the client is connected to.
  • siteName - Name of the site the client is connected to.
  • lastSeenAt - Timestamp of the last time the client was seen on the network.
  • connectedDeviceSerial - Serial number of the device the client is connected to.
  • wlanName - SSID or WLAN name the client is connected to.
  • vlanId - VLAN ID associated with the client.
  • tunnelType - Type of tunnel used by the client connection.
  • role - Role assigned to the client.

Dependencies

  • Aruba Central Next Gen API with OAuth2 authentication

Troubleshooting

  • Ensure the OAuth2 API credentials are correctly configured and have the necessary permissions to access client data.
  • If the node returns no clients, verify the filter criteria and time range are correctly set and that clients exist matching those filters.
  • For pagination issues, ensure the 'Next Page Cursor' is correctly passed when 'Return All' is false and results exceed the limit.
  • Enable Debug Mode to get detailed logs for troubleshooting errors during execution.

Links

Discussion