Aruba ClearPass icon

Aruba ClearPass

Interact with Aruba ClearPass API

Endpoints → Update

AI-generated

Overview

This node interacts with the Aruba ClearPass API to update an existing endpoint within the 'Identities' domain. It allows users to modify properties of an endpoint such as its description, status, whether the MAC address is randomized, device insight tags, and additional custom attributes. This is useful in network management scenarios where endpoint details need to be kept current, for example, updating endpoint status or adding descriptive tags for better device identification and policy enforcement.

Use Case Examples

  1. Updating the description and status of a specific endpoint by its numeric ID.
  2. Modifying device insight tags and custom attributes for an endpoint to enhance network monitoring and control.

Properties

Name Meaning
Domain API domain to access, fixed to 'Identities' for this operation.
Endpoint ID Numeric ID of the endpoint to update.
Description Description of the endpoint.
Status Status of the endpoint, can be 'Known', 'Unknown', or '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 attributes as key/value pairs for the endpoint.

Output

JSON

  • id - The unique identifier of the updated endpoint.
  • description - The updated description of the endpoint.
  • status - The updated status of the 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
  • An API key credential for authentication

Troubleshooting

  • Ensure the Endpoint ID is valid and exists in the ClearPass system to avoid 'not found' errors.
  • Verify that the API key credential is correctly configured and has sufficient permissions to update endpoints.
  • Check that the input properties conform to expected types and values, especially for enumerated fields like Status.
  • If the node throws an error, enabling 'Continue on Fail' will output the error message as part of the node's output for easier debugging.

Links

Discussion