Configure Connection
Aruba ClearPass guide
Configure the ClearPass connection in NIM, test endpoint retrieval, and validate auditing and cleanup.
Before you beginDirect link to Before you begin
Review the vendor's Creating and Editing API Clients documentation. ClearPass API client settings are available under Administration > API Services > API Clients. The selected Operator Profile determines which API objects and methods are available.
NIM requires Tenant URL, Username, and Password.
Prepare API accessDirect link to Prepare API access
- Identify the ClearPass tenant address.
- Follow the vendor documentation to configure API access for your ClearPass environment.
- Obtain the username and password used by NIM. Ensure the configured access permits endpoint retrieval and, when needed, endpoint deletion.
- Ensure the NIM server can reach ClearPass over HTTPS.
Enter the connection settingsDirect link to Enter the connection settings
- In NIM Studio, open Systems > Overview and add an Aruba ClearPass system, or select the existing system.
- Open Connection, enter the following settings, and save.
| NIM setting | Value |
|---|---|
| Tenant URL | The ClearPass tenant address, using the format expected by the Connection screen. |
| Username | The account used by NIM to access ClearPass. |
| Password | The password for that account. |
Test endpoint retrievalDirect link to Test endpoint retrieval
-
Select Test Connection. NIM attempts to retrieve a single endpoint using:
GET /api/endpoint?offset=0&limit=1&calculate_count=true -
If the test fails, verify the Tenant URL, Username, Password, API access configuration, permissions, and network access.
-
Collect endpoint records and validate the results in NIM before using them in filters or reports.
-
If deletion is part of your process, validate it with a test endpoint and confirm the result in ClearPass before enabling automated cleanup.
The connection test checks endpoint retrieval. Validate deletion separately to confirm that the configured access permits that operation.