Actions95
- Access Point Actions
- Client Actions
- Events Actions
- Gateway Actions
- Label Actions
- Mobility Controller Actions
- Network Actions
- Site Actions
- Swarm Actions
- Switch Actions
- List Switches
- Get VLAN Info of the Switch
- Get VLAN Info for CX Switch
- Get VLAN Info of the Switch Stack
- Get VLAN Info of the CX Switch Stack
- Get Switch Port PoE Info
- Get Switch Port PoE Info for CX Switch
- Get Switch PoE Info
- Get Switch PoE Info for CX Switch
- Get Switch VSX Info for CX Switch
- Get LLDP Device Neighbor Info for CX Switch
- Get LLDP Device Neighbor Info for CX Switch Stack
- Switch Bandwidth Usage
- Top N Switches
- Switch Details
- Delete Switch
- Switch Ports Details
- Get Ports Details for CX Switch
- Switch Chassis Details
- Switch Ports Bandwidth Usage
- Ports Bandwidth Usage for CX Switch
- Switch Ports Errors
- CX Switch Ports Errors
- Switch Stack Port Details
- CX Switch Stack Port Details
- List Switch Stacks
- Switch Stack Details
- Delete Switch Stack
- VPN Actions
Gateway → Get DHCP Clients
AI-generatedOverview
This node interacts with the Aruba Central API to retrieve DHCP client information from a specified gateway device. It is useful for network administrators who want to monitor and manage DHCP clients connected to their gateway devices in Aruba Central's monitoring domain. For example, it can be used to fetch a list of DHCP clients for a gateway identified by its serial number, optionally including DHCP reservations.
Use Case Examples
- Retrieve all DHCP clients connected to a specific gateway device by providing its serial number.
- Limit the number of DHCP clients returned to a specified maximum count.
- Include DHCP reservation details in the returned client list by enabling the reservation flag.
Properties
| Name | Meaning |
|---|---|
| Domain | Specifies the domain of the Aruba Central API to use, defaulting to 'monitoring' for this operation. |
| Return All | Determines whether to return all DHCP client results or limit the number of results. |
| Limit | Maximum number of DHCP client results to return when 'Return All' is false. |
| Serial | Serial number of the gateway device to query for DHCP clients. |
| Additional Fields | Optional additional parameters for the request, such as enabling the listing of DHCP reservations. |
Output
JSON
clients- Array of DHCP client objects retrieved from the gateway.
Dependencies
- Aruba Central API with OAuth2 authentication
Troubleshooting
- Ensure the provided gateway serial number is correct and the device is registered in Aruba Central.
- Verify that the OAuth2 credentials for Aruba Central API are valid and have sufficient permissions.
- If the node returns an error about limits, check the 'Return All' and 'Limit' settings to ensure they are configured properly.
Links
- Aruba Central API Documentation - Official API documentation for Aruba Central, including endpoints for monitoring and managing gateways.