Aruba Central Next Gen icon

Aruba Central Next Gen

Consume Aruba Central Next Gen API

Actions408

Gateway → List Gateways

AI-generated

Overview

This node operation lists gateways from the Aruba Central Next Gen API within the Monitoring domain. It allows users to retrieve information about gateways with options to filter by site ID, model, status, and deployment type. Users can also control the number of results returned and specify sorting preferences. This operation is useful for network administrators who want to monitor and manage gateways in their network environment.

Use Case Examples

  1. A network admin wants to get a list of all gateways currently online in a specific site to check their status.
  2. Retrieve up to 50 gateways sorted by site ID in ascending order to review deployment details.

Properties

Name Meaning
Debug Mode Enable detailed debug logs for troubleshooting.
Domain API domain to interact with, set to 'monitoring' for this operation.
Return All Whether to return all results or only up to a given limit.
Limit Maximum number of results to return when 'Return All' is false.
Additional Fields Additional optional filters and sorting options for listing gateways.

Output

JSON

  • id - Unique identifier of the gateway.
  • name - Name of the gateway.
  • model - Model of the gateway device.
  • status - Current status of the gateway (e.g., ONLINE, OFFLINE, UNKNOWN).
  • siteId - Identifier of the site where the gateway is located.
  • deployment - Type of deployment (e.g., CAMPUS, BRANCH).
  • additionalProperties - Other gateway-related properties returned by the API.

Dependencies

  • Aruba Central Next Gen API with OAuth2 authentication

Troubleshooting

  • Ensure the OAuth2 API credentials are correctly configured and valid to avoid authentication errors.
  • If no gateways are returned, verify that the filters (site ID, model, status, deployment) are correctly set and that gateways exist matching those criteria.
  • If the node fails with an error message, check the debug logs if Debug Mode is enabled for detailed error information.

Discussion