Aruba ClearPass

Interact with Aruba ClearPass API

Actions34

Overview

This node integrates with the Aruba ClearPass API, enabling users to interact with various ClearPass domains and resources. Specifically, for the "Devices" resource under the "Identities" domain, it supports operations such as retrieving device information by MAC address. This is useful in network management scenarios where administrators need to query device details based on their MAC addresses, for example, to verify device compliance, track devices on the network, or automate policy enforcement.

Practical examples include:

  • Fetching detailed device attributes from ClearPass by providing a MAC address.
  • Automating workflows that require device validation before granting network access.
  • Integrating ClearPass device data into broader IT asset management systems.

Properties

Name Meaning
Domain The API domain to access. Options: "Identities", "Policy Elements", "Enforcement Profile".
MAC Address The MAC address of the device account to retrieve. Must be provided when Domain is "Identities" and Resource is "Device" with operation "Get By MAC".

Output

The node outputs an array of JSON objects representing the results returned from the ClearPass API for the requested operation. For the "Get By MAC" operation on Devices, the output JSON contains the device details associated with the specified MAC address.

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

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 and handle the operation logic.
  • Proper configuration of the ClearPass API credentials within n8n is necessary.

Troubleshooting

  • Common issues:

    • Invalid or missing MAC address input will likely cause the API call to fail.
    • Incorrect domain or resource selection may result in no data or errors.
    • Authentication failures if the API key credential is not set up correctly.

  • Error messages:

    • Errors thrown during execution are logged and, if "Continue On Fail" is enabled, returned as part of the node output.
    • Typical error messages might relate to network connectivity, invalid credentials, or malformed requests.

  • Resolution tips:

    • Verify the MAC address format and ensure it matches expected patterns.
    • Confirm that the API credentials are valid and have sufficient permissions.
    • Check network connectivity to the ClearPass API endpoint.

Links and References

Discussion