Aruba ClearPass

Interact with Aruba ClearPass API

Actions34

Overview

The "Update By MAC" operation for the Devices resource in this Aruba ClearPass node allows users to update device account information by specifying the device's MAC address. This is useful in network management scenarios where administrators need to modify attributes of a device record, such as enabling/disabling the account, changing roles, updating visitor or sponsor details, or adding custom fields.

Practical examples include:

  • Enabling or disabling a device account based on its MAC address.
  • Assigning a new role or updating role information for a device.
  • Adding notes or custom metadata to a device account.
  • Scheduling activation or expiration times for device access.

This operation streamlines device management by targeting devices uniquely identified by their MAC addresses.

Properties

Name Meaning
Domain API domain to access. Options: Identities, Policy Elements, Enforcement Profile. For this operation, "Identities" is relevant.
MAC Address The MAC address of the device account to update. This uniquely identifies the device in the system.
Update Fields Collection of fields to update on the device account. Possible fields include:
- MAC Address: MAC address of the device (string)
- Role ID: Numeric role identifier (number)
- Role Name: Name of the role (string)
- Enabled: Whether the account is enabled (boolean)
- Start Time: Activation time in ISO 8601 format (dateTime)
- Expire Time: Expiration time in ISO 8601 format (dateTime)
- Visitor Name: Display name for the account (string)
- Sponsor Name: Name of the sponsor (string)
- Sponsor Profile: Numeric operator profile ID for the sponsor (string)
- Notes: Comments or notes (string)
- Source: Origin of the account (string)
- Custom Fields: JSON object with custom fields to include (JSON)
Options Additional options for the update operation. Includes:
- Change of Authorization: Whether to update the network state using Disconnect-Request or CoA-Request. Options: Use Default Setting, Yes, No.

Output

The node outputs an array of JSON objects representing the updated device accounts after the operation completes successfully. Each item contains the updated device data as returned by the Aruba ClearPass API.

If the operation fails and "Continue on Fail" is enabled, the output will contain an error object with an error field describing the failure message.

No binary data output is involved in this operation.

Dependencies

  • Requires an API key credential for authenticating with the Aruba ClearPass API.
  • The node depends on the external Aruba ClearPass service being accessible and properly configured.
  • Network connectivity to the ClearPass server is necessary.
  • Proper permissions on the ClearPass API to perform device updates by MAC address are required.

Troubleshooting

  • Common Issues:

    • Invalid or malformed MAC address input can cause the operation to fail.
    • Insufficient API permissions may result in authorization errors.
    • Network connectivity issues to the ClearPass server will prevent execution.
    • Providing invalid date formats for start or expire times may cause errors.

  • Error Messages:

    • Errors from the ClearPass API will be logged and, if "Continue on Fail" is enabled, returned as part of the output.
    • Typical error messages include authentication failures, resource not found (if MAC does not exist), or validation errors on update fields.

  • Resolutions:

    • Verify MAC address format and existence in ClearPass.
    • Check API credentials and permissions.
    • Ensure date/time fields use correct ISO 8601 format.
    • Confirm network access to ClearPass API endpoint.

Links and References

Discussion