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
Mirror Endpoints → List
AI-generatedSummary
Retrieves a list of configured mirror endpoints from an Aruba CX switch via the REST API.
Inputs
- hostOverride — Optional hostname or IP address to override the host defined in credentials, useful for processing multiple switches in a loop.
- domain (required) — The API domain. Currently restricted to 'System'.
- returnAll — If true, retrieves all results; if false, uses the Limit parameter. Only available when Domain is 'System'.
- limit — Maximum number of results to return (1-1000). Required when 'Return All' is false.
- filters — Optional collection containing 'depth' (integer) and 'selector' (string) to filter details returned.
Output shape
A list of items, each representing a mirror endpoint configuration.
The item shape is defined by the node's description properties and includes fields such as 'name', 'port', and 'status'.
Examples
Example 1: List all mirror endpoints with a limit of 100
Domain: System, Return All: false, Limit: 100
Example 2: Retrieve detailed configuration for specific endpoints using a selector
Domain: System, Filters: Selector='configuration', Depth=2