Aruba Central icon

Aruba Central

Interact with the Aruba Central API

Actions95

Site → List Sites

AI-generated

Overview

This node interacts with the Aruba Central API to list sites within the specified domain, particularly useful for network administrators managing Aruba Central environments. It supports filtering, sorting, and pagination of site data, enabling efficient retrieval of site information for monitoring and management purposes.

Use Case Examples

  1. A network admin wants to retrieve all monitoring sites to generate a report on network health.
  2. Filtering sites by exact site name to focus on a specific location's network status.
  3. Sorting sites by name in ascending or descending order to organize site data for display or further processing.

Properties

Name Meaning
Domain Specifies the domain of the Aruba Central API to interact with, such as monitoring, inventory, or configuration.
Return All Determines whether to return all results or limit the number of results returned. Only applicable when domain is 'monitoring'.
Limit Maximum number of site results to return when 'Return All' is false. Minimum value is 1.
Additional Fields Additional optional parameters to refine the site listing, including calculating total number of sites, filtering by exact site name, and sorting order.

Output

JSON

  • site_id - Unique identifier of the site.
  • site_name - Name of the site.
  • domain - Domain under which the site is categorized.
  • additional_fields
    • calculate_total - Indicates if total number of sites was calculated.
    • site_name - Filter applied for site name.
    • sort - Sort order applied to the site list.

Dependencies

  • Aruba Central API with OAuth2 authentication

Troubleshooting

  • Ensure the OAuth2 credentials for Aruba Central API are correctly configured and valid.
  • If the node returns an error, check network connectivity to Aruba Central API endpoints.
  • When filtering by site name, ensure the exact match is used to avoid empty results.
  • If 'Return All' is set to false, verify the 'Limit' value is within allowed range to avoid incomplete data retrieval.

Discussion