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
DHCP Relay → List
AI-generatedSummary
List DHCP Relay scopes on an Aruba CX switch
Inputs
- domain (required) — Domain of the Aruba CX API (must be System).
- hostOverride — Optional hostname to override from credentials, useful for looping over multiple switches.
- returnAll — If true, ignore the limit and return all matching results; otherwise respect the limit value.
- limit — Maximum number of results to return when returnAll is false; range 1‑1000.
- filters — Collection of filter options to refine the query, such as depth and selector.
Output shape
a list of DHCP Relay configuration objects
Results are returned as an array; pagination is controlled by limit and returnAll, and the response may be empty if no items match.
Examples
Example 1: List default DHCP Relay scopes
domain: System, hostOverride: , returnAll: false, limit: 100
Example 2: Retrieve all DHCP Relay entries
domain: System, hostOverride: , returnAll: true, limit: 0, filters: depth=1, selector=configuration