Aruba ClearPass icon

Aruba ClearPass

Interact with Aruba ClearPass API

Actions34

Devices → Update

AI-generated

Overview

This node interacts with the Aruba ClearPass API to update device accounts within the 'Devices' resource under the 'Identities' domain. It allows users to modify various attributes of a device account such as MAC address, role assignment, account status, timing for activation and expiration, visitor and sponsor details, notes, source, and custom fields. This node is useful in scenarios where device account information needs to be programmatically updated, for example, updating a device's role or enabling/disabling a device account based on network policies.

Use Case Examples

  1. Updating the role of a device account to assign new permissions.
  2. Enabling or disabling a device account based on its MAC address.
  3. Setting expiration time for a device account to automate access control.

Properties

Name Meaning
Domain API domain to access, fixed to 'Identities' for device updates.
Device ID The unique identifier of the device account to update.
Update Fields Collection of fields to update on the device account, including MAC address, role ID or 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 whether to update the network state using Disconnect-Request or CoA-Request.

Output

JSON

  • id - The 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 - ISO 8601 formatted start time when the account becomes active.
  • expire_time - ISO 8601 formatted expiration time of the 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 stored with 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

  • Common issues include invalid device ID, missing required fields, or incorrect API domain selection. Verify that the device ID exists and the domain is set to 'Identities'.
  • Error messages may indicate authentication failures; ensure the API key credential is correctly configured.
  • Network state update errors may occur if the Change of Authorization option is misconfigured; verify the option settings.

Links

Discussion