Aruba Central Next Gen icon

Aruba Central Next Gen

Consume Aruba Central Next Gen API

Actions408

Site Health → Get Site Information

AI-generated

Overview

This node operation retrieves detailed health information for a specific site within the Aruba Central Next Gen platform. It is useful for monitoring the status and performance of a site by querying site health data at a given point in time. For example, network administrators can use this operation to get real-time or historical health metrics of a site to troubleshoot issues or assess network conditions.

Use Case Examples

  1. Retrieve site health information for a site identified by its UUID to monitor network performance.
  2. Query site health data at a specific timestamp to analyze historical network conditions.

Properties

Name Meaning
Debug Mode Whether to enable detailed debug logs for troubleshooting.
Domain API domain to interact with, such as monitoring, configuration, interfaces, routing, network services, security, management, or system.
Site ID UUID identifier of the site for which information is requested.
Query Time Timestamp in epoch milliseconds for the data request. If not provided, current time is used.

Output

JSON

  • siteHealthData - The detailed health information of the specified site returned by the API.

Dependencies

  • Requires Aruba Central Next Gen API credentials for authentication.

Troubleshooting

  • Ensure the Site ID is a valid UUID and corresponds to an existing site in Aruba Central.
  • If the API domain is incorrect or not set to 'monitoring', the operation may fail to retrieve site health data.
  • If Query Time is provided, ensure it is a valid epoch timestamp in milliseconds.
  • Enable Debug Mode to get detailed logs for troubleshooting errors during execution.

Discussion