Aruba ClearPass

Interact with Aruba ClearPass API

Actions34

Overview

This node integrates with the Aruba ClearPass API, specifically allowing users to list devices within the "Identities" domain. It is designed to retrieve device information managed by ClearPass, which can be useful for network administrators who want to automate inventory management, monitor connected devices, or apply policies based on device attributes.

Common scenarios include:

  • Fetching a list of all registered devices in the network.
  • Filtering devices by specific criteria such as MAC address patterns.
  • Sorting devices by creation time or other attributes.
  • Paginating results when dealing with large numbers of devices.

Practical example:

  • An administrator wants to get all devices whose MAC addresses contain "00:11:22" and sort them by creation time descending, limiting the output to 100 devices.

Properties

Name Meaning
Domain The API domain to access. Options: "Identities", "Policy Elements", "Enforcement Profile".
Return All Whether to return all results or only up to a given limit (boolean).
Limit Maximum number of results to return (number between 1 and 1000). Only used if "Return All" is false.
Filters Collection of filtering options:
  Filter JSON filter expression specifying the items to return. Example: {"mac": {"$contains": "00:11:22"}}
  Sort Sort ordering for returned items. Examples: "+mac" or "-create_time". Default is "-id".
  Calculate Count Whether to calculate the total item count (boolean).

Output

The node outputs an array of JSON objects representing the devices retrieved from the ClearPass API according to the specified filters and limits.

  • Each item in the output corresponds to a device with its associated properties as returned by the API.
  • If an error occurs and "Continue on Fail" is enabled, the output will contain an object with an error field describing the issue.
  • The node does not output binary data.

Dependencies

  • Requires an API key credential for authenticating with the Aruba ClearPass API.
  • The node depends on an internal helper function (executeOperation) that handles the actual API request and response processing.
  • No additional external services are required beyond the ClearPass API itself.
  • Proper configuration of the API credentials in n8n is necessary.

Troubleshooting

  • Common issues:

    • Authentication failures due to invalid or missing API credentials.
    • Incorrect filter JSON syntax causing API errors.
    • Requesting more items than allowed by the API limit.
    • Network connectivity issues preventing API calls.

  • Error messages:

    • Errors thrown during execution are logged and, if "Continue on Fail" is enabled, returned as part of the output.
    • Typical error messages may relate to authentication, invalid parameters, or server errors.

  • Resolutions:

    • Verify API credentials and permissions.
    • Ensure filter expressions are valid JSON and conform to API expectations.
    • Use the "Limit" property appropriately and consider enabling "Return All" for full datasets.
    • Check network connectivity and ClearPass API availability.

Links and References

Discussion