Supporting App for AXL | Installation Notes

AXL Install 1 - Configure UCM

All these steps are performed in Call Manager. 

The four steps are to 

Experts bypass: If all the above is old hat to you, you may only need a quick reminder of what to do. In that case, see the various little sections titled Experts”

Enable the AXL Web Service

These steps enable the AXL web service to work. 

Experts: Check that the Cisco AXL Web Service is started and running.

If you need more specific directions –

  1. Log into the Cisco Unified Serviceability application using an administrator account.
  2. Browse to Tools, then to Control Center – Feature Services.
  3. Select your CUCM server from the drop down asking which server to configure, then click Go.
  4. Browse that list, find the Cisco AXL Web Service confirm its Status says Started.
    1. If it is not, click it and click Start at the bottom. 

Create group AXL Service Users”

This creates a group that we call AXL Service User”, which has the rights/​permissions inside CUCM for allowing anyone that’s a member of this group access to the AXL information. This is needed so that the user we create in the next step can be added to this role, and thus can access AXL.

Experts: Create a User level Access Control Group, then assign to that group the role Standard AXL API Access.

Or, follow along below:

  1. Log into the Cisco Unified CM Administration application using an administrator account. 
    • NOTE you can access it from the Navigation” menu in the upper right if you came to this section straight from the Enable the AXL web service section above.
  2. Click User Management > User Settings > Access Control Group.
  3. Click the Add New button.
  4. Type in AXL Service Users for the name and click Save.
  5. In the upper right, to the right of Related Links: (Which should say Back to Find/​List”) click Go.
  6. Click Find to find and display the AXL user we just created.
  7. To the right of the newly created Access Control Group AXL Service Users, click the i” button under Roles.
  8. Click the button Assign Role to Group.
  9. In the Find and List Roles” window, click Find to have it display all available Roles
  10. Click the checkbox beside Standard AXL API Access.
  11. At either the very top of the page or the very bottom, click Add Selected.
  12. Click Save.

Create an AXL-enabled user

This creates a new user and adds the permissions (via the group created above) required for it to query the AXL information.

Experts: Create a user and add it to the above created access control group so that it can query AXL.

  1. Log into the Cisco Unified CM Administration application using an administrator account.
    • NOTE you can access it from the Navigation” menu in the upper right if you came to this section straight from the Enable the AXL web service section above.
  2. Click User Management > Application User.
  3. Click the Add New button.
  4. Supply a user name and an appropriate password. Remember these, we’ll need them later.
  5. For that user, down near the bottom find Add to Access Control Group
  6. In the new Find and List Access Control Groups” window, click the checkbox beside AXL Service Users
  7. At the bottom of the page, click Add Selected.
  8. When returned to the Application User Configuration page, click Save.
  9. Again, this is a screen where the confirmation is subtle – Add successful” but no other change.
  10. Check the roles and groups applied by going to User Management, Application User, finding the user you created in step 3 above and confirming it lists the Permissions information at the bottom.
  11. Click Save.

Retrieve the needed files from UCM

Cisco’s licensing does not allow redistribution of the portions of the Cisco Call Manager AXL SQL Toolkit Plugin, so we can’t provide it with the CDR app. Instead, see the below instructions to retrieve the toolkit and extract and deploy the required files.

  1. Log into the Cisco Unified CM Administration application using an administrator account. NOTE you may already be in this application if you were following the steps above.
  2. Go to Application > Plugins
  3. Click the Find button once (with default parameters) to populate the list.
  4. Click on the Download link by the
    • Cisco CallManager AXL SQL Toolkit Plugin (older versions) or the
    • Cisco AXL Toolkit (newer versions).
    • (In both cases, it’s often the first download listed)
  5. Save the file onto your local system in a convenient place.
  6. After saving the axlsqltoolkit.zip file to your local system, open it with your favorite zip file utility.
  7. Drill down into axlsqltoolkit/schema/<UCM version>/
    (For instance axlsqltoolkit/schema/11.5/ )
  8. Extract the three files you find there – AXLAPI.wsdl, AXLEnums.xsd and AXLSoap.xsd – into a temporary local folder. 

Next Steps

Next up is to Install the AXL app into Splunk next to the Cisco CDR Reporting and Analytics app.

Related

Installation Notes

There are many ways to deploy, configure and update the Splunk Universal Forwarder. Here we cover a variety of the more advanced ways to handle updating the TA for Cisco CDR Reporting and Analytics.

Installation Notes