IBM License Metric Tool

https://www.ibm.com/docs/en/license-metric-tool/9.2.0
Admin
IBM License Metric Tool is a software license management solution that discovers and inventories...
Tokens:384,528
Snippets:6,454
Trust Score:10
Update:5 months ago
Show doc for...
Tokens:
Raw
### Example of Silent Installation Command

Source: https://www.ibm.com/docs/en/license-metric-tool/9.2.0?topic=linux-alternative-installation-method

This is an example of the command to start a silent installation, specifying the path to the response file.

```bash
setup-server-server-linux-x86_64.sh -f /tmp/images/install_response.txt -i silent
```

--------------------------------

### Example Silent Server Installation

Source: https://www.ibm.com/docs/en/license-metric-tool/9.2.0?topic=s3is-installing-server-in-silent-mode

An example of the silent server installation command, specifying the response file path.

```bash
setup-server-linux-x86_64.sh -f /root/ILMT_installer/install_response.txt -i silent
```

--------------------------------

### Start License Metric Tool Server

Source: https://www.ibm.com/docs/en/license-metric-tool/9.2.0?topic=database-configuring-transaction-log-location-db2

Navigate to the License Metric Tool installation directory's 'cli' folder and run the 'srvstart.sh' script to start the server. The default installation directory is /opt/ibm/LMT.

```bash
srvstart.sh
```

--------------------------------

### Example GET Request for Software Instances

Source: https://www.ibm.com/docs/en/license-metric-tool/9.2.0?topic=associations-computer-hardware-association

This example demonstrates how to retrieve software instances and include computer type details using the `computer_hardware` association.

```http
GET https://server_url:server_port/api/sam/v2/software_instances?columns[]=computer_hardware.computer_type
```

--------------------------------

### Start License Metric Tool Server Installation

Source: https://www.ibm.com/docs/en/license-metric-tool/9.2.0?topic=db2-step-2a-installing-in-interactive-mode

Initiates the installation process for the License Metric Tool server on Linux. This script should be executed from the directory containing the extracted installation files.

```bash
./setup-server-linux-x86_64.sh
```

--------------------------------

### Example Silent Installation Command

Source: https://www.ibm.com/docs/en/license-metric-tool/9.2.0?topic=linux-step-2b-installing-in-silent-mode

An example of the silent installation command, showing a specific path for the response file. Replace '/tmp/images/install_response.txt' with the actual path to your response file.

```bash
setup-server-linux-x86_64.sh -f /tmp/images/install_response.txt -i silent
```

--------------------------------

### Example GET Request for File Path

Source: https://www.ibm.com/docs/en/license-metric-tool/9.2.0?topic=associations-discovery-details-association

This example demonstrates how to make a GET request to the `software_instances` API to retrieve the file path associated with discovery details. Replace `server_url` and `server_port` with your actual server details.

```http
GET https://server_url:server_port/api/sam/v2/software_instances?columns[]=discovery_details.file_path
```

--------------------------------

### Select License Setup Type

Source: https://www.ibm.com/docs/en/license-metric-tool/9.2.0?topic=platform-step-3-installing-bigfix

Choose the method for installing with a license. Options include using a license authorization file, a production license, or an existing masthead.

```text
[1]  I want to install with a BES license authorization file.
[2]  I want to install with a production license that I already have.
[3]  I want to install with an existing masthead.
Choose one of the options above or press <Enter> to accept the default value: [1]
```

--------------------------------

### Example GET request for shared_disk_members

Source: https://www.ibm.com/docs/en/license-metric-tool/9.2.0?topic=associations-shared-disk-members-association

This example demonstrates how to make a GET request to retrieve the `mount_point` column for shared disks.

```http
GET https://server_url:server_port/api/sam/v2/shared_disks?columns[]=shared_disk_members.mount_point
```

--------------------------------

### Start Silent Server Installation (Linux)

Source: https://www.ibm.com/docs/en/license-metric-tool/9.2.0?topic=linux-alternative-installation-method

Initiate a silent installation of the License Metric Tool server using a response file. Ensure the RSP_LICENSE_ACCEPTED parameter is set to true in the response file.

```bash
setup-server-linux-x86_64.sh -f response_file_path -i silent
```

--------------------------------

### Start License Metric Tool Server on Linux

Source: https://www.ibm.com/docs/en/license-metric-tool/9.2.0?topic=server-starting

Run this script from the License Metric Tool installation directory's 'cli' folder to start the server on Linux systems. Ensure you have the necessary user privileges.

```bash
cd /opt/ibm/LMT
./cli/srvstart.sh
```

--------------------------------

### Example: Retrieve Catalog Version

Source: https://www.ibm.com/docs/en/license-metric-tool/9.2.0?topic=associations-computer-health-association

This example shows a GET request to the `api/sam/v2/software_instances` API, specifically requesting the `catalog_version` from the `computer_health` association.

```http
GET api/sam/v2/software_instances?columns[]=computer_health.catalog_version
```

--------------------------------

### Start Data Import

Source: https://www.ibm.com/docs/en/license-metric-tool/9.2.0?topic=api-rest-data-imports

Use this GET request to start a data import. Ensure the 'Token' header is correctly set. The response indicates the import status and provides URLs for further monitoring.

```http
GET https://server_host_name:port_number/api/import_status.json?run=true
```

```http
Accept: application/json
Accept-Language: en-US
Token: <token>
```

```http
HTTP/1.1 200 OK
Content-Type: application/json
Content-Language: en-US
```

```json
{
"mode":"running",
"can_run_imports":true,
"import_status_url":"/import_status",
"import_create_url":"/management/imports",
"progress":1,
"last_success_time":"2022-08-30T03:09:04Z",
"last_status":"successful",
"last_import_time":"2022-08-30T03:09:04Z",
"last_import_type":"complete",
"next_import_time":"2022-08-31T00:00:00Z",
"next_import_time_in":38946,
"next_import_type":"complete"
}
```

--------------------------------

### VM Manager Tool Trace Log Example

Source: https://www.ibm.com/docs/en/license-metric-tool/9.2.0?topic=managers-configuring-vm-manager-subcapacity-reporting

This example shows log entries from the `trace.log` file, illustrating the start and end times of the `runonce` command. Analyzing the time difference helps determine if connections are processing within acceptable limits.

```log
2018-07-25 11:35:38 : (main) com.ibm.license.mgmt.datacollector.Runner:
:initialiseLogger::Logger initialised successfully. 
...
2018-07-25 11:37:49 : (main) com.ibm.license.mgmt.datacollector.Runner::runCollector
(Configuration)::Finished 'run once' command.
```

--------------------------------

### Retrieve Software Instances via REST API

Source: https://www.ibm.com/docs/en/license-metric-tool/9.2.0?topic=api-authenticating-rest-requests

Example GET request to retrieve software instances. Ensure the 'Token' header is correctly provided.

```http
GET https://server_url:server_port/api/sam/v2/software_instances
```

```http
Accept: application/json 
Accept-Language: en-US
Token: <token>
```

--------------------------------

### Retrieve Software Instances with Token in URL

Source: https://www.ibm.com/docs/en/license-metric-tool/9.2.0?topic=api-authenticating-rest-requests

Example GET request to retrieve software instances with the token appended to the URL. The token in the URL is ignored if also provided in the header.

```http
GET https://server_url:server_port/api/sam/v2/software_instances?token=<token>
```

```http
Accept: application/json 
Accept-Language: en-US
```

--------------------------------

### Schedule hardware scan using setup script

Source: https://www.ibm.com/docs/en/license-metric-tool/9.2.0?topic=codes-return-from-disconnected-scanner-upgrade

Run this script to schedule the hardware scan if return code 4 or 5 is encountered. The script is located in the scanner installation directory.

```bash
./setup.sh
```

```bat
setup.bat
```

--------------------------------

### View Installation Help

Source: https://www.ibm.com/docs/en/license-metric-tool/9.2.0?topic=s3is-installing-server-in-silent-mode-1

To view help information and available options for the server installation script on Windows, use the -h flag.

```bash
setup-server-windows-x86_64.bat -h
```

--------------------------------

### Retrieve Specific Columns

Source: https://www.ibm.com/docs/en/license-metric-tool/9.2.0?topic=v2-retrieval-license-usage-information-per-server

Use the `columns[]` parameter to specify which data fields you want to retrieve. This example shows how to get the GUID of the Cloud Pak or bundle a product is assigned to.

```http
URL?columns[]=bundle_guid
```

--------------------------------

### View Installation Script Help

Source: https://www.ibm.com/docs/en/license-metric-tool/9.2.0?topic=db2-step-2b-installing-in-silent-mode

Use the -h option to display help information for the installation script.

```bash
setup-server-linux-x86_64.sh -h
```

--------------------------------

### Example GET Request for Server Name

Source: https://www.ibm.com/docs/en/license-metric-tool/9.2.0?topic=associations-server-association

Example of a GET request to retrieve the server name for a specific date using the `server` association.

```http
GET https://server_url:server_port/api/sam/v2/license_usage_per_server?columns[]=server.name&date=2021-04-28
```

--------------------------------

### Select Installation Type

Source: https://www.ibm.com/docs/en/license-metric-tool/9.2.0?topic=platform-step-3-installing-bigfix

Choose between 'Evaluation' and 'Production' installation types. Production requires a license or authorization.

```text
Select the type of installation
[1]  Evaluation: Request a free evaluation license from HCL Technologies Limited. This license allows you to install a fully functional copy of the BigFix on up to 1000 clients, for a period of 30 days.
[2] Production: Install using a production license or an authorization for a production license.
Choose one of the options above or press <Enter> to accept the default value: [1]
2
```

--------------------------------

### Example of a full package path

Source: https://www.ibm.com/docs/en/license-metric-tool/9.2.0?topic=troubleshooting-discovery

This is an example of the output from the 'find' command, showing the full path to a package. Provide this to IBM Support.

```text
/disconnected/<package_name>

```

--------------------------------

### Export Environment Variable for Online Installation (Linux)

Source: https://www.ibm.com/docs/en/license-metric-tool/9.2.0?topic=one-optional-creating-license-files

Export this environment variable before starting the installation if you want to install License Metric Tool on a computer with Internet access. Continue the installation in the same command session after setting this variable.

```bash
export tlm_debug_online_installation=false
```

--------------------------------

### Start DB2 Instance and License Metric Tool Server

Source: https://www.ibm.com/docs/en/license-metric-tool/9.2.0?topic=problems-server-operation

Commands to start the DB2 instance and the License Metric Tool server. Ensure the DB2 instance owner is used for the 'db2start' command.

```bash
su db2inst1
db2start
```

```bash
/etc/init.d/LMTserver start
```

--------------------------------

### Example GET Request for Computer Tags

Source: https://www.ibm.com/docs/en/license-metric-tool/9.2.0?topic=associations-computer-tags-association

This example demonstrates how to retrieve the 'name' of computer tags using the `api/sam/v2/computers` REST API.

```http
GET https://server_url:server_port/api/sam/v2/computers?columns[]=computer_tags.name
```

--------------------------------

### GET /api/sam/v2/bundling_options

Source: https://www.ibm.com/docs/en/license-metric-tool/9.2.0?topic=v2-retrieval-bundling-options

Retrieves bundling options for a component identified by its GUID.

```APIDOC
## GET /api/sam/v2/bundling_options

### Description
Retrieves bundling options for a component based on its discoverable GUID. This endpoint is useful for understanding how a specific component is bundled within IBM products.

### Method
GET

### Endpoint
/api/sam/v2/bundling_options

### Query Parameters
- **criteria** (string) - Required - A JSON string specifying the filtering criteria. For example: `{"and":[["discoverable_guid","=","B1BAC35F-7486-44E3-A44E-4FE143CB4034"]]}`

### Request Header Example
```
Accept: application/json
Accept-Language: en-US
Token: <your_api_token>
```

### Response
#### Success Response (200)
- **total** (integer) - The total number of bundling options found.
- **rows** (array) - An array of bundling option objects.
  - **component_name** (string) - The name of the component.
  - **component_release** (string) - The release version of the component.
  - **discoverable_guid** (string) - The unique identifier for the discoverable component.
  - **product_name** (string) - The name of the IBM product.
  - **product_release** (string) - The release version of the product.
  - **product_release_guid** (string) - The unique identifier for the product release.
  - **product_metric_id** (integer) - The ID of the product metric.
  - **product_metric_code_name** (string) - The code name of the product metric.
  - **bundle_name** (string) - The name of the bundle.
  - **bundle_guid** (string) - The unique identifier for the bundle.
  - **is_charged** (integer) - Indicates if the bundle is charged (1 for true, 0 for false).
  - **is_custom** (integer) - Indicates if the bundle is custom (1 for true, 0 for false).

#### Response Example
```json
{
   "total":6766,
   "rows":[
      {
         "component_name":"IBM MQ",
         "component_release":"9.0",
         "discoverable_guid":"B1BAC35F-7486-44E3-A44E-4FE143CB4034",
         "product_name":"IBM MQ Advanced",
         "product_release":"9.0",
         "product_release_guid":"A205E872-0EB5-4BE9-8F55-02DB73A6C27E",
         "product_metric_id":5844,
         "product_metric_code_name":"VIRTUAL_PROCESSOR_CORE",
         "bundle_name":"IBM Cloud Pak for Integration",
         "bundle_guid":"C8B82D18-9E75-45F0-892D-B9EF2731B90D",
         "is_charged":1,
         "is_custom":0
      }
   ]
}
```
```

--------------------------------

### Get Bundling Options by GUID

Source: https://www.ibm.com/docs/en/license-metric-tool/9.2.0?topic=v2-retrieval-bundling-options

Use this request to retrieve bundling options for a component identified by its discoverable GUID. Ensure the server URL and port are correctly specified.

```http
GET https://server_url:server_port/api/sam/v2/bundling_options?criteria={"and":[["discoverable_guid","=","B1BAC35F-7486-44E3-A44E-4FE143CB4034"]]}
```

```http
Accept: application/json
Accept-Language: en-US
Token: <token>
```

```json
{
   "total":6766,
   "rows":[
      {
         "component_name":"IBM MQ",
         "component_release":"9.0",
         "discoverable_guid":"B1BAC35F-7486-44E3-A44E-4FE143CB4034",
         "product_name":"IBM MQ Advanced",
         "product_release":"9.0",
         "product_release_guid":"A205E872-0EB5-4BE9-8F55-02DB73A6C27E",
         "product_metric_id":5844,
         "product_metric_code_name":"VIRTUAL_PROCESSOR_CORE",
         "bundle_name":"IBM Cloud Pak for Integration",
         "bundle_guid":"C8B82D18-9E75-45F0-892D-B9EF2731B90D",
         "is_charged":1,
         "is_custom":0
      },
(...)
   ]
}
```

--------------------------------

### Create Site List for Airgap Download

Source: https://www.ibm.com/docs/en/license-metric-tool/9.2.0?topic=site-updating-content-fixlet-linux

Run this command to create a site list file. Ensure the IBM License Reporting site has the flag 'A' to gather necessary files.

```bash
./Airgap.sh -serial <serial_number> -email <mail_address> -createSiteList <site_list_file_name>
```

```text
N::BES Support::http://sync.bigfix.com/cgi-bin/bfgather/bessupport
A::IBM License Reporting::http://sync.bigfix.com/cgi-bin/bfgather/ibmlicensereporting
```

--------------------------------

### VM Manager Tool Event Log Error Example

Source: https://www.ibm.com/docs/en/license-metric-tool/9.2.0?topic=pau-known-issues-defect-fixes-in-previous-application-updates

This example shows an error that might appear in the event log on a Windows computer where the VM Manager Tool is installed.

```text
application impairment occurs : prunsrv.exe
```

--------------------------------

### Start License Metric Tool Server on Windows

Source: https://www.ibm.com/docs/en/license-metric-tool/9.2.0?topic=server-starting

Execute this script to start the License Metric Tool server on Windows systems. For Windows authentication, the user must have specific administrative privileges for the database.

```batch
srvstart.bat
```

--------------------------------

### All columns retrieval request

Source: https://www.ibm.com/docs/en/license-metric-tool/9.2.0?topic=v2-retrieval-hardware-inventory

Example GET request to retrieve all available columns for computers.

```HTTP
GET https://server_url:server_port/api/sam/v2/computers
?columns[]=id&columns[]=bigfix_id&columns[]=computer_group_id
&columns[]=name&columns[]=dns_name&columns[]=ip_address
&columns[]=end_of_eligibility&columns[]=os&columns[]=os_type
&columns[]=first_seen&columns[]=last_seen&columns[]=is_deleted
&columns[]=deletion_date&columns[]=is_managed_by_vm_manager
```

--------------------------------

### Default columns retrieval request

Source: https://www.ibm.com/docs/en/license-metric-tool/9.2.0?topic=v2-retrieval-hardware-inventory

Example GET request to retrieve computers with default columns.

```HTTP
GET https://server_url:server_port/api/sam/v2/computers
```

--------------------------------

### Example of a full file path

Source: https://www.ibm.com/docs/en/license-metric-tool/9.2.0?topic=troubleshooting-discovery

This is an example of the output from the 'find' command, showing the full path to a failed file within the server's temporary directory. Provide this to IBM Support.

```text
./wlp/usr/servers/server1/tmp/datasources/2/UploadManager/sha1/75/375/<package_name>

```

--------------------------------

### Start License Metric Tool Server

Source: https://www.ibm.com/docs/en/license-metric-tool/9.2.0?topic=infrastructure-administering-server

Use the appropriate script to start the License Metric Tool server. Ensure you are using the correct script for your operating system (shell for Linux/macOS, batch for Windows).

```shell
srvstart.sh
```

```batch
srvstart.bat
```

--------------------------------

### GET Request for Shared Disks (Default Columns)

Source: https://www.ibm.com/docs/en/license-metric-tool/9.2.0?topic=v2-retrieval-shared-disks

Example GET request to retrieve shared disk information using default columns. Ensure the 'Accept' and 'Token' headers are correctly set.

```HTTP
GET https://server_url:server_port/api/sam/v2/shared_disks
```

--------------------------------

### Start VM Manager Tool

Source: https://www.ibm.com/docs/en/license-metric-tool/9.2.0?topic=disconnected-running-vm-manager-tool

Use this command to start the VM Manager Tool. If the tool is already running, a message indicating this will be displayed.

```bash
./vmman.sh -run
```

```batch
vmman.bat -run
```

--------------------------------

### Additional columns retrieval request

Source: https://www.ibm.com/docs/en/license-metric-tool/9.2.0?topic=v2-retrieval-hardware-inventory

Example GET request to retrieve specific additional columns for computers.

```HTTP
GET https://server_url:server_port/api/sam/v2/computers
?columns[]=id&columns[]=is_deleted&columns[]=deletion_date
```

--------------------------------

### Run DB2 Installation Script

Source: https://www.ibm.com/docs/en/license-metric-tool/9.2.0?topic=tool-step-1-installing-db2

Navigates to the extracted directory and initiates the DB2 installation process.

```bash
./db2setup
```

--------------------------------

### Run Installation Script

Source: https://www.ibm.com/docs/en/license-metric-tool/9.2.0?topic=platform-step-3-installing-bigfix

Execute the installation script from the extracted directory. This script initiates the BigFix installation process.

```bash
./install.sh
```

--------------------------------

### Resource URL for Data Imports

Source: https://www.ibm.com/docs/en/license-metric-tool/9.2.0?topic=api-rest-data-imports

Use this URL to start data imports or check their status via a GET request.

```text
https://server_url:server_port/api/import_status.json
```

--------------------------------

### Run Silent Server Installation on Windows

Source: https://www.ibm.com/docs/en/license-metric-tool/9.2.0?topic=s3is-installing-server-in-silent-mode-1

Use this command to initiate a silent installation of the License Metric Tool server on Windows. Ensure the response file path is correctly specified.

```bash
setup-server-windows-x86_64.bat -f response_file_path -i silent
```

```bash
setup-server-windows-x86_64.bat -f "C:\Program Files (x86)\ILMT_installer\install_response.txt" -i silent
```

--------------------------------

### Starting a Data Import via URL Parameter

Source: https://www.ibm.com/docs/en/license-metric-tool/9.2.0?topic=api-rest-data-imports

Append the 'run=true' parameter to the resource URL to initiate a data import.

```text
URL?run=true
```

--------------------------------

### GET /api/sam/v2/software_instances

Source: https://www.ibm.com/docs/en/license-metric-tool/9.2.0?topic=v2-retrieval-software-inventory

Retrieves a list of software instances with specified columns. This endpoint is useful for querying detailed information about software installations on managed computers.

```APIDOC
## GET /api/sam/v2/software_instances

### Description
Retrieves a list of software instances, allowing specific columns to be requested.

### Method
GET

### Endpoint
https://server_url:server_port/api/sam/v2/software_instances

### Query Parameters
- **columns[]** (string) - Required - Specifies the columns to include in the response. Multiple columns can be requested by repeating the parameter.

### Request Header Example
```
Accept: application/json
Accept-Language: en-US
Token: <token>
```

### Response
#### Success Response (200)
- **computer_id** (integer) - The ID of the computer where the software instance is located.
- **catalog_version** (integer) - The version of the software catalog used for this instance.

#### Response Example
```json
[
  {
    "computer_id": 1,
    "catalog_version": 1304630
  }
]
```
```
Tokens:
Raw