Aruba Central Next Gen icon

Aruba Central Next Gen

Consume Aruba Central Next Gen API

Actions408

Scope Management → Get All Device Collections

AI-generated

Overview

This node operation retrieves all device collections within the Scope Management resource of the Aruba Central Next Gen API. It is useful for scenarios where users need to list or manage groups of devices, such as organizing devices by scope or monitoring device collections for network management purposes. For example, a network administrator might use this operation to fetch all device collections to audit or apply configurations to specific groups.

Use Case Examples

  1. Fetch all device collections to display in a dashboard.
  2. Retrieve device collections filtered by a specific scope name for targeted management.

Properties

Name Meaning
Debug Mode Enables detailed debug logs for troubleshooting the node execution.
Domain Specifies the API domain to interact with, set to 'configuration' for this operation.
Return All Determines whether to return all device collections or limit the number of results.
Limit Maximum number of device collections to return when 'Return All' is false.
Additional Fields Optional fields to refine the query, including filter, search, and sort parameters.

Output

JSON

  • deviceCollections - Array of device collection objects retrieved from the API, each representing a group of devices within the scope management domain.

Dependencies

  • Aruba Central Next Gen API with OAuth2 authentication

Troubleshooting

  • If the node returns no device collections, verify that the filter and search parameters are correctly specified and that the user has appropriate permissions.
  • Enable Debug Mode to get detailed logs for troubleshooting API request failures or unexpected responses.
  • Common errors include authentication failures due to invalid or expired OAuth2 tokens; ensure credentials are up to date.
  • API rate limits might cause request failures; consider using 'Return All' cautiously or applying limits.

Links

Discussion