Aruba ClearPass

Interact with Aruba ClearPass API

Actions34

Overview

The "Update By MAC" operation in the Endpoints resource of this Aruba ClearPass node allows users to update endpoint information by specifying the MAC address. This is useful for managing network endpoints dynamically, such as updating device descriptions, status, or attributes based on their MAC addresses.

Common scenarios include:

  • Updating endpoint metadata after a device changes location or role.
  • Marking devices as known, unknown, or disabled for network access control.
  • Adding or modifying custom attributes or tags for better device categorization and policy enforcement.

For example, a network administrator can update the description and status of a device identified by its MAC address to reflect its current usage or security posture.

Properties

Name Meaning
Domain API domain to access. Options: Identities, Policy Elements, Enforcement Profile
MAC Address The MAC address of the endpoint to update (e.g., "00:11:22:33:44:55")
Description Text description of the endpoint
Status Status of the endpoint. Options: Known, Unknown, Disabled
Randomized MAC Boolean indicating whether the MAC address is randomized
Device Insight Tags List of tags associated with the device for insight purposes
Attributes Additional key/value pairs as JSON to store extra attributes about the endpoint

Output

The node outputs an array of JSON objects representing the updated endpoint(s). Each item contains the updated data fields reflecting the changes made via the operation.

If an error occurs and "Continue on Fail" is enabled, the output will contain an object with an error field describing the issue.

No binary data output is indicated.

Dependencies

  • Requires an API key credential for authenticating with the Aruba ClearPass API.
  • The node depends on the external Aruba ClearPass service being accessible.
  • Proper configuration of the API domain and resource selection is necessary.

Troubleshooting

  • Common issues:

    • Invalid or missing MAC address format may cause the update to fail.
    • Incorrect API domain or resource selection can lead to failed requests.
    • Network connectivity or authentication errors with the ClearPass API.

  • Error messages:

    • Errors thrown during execution are logged and, if "Continue on Fail" is enabled, returned as part of the output JSON under an error property.
    • To resolve, verify credentials, input parameters, and network access.

Links and References

  • Aruba ClearPass API documentation (consult official Aruba Networks resources)
  • n8n documentation on creating and using custom nodes and credentials

Discussion