Aruba Central icon

Aruba Central

Interact with the Aruba Central API

Actions95

Network → Get Networks

AI-generated

Overview

This node interacts with the Aruba Central API to retrieve network information specifically under the 'Network' resource with the 'Get Networks' operation. It is useful for users who want to fetch details about networks monitored by Aruba Central, such as network devices and client counts. Practical applications include network monitoring, inventory management, and troubleshooting within an Aruba Central managed environment.

Use Case Examples

  1. A network administrator wants to get a list of all monitored networks along with client counts per SSID to analyze network usage.
  2. An IT team needs to retrieve network data sorted by ESSID to organize network reports.
  3. A user wants to limit the number of network results returned to avoid overwhelming the system with data.

Properties

Name Meaning
Domain Specifies the domain of the Aruba Central API to interact with, such as monitoring, configuration, or firmware management. For this operation, the default and required domain is 'monitoring'.
Return All Determines whether to return all network results or limit the number of results returned. Only applicable when domain is 'monitoring' and operation is 'getNetworks'.
Limit Specifies the maximum number of network results to return when 'Return All' is false. Minimum value is 1. Only applicable when domain is 'monitoring', operation is 'getNetworks', and 'Return All' is false.
Additional Fields Additional optional parameters for the 'Get Networks' operation under the 'monitoring' domain. Includes options to calculate client count per SSID and to sort results by ESSID.

Output

JSON

  • networks - Array of network objects retrieved from Aruba Central API containing network details such as SSID, client counts, and other monitoring data.

Dependencies

  • Aruba Central API with OAuth2 authentication

Troubleshooting

  • If the node fails to authenticate, ensure the OAuth2 credentials for Aruba Central API are correctly configured and valid.
  • If no networks are returned, verify that the domain is set to 'monitoring' and that the user has appropriate permissions in Aruba Central.
  • Errors related to parameter validation may occur if 'Limit' is set below 1 or if unsupported sort parameters are used. Adjust parameters accordingly.

Links

Discussion