Aruba Central icon

Aruba Central

Interact with the Aruba Central API

Actions95

Client → Get Wired Clients

AI-generated

Overview

This node interacts with the Aruba Central API to retrieve information about wired clients in a network. It is particularly useful for network administrators who want to monitor and manage wired client devices connected to their network infrastructure. For example, it can be used to fetch details about clients connected to switches, filter clients by various criteria such as group, site, or serial number, and sort the results by MAC address.

Use Case Examples

  1. A network admin wants to get a list of all wired clients connected to a specific site to analyze network usage.
  2. Filtering wired clients by switch serial number to troubleshoot connectivity issues.
  3. Retrieving a limited number of wired clients with specific fields like IP address and VLAN for reporting purposes.

Properties

Name Meaning
Domain Specifies the domain of the Aruba Central API to use, such as monitoring, configuration, or firmware. For this operation, the domain is typically 'monitoring'.
Return All Determines whether to return all results or only up to a specified limit.
Limit Maximum number of results to return. When 'Return All' is enabled, it controls the number of items fetched per API request (page size).
Additional Fields Optional filters and parameters to refine the query for wired clients, such as filtering by group, swarm ID, label, site, serial number, cluster ID, stack ID, specific fields to return, whether to calculate total clients, sorting order, and last client MAC address for pagination.

Output

JSON

  • name - Name of the wired client.
  • ip_address - IP address of the wired client.
  • username - Username associated with the wired client.
  • associated_device - Device to which the client is connected.
  • group_name - Group name the client belongs to.
  • interface_mac - MAC address of the client's network interface.
  • vlan - VLAN ID associated with the client.

Dependencies

  • Aruba Central API with OAuth2 authentication

Troubleshooting

  • Ensure the OAuth2 API credentials are correctly configured and have the necessary permissions to access the monitoring domain.
  • If the node returns an error about invalid parameters, verify that the filter fields and sort options are correctly specified according to the API documentation.
  • When using pagination with 'Last Client MAC', ensure the MAC address format is correct to avoid empty or incomplete results.
  • Network connectivity issues to Aruba Central API can cause timeouts or failures; verify network access and API endpoint availability.

Links

Discussion