Aruba Central Next Gen icon

Aruba Central Next Gen

Consume Aruba Central Next Gen API

Actions408

Gateway → Get Summary of Gateway Tunnel Health

AI-generated

Overview

This node operation retrieves a summary of the health status of gateway tunnels for a specified gateway device. It is useful for network administrators who want to monitor the performance and health of gateway tunnels in their network infrastructure. For example, it can be used to quickly assess tunnel connectivity and identify potential issues affecting network traffic through the gateway.

Use Case Examples

  1. Monitoring the health of VPN tunnels on a gateway device to ensure reliable connectivity.
  2. Fetching tunnel health summary data to integrate with a network monitoring dashboard.

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 tunnel health summary is requested.
Site ID Site ID to filter gateway details, required by the API to specify the site context for the gateway.

Output

JSON

  • tunnelHealthSummary - Summary data of the gateway tunnel health including status and metrics.

Dependencies

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

Troubleshooting

  • Common issues include invalid or missing serial number or site ID, resulting in API errors or empty responses.
  • Enabling Debug Mode helps to get detailed logs for troubleshooting connectivity or data retrieval issues.
  • API rate limits or network connectivity problems may cause execution failures.

Discussion