Build Cisco API integration to pull Software Entitlements data using Smart Licensing API

Aishwaryaaa_
Kilo Sage

3 weeks ago

We have a requirement to pull the Software Entitlement data into ServiceNow alm_license table.
We need to pull below fields:

  • License ID / Entitlement ID
  • Software Model
    • model field
    • Query the cmdb_software_product_model table for a matching Software Model
  • License type
    • product_type field
  • License metric field
  • Unit Cost field
  • Quantity purchased
    • purchased_rights field
  • Available license count
    • allocations_available field
  • License key or activation ID
    • license_key field
    • Not required, but check if the spoke can pull this in
  • License start and expiration dates
    • start_date field
    • end_date field
  • Maintenance or support expiration
    • maintenance_expiration_date field

We need to map these fields to alm_license table.
We were thinking to use "Get All Subscription Details" CISCO API this we found in the below link(page 16):
https://www.cisco.com/c/en/us/td/docs/voice_ip_comm/hcs/12_5/HCS_Solution/Smart_Licensing/chcs_b_hcs...

Let me know, if anyone has any idea on this stuff.

Thanks!!

Aishwarya Shelake
0 Helpfuls
  • 333 Views
1 REPLY 1

pr8172510
Tera Guru

3 weeks ago

Hi @Aishwaryaaa_,

Yes, this approach is possible and your idea of using the Cisco Smart Licensing API is correct.

 the recommended approach would be:

  • Use REST API integration with Cisco Smart Licensing APIs

  • Pull entitlement/subscription data into a staging table first

  • Transform and map the data into alm_license

  • Match Software Models against cmdb_software_product_model

Your proposed API:
Get All Subscription Details
is usually the correct starting point because it returns entitlement and subscription-related information.

Suggested architecture:

Cisco Smart Licensing API
→ REST Message / IntegrationHub
→ Import Set or Staging Table
→ Transform Map / Flow / Scripted ETL
→ alm_license

Recommended field mapping:

Cisco API Field ServiceNow Field

Entitlement IDlicense_id
Product Namemodel
License Typeproduct_type
Quantity Purchasedpurchased_rights
Available Quantityallocations_available
License Keylicense_key
Start Datestart_date
Expiration Dateend_date
Support Expirationmaintenance_expiration_date

For Software Model mapping:
You can query cmdb_software_product_model using:

  • Display Name

  • Publisher

  • Version

and map the matching sys_id into the model reference field on alm_license.

One important thing:
alm_license is generally managed by SAM normalization/reconciliation processes, so many implementations use:

  • staging table

  • transform map

  • scripted reconciliation logic

instead of directly inserting raw API data into alm_license.

Also check whether:

  • Cisco API exposes perpetual vs subscription license types

  • Smart Account hierarchy is needed

  • Token refresh/OAuth authentication is required

 

0 Helpfuls