Aruba Central Next Gen icon

Aruba Central Next Gen

Consume Aruba Central Next Gen API

Actions408

Scope Management → Get All Device Groups

AI-generated

Overview

This node operation retrieves all device groups within the Scope Management resource of the Aruba Central Next Gen API. It is useful for network administrators who need to list and manage device groups for monitoring or configuration purposes. For example, it can be used to fetch device groups to audit network segmentation or to apply configuration policies to specific groups.

Use Case Examples

  1. Fetch all device groups to display in a network management dashboard.
  2. Retrieve device groups filtered by name or sorted by device count for reporting.

Properties

Name Meaning
Debug Mode Whether to enable detailed debug logs for troubleshooting.
Domain API domain to interact with, such as monitoring or configuration.
Return All Whether to return all results or only up to a given limit.
Limit Max number of device groups to return (1-100).
Additional Fields Optional filters, search, and sort parameters for the device groups query.

Output

JSON

  • deviceGroups - Array of device group objects retrieved from the API, each containing details like scopeName and deviceCount.

Dependencies

  • Aruba Central Next Gen API with OAuth2 authentication

Troubleshooting

  • Ensure the OAuth2 API credentials are correctly configured and valid to avoid authentication errors.
  • If no device groups are returned, verify the filter and search parameters for correctness and that device groups exist in the specified domain.
  • Enable Debug Mode to get detailed logs for troubleshooting API request and response issues.

Discussion