Aruba ClearPass icon

Aruba ClearPass

Interact with Aruba ClearPass API

Actions34

Devices → Update By MAC

AI-generated

Overview

This node interacts with the Aruba ClearPass API to update device accounts identified by their MAC address within the Identities domain. It is useful for managing device attributes such as role assignment, account status, time-based access controls, visitor and sponsor information, notes, source, and custom fields. For example, it can be used to update a device's role or enable/disable the device account based on its MAC address.

Use Case Examples

  1. Updating the role of a device account by specifying its MAC address.
  2. Enabling or disabling a device account and setting its expiration time.
  3. Adding custom fields or notes to a device account identified by MAC address.

Properties

Name Meaning
Domain API domain to access, e.g., Identities, Policy Elements, Enforcement Profile, etc.
MAC Address MAC address of the device account to update.
Update Fields Collection of fields to update on the device account, including MAC address, role ID, role name, enabled status, start and expire times, visitor and sponsor names, sponsor profile, notes, source, and custom fields.
Options Additional options for the update operation, such as Change of Authorization (CoA) settings.

Output

JSON

  • id - Unique identifier of the updated device account.
  • mac - MAC address of the updated device.
  • role_id - Role ID assigned to the device account.
  • role_name - Role name assigned to the device account.
  • enabled - Boolean indicating if the device account is enabled.
  • start_time - Start time when the device account becomes active.
  • expire_time - Expiration time of the device account.
  • visitor_name - Visitor name associated with the device account.
  • sponsor_name - Sponsor name associated with the device account.
  • sponsor_profile - Sponsor profile ID associated with the device account.
  • notes - Notes or comments related to the device account.
  • source - Source or origin of the device account.
  • customFields - Custom fields included with the device account.

Dependencies

  • Aruba ClearPass API
  • API key credential for authentication

Troubleshooting

  • Ensure the MAC address provided is valid and exists in the ClearPass system.
  • Verify that the API credentials are correct and have sufficient permissions to update device accounts.
  • If the node throws an error, check the error message for details such as invalid fields or network issues.
  • Enable 'Continue on Fail' option to handle errors gracefully and receive error details in output.

Links

Discussion