Aruba ClearPass

Interact with Aruba ClearPass API

Overview

This node integrates with the Aruba ClearPass API, specifically allowing management of devices within the "Identities" domain. The "Delete" operation for the "Devices" resource enables users to remove a device account from the ClearPass system by specifying its unique Device ID.

Common scenarios where this node is beneficial include:

  • Automating cleanup of obsolete or compromised devices in network access control.
  • Integrating device lifecycle management into broader IT workflows.
  • Enforcing security policies by removing unauthorized devices programmatically.

For example, an administrator could use this node in an automation workflow to delete devices that have been inactive for a certain period or flagged by a security system.

Properties

Name Meaning
Domain API domain to access. Options: Identities, Policy Elements, Enforcement Profile.
Device ID The unique identifier of the device account to delete.
Options > Change of Authorization Whether to update the network state using Disconnect-Request or Change of Authorization (CoA) Request. Options: Use Default Setting, Yes, No.

Output

The node outputs an array of JSON objects representing the result of the delete operation. Typically, this will contain confirmation of deletion or relevant status information returned by the ClearPass API.

If an error occurs and "Continue on Fail" is enabled, the output will be a JSON object containing an error field with the error message.

The node does not output binary data.

Dependencies

  • Requires an API key credential for authenticating with the Aruba ClearPass API.
  • The node depends on an internal helper function (executeOperation) to perform the actual API call.
  • Proper configuration of the ClearPass API endpoint and credentials in n8n is necessary.

Troubleshooting

  • Common Issues:

    • Invalid or missing Device ID will cause the delete operation to fail.
    • Incorrect API credentials or insufficient permissions can lead to authentication errors.
    • Network connectivity issues may prevent communication with the ClearPass API.
  • Error Messages:

    • Errors thrown during execution are logged and, if "Continue on Fail" is enabled, returned as part of the node's output.
    • Typical error messages might include authorization failures, device not found, or API rate limits exceeded.
  • Resolution Tips:

    • Verify the Device ID is correct and exists in ClearPass.
    • Ensure the API key credential has appropriate permissions.
    • Check network connectivity and ClearPass API availability.
    • Enable "Continue on Fail" to handle errors gracefully in workflows.

Links and References

Discussion