Aruba Central Next Gen icon

Aruba Central Next Gen

Consume Aruba Central Next Gen API

Actions408

Scope Management → Get Device Collection

AI-generated

Overview

This node operation retrieves a specific device collection within the Scope Management resource of the Aruba Central Next Gen API. It is useful for users who need to access detailed information about a particular group of devices identified by a scope ID. For example, network administrators can use this operation to fetch device collections for monitoring or configuration purposes within their network management workflows.

Use Case Examples

  1. Retrieve a device collection by providing its scope ID to monitor device statuses.
  2. Fetch device collection details to apply configuration changes or audit device groups.

Properties

Name Meaning
Debug Mode Enables detailed debug logs for troubleshooting the node execution.
Domain Specifies the API domain to interact with, such as monitoring, configuration, or system domains.
Scope ID The unique identifier of the device collection to retrieve within the specified domain.

Output

JSON

  • deviceCollection - The retrieved device collection data corresponding to the provided scope ID.

Dependencies

  • Requires an API key credential for Aruba Central Next Gen OAuth2 authentication to access the API.

Troubleshooting

  • Common issues include providing an invalid or empty scope ID, which results in failure to retrieve the device collection.
  • Errors may occur if the API domain is incorrectly specified or if the API authentication token is missing or expired.
  • Debug mode can be enabled to get detailed logs for troubleshooting execution errors.

Discussion