Configure Connection
Cisco Unified CM guide
Prepare AXL API access, enter the hostname and credentials in NIM, and collect data to verify the connection.
Before you startDirect link to Before you start
Configure API access following the Cisco AXL Developer Guide for your Unified CM version. AXL is Cisco Unified CM's provisioning and configuration API. Work with your Cisco administrator to authorize the account for the phone, end-user, and device assignment operations your NIM process needs.
NIM requires Hostname, Username, and Password.
Verify access by collecting data
The connector currently always returns success for Test Connection. This result does not verify connectivity or credentials. Run a collection from the system to test the connection.
Prepare the integration accountDirect link to Prepare the integration account
- Have your Cisco administrator configure an integration account with AXL API access using the vendor guide linked above.
- Confirm that the account can read the data and perform the provisioning operations needed by your process.
- Obtain the Unified CM hostname and integration account credentials. Cisco recommends accessing AXL on the Publisher server.
- Confirm that NIM can reach the selected server's AXL service over HTTPS.
Enter the connection settingsDirect link to Enter the connection settings
- In NIM Studio, open Systems > Overview and add a Cisco Unified CM system, or select the existing system.
- Open its Connection screen.
- Enter the following settings and save the connection.
| NIM setting | Value |
|---|---|
| Hostname | The hostname of the Cisco Unified CM server NIM will access. |
| Username | The integration account username authorized for AXL access. |
| Password | The password belonging to that account. |
Test access by collecting dataDirect link to Test access by collecting data
- Run a collection from the Cisco Unified CM system in NIM. Test Connection currently always returns success and cannot be used to verify access.
- Confirm that collection completes successfully and inspect Phones, EndUsers, and EndUserDeviceMaps for your process.
- If collection fails, verify the hostname, credentials, network access, AXL service availability, and account permissions.
- Validate intended phone, user, and assignment changes with safe test records before enabling scheduled automation or exposing actions through delegated forms.
Successful collection verifies read access. Validate each intended write operation separately.
Step 1 of 3