IBM Support

PH01810:provide connectivity with ibm cloud private metering



Provide connectivity with IBM Cloud Private metering

Download Description

PH01810 resolves the following problem:

WebSphere Application Server should register with IBM Cloud Private metering and provide usage metrics.

IBM WebSphere Application Server should provide a mechanism to register and provide metrics to the IBM Cloud Private metering service.

All users of IBM WebSphere Application Server

Provide connectivity with IBM Cloud Private metering

APAR PH01810 provides support for registering a WebSphere Application server with an instance of the IBM Cloud Private metering service.

The IBM Cloud Private metering service allows you to connect your IBM WebSphere Application Server to report registration and usage information. This includes application servers hosted both in IBM Cloud and in other environments. When an application server is configured to connect to the metering service, the following information is reported and can be viewed on the metering service dashboard:
- Number of active servers
- Host location of each server
- Product edition and version of each server
- Product metrics which indicate how busy each server is
- The virtual processor cores available to each server

After installing the APAR, before you connect an IBM WebSphere Application Server traditional server to IBM Cloud Private metering, you must have an IBM Cloud Private installation configured to support metering. WebSphere customers are entitled to use IBM Cloud Private Foundation at no charge for metering restricted use.

Ensure that you have the URL and API key values of the IBM Cloud Private metering service that you want WebSphere Application Server to register to.

Once the IBM Cloud Private installation is complete and the URL and API key are known, then configure the WebSphere Application Server traditional server using the following procedure:

1 -
Create a file with the following contents, substituting the URL and API key from the service credentials.

# required
url=<URL for IBM Cloud Private metering service>
apiKey=<API key for IBM Cloud Private metering>

## One of the following is required for SSL
# sslRef=<SSL alias name of server SSL configuration>
# Or the following 3 properties
# trustStore=<trustStore JKS file name>
# trustStorePassword=<trustStore password>
# httpsProtocol=<TLS protocol , defaults to TLSv1.2>

# optional - to use, remove #
# group=<group>
# logData=<csv|json|all>

On the url and apiKey properties, specify the URL and API key credentials that you noted when you configured the IBM Cloud Private metering service.

SSL is required to connect with the IBM Cloud Private metering service and can be provided one of two ways. The sslRef property can be specified and set to the SSL alias name corresponding to an SSL configuration for the server, or use the trustStore, trustStorePassword and httpProtocol properties to specify the name of the .jks truststore file that contains the IBM Cloud Private certificate, the truststore password, and HTTP protocol. When you are building a docker image, the suggested action is to copy the trustStore file with the files.

A truststore JKS file can be created with the wasadmin createKeyStore command. From your traditional profile, run wsadmin to run the following AdminTasks:

-keyStoreName metering_keystore_name
-keyStoreType JKS
-keyStoreLocation path_to_keystore_JKS_file_to_create
-keyStorePassword keyStorePassword
-keyStorePasswordVerify keyStorePassword
-keyStoreDescription "ICP metering truststore file" ]')

The metering certificate can be added to the truststore file by using the retrieveSignerFromPort command.

-keyStoreName metering_keystore_name
-host ICP_host_or_IP_Address
-port ICP_Port
-certificateAlias certificateAlias]')

On the optional group attribute, you can define sets of servers to be grouped for reporting purposes. You can define multiple nested group levels by specifying highest-level groups first and specify nested groups in the format <parentGroup>/<nestedGroup>, as shown in the following example:


In this example, smallGroupx is nested inside subgroupA, which is nested inside WASGroup1. Grouped servers are displayed hierarchically on the metering service dashboard.

Use the option logData property to generate logs containing all registration and usage metering data in the specified file format. Log files are written to the application server logs directory. Log files may be generated in the csv format, json format, or both.

2 -
Add the file to your installation.

- For WebSphere Application Server (base), place the file in the directory:


- For WebSphere Application Server Network Deployment or WebSphere Application Server for z/OS, place the file in any of the following directories. You can configure Product Insights at the server, cluster, node, or cell level, depending on which directory is used.

- Server directory: 
- Cluster directory: 
    <wasInstallRoot>/profiles/<profileName>/config/cells/<cellName>/ clusters/<clustername>
- Node directory: 
- Cell directory: 

If your environment uses a deployment manager, place the file in the directory tree for the deployment manager profile. Then, propagate the file to each of the managed nodes by starting wsadmin and running the following commands:

AdminControl.invoke(repository, 'refreshRepositoryEpoch')

If your environment does not use a deployment manager, place the file in the corresponding directory for each server, node, or cell that you want to register.

After you add the file, if the server is running or the next time it starts, the server registers with the Product Insights service instance.


Each registered WebSphere Application Server traditional server - or for Network Deployment, each registered cluster, node, or cell - reports usage metrics to your metering service instance.


If you no longer want to report metrics to the metering service, remove the file from your WebSphere Application Server installation.

For additional details, the IBM Knowledge Center topic "Registering WebSphere traditional servers with the metering Service in IBM Cloud Private".

The fix for this APAR is currently targeted for inclusion in fix packs and
Please refer to the Recommended Updates page for delivery information:



Installation Instructions

Please review the readme.txt for detailed installation instructions.

V85 Readme 13882


Download Package




What is Fix Central(FC)? 09-28-2018 1301196 FC 09-28-2018 1301191 FC


Problems Solved


Technical Support

Contact IBM Support using SR (, visit the support web site, or contact 1-800-IBM-SERV (U.S. only).

Problems (APARS) fixed

Document information

More support for: WebSphere Application Server

Component: General, ">More...

Software version:,

Operating system(s): AIX, HP-UX, IBM i, Inspur K-UX, Linux, Mac OS, Solaris, Windows, z/OS

Software edition: Base,Developer,Express,Network Deployment

Reference #: 0734073

Modified date: 04 October 2018

Translate this page: