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 → Get
AI-generatedSummary
Retrieves DHCP relay configuration for a specific interface and VRF on an Aruba CX switch.
Inputs
- hostOverride — Optional hostname to override the credential's host (useful for iterating over multiple switches).
- domain (required) — Domain of the Aruba CX API; only 'System' is available.
- vrfName (required) — VRF name whose DHCP relay settings are queried. Defaults to 'default'.
- interfaceName (required) — Interface identifier (e.g., '1/1/1' or 'vlan10') for which DHCP relay is retrieved.
- filters — Optional filter collection to adjust the response detail.
- filters.depth — Depth of resource details to include in the response. Defaults to 1.
- filters.selector — Selects which aspects to return: configuration, status, and/or statistics. Empty string returns all.
Output shape
Array containing a single JSON object with the DHCP relay settings for the specified interface and VRF. The exact fields depend on the selector and depth values (e.g., configuration details, status counters, or statistics).
If no matching DHCP relay is found, the node returns an empty array.
Examples
Example 1: Get DHCP relay configuration on interface 1/1/1 in the default VRF.
Set vrfName='default', interfaceName='1/1/1', leave filters at defaults, and execute the Get operation.