Aruba Central icon

Aruba Central

Interact with the Aruba Central API

Actions95

Client → Get Wireless Clients

AI-generated

Overview

This node interacts with the Aruba Central API to retrieve wireless client information within the monitoring domain. It is useful for network administrators who want to monitor and analyze wireless client data such as connection details, device information, and network usage. For example, it can be used to fetch a list of all wireless clients connected to the network, filter clients by specific criteria like group or site, and sort or limit the results for reporting or troubleshooting purposes.

Use Case Examples

  1. Fetching all wireless clients connected to a specific site for monitoring network usage.
  2. Filtering wireless clients by OS type or radio band to analyze client distribution.
  3. Sorting clients by MAC address and limiting the number of results for efficient data handling.

Properties

Name Meaning
Domain Specifies the domain of the Aruba Central API to use, here it is set to 'monitoring' for wireless client data.
Return All Determines whether to return all results or only up to a specified limit.
Limit Maximum number of results to return or the page size when returning all results.
Additional Fields Optional filters and parameters to refine the wireless client query, such as group, swarm ID, label, site, network, serial number, OS type, cluster ID, band, fields to return, whether to calculate total clients, sort order, and last client MAC for pagination.

Output

JSON

  • name - Client's name
  • ip_address - Client's IP address
  • username - Client's username
  • os_type - Client's operating system type
  • connection - Connection details of the client
  • associated_device - Device the client is associated with
  • group_name - Group name the client belongs to
  • swarm_id - Swarm ID associated with the client
  • network - Network name the client is connected to
  • radio_mac - MAC address of the client's radio
  • manufacturer - Client device manufacturer
  • vlan - VLAN information
  • encryption_method - Encryption method used for the client connection
  • radio_number - Radio number the client is connected to
  • speed - Connection speed
  • usage - Network usage by the client
  • health - Health status of the client connection
  • labels - Labels associated with the client
  • site - Site name where the client is located
  • signal_strength - Signal strength of the client connection
  • signal_db - Signal strength in dB
  • snr - Signal-to-noise ratio

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 no data, verify that the filters in Additional Fields are correctly set and that clients exist matching those filters.
  • Pagination issues may occur if 'Last Client MAC' is not correctly used when fetching multiple pages; ensure it is set from the last response's client MAC.
  • API rate limits or network issues may cause errors; check network connectivity and API usage limits.

Links

Discussion