CUCM - AXL API : Getting License Info

- Mark as New
- Bookmark
- Subscribe
- Mute
- Subscribe to RSS Feed
- Permalink
- Report Inappropriate Content
08-11-2015 07:37 AM
Hi All,
Looking AXL API capability matrix, I can see that using AXL api, we could perform the following options in CUCM.
- listLicenseCapabilities
- updateLicenseCapabilities
- getLicenseUnitReport
- getLicensedUsers
Could some one please help with right documentation to know about the wsdl urls and how do we use this API in terms of request and responses - A developer guide.
The actual objective is pull the license data from CUCM into a my internal monitoring tool as there is no SNMP / option available to get the data from CUCM
It would be great If somebody can guide me a sample of this method using SOAP UI
Thanks in advance
- JP
- Labels:
-
AXL

- Mark as New
- Bookmark
- Subscribe
- Mute
- Subscribe to RSS Feed
- Permalink
- Report Inappropriate Content
08-11-2015 02:03 PM
Note that as of CUCM 9.0, licensing is managed by the Enterprise Licensing Manager/Cisco Prime component, and so most license details will not be present in the CUCM database for retrieval via AXL. Note that ELM/Prime does not have any supported APIs itself - it may not be possible to programmatically retrieve all licensing details.
From 9.x-10.0, I believe that the requests listed above may be accepted, but may return invalid/empty results. For these releases essentially no licensing info can be retrieved.
For 10.5, a 'getLicensedUser' operations was added, see an example below, which gets some basic license info per individual.
For 11.0, 'listLicensedUser' was added for searching/bulk info of users, along with 'doUpdateLicenseUsage', which (I think) causes CUCM to sync license info with ELM/Prime for updated data. Note the operations-by-release page does not seem to reflect these two APIs currently (will fix.)
See this page for obtaining the AXL WSDL from the CUCM server:
https://developer.cisco.com/site/axl/learn/how-to/get-wsdl.gsp
getLicensedUser request/response:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.cisco.com/AXL/API/10.5">
<soapenv:Header/>
<soapenv:Body>
<ns:getLicensedUser>
<name>dstaudt</name>
</ns:getLicensedUser>
</soapenv:Body>
</soapenv:Envelope>
---------------------------
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:getLicensedUserResponse xmlns:ns="http://www.cisco.com/AXL/API/10.5">
<return>
<licensedUser uuid="{1F1D3AFF-F77D-319B-7693-3C2221E6AF78}">
<userId>dstaudt</userId>
<firstName>David</firstName>
<lastName>Staudt</lastName>
<snrEnabled>f</snrEnabled>
<emEnabled>f</emEnabled>
<deviceCount>2</deviceCount>
<licenseType>HCS_Standard</licenseType>
<licenseUsed>1</licenseUsed>
</licensedUser>
</return>
</ns:getLicensedUserResponse>
</soapenv:Body>
</soapenv:Envelope>
- Mark as New
- Bookmark
- Subscribe
- Mute
- Subscribe to RSS Feed
- Permalink
- Report Inappropriate Content
08-13-2015 12:21 AM
Hi,
Thank you for the response.
I am in the need of mainly pulling license information of CUCM Version 9.x-10.0. Is there any option that I can think of in getting it ?
Will there be an option to query the ELM database to pull this data externally ? Any inputs.
Regards,
JP

- Mark as New
- Bookmark
- Subscribe
- Mute
- Subscribe to RSS Feed
- Permalink
- Report Inappropriate Content
08-13-2015 08:49 AM
Unfortunately I don't think there is a solution for now.
This FAQ notes a place where you can provide feedback on enhancements (e.g. an API) on ELM/Prime programmability:

- Mark as New
- Bookmark
- Subscribe
- Mute
- Subscribe to RSS Feed
- Permalink
- Report Inappropriate Content
08-19-2016 02:21 AM
Any update about this so far?
