Aruba CX icon

Aruba CX

Interact with Aruba CX Switch REST API

Port Access Cached Clients → Get

AI-generated

Summary

Retrieve cached client information for a specified MAC address from an Aruba CX switch

Inputs

  • hostOverride — Optional override of the hostname from credentials (useful for loops with multiple switches)
  • domain (required) — Domain of the Aruba CX API; typically set to "System"
  • clientMac (required) — MAC address of the cached client to retrieve
  • filters — Collection of additional query options such as depth and selector to control response details

Output shape

a list of cached client objects

The response may be empty if no matching clients are found; fields returned are determined by the selector and depth set in filters; errors are propagated as thrown exceptions unless continueOnFail is enabled

Examples

Example 1: Fetch details for a specific client

Set Domain to System, Client MAC Address to 00:11:22:33:44:55

Example 2: List all cached clients with basic status

Leave Client MAC Address empty, set Filters depth to 1 and selector to status

Discussion