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 retrieve health information about all sites within a specified domain, particularly under the "monitoring" domain. It is useful for network administrators and IT professionals who want to monitor the status and health metrics of multiple sites managed via Aruba Central. For example, it can be used to fetch real-time health data across all sites to quickly identify issues or trends affecting network performance.

Properties

Name Meaning
Debug Mode Whether to enable detailed debug logs for troubleshooting.
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 "sites", Operation is "getAllSites").
Limit Maximum number of results to return (1-100). Only used if Return All is false.
Additional Fields Collection of optional fields:
- Filters: Field name and value pairs to filter the request.
- Sort Options: String to specify sorting order (e.g., "name", "+name", "-name").

Output

The node outputs JSON data representing the health status of sites retrieved from the Aruba Central API. The output typically includes an array of site health objects, each containing various metrics and status indicators relevant to site monitoring.

If binary data were involved, it would be summarized here, but this node focuses on JSON data output.

Dependencies

  • Requires an API key credential for authenticating with Aruba Central Next Gen API.
  • Needs proper configuration of the API domain ("monitoring" or "configuration") depending on the operation.
  • The node uses internal helper modules for executing operations and logging, bundled within the node's codebase.

Troubleshooting

  • Common Issues:

    • Authentication failures due to invalid or missing API credentials.
    • Request limits exceeded if too many results are requested without enabling pagination or limiting results.
    • Incorrect filter or sort option formats causing API errors.
  • Error Messages:

    • "Unknown error in node execution": Generic catch-all error; check debug logs if enabled.
    • Errors related to API calls will include messages from the Aruba Central API; ensure correct domain and parameters.
  • Resolutions:

    • Verify API credentials and permissions.
    • Use "Return All" carefully to avoid large data requests; use "Limit" to control result size.
    • Validate filter fields and values against Aruba Central API documentation.
    • Enable Debug Mode to get detailed logs for diagnosing issues.

Links and References

  • Aruba Central Next Gen API Documentation (official Aruba Networks site)
  • n8n Documentation on creating custom nodes and handling API integrations
  • Network monitoring best practices for multi-site environments

Discussion