Aruba Central Next Gen icon

Aruba Central Next Gen

Consume Aruba Central Next Gen API

Actions82

Overview

The node "Aruba Central Next Gen" interacts with the Aruba Central Next Gen API to retrieve and manage network-related data. Specifically, for the Site Health resource and the Get Site Information operation, it fetches detailed information about a particular site identified by its unique site ID. This is useful for network administrators who want to monitor the health and status of their sites in real-time or at a specific point in time.

Common scenarios include:

  • Retrieving current or historical health data of a site to analyze performance or troubleshoot issues.
  • Integrating site health data into dashboards or automated workflows for proactive network management.
  • Using debug mode to get detailed logs when troubleshooting API communication or data retrieval problems.

Example use case:

  • A network admin wants to pull the latest health metrics of a branch office site to check connectivity and device status before a scheduled maintenance.

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
Site ID UUID identifier of the site for which information is requested (required when Domain is "monitoring").
Query Time Timestamp in epoch milliseconds for the data request. If not provided, current time is used.

Output

The node outputs JSON data containing detailed information about the specified site’s health. The structure typically includes various metrics and status indicators relevant to the site’s network health, such as device statuses, client connections, and other monitoring data.

If binary data were output, it would represent files or media related to the site health, but this node focuses on JSON structured data.

Dependencies

  • Requires an API key credential for authenticating with the Aruba Central Next Gen API.
  • Needs proper configuration of the API domain (Monitoring or Configuration) depending on the operation.
  • The node depends on internal helper modules for executing operations and logging, but these are bundled within the node package.

Troubleshooting

  • Common Issues:

    • Invalid or missing Site ID will cause the API call to fail.
    • Incorrect domain selection may lead to unsupported operations or empty responses.
    • Network or authentication errors if the API key credential is misconfigured or expired.
  • Error Messages:

    • "Unknown error in node execution": Generic catch-all error; check debug logs if enabled.
    • API-specific errors returned from Aruba Central API will be surfaced via the node's error handling.
  • Resolutions:

    • Verify that the Site ID is correct and corresponds to an existing site.
    • Ensure the API key credential is valid and has necessary permissions.
    • Enable Debug Mode to get detailed logs for diagnosing issues.

Links and References

Discussion