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 Detail
AI-generatedOverview
This node interacts with the Aruba Central API to retrieve detailed monitoring information about a specific gateway device. It is useful for network administrators who need to monitor the status and performance of gateway devices within their network. For example, it can fetch uplink statistics for a gateway over a specified time range, helping in network troubleshooting and performance analysis.
Use Case Examples
- Retrieve uplink stats for a gateway device with a given serial number over the past week.
- Fetch detailed monitoring data for a gateway to analyze network performance and detect issues.
Properties
| Name | Meaning |
|---|---|
| Domain | Specifies the domain of the Aruba Central API to interact with, such as monitoring, inventory, or configuration. For this operation, it defaults to 'monitoring'. |
| Return All | Determines whether to return all results or limit the number of results returned. Only applicable when domain is 'monitoring' and operation is 'getDetail'. |
| Limit | Maximum number of results to return when 'Return All' is false. Minimum value is 1. |
| Serial | Serial number of the gateway device to query. This is a required field. |
| Timerange | Time range for uplink statistics information. Options include 3 hours, 1 day, 1 week, 1 month, and 3 months. |
Output
JSON
gatewayDetail- Detailed information about the gateway device retrieved from the Aruba Central API.
Dependencies
- Aruba Central API
- OAuth2 API key credential
Troubleshooting
- Ensure the serial number provided is correct and corresponds to an existing gateway device in Aruba Central.
- Verify that the OAuth2 API credentials are valid and have the necessary permissions to access gateway monitoring data.
- If the node returns an error related to the time range, ensure the value is one of the allowed options (3H, 1D, 1W, 1M, 3M).
- If 'Return All' is set to false and the limit is too low, you might not get all expected data; adjust the limit accordingly.
Links
- Aruba Central API Documentation - Official API documentation for Aruba Central, useful for understanding available endpoints and data structures.