Aruba Central Next Gen icon

Aruba Central Next Gen

Consume Aruba Central Next Gen API

Actions408

Roles & Policy → Get All Policy Groups

AI-generated

Overview

This node operation retrieves all policy groups related to roles and policies within the Aruba Central Next Gen platform. It supports pagination and filtering options to customize the data retrieval, making it useful for managing and auditing policy groups in network configurations.

Use Case Examples

  1. A network administrator wants to list all policy groups in the configuration domain to review access controls.
  2. An automation workflow fetches policy groups with detailed annotations for compliance reporting.

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.
Limit Limit for pagination, specifying the maximum number of policy groups to retrieve (1-1000).
Offset Offset for pagination, specifying the starting point for retrieval.
Additional Fields Optional fields to customize the retrieval of policy groups, including view type, object type, scope ID, persona filter, detailed annotations, and effective configuration.

Output

JSON

  • policyGroups - Array of policy group objects retrieved from the API, containing details about each policy group.

Dependencies

  • An API key credential for Aruba Central Next Gen OAuth2 authentication

Troubleshooting

  • Ensure the API credentials are correctly configured and have sufficient permissions to access policy groups.
  • Check that the domain is set to 'configuration' as this operation is specific to configuration domain.
  • Verify pagination parameters (limit and offset) are within allowed ranges to avoid errors.
  • If using LOCAL view type, ensure the scope ID is provided as it is mandatory.
  • Enable Debug Mode to get detailed logs for troubleshooting errors.

Discussion