Aruba Central Next Gen icon

Aruba Central Next Gen

Consume Aruba Central Next Gen API

Actions408

Gateway → Gateway Tunnel Detail

AI-generated

Overview

This node operation retrieves detailed information about a specific tunnel on a gateway device within the Aruba Central Next Gen platform. It is useful for network administrators who need to monitor or troubleshoot tunnel connections on gateways, such as VPN tunnels or other network tunnels. For example, it can be used to fetch tunnel status, performance metrics, or configuration details for a given tunnel name on a specified gateway device at a particular site.

Use Case Examples

  1. A network admin wants to check the status and details of a VPN tunnel named 'Tunnel1' on a gateway with serial number 'GW12345' at site 'SiteA'.
  2. Monitoring tunnel health and performance metrics for a specific gateway tunnel to ensure network reliability.

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.
Site ID Site ID to filter gateway details, required by the API for this operation.
Tunnel Name Tunnel name to retrieve details for, specifying which tunnel's details to fetch.

Output

JSON

  • tunnelDetails - Detailed information about the specified gateway tunnel, including status, metrics, and configuration.

Dependencies

  • Aruba Central Next Gen API with OAuth2 authentication

Troubleshooting

  • Ensure the serial number, site ID, and tunnel name are correctly specified and exist in the Aruba Central system.
  • If debug mode is enabled, detailed logs can help identify issues with API requests or responses.
  • Common errors may include authentication failures, invalid parameters, or network connectivity issues to the Aruba Central API.

Links

Discussion