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 Tunnels
AI-generatedOverview
This node interacts with the Aruba Central API to retrieve tunnel information for a specified gateway device. It is useful for network administrators who want to monitor and analyze tunnel statistics of their gateways within the Aruba Central monitoring domain. For example, it can fetch tunnel data for a gateway identified by its serial number, optionally filtered by a time range, and can return either all results or a limited number of them.
Use Case Examples
- Retrieve tunnel statistics for a gateway device with a specific serial number over the past day.
- Fetch all tunnel data for a gateway to analyze network performance and troubleshoot issues.
Properties
| Name | Meaning |
|---|---|
| Domain | Specifies the Aruba Central API domain to use, such as monitoring, configuration, or firmware. For this operation, the domain is typically 'monitoring'. |
| Return All | Determines whether to return all tunnel results or limit the number of results returned. Only applicable when domain is 'monitoring' and operation is 'getTunnels'. |
| Limit | Maximum number of tunnel results to return when 'Return All' is false. Minimum value is 1. |
| Serial | Serial number of the gateway device to query for tunnel information. |
| Additional Fields | Optional additional parameters for the query, such as 'Timerange' to specify the time range for tunnel statistics. Timerange options include 3H (3 hours), 1D (1 day), 1W (1 week), 1M (1 month), and 3M (3 months). |
Output
JSON
tunnels- Array of tunnel information objects retrieved from the gateway.
Dependencies
- Aruba Central API with OAuth2 authentication
Troubleshooting
- Ensure the serial number of the gateway is correct and the device is registered in Aruba Central.
- Verify that the OAuth2 credentials for Aruba Central API are valid and have the necessary permissions.
- If the node returns an error, check if the specified domain is set to 'monitoring' as this operation is domain-specific.
- If 'Return All' is false and the limit is set too low, you might not get all relevant tunnel data; adjust the limit accordingly.
Links
- Aruba Central API Documentation - Official API documentation for Aruba Central, including endpoints for monitoring and gateway tunnel data.