HP Matrix Operating Environment Chargeback

Technical white paper | HP Matrix Operating Environment Chargeback

API

The CLI tool uses the infrastructure orchestration chargeback SOAP API, which is used to programmatically retrieve XML

encoded chargeback data. The Web Service Description Language (WSDL) definition of the interface is available at:

https://<cms-ip-address>:55443/hpio/chargeback/soap/v3?wsdl

Following is the correspondence between the previously described CLI operations and the API operations they invoke:

CLI Operation

API Operation

get usage

getServiceUsagePage

get aggregatedusage

getAggregatedServiceUsage

get detailedusage

getServiceUsageDetailedPage

archive databaseexport

archiveDatabaseExport

archive databasedelete

archiveDatabaseDelete

archive executionhistory

archiveExecutionHistory

The following summarizes evolution of the API:

• V1—Support for core chargeback operations (getServiceUsagePage, getAggregatedServiceUsage,

getServiceUsageDetailedPage).

• V2—Added support for archival operations (archiveDatabaseExport, archiveDatabaseDelete,

archiveExecutionHistory).These operations allow administrators to export and remove records that are no

longer needed, possibly improving database performance.

• V3—Includes isInCoud information for IP addresses (ipAddressUsageDetail)

For detailed information about the chargeback API and an example client that uses the API see HP CloudSystem

Matrix/Matrix Operating Environment Integration Interfaces API and CLI Operations Reference Guide at

www.hp.com/go/matrixoe/docs.

Understanding the chargeback output data

To create an XSL file to generate a report, it is important to understand the format of the data in the source XML file. The

XML content depends on which CLI operation was used to generate the data. Each operation generates a different XML

structure. The example discussed here refers to version 7.3 and might be different in future versions.

The “get detailedusage” operation response shown in Figure 8 offers a complex XML structure that will be used as the

source XML for all examples demonstrated in the next sections.

This section explains in detail how the data is organized and represented in the “get detailedusage” XML file.

“get detailedusage” XML elements

The XML elements contain all of the allocation data and cost metrics that later are used to build the reports. Table 1 lists all

elements available in the “get detailedusage” source XML and its data types. A detailed overview of what each attribute

represents will be shown in the following section.