Aruba ClearPass

Interact with Aruba ClearPass API

Actions34

Overview

This node integrates with the Aruba ClearPass API, specifically targeting the "Endpoints" resource under the "Identities" domain for the "List" operation. It allows users to retrieve a list of endpoint devices managed by ClearPass. This is useful in scenarios where you want to automate inventory management, monitor connected devices, or apply policies based on endpoint attributes.

For example, you could use this node to:

  • Fetch all known endpoints to audit network access.
  • Retrieve endpoints filtered by specific criteria such as MAC address patterns or status.
  • Sort and limit the number of returned endpoints for reporting or further processing.

Properties

Name Meaning
Domain API domain to access. Options: Identities, Policy Elements, Enforcement Profile. Default: Identities.
Return All Whether to return all results or only up to a given limit. Boolean value (true or false).
Limit Maximum number of results to return when Return All is false. Number between 1 and 1000. Default: 100.
Filters Collection of optional filters to refine the list query:
- Filter JSON filter expression specifying which items to return. Example: {"status": "Known", "mac_address": {"$contains": "00:11"}}
- Sort Sort ordering for returned items. Examples: +id (default), +mac_address, -status.
- Calculate Count Boolean indicating whether to calculate the total item count matching the filter.

Output

The node outputs an array of JSON objects representing the endpoints retrieved from the ClearPass API. Each object corresponds to an endpoint with its associated properties 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 produced by this node.

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 calls.
  • Proper configuration of the API credentials within n8n is necessary for successful operation.

Troubleshooting

  • Common Issues:

    • Authentication failures due to invalid or missing API credentials.
    • Incorrect filter JSON syntax causing API request errors.
    • Exceeding API rate limits or returning too many results without enabling pagination (Return All).

  • Error Messages:

    • Errors thrown by the API or network issues are logged and, if "Continue on Fail" is enabled, returned as part of the node output.
    • To resolve errors, verify API credentials, check filter syntax, and adjust the Limit or enable Return All as needed.

Links and References

Discussion