Aruba ClearPass

Interact with Aruba ClearPass API

Actions34

Overview

This node integrates with the Aruba ClearPass API, allowing users to manage various resources within different API domains such as "Identities," "Policy Elements," and "Enforcement Profile." Specifically, for the "Local Users" resource under the "Identities" domain, it supports operations including deleting a local user by their numeric ID.

Common scenarios where this node is beneficial include automating user management tasks in network access control systems, such as removing outdated or unauthorized local user accounts from Aruba ClearPass. For example, an administrator can set up a workflow that automatically deletes local users who no longer require access based on external triggers or schedules.

Properties

Name Meaning
Domain API domain to access. Options: "Identities", "Policy Elements", "Enforcement Profile".
Local User ID Numeric ID of the local user to delete. Required when Domain is "Identities" and Resource is "LocalUser" with operation "delete".

Output

The node outputs an array of JSON objects representing the results of the executed operation. For the delete operation on a local user, the output typically contains confirmation details or status information returned by the Aruba ClearPass API about the deletion action.

No binary data output is indicated in the source code.

Dependencies

  • Requires an API key credential for authenticating with the Aruba ClearPass API.
  • The node depends on an internal helper module (./helpers/executeOperation) to perform the actual API call.
  • Proper configuration of the API domain, resource, and operation parameters is necessary.
  • Network connectivity to the Aruba ClearPass server is required.

Troubleshooting

  • Common Issues:

    • Incorrect or missing API credentials will cause authentication failures.
    • Providing an invalid or non-existent Local User ID will result in errors from the API.
    • Selecting mismatched Domain, Resource, and Operation combinations may lead to unexpected behavior or errors.

  • Error Messages:

    • Errors thrown during execution are logged and, if "Continue on Fail" is enabled, returned as part of the node's output JSON under an error field.
    • Typical error messages might include authentication failures, resource not found, or permission denied.

  • Resolutions:

    • Verify API credentials and permissions.
    • Ensure the Local User ID exists before attempting deletion.
    • Confirm that the Domain, Resource, and Operation selections align correctly.

Links and References

Discussion