Aruba Central Next Gen icon

Aruba Central Next Gen

Consume Aruba Central Next Gen API

Actions408

Gateway → Get Summary of Cluster Tunnel Status

AI-generated

Overview

This node operation retrieves a summary of the cluster tunnel status for a specified gateway cluster in Aruba Central Next Gen. It is useful for network administrators who need to monitor the health and status of tunnels within a gateway cluster, helping to ensure network connectivity and performance. For example, it can be used to quickly get an overview of tunnel statuses to identify any issues or bottlenecks in the cluster.

Use Case Examples

  1. Monitoring the tunnel status summary of a gateway cluster to detect connectivity issues.
  2. Generating reports on cluster tunnel health for network maintenance and troubleshooting.

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.
Cluster Name Gateway cluster name to specify which cluster's tunnel status summary to retrieve.

Output

JSON

  • clusterTunnelStatusSummary - Summary details of the cluster tunnel status including health and connectivity information.

Dependencies

  • Requires an API key credential for Aruba Central Next Gen OAuth2 authentication to access the API.

Troubleshooting

  • Common issues include invalid or missing cluster name, incorrect domain selection, or API authentication failures.
  • Error messages may indicate network connectivity problems, invalid parameters, or permission issues. Enabling Debug Mode can provide detailed logs to help diagnose these errors.

Discussion