Aruba ClearPass

Interact with Aruba ClearPass API

Actions34

Overview

This node integrates with the Aruba ClearPass API, allowing users to interact with various API domains such as "Identities," "Policy Elements," and "Enforcement Profile." Specifically, for the "Endpoints" resource under the "Identities" domain, it supports operations like retrieving details of a specific endpoint by its numeric ID. This is useful in network management scenarios where you need to fetch detailed information about endpoints connected to your network for monitoring, auditing, or automated workflows.

Practical examples include:

  • Automatically retrieving endpoint details when a new device connects to the network.
  • Fetching endpoint information to enrich logs or trigger security policies.
  • Integrating endpoint data into broader IT asset management systems.

Properties

Name Meaning
Domain The API domain to access. Options: "Identities", "Policy Elements", "Enforcement Profile".
Endpoint ID Numeric ID of the endpoint to retrieve (required when Domain is "Identities" and Resource is "Endpoint" with operation "get").

Output

The node outputs an array of JSON objects representing the data retrieved from the Aruba ClearPass API for the requested endpoint. Each item corresponds to an endpoint's details as returned by the API.

If the node encounters an error during execution 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 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 credentials within n8n is necessary for successful operation.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Providing an incorrect or non-existent Endpoint ID will result in errors or empty responses.
    • Network connectivity issues can prevent the node from reaching the Aruba ClearPass API.

  • 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 may relate to authentication failure, invalid parameters, or API unavailability.

  • Resolution tips:

    • Verify that the API key credential is correctly set up and has sufficient permissions.
    • Double-check the Endpoint ID value for correctness.
    • Ensure network access to the Aruba ClearPass API endpoint.

Links and References

Discussion