Aruba ClearPass

Interact with Aruba ClearPass API

Actions34

Overview

This node integrates with the Aruba ClearPass API, specifically allowing users to update device accounts within the "Devices" resource under the "Identities" domain. It is designed to modify properties of existing devices such as MAC address, role assignments, enablement status, timing constraints, and custom metadata.

Common scenarios include:

  • Updating device information in a network access control system.
  • Changing device roles or permissions dynamically based on external triggers.
  • Managing visitor or sponsor details for devices in enterprise environments.
  • Automating device lifecycle events like enabling/disabling accounts or setting expiration times.

Practical example:

  • Automatically disable a device account after a certain date/time by updating its "Expire Time".
  • Change the role assigned to a device when it moves between network zones.

Properties

Name Meaning
Domain The API domain to access. Options: Identities, Policy Elements, Enforcement Profile. For this operation, "Identities" is relevant.
Device ID The unique identifier of the device account to update.
Update Fields Collection of fields to update on the device account:
- MAC Address: The device's MAC address.
- Role ID: Numeric role identifier to assign.
- Role Name: Name of the role to assign.
- Enabled: Boolean to enable/disable the account.
- Start Time: ISO 8601 datetime when the account becomes active.
- Expire Time: ISO 8601 datetime when the account expires.
- Visitor Name: Display name for the device.
- Sponsor Name: Name of the account's sponsor.
- Sponsor Profile: Numeric profile ID for the sponsor.
- Notes: Comments or notes about the device.
- Source: Origin of the account.
- Custom Fields: JSON object with additional custom data.
Options Additional options for the update:
- Change of Authorization: Whether to send a network state update using Disconnect-Request or CoA-Request. Options: Use Default Setting, Yes, No.

Output

The node outputs an array of items where each item contains a json property representing the updated device account data returned from the Aruba ClearPass API. This typically includes the updated fields reflecting the changes made.

No binary data output is indicated.

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 call.
  • Proper configuration of the API endpoint and credentials in n8n is necessary.

Troubleshooting

  • Common issues:

    • Invalid or missing Device ID will cause the update to fail.
    • Incorrectly formatted dates (Start Time, Expire Time) may result in API errors.
    • Insufficient permissions or invalid API credentials can cause authentication failures.
    • Providing unsupported or malformed custom fields JSON may lead to request rejection.

  • 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 problems with the API key or token.
    • Validation errors from the API usually specify which field caused the issue.

  • Resolution tips:

    • Verify that the Device ID exists and is correct.
    • Ensure date/time fields follow ISO 8601 format.
    • Check API credentials and permissions.
    • Validate JSON syntax for custom fields before submission.

Links and References

Discussion