Actions95
- Access Point Actions
- Client Actions
- Events Actions
- Gateway Actions
- Label Actions
- Mobility Controller Actions
- Network Actions
- Site Actions
- Swarm Actions
- Switch Actions
- List Switches
- Get VLAN Info of the Switch
- Get VLAN Info for CX Switch
- Get VLAN Info of the Switch Stack
- Get VLAN Info of the CX Switch Stack
- Get Switch Port PoE Info
- Get Switch Port PoE Info for CX Switch
- Get Switch PoE Info
- Get Switch PoE Info for CX Switch
- Get Switch VSX Info for CX Switch
- Get LLDP Device Neighbor Info for CX Switch
- Get LLDP Device Neighbor Info for CX Switch Stack
- Switch Bandwidth Usage
- Top N Switches
- Switch Details
- Delete Switch
- Switch Ports Details
- Get Ports Details for CX Switch
- Switch Chassis Details
- Switch Ports Bandwidth Usage
- Ports Bandwidth Usage for CX Switch
- Switch Ports Errors
- CX Switch Ports Errors
- Switch Stack Port Details
- CX Switch Stack Port Details
- List Switch Stacks
- Switch Stack Details
- Delete Switch Stack
- VPN Actions
Gateway → Get Tunnel Stats
AI-generatedOverview
This node interacts with the Aruba Central API to retrieve tunnel statistics for a specified Gateway device. It is useful for network administrators who want to monitor and analyze the performance and status of tunnels on their gateway devices within the Aruba Central monitoring domain. For example, it can be used to fetch detailed tunnel stats filtered by gateway serial number and other optional parameters like tunnel map name or interval.
Use Case Examples
- Retrieve tunnel statistics for a specific gateway device by providing its serial number.
- Fetch all available tunnel stats without limiting the number of results.
- Filter tunnel stats by specific tunnel map name or time interval for detailed analysis.
Properties
| Name | Meaning |
|---|---|
| Domain | Specifies the domain of the Aruba Central API to use, defaulting to 'monitoring' for this operation. |
| Return All | Determines whether to return all tunnel stats results or limit the number of results. |
| Limit | Maximum number of tunnel stats results to return when 'Return All' is false. |
| Serial | The serial number of the Gateway device to filter tunnel stats for. |
| Additional Fields | Optional filters for the tunnel stats such as uplink ID (deprecated), tunnel map name, and interval (e.g., 5 minutes, 1 hour, 1 day, 1 week). |
Output
JSON
tunnelStats- Array of tunnel statistics objects retrieved from the Aruba Central API for the specified Gateway.
Dependencies
- Aruba Central API with OAuth2 authentication
Troubleshooting
- Ensure the Gateway serial number is correctly provided; missing or incorrect serial will result in no data or errors.
- If 'Return All' is false and 'Limit' is set too low, you may not get all relevant tunnel stats; adjust accordingly.
- Deprecated fields like 'uplink_id' may not have any effect; avoid using them.
- API authentication errors may occur if OAuth2 credentials are invalid or expired; refresh credentials as needed.