Aruba CX icon

Aruba CX

Interact with Aruba CX Switch REST API

DHCP Relay → Update

AI-generated

Summary

Update DHCP Relay configuration on an Aruba CX switch

Inputs

  • hostOverride — Optional: Override the hostname from credentials (useful for loops with multiple switches)
  • domain (required) — Domain of the Aruba CX API
  • vrfName (required) — VRF name (default for default VRF)
  • interfaceName (required) — Interface name (e.g., 1/1/1, vlan10)
  • updateFields — Fields to update for DHCP Relay configuration (e.g., helperAddresses, enabled)

Output shape

array of updated DHCP Relay objects

Successful execution returns an array of updated DHCP Relay records; on error a single-item array containing an {error} object is returned.

Examples

Example 1: Update helper addresses on interface 1/1/1

domain=System, vrfName=default, interfaceName=1/1/1, updateFields{helperAddresses='192.168.1.10,192.168.1.11', enabled=true}

Example 2: Enable DHCP Relay on all interfaces in default VRF

domain=System, vrfName=default, updateFields{enabled=true}

Example 3: Override hostname and set new helper addresses

hostOverride=192.168.2.1, domain=System, vrfName=default, interfaceName=vlan10, updateFields{helperAddresses='192.168.2.10'}

Discussion