Aruba ClearPass

Interact with Aruba ClearPass API

Actions34

Overview

This node integrates with the Aruba ClearPass API, specifically allowing users to create new endpoint records within the "Endpoints" resource under the "Identities" domain. It is useful for network administrators who want to programmatically register devices by their MAC addresses into ClearPass for identity and access management purposes.

Typical use cases include:

  • Automatically onboarding new devices detected on a network.
  • Maintaining an up-to-date inventory of endpoints with associated metadata.
  • Setting device status and attributes to control network access policies.

For example, you can create an endpoint by specifying its MAC address, description, status (Known, Unknown, Disabled), whether the MAC is randomized, device insight tags, and additional custom attributes.

Properties

Name Meaning
Domain API domain to access. Options: Identities, Policy Elements, Enforcement Profile.
MAC Address The MAC address of the endpoint to create (e.g., "00:11:22:33:44:55").
Description A textual description of the endpoint device.
Status The status of the endpoint. Options: Known, Unknown, Disabled.
Randomized MAC Boolean indicating if the MAC address is randomized.
Device Insight Tags Comma-separated list of tags related to device insights.
Attributes Additional key/value pairs as JSON object representing extra attributes for the endpoint.

Output

The node outputs an array of JSON objects representing the created endpoint(s) as returned by the Aruba ClearPass API. Each item in the output corresponds to one endpoint record with its properties as stored or acknowledged by the API.

No binary data output is indicated.

Dependencies

  • Requires an API key credential for authenticating with the Aruba ClearPass API.
  • The node depends on an internal helper module (executeOperation) that handles the actual API request execution.
  • Proper configuration of the API credentials in n8n is necessary for successful operation.

Troubleshooting

  • Common issues:
    • Invalid or missing MAC address format may cause API errors.
    • Insufficient permissions or incorrect API credentials will result in authentication failures.
    • Providing invalid JSON in the Attributes field can cause parsing errors.
  • Error messages:
    • Errors thrown during execution are logged and, if "Continue on Fail" is enabled, returned as error objects in the output.
    • Authentication errors typically indicate misconfigured API credentials.
    • Validation errors from the API usually specify which input property is invalid or missing.

Links and References

Discussion