Aruba ClearPass

Interact with Aruba ClearPass API

Actions34

Overview

This node integrates with the Aruba ClearPass API, allowing users to interact with various domains and resources within ClearPass. Specifically, for the Devices resource with the Get operation, it retrieves detailed information about a specific device account by its ID. This is useful in network management scenarios where administrators need to query device details for monitoring, auditing, or troubleshooting purposes.

Practical examples include:

  • Fetching device attributes to verify compliance or security posture.
  • Retrieving device information before applying policy changes.
  • Auditing device access history or status in the ClearPass system.

Properties

Name Meaning
Domain The API domain to access. Options: "Identities", "Policy Elements", "Enforcement Profile". For this operation, "Identities" is used.
Device ID The unique identifier of the device account to retrieve. This is a required string input.

Output

The node outputs an array of JSON objects representing the device data retrieved from the ClearPass API. Each item corresponds to a device record with its associated properties as returned by the API.

If the node encounters an error and "Continue on Fail" is enabled, it outputs a JSON object containing an error field with the error message.

No binary data output is indicated.

Dependencies

  • Requires an API key credential for authenticating with the Aruba ClearPass API.
  • The node depends on internal helper functions (from ./helpers/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 API call to fail.
    • Incorrect or expired API credentials will result in authentication errors.
    • Network connectivity problems can prevent successful API communication.

  • Error messages:

    • Errors thrown during execution are logged and, if "Continue on Fail" is enabled, returned as part of the output JSON under the error key.
    • Typical errors include authentication failures, resource not found (invalid Device ID), or API rate limits.

  • Resolution tips:

    • Verify that the Device ID is correct and exists in ClearPass.
    • Ensure API credentials are valid and have sufficient permissions.
    • Check network connectivity and ClearPass API availability.

Links and References

Discussion