Aruba Central Next Gen icon

Aruba Central Next Gen

Consume Aruba Central Next Gen API

Actions408

Scope Management → Get All Sites

AI-generated

Overview

This node operation retrieves a list of sites from the Aruba Central Next Gen API under the Scope Management resource. It is useful for scenarios where users need to fetch site information for monitoring, configuration, or management purposes within a network environment. For example, a network administrator can use this operation to get all site details to monitor network coverage or to configure site-specific settings.

Use Case Examples

  1. Fetch all sites with a limit of 50 to monitor network coverage.
  2. Retrieve all sites with a filter applied to get only sites in a specific city.
  3. Get all sites sorted by site name for easier management.

Properties

Name Meaning
Debug Mode Whether to enable detailed debug logs for troubleshooting.
Domain API domain to interact with, such as monitoring, configuration, interfaces, routing, network services, security, management, or system.
Return All Whether to return all results or only up to a given limit.
Limit Max number of sites to return (1-100).
Additional Fields Optional additional parameters such as filter, search, and sort to refine the site retrieval.

Output

JSON

  • siteId - Unique identifier of the site.
  • scopeName - Name of the site scope.
  • address - Physical address of the site.
  • city - City where the site is located.
  • state - State or region of the site.
  • country - Country of the site.
  • zipcode - Postal code of the site.
  • collectionName - Name of the collection the site belongs to.
  • deviceCount - Number of devices associated with the site.
  • timezone - Timezone of the site location.
  • longitude - Longitude coordinate of the site.
  • latitude - Latitude coordinate of the site.

Dependencies

  • Aruba Central Next Gen API with OAuth2 authentication

Troubleshooting

  • Common issues include API authentication failures due to invalid or expired OAuth2 tokens. Ensure the OAuth2 credentials are correctly configured and refreshed.
  • Incorrect filter or search syntax may cause the API to return errors or no results. Verify the OData filter syntax and search terms.
  • If the limit is set too high without enabling 'Return All', the node may only return up to the specified limit, potentially missing some sites.
  • Debug Mode can be enabled to get detailed logs for troubleshooting execution issues.

Links

Discussion