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 By MAC" operation enables users to delete a device record by specifying its MAC address. This is useful in network administration scenarios where devices need to be removed from identity management systems based on their hardware address, for example, when decommissioning devices or removing unauthorized devices from the network.

Practical examples:

  • Automatically removing a device from ClearPass when it is no longer authorized to access the network.
  • Cleaning up stale device entries by deleting them via their MAC addresses.
  • Integrating with asset management workflows to keep ClearPass device records synchronized.

Properties

Name Meaning
Domain API domain to access. Options: "Identities", "Policy Elements", "Enforcement Profile".
MAC Address The MAC address of the device account to delete.
Options Additional options for the operation:
- Change of Authorization: Whether to update the network state using Disconnect-Request or 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 include confirmation of deletion or any relevant status information returned by the ClearPass API.

If the operation fails and "Continue on Fail" is enabled, the output will contain an error object with an error field describing the failure message.

The node does not output binary data.

Dependencies

  • Requires an active connection to Aruba ClearPass API.
  • Needs an API authentication credential configured in n8n (an API key or token).
  • The node depends on internal helper functions (executeOperation) to perform the API call.

Troubleshooting

  • Common issues:

    • Invalid or missing MAC address format can cause the API call to fail.
    • Insufficient permissions or invalid API credentials will result in authentication errors.
    • Network connectivity issues to the ClearPass server may cause timeouts or connection errors.
  • Error messages:

    • Errors thrown during execution are logged and, if "Continue on Fail" is enabled, returned as part of the output.
    • Typical error messages might include authentication failures, resource not found (if the MAC address does not exist), or validation errors.
  • Resolution tips:

    • Verify the MAC address format and ensure it exists in ClearPass.
    • Check that the API credentials are valid and have sufficient permissions.
    • Ensure network connectivity to the ClearPass API endpoint.
    • Enable "Continue on Fail" to handle errors gracefully in workflows.

Links and References

  • Aruba ClearPass API documentation (consult Aruba Networks official docs for detailed API usage)
  • n8n documentation on creating and configuring API credential nodes
  • General MAC address formatting standards

Discussion