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 Gateways
AI-generatedOverview
This node interacts with the Aruba Central API to retrieve information about network gateways. Specifically, for the 'Gateway' resource and 'Get Gateways' operation, it fetches a list of gateways from the monitoring domain of Aruba Central. This is useful for network administrators who want to monitor and manage their network gateways, filter them by various criteria, and obtain detailed information such as status, MAC address, model, firmware version, and usage statistics.
Use Case Examples
- A network admin wants to get all gateways currently monitored in their network to check their status and firmware versions.
- Filtering gateways by model or MAC address to troubleshoot specific devices.
- Retrieving a limited number of gateways with specific fields for a dashboard display.
Properties
| Name | Meaning |
|---|---|
| Domain | Specifies the domain of the Aruba Central API to interact with, such as monitoring, configuration, or firmware. |
| Return All | Whether to return all gateway results or only up to a specified limit. |
| Limit | Maximum number of gateway results to return when 'Return All' is false. |
| Additional Fields | Optional filters and parameters to refine the gateway query, such as status, MAC address, model, fields to return, sorting, device type, and whether to calculate total gateways. |
Output
JSON
status- Status of the gateway device.ip_address- IP address of the gateway.model- Model identifier of the gateway device.firmware_version- Firmware version running on the gateway.labels- Labels associated with the gateway for categorization.ap_count- Number of access points connected to the gateway.usage- Usage statistics of the gateway device.
Dependencies
- Aruba Central API
- OAuth2 API key credential
Troubleshooting
- Ensure the OAuth2 API credentials are correctly configured and have the necessary permissions to access the monitoring domain and gateway data.
- If the node returns an error about limits or pagination, check the 'Return All' and 'Limit' settings to ensure they are appropriate for the expected data volume.
- Filtering fields must be valid and correctly formatted; invalid filter values may cause the API to reject the request.