Aruba Central Next Gen icon

Aruba Central Next Gen

Consume Aruba Central Next Gen API

Actions408

Roles & Policy → Get All Role GPIDs

AI-generated

Overview

This node interacts with the Aruba Central Next Gen API to retrieve all Role GPIDs (Group Policy IDs) within the Roles & Policy resource. It is useful for network administrators who need to manage or audit role-based policies in their Aruba Central environment. For example, it can be used to fetch a list of all role GPIDs to review or update access controls and policies.

Use Case Examples

  1. Fetch all Role GPIDs with a limit of 100 and offset 0 to paginate through results.
  2. Enable debug mode to troubleshoot API call issues when retrieving role GPIDs.
  3. Specify additional fields like view type, object type, or persona to filter the role GPIDs returned.

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 Maximum number of role GPIDs to retrieve, with a minimum of 1 and maximum of 1000.
Offset Starting point for retrieving role GPIDs, used for pagination, minimum value is 0.
Additional Fields Optional parameters to refine the query such as view type (Library or Local), object type (Local, Shared, or Both), scope ID, persona, detailed flag, and effective flag.

Output

JSON

  • roleGpidList - Array of role GPIDs retrieved from the API.

Dependencies

  • Aruba Central Next Gen API with OAuth2 authentication

Troubleshooting

  • Ensure the OAuth2 API credentials are correctly configured and valid.
  • Check that the domain and resource parameters are correctly set to 'configuration' and 'rolesPolicy' respectively for this operation.
  • If the node returns an error, enable Debug Mode to get detailed logs for troubleshooting.
  • Verify that the limit and offset values are within the allowed range to avoid API errors.

Discussion