Aruba ClearPass icon

Aruba ClearPass

Interact with Aruba ClearPass API

Actions34

Devices → Replace

AI-generated

Overview

This node interacts with the Aruba ClearPass API to replace a device account within the Identities domain. It is useful for updating or completely replacing the details of a device account identified by either its Device ID or MAC address. Typical use cases include managing device roles, enabling or disabling accounts, setting account expiration, and updating custom fields for device management in network security environments.

Use Case Examples

  1. Replacing a device account by Device ID to update its role and enable status.
  2. Replacing a device account by MAC address to change its role and add custom notes.

Properties

Name Meaning
Domain API domain to access, fixed to 'Identities' for device operations.
Device ID The unique identifier of the device account to replace.
MAC Address The MAC address of the device to replace the account for.
Role ID The role ID to assign to the device account.
Additional Fields Optional additional fields to set on the device account, such as role name, enabled status, start and expire times, visitor and sponsor names, notes, source, and custom JSON fields.
Options Additional options such as Change of Authorization to update network state using Disconnect-Request or CoA-Request.

Output

JSON

  • id - The unique identifier of the replaced device account.
  • mac - The MAC address of the replaced device.
  • role_id - The role ID assigned to the device account.
  • enabled - Whether the device account is enabled.
  • start_time - The start time when the account becomes active.
  • expire_time - The expiration time of the account.
  • visitor_name - The visitor name associated with the device account.
  • sponsor_name - The sponsor name associated with the device account.
  • notes - Any notes or comments stored with the device account.
  • source - The origin of the device account.
  • customFields - Custom fields included with the device account.

Dependencies

  • Aruba ClearPass API
  • An API key credential for authentication

Troubleshooting

  • Common issues include invalid Device ID or MAC address, missing required fields like Role ID, or API authentication errors.
  • Error messages may indicate network connectivity problems, invalid input data, or permission issues with the API key.
  • To resolve errors, verify the device identifiers, ensure all required fields are provided, and confirm the API credentials are correct and have sufficient permissions.

Links

Discussion