Aruba Central Next Gen icon

Aruba Central Next Gen

Consume Aruba Central Next Gen API

Actions408

Roles & Policy → Delete Role GPID

AI-generated

Overview

This node operation deletes a Role GPID within the Aruba Central Next Gen API under the Roles & Policy resource. It is useful for managing and cleaning up role-based access controls by removing specific role GPIDs based on their name and optional additional parameters such as object type, scope ID, and persona. This operation is typically used in network management scenarios where roles need to be dynamically updated or removed to maintain security and proper access control.

Use Case Examples

  1. Deleting a role GPID named 'my-role-gpid' in the Configuration domain to revoke access or update role assignments.
  2. Using additional fields like Object Type and Scope ID to target specific shared or local roles for deletion.

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.
Name The name of the role GPID to delete.
Additional Fields Optional additional parameters for the delete operation, including Object Type (Local or Shared), Scope ID, and Persona.

Output

JSON

  • success - Indicates whether the role GPID deletion was successful.
  • message - Additional information or status message about the deletion operation.

Dependencies

  • Requires Aruba Central Next Gen API credentials for authentication.

Troubleshooting

  • Common issues include invalid role GPID name, insufficient permissions, or incorrect domain selection.
  • Error messages may indicate network issues, authentication failures, or invalid parameters. Enabling Debug Mode can provide detailed logs to help diagnose problems.

Discussion