Aruba ClearPass icon

Aruba ClearPass

Interact with Aruba ClearPass API

Actions34

Devices → Create

AI-generated

Overview

This node interacts with the Aruba ClearPass API to create a new device entry under the 'Identities' domain. It is useful for automating device management tasks such as adding devices with specific roles and attributes in a network environment managed by Aruba ClearPass. For example, it can be used to register a new device by specifying its MAC address, role, and additional optional fields like enabled status, start and expire times, visitor name, sponsor details, notes, source, and custom fields.

Use Case Examples

  1. Creating a new device with a MAC address and assigning a role ID to it.
  2. Adding a device with additional optional fields such as enabling the device, setting start and expire times, and adding custom notes.

Properties

Name Meaning
Domain API domain to access, fixed to 'Identities' for device creation.
MAC Address MAC address of the device to be created.
Role ID Role to assign to the device account.
Additional Fields Optional additional fields for the device account such as role name, enabled status, start and expire times, visitor name, sponsor name and profile, notes, source, and custom fields.
Options Additional options for the operation such as Change of Authorization (CoA) settings.

Output

JSON

  • id - Unique identifier of the created device.
  • mac - MAC address of the created device.
  • role_id - Role ID assigned to the device.
  • enabled - Indicates 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.
  • 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 credentials required for authentication.

Troubleshooting

  • Common issues include authentication failures due to invalid or missing API credentials. Ensure the ClearPass API credentials are correctly configured.
  • Validation errors may occur if required fields like MAC address or role ID are missing or incorrectly formatted. Verify input data before execution.
  • Network or API endpoint issues can cause request failures. Check network connectivity and API availability.
  • Error messages from the API will be returned in the output if 'Continue on Fail' is enabled, allowing for graceful error handling.

Links

Discussion