Aruba Central Next Gen icon

Aruba Central Next Gen

Consume Aruba Central Next Gen API

Actions408

Gateway → Get Summary of Gateway WAN Tunnel Health

AI-generated

Overview

This node operation retrieves a summary of the WAN tunnel health for a specified gateway device in Aruba Central Next Gen. It is useful for network administrators who want to monitor the health and status of WAN tunnels on their gateways to ensure network reliability and performance. For example, it can be used to quickly get an overview of tunnel health metrics to identify potential issues or confirm stable operation.

Use Case Examples

  1. Monitoring WAN tunnel health status for a specific gateway by providing its serial number.
  2. Enabling debug mode to get detailed logs for troubleshooting WAN tunnel health data retrieval.

Properties

Name Meaning
Debug Mode Whether to enable detailed debug logs for troubleshooting.
Domain API domain to interact with, set to 'monitoring' for this operation.
Serial Number Gateway serial number to identify the specific gateway device for which the WAN tunnel health summary is retrieved.

Output

JSON

  • tunnelHealthSummary - Summary data of the WAN tunnel health for the specified gateway.

Dependencies

  • An API key credential for Aruba Central Next Gen OAuth2 authentication

Troubleshooting

  • If the node fails with an authentication error, verify that the Aruba Central Next Gen OAuth2 API credentials are correctly configured and valid.
  • If no data is returned, ensure the provided gateway serial number is correct and the gateway is registered in Aruba Central.
  • Enable Debug Mode to get detailed logs which can help identify issues with API requests or responses.

Discussion