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 Gateway
AI-generatedOverview
This node interacts with the Aruba Central API to retrieve information about a specific gateway device within the Monitoring domain. It is useful for network administrators who need to query detailed data about gateway devices, such as their status, metrics, and configurations, directly from Aruba Central.
Use Case Examples
- A network admin wants to monitor the status and performance of a gateway device by its serial number.
- An automated workflow retrieves gateway details to trigger alerts or update a network management system.
Properties
| Name | Meaning |
|---|---|
| Domain | Specifies the domain of the Aruba Central API to interact with, such as Monitoring, Configuration, or Firmware. For this operation, it defaults to 'monitoring'. |
| Serial | The serial number of the gateway device to be queried. This is a required string input. |
| Additional Fields | Optional additional parameters for the request. For this operation, it includes a boolean 'stats_metric' to indicate if uplinks and tunnels count should be retrieved. |
Output
JSON
gatewayDetails- The detailed information about the queried gateway device, including status and metrics if requested.
Dependencies
- Requires an OAuth2 API credential for Aruba Central to authenticate requests.
Troubleshooting
- Common issues include invalid or missing serial number, resulting in errors from the API about the device not found.
- Authentication failures due to incorrect or expired OAuth2 credentials.
- Network or API endpoint issues causing request failures.
- If 'stats_metric' is set incorrectly, the returned data may not include expected metrics.
Links
- Aruba Central API Documentation - Official API documentation for Aruba Central, useful for understanding available domains, operations, and parameters.