License Utility API

You can use the License Utility API to connect with BMC Helix Capacity Optimization and return the license information in the XML and JSON formats. The XML generated is same as that returned by License Tracking utility.

To access the API, ensure that your user role has the following activities assigned to it:

  • Enable access to Data API activity - (API_DATA)  
  • Administration section - View activity - (WEB_ADMIN)

For more information about managing roles and activities, see Configuring user roles and access groups.

Retrieving the licenses in XML format

MethodGET
URI pattern
/dh-services/data/license
DescriptionRetrieve the licenses in XML format
Request parameters

NA

Sample response
<?xml version="1.0" encoding="UTF-8"?><bmc_license_xml_report  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="LicenseDataXMLSimplifiedSample.xsd">
  <entry>
    <field_value>
      <name>AuditCount</name>
      <value>1</value>
    </field_value>
    <field_value>
      <name>Host</name>
      <value>vl-pun-bco-qa34.bmc.com</value>
    </field_value>
    <field_value>
      <name>LicenseChecksum</name>
      <value>486767383</value>
    </field_value>
    <field_value>
      <name>LicenseDescription</name>
      <value>Overall number of managed systems</value>
    </field_value>
    <field_value>
      <name>LicenseRequestedFrom</name>
      <value>1484677800000</value>
    </field_value>
    <field_value>
      <name>LicenseRequestedTo</name>
      <value>1484764200000</value>
    </field_value>
    <field_value>
      <name>LicenseType</name>
      <value>20</value>
    </field_value>
    <field_value>
      <name>ProductName</name>
      <value><product_name> for Servers</value>
    </field_value>
    <field_value>
      <name>ReportDate</name>
      <value>1484806077261</value>
    </field_value>
    <field_value>
      <name>SuiteName</name>
      <value><product_name></value>
    </field_value>
  </entry>
  <entry>
    <field_value>
      <name>AuditCount</name>
      <value>1</value>
    </field_value>
    <field_value>
      <name>Host</name>
      <value>vl-pun-bco-qa34.bmc.com</value>
    </field_value>
    <field_value>
      <name>LicenseChecksum</name>
      <value>1677676054</value>
    </field_value>
    <field_value>
      <name>LicenseDescription</name>
      <value>Overall number of managed systems - distinct by name</value>
    </field_value>
    <field_value>
      <name>LicenseRequestedFrom</name>
      <value>1484677800000</value>
    </field_value>
    <field_value>
      <name>LicenseRequestedTo</name>
      <value>1484764200000</value>
    </field_value>
    <field_value>
      <name>LicenseType</name>
      <value>20</value>
    </field_value>
    <field_value>
      <name>ProductName</name>
      <value><product_name> for Servers - distinct by name</value>
    </field_value>
    <field_value>
      <name>ReportDate</name>
      <value>1484806077261</value>
    </field_value>
    <field_value>
      <name>SuiteName</name>
      <value><product_name></value>
    </field_value>
  </entry>
  <entry>
    <field_value>
      <name>AuditCount</name>
      <value>0</value>
    </field_value>
    <field_value>
      <name>Host</name>
      <value>vl-pun-bco-qa34.bmc.com</value>
    </field_value>
    <field_value>
      <name>LicenseChecksum</name>
      <value>289352045</value>
    </field_value>
    <field_value>
      <name>LicenseDescription</name>
      <value>Number of managed systems imported from Capacity Agents</value>
    </field_value>
    <field_value>
      <name>LicenseRequestedFrom</name>
      <value>1484677800000</value>
    </field_value>
    <field_value>
      <name>LicenseRequestedTo</name>
      <value>1484764200000</value>
    </field_value>
    <field_value>
      <name>LicenseType</name>
      <value>20</value>
    </field_value>
    <field_value>
      <name>ProductName</name>
      <value><product_name> for Servers [Capacity Agents]</value>
    </field_value>
    <field_value>
      <name>ReportDate</name>
      <value>1484806077261</value>
    </field_value>
    <field_value>
      <name>SuiteName</name>
      <value><product_name></value>
    </field_value>
  </entry>
  <entry>
    <field_value>
      <name>AuditCount</name>
      <value>0</value>
    </field_value>
    <field_value>
      <name>Host</name>
      <value>vl-pun-bco-qa34.bmc.com</value>
    </field_value>
    <field_value>
      <name>LicenseChecksum</name>
      <value>2037891146</value>
    </field_value>
    <field_value>
      <name>LicenseDescription</name>
      <value>Number of managed systems imported from Capacity Agents - distinct by name</value>
    </field_value>
    <field_value>
      <name>LicenseRequestedFrom</name>
      <value>1484677800000</value>
    </field_value>
    <field_value>
      <name>LicenseRequestedTo</name>
      <value>1484764200000</value>
    </field_value>
    <field_value>
      <name>LicenseType</name>
      <value>20</value>
    </field_value>
    <field_value>
      <name>ProductName</name>
      <value><product_name> for Servers [Capacity Agents] - distinct by name</value>
    </field_value>
    <field_value>
      <name>ReportDate</name>
      <value>1484806077261</value>
    </field_value>
    <field_value>
      <name>SuiteName</name>
      <value><product_name></value>
    </field_value>
  </entry>
  <entry>
    <field_value>
      <name>AuditCount</name>
      <value>0</value>
    </field_value>
    <field_value>
      <name>Host</name>
      <value>vl-pun-bco-qa34.bmc.com</value>
    </field_value>
    <field_value>
      <name>LicenseChecksum</name>
      <value>1548499269</value>
    </field_value>
    <field_value>
      <name>LicenseDescription</name>
      <value>Overall number of managed network devices</value>
    </field_value>
    <field_value>
      <name>LicenseRequestedFrom</name>
      <value>1484677800000</value>
    </field_value>
    <field_value>
      <name>LicenseRequestedTo</name>
      <value>1484764200000</value>
    </field_value>
    <field_value>
      <name>LicenseType</name>
      <value>20</value>
    </field_value>
    <field_value>
      <name>ProductName</name>
      <value><product_name> for Network</value>
    </field_value>
    <field_value>
      <name>ReportDate</name>
      <value>1484806077261</value>
    </field_value>
    <field_value>
      <name>SuiteName</name>
      <value><product_name></value>
    </field_value>
  </entry>
  <entry>
    <field_value>
      <name>AuditCount</name>
      <value>0</value>
    </field_value>
    <field_value>
      <name>Host</name>
      <value>vl-pun-bco-qa34.bmc.com</value>
    </field_value>
    <field_value>
      <name>LicenseChecksum</name>
      <value>811262598</value>
    </field_value>
    <field_value>
      <name>LicenseDescription</name>
      <value>Overall number of managed ports</value>
    </field_value>
    <field_value>
      <name>LicenseRequestedFrom</name>
      <value>1484677800000</value>
    </field_value>
    <field_value>
      <name>LicenseRequestedTo</name>
      <value>1484764200000</value>
    </field_value>
    <field_value>
      <name>LicenseType</name>
      <value>20</value>
    </field_value>
    <field_value>
      <name>ProductName</name>
      <value><product_name> for Storage</value>
    </field_value>
    <field_value>
      <name>ReportDate</name>
      <value>1484806077261</value>
    </field_value>
    <field_value>
      <name>SuiteName</name>
      <value><product_name></value>
    </field_value>
  </entry>
</bmc_license_xml_report>

Retrieving the licenses in JSON format

MethodGET
URI pattern
/dh-services/data/v2/license
DescriptionRetrieve the licenses in JSON format
Request parameters

NA

Request headerAccept: application/json 
Sample response

{

  "co": {

    "AUDIT_COUNT": "24789",

    "HOST": "optcore",

    "LICENSE_DESCRIPTION": "Overall number of managed systems",

    "LICENSE_REQUESTED_FROM": "1582848000000",

    "LICENSE_REQUESTED_TO": "1584057600000",

    "LICENSE_TYPE": "20",

    "PRODUCT_NAME": "TrueSight Capacity Optimizer for Servers",

    "PRODUCT_VERSION": "20.02",

    "REPORT_DATE": "1584119036388",

    "SUITE_NAME": "TrueSight Capacity Optimization"

  },

  "co-distinct-name": {

    "AUDIT_COUNT": "24789",

    "HOST": "optcore",

    "LICENSE_DESCRIPTION": "Overall number of managed systems - distinct by name",

    "LICENSE_REQUESTED_FROM": "1582848000000",

    "LICENSE_REQUESTED_TO": "1584057600000",

    "LICENSE_TYPE": "20",

    "PRODUCT_NAME": "TrueSight Capacity Optimizer for Servers",

    "PRODUCT_VERSION": "20.02",

    "REPORT_DATE": "1584119036388",

    "SUITE_NAME": "TrueSight Capacity Optimization"

  },

  "coee": {

    "AUDIT_COUNT": "24786",

    "HOST": "optcore",

    "LICENSE_DESCRIPTION": "Number of managed systems imported from Capacity Agents",

    "LICENSE_REQUESTED_FROM": "1582848000000",

    "LICENSE_REQUESTED_TO": "1584057600000",

    "LICENSE_TYPE": "20",

    "PRODUCT_NAME": "TrueSight Capacity Optimizer for Servers [Capacity Agents]",

    "PRODUCT_VERSION": "20.02",

    "REPORT_DATE": "1584119036388",

    "SUITE_NAME": "TrueSight Capacity Optimization"

  },

  "coee-distinct-name": {

    "AUDIT_COUNT": "24786",

    "HOST": "optcore",

    "LICENSE_DESCRIPTION": "Number of managed systems imported from Capacity Agents - distinct by name",

    "LICENSE_REQUESTED_FROM": "1582848000000",

    "LICENSE_REQUESTED_TO": "1584057600000",

    "LICENSE_TYPE": "20",

    "PRODUCT_NAME": "TrueSight Capacity Optimizer for Servers [Capacity Agents]",

    "PRODUCT_VERSION": "20.02",

    "REPORT_DATE": "1584119036388",

    "SUITE_NAME": "TrueSight Capacity Optimization"

  },

  "network": {

    "AUDIT_COUNT": "0",

    "HOST": "optcore",

    "LICENSE_DESCRIPTION": "Overall number of managed network devices",

    "LICENSE_REQUESTED_FROM": "1582848000000",

    "LICENSE_REQUESTED_TO": "1584057600000",

    "LICENSE_TYPE": "20",

    "PRODUCT_NAME": "TrueSight Capacity Optimizer for Network",

    "PRODUCT_VERSION": "20.02",

    "REPORT_DATE": "1584119036388",

    "SUITE_NAME": "TrueSight Capacity Optimization"

  },

  "storage": {

    "AUDIT_COUNT": "0",

    "HOST": "optcore",

    "LICENSE_DESCRIPTION": "Overall number of managed ports",

    "LICENSE_REQUESTED_FROM": "1582848000000",

    "LICENSE_REQUESTED_TO": "1584057600000",

    "LICENSE_TYPE": "20",

    "PRODUCT_NAME": "TrueSight Capacity Optimizer for Storage",

    "PRODUCT_VERSION": "20.02",

    "REPORT_DATE": "1584119036388",

    "SUITE_NAME": "TrueSight Capacity Optimization"

  }

}

Related topic

Maintenance

 

Was this page helpful? Yes No Submitting... Thank you

Comments