Actions74
- ACLs Actions
- CLI Actions
- Configuration Actions
- DHCP Relay Actions
- Firmware Actions
- Interfaces Actions
- LLDP Neighbors Actions
- Logs Actions
- Mirror Sessions Actions
- Mirror Endpoints Actions
- Packet Captures Actions
- Port Access Cached Clients Actions
- Port Access Roles Actions
- SNMP Communities Actions
- System Actions
- Users Actions
- VLANs Actions
- VRFs Actions
Users → Get
AI-generatedSummary
Retrieves user details from an Aruba CX switch via the REST API.
Inputs
- hostOverride — Optional hostname or IP address to override the one stored in credentials.
- domain (required) — Domain of the Aruba CX API (currently defaults to 'System').
- username (required) — Username to identify the user for authentication.
- filters — Optional filters to limit the response. Includes 'Depth' (integer, default 1) for resource details and 'Selector' (string) to specify configuration, status, or statistics.
Output shape
One or more items containing user data ().
The specific shape of the returned user data depends on the 'filters' Depth and Selector values. If an error occurs and continueOnFail is enabled, an item with an 'error' field is returned.
Examples
Example 1: Retrieve basic user information with default settings.
Set domain to 'System', provide a username, and keep default filters.
Example 2: Fetch detailed user configuration and statistics.
Set domain to 'System', provide a username, and set filters Depth to 2 and Selector to 'configuration,statistics'.
Example 3: Connect to a specific switch for a loop.
Use 'hostOverride' to specify a different IP address than the one in credentials.