Aruba ClearPass icon

Aruba ClearPass

Interact with Aruba ClearPass API

Endpoints → Update By MAC

AI-generated

Overview

This node interacts with the Aruba ClearPass API to update an endpoint resource identified by its MAC address within the Identities domain. It is useful for network administrators who need to programmatically update endpoint details such as description, status, randomized MAC flag, device insight tags, and additional attributes based on the MAC address of the device. For example, updating the status of a device from 'Unknown' to 'Known' or adding descriptive tags to an endpoint for better network management.

Use Case Examples

  1. Updating the description and status of an endpoint identified by its MAC address.
  2. Setting the randomized MAC flag and adding device insight tags to an endpoint.

Properties

Name Meaning
Domain API domain to access, fixed to 'Identities' for this operation.
MAC Address The MAC address of the endpoint to update.
Description Description of the endpoint to update.
Status Status of the endpoint, e.g., Known, Unknown, Disabled.
Randomized MAC Boolean flag indicating whether the MAC address is randomized.
Device Insight Tags List of device insight tags associated with the endpoint.
Attributes Additional key/value pair attributes for the endpoint.

Output

JSON

  • id - Unique identifier of the updated endpoint.
  • macAddress - MAC address of the updated endpoint.
  • description - Description of the updated endpoint.
  • status - Status of the updated endpoint.
  • randomizedMac - Indicates if the MAC address is randomized.
  • deviceInsightTags - List of device insight tags associated with the endpoint.
  • attributes - Additional attributes of the endpoint as key/value pairs.

Dependencies

  • Aruba ClearPass API with appropriate credentials

Troubleshooting

  • Ensure the MAC address is correctly formatted and exists in the system; otherwise, the update will fail.
  • Verify that the API credentials are valid and have sufficient permissions to update endpoint resources.
  • If the node throws an error, check the error message for details; enabling 'Continue on Fail' allows the workflow to handle errors gracefully by outputting the error message as JSON.

Discussion