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 → List
AI-generatedSummary
List Aruba CX users with configurable domain, limit and optional filters.
Inputs
- hostOverride — Optional override of the hostname from credentials; useful when looping over multiple switches.
- domain (required) — Domain of the Aruba CX API (must be set to 'System' for this resource).
- returnAll — If true, retrieve all results regardless of limit; otherwise respects the Limit parameter.
- limit — Maximum number of results to return when returnAll is false; integer between 1 and 1000.
- filters — Collection of filter options (Depth and Selector) to refine the query.
Output shape
a list of user objects
Pagination is controlled by Limit and Return All; results may include additional fields based on the Selector filter; no error envelope is returned on success.
Examples
Example 1: Retrieve the first 50 users in the System domain.
Domain=System, Limit=50, Return All=false, no Filters.
Example 2: Fetch all users and include configuration details.
Domain=System, Return All=true, Selector=configuration via Filters.
Example 3: Override hostname for a loop of switches while listing users.
Host Override=192.168.1.1, Domain=System, Resource=users, Limit=100.