Aruba ClearPass icon

Aruba ClearPass

Interact with Aruba ClearPass API

Actions34

Devices → Replace By MAC

AI-generated

Overview

This node interacts with the Aruba ClearPass API to replace a device account identified by its MAC address within the 'Devices' resource under the 'Identities' domain. It is useful for updating or replacing device information in network access control scenarios, such as changing device roles or updating device attributes based on MAC address. For example, it can be used to replace a device's role or update its enabled status by specifying the MAC address and new details.

Use Case Examples

  1. Replacing a device account by MAC address to assign a new role and update additional fields like enabled status and notes.
  2. Updating device information in ClearPass when a device's attributes need to be refreshed or corrected.

Properties

Name Meaning
Domain API domain to access, fixed to 'Identities' for this operation.
MAC Address The MAC address of the device to be replaced.
Role ID The role ID to assign to the device account.
Additional Fields Optional additional fields to update on the device account, such as role name, enabled status, start and expire times, visitor name, sponsor details, notes, source, and custom fields.
Options Additional options for the operation, such as whether to update the network state using Disconnect-Request or Change of Authorization (CoA) Request.

Output

JSON

  • id - Unique identifier of the replaced device account.
  • mac - MAC address of the device.
  • role_id - Role ID assigned to the device account.
  • role_name - Name of the role assigned.
  • enabled - Boolean indicating if the device account is enabled.
  • start_time - Account enable start time in ISO 8601 format.
  • expire_time - Account expiration time in ISO 8601 format.
  • visitor_name - Display name for the device account.
  • sponsor_name - Name of the sponsor for the device account.
  • sponsor_profile - Sponsor profile ID.
  • notes - Notes or comments associated with the device account.
  • source - Origin of the device account.
  • customFields - Custom fields included with the device account.

Dependencies

  • An API key credential for Aruba ClearPass API authentication

Troubleshooting

  • Common issues include invalid or missing MAC address, incorrect role ID, or API authentication failures.
  • Error messages may indicate network connectivity problems, permission issues, or invalid input data.
  • To resolve errors, verify the MAC address format, ensure the role ID exists, and confirm API credentials are correct and have sufficient permissions.

Links

Discussion