Aruba Central Next Gen icon

Aruba Central Next Gen

Consume Aruba Central Next Gen API

Actions82

Overview

This node interacts with the Aruba Central Next Gen API to list gateways within a specified domain, primarily under the "monitoring" domain. It allows users to retrieve information about network gateways, including filtering by site, model, status, and deployment type. This is useful for network administrators who want to monitor the status and details of their gateways in real-time or gather inventory data.

Practical examples include:

  • Fetching all online gateways deployed at a specific site.
  • Retrieving a limited number of gateways sorted by status or site ID.
  • Filtering gateways by model or deployment type to analyze specific segments of the network.

Properties

Name Meaning
Debug Mode Whether to enable detailed debug logs for troubleshooting. When enabled, the node outputs additional logging information to help diagnose issues.
Domain API domain to interact with. Options:
- Monitoring: Monitor devices, clients, and sites
- Configuration: Configure devices, groups, and profiles
Return All Whether to return all results or only up to a given limit. Only applicable when Domain is "monitoring", Resource is "gateways", and Operation is "listGateways".
Limit Max number of results to return if "Return All" is false. Value between 1 and 100. Only shown when Domain is "monitoring", Resource is "gateways", Operation is "listGateways", and Return All is false.
Additional Fields Collection of optional fields to refine the query:
- Filters:
  • Site ID: Filter gateways by site ID
  • Model: Filter by gateway model
  • Status: Online, Offline, Unknown
  • Deployment: Campus or Branch
- Sort Options: Comma-separated list of fields to sort by, e.g., "siteId asc, status desc"

Output

The node outputs an array of JSON objects representing gateways matching the query criteria. Each object contains gateway details such as ID, model, status, site association, and deployment type. The exact structure depends on the API response but typically includes:

  • Gateway identifiers
  • Status (Online, Offline, Unknown)
  • Model information
  • Site ID
  • Deployment type (Campus or Branch)

No binary data output is indicated.

Dependencies

  • Requires an API key credential for authenticating with the Aruba Central Next Gen API.
  • The node expects proper configuration of this credential within n8n.
  • Network connectivity to Aruba Central API endpoints.
  • Optional debug mode can be enabled for detailed logging during execution.

Troubleshooting

  • Common Issues:

    • Authentication failures due to invalid or expired API credentials.
    • Network timeouts or unreachable API endpoints.
    • Invalid filter values causing no results or errors.
    • Exceeding API rate limits when requesting large datasets without pagination.
  • Error Messages:

    • "Unknown error in node execution": Generic catch-all error; check logs for more details.
    • Authentication errors: Verify API key validity and permissions.
    • Validation errors on filters or parameters: Ensure correct types and allowed values are used.
  • Resolutions:

    • Enable Debug Mode to get detailed logs for diagnosing issues.
    • Confirm API credentials and renew if necessary.
    • Adjust filters and limits to valid values.
    • Implement retry logic or reduce request frequency if hitting rate limits.

Links and References

Discussion