The administration tool displays that the license is no longer in use.

Note: If the user Sandra did not hand back the license, when the five-day
reservation period expires, the license is handed back. The
administration tool displays that the license is no longer in use.

Command-Line Equivalent
The equivalent CLI commands are as follows.
To update (to 50) the maximum number of days a product can be reserved.
i4blt -U -v "IBM Corporation" -p "DataMaster" O 50

To modify the default authorization for DataMaster licenses:

i4blt -A m -v "IBM Corporation" -p "DataMaster 3.1" -t 899460562 -T no
-w "password"

To create a reservation record for the DataMaster license for the user Sandra, for
any group and target ID:
i4blt -A a -v "IBM Corporation" -p "DataMaster 3.1" -T yes
-u "Sandra * *" w "lum_group"

It is not possible modify using a unique command an authorization record other

than the default record. The administrator needs to delete the old record and create
a new record. To delete a reservation record for DataMaster licenses for the user
Sandra:
i4blt -A d -v "IBM Corporation" -p "DataMaster 3.1"
-t 899460562

-u "Sandra * *"

To create a authorization record for the DataMaster license for the user Sandra for
a specific machine with target id 57f48e93:
i4blt -A a -v "IBM Corporation" -p "DataMaster 3.1"
"Sandra * 57f48e93" w "lum_group"

-T yes -u

To list all the authorization records for the DataMaster license3:

i4blt -A l -v "IBM Corporation" -p "DataMaster 3.1"

To display information about the users of concurrent-offline licenses for the

DataMaster product:
i4blt -s l co -v "IBM Corporation" -p "DataMaster"

Chapter 5. Administering License Use Management Runtime

137

138

Using License Use Management Runtime

Chapter 6. License Use Management Runtime Command Line

Interface
This chapter describes how to use the License Use Management Runtime CLI.
In the descriptions of command syntax, the following conventions are used:
Bold type

Code this item exactly as shown.

Italic type

Replace this item with your own value.

Brackets []

The item or items in brackets are optional.

Braces {}

Choose one item from the list of alternative items inside the
brackets.

Vertical line | This OR sign separates the alternative items.

Three dots

An ellipsis following an item means you can include more than

one of the item. For example, [filename]... specifies an optional list
of files.

The following commands are available on all operating systems:

i4blt

Basic License Tool (page 140)

i4cfg

Configuration Tool (page 167)

i4tv

Test Verification Tool (page 173)

i4target

Target View Tool (page 174)

i4lmd

Network License Server (page 176)

i4llmd

Nodelocked License Server (page 178)

i4gdb

Central Registry (page 180)

The following commands are available on both UNIX and AIX:

lb_admin

Local Broker Administration (page 182)

drm_admin

GLBD Replicas Administration (page 186)

lb_find

GLBs List (page 189)

uuid_gen

ID Generator (page 190)

llbd

Local Location Broker Subsystem (page 191)

glbd

Global Location Broker Subsystem (page 192)

i4glbcd

Global Location Broker Data Cleaner Subsystem (page 194)

Copyright IBM Corp. 1995, 2004-2008

139

i4blt - Basic License Tool

i4blt - Basic License Tool

Primary Command Options
ALL

The i4blt command has the following primary command options:

(No option)

Start the basic license tool GUI.

i4blt -a Enroll a Product

Add products to a license database.

i4blt -A Authorize

Authorize an offline-nodelocked license.

i4blt -C Clean Up Stale Licenses

Update the number of concurrent, reservable,

per-server, and concurrent nodelocked licenses in use.

i4blt -d Delete a Product License

or Bundle

Delete bundles, delete products from a license

database, or delete Application Client Identifiers from
the central registry.

i4blt -E Extract and Distribute

Licenses

Extract and distribute licenses from a network

compound password of a given product to the servers.

i4blt -h Display Help

Display command syntax and usage information about

the basic license tool CLI.

i4blt -H Administer
High-Availability Licensing

Create a cluster of network license servers; add servers

to an existing cluster; display cluster status; activate
and deactivate servers in a cluster.

i4blt -l Display a List

List license database information about servers,

vendors, bundles, products, and licenses.
Check the state of databases and repair them
if needed.
List all the databases and their states (provide
the information if they are corrupted).

140

i4blt -m Monitor and Log

Threshold Events

Monitor and log the threshold messages.

i4blt -r Generate a Report

Report on information recorded in the log file of a

license server.

i4blt -R Reserve Licenses; Delete

or Update Reserved Licenses

Reserve reservable licenses for use by a specific user,

group, or node; deletes reserved licenses; updates
reservation status.

i4blt -s Display Product License

Status

Gather status information about license usage.

i4blt -S Set the Stress Threshold

Set the network license server load threshold.

i4blt -T Activate or Deactivate

Tracing

Display information about current product usage on

specified license servers.

i4blt -U Update a Product

Update the number of licenses you enrolled, update

the hard stop/soft stop policy and high-water mark
when enabled on the product, switch from per-server
to per-seat licenses, set the threshold value of a
customer-managed product, and set the maximum
allowed period that a concurrent-offline license can be
reserved.

i4blt -x Delete Server Log Entries

Delete license server and central registry log file

entries.

Using License Use Management Runtime

i4blt - Basic License Tool

General Rules for the i4blt command

1. The root user (UNIX), or the administrator (Windows), can run the i4blt
command with all its options.
Other users can run the -l (Display a List), -s (Display Product License Status),
-r (Generate a Report), -Hs (check a cluster status), and -h (Display Help)
options and the equivalent GUI actions, allowing them to display the content of
the license and license users databases.
2. The parameters within any of the following name specifications are positional:
v vendor_information (vendor_name vendor_id vendor_password)
v product_information (product_name product_version license_password
license_annotation)
v administrator_information (administrator_name company_name address
additional_info)
v user_information (user_id user_group user_node)
3. All the following name specifications must be enclosed within double quotation
marks (for example: vendor_name vendor_id vendor_password).
v vendor_information (vendor_name vendor_id vendor_password)
v product_information (product_name product_version license_password
license_annotation)
v administrator_information (administrator_name company_name address
additional_info)
v user_information (user_id user_group user_node)
v signature_information
4. When a list of values (such as server names, vendor names, product names, or
user names) is entered as a parameter, the list must be enclosed in double
quotation marks. For example:
i4blt -r3 -u "katie dustin emily adam"

5. A name that contains character spaces must additionally be enclosed within

single quotation marks. If multiple blanks within the name must be preserved,
each must be preceded by a backslash. For example:
-v "IBM Corporation"
-p "Corel\ \ - System 1.1"

6. The parameters you specify in any of the command options (for example,
server names, vendor names, and product names) are case-sensitive.
7. The following command parameters have a limited length.
group_name

31 characters
Note: License Use Management Runtime fix pack 12 supports
Windows groups with names longer than 31 characters by
truncating the group name to 31 characters; this ensures
backward compatibility. If group names are different only after
the 31st character they will be treated as the same group.

server_name

31 characters
Attention: The first three character positions are reserved for
the string ip: Any server name that is longer than 28 characters
is truncated on the right.

user_name
31 characters
8. You can display help on i4blt command options as follows:
v To get help on just the -a, -U, -E, -d, -m or -H option:
Chapter 6. License Use Management Runtime Command Line Interface

141

i4blt - Basic License Tool

i4blt -option

v To get help on just the -R, -l, -r, or -x option:

i4blt -optionh

Examples
v Display the i4blt -E syntax:
i4blt -E

v Display the i4blt -r syntax:

i4blt -rh

i4blt -a Enroll a Product

This option adds a product to the license database on the license server that you
specify. Use the i4blt -a command to add a new product and its initial licenses to
a license server database. You can also use this command to add licenses for
existing vendor-managed products.
You can add product license information to a server in two ways:
v If you got the product license information in the form of an enrollment
certificate file, you can install the product importing the enrollment certificate.
You can enroll more than one product at the same time.
v If you got the product license information in a format other than an enrollment
certificate file, you must enter the product information manually.
Note: You can only enroll licenses that have an associated additional license
annotation file if you have the enrollment certificate file (that is, enroll using
the -f option). In this case, make sure that the additional license annotation
file is present in the directory indicated by the enrollment certificate file
before you enroll the product (see the AdditionalLicenseData tag of the
certificate).
Syntax: If you have the enrollment certificate file:
i4blt -a
[ -n server_name ] -f filename [filename]...
[ -R administrator_name [ company_name address additional_info ] ]
[-T enrolled_licenses ]
[ -I signature_information ]
If you do not have the enrollment certificate file:
i4blt -a
[ -n server_name ]
-v vendor_name vendor_id vendor_password
-p product_name product_version license_password [ license_annotation ]
[ -R administrator_name [ company_name address additional_info ] ]
[ -T enrolled_licenses ]
[ -I signature_information ]
[ -S { serial_number | bundle_id } ]
Parameters:
-n server_name
Specifies the name of the license server to which you intend to add the
product. If -n is omitted:
v If the product is customer-managed, and the licenses are network
licenses, they are enrolled on the central registry.

142

Using License Use Management Runtime

i4blt - Basic License Tool

v If the product is customer-managed, and the license is nodelocked, it is
enrolled on the local workstation.
v If the product is vendor-managed, and the enrollment certificate file
specifies a target ID, the licenses are enrolled on that workstation.
v If the product is vendor-managed, and the enrollment certificate file
does not specify a target ID, the licenses are enrolled on the local
workstation.
-f filename [ filename ]...
(Only if you have the enrollment certificate) The complete path and file
name of the enrollment certificate file containing the product license
information that you intend to add. You can specify a list of file names if
you want to enroll more than one certificate at a time.
-v vendor_name vendor_id vendor_password
(If you do not have the enrollment certificate)
vendor_name
The name of the vendor that manufactured the product that you
intend to add.
vendor_id
The unique vendor ID string for the vendor that you specify in the
vendor_name argument.
vendor_password
The unique vendor password string for the vendor that you specify
in the vendor_name argument.
-p product_name product_version license_password [ license_annotation ]
(If you do not have the enrollment certificate)
product_name
The name of the product that you want to install.
product_version
The version of the product that you specified in the product_name
parameter.
license_password
The unique license password string associated with the product.
license_annotation
The license annotation information (if any) provided by the vendor.
-R administrator_name [ company_name address additional_info ]
(for customer-managed use products only)
administrator_name
The name of the administrator who performs the operation. This
parameter is required.
company_name
The name of your company.
address The address of your company.
additional_info
Comments, notices to future users, or other information about the
initial enrollment of this product.
If you enroll several products, the value you specify for these options
apply to all the license certificates.
Chapter 6. License Use Management Runtime Command Line Interface

143

i4blt - Basic License Tool

-T enrolled_licenses
(for customer-managed use products only) The number of licenses you
have acquired from the software supplier. This parameter is required.
If you enroll several products, the value you specify for this option applies
to all the license certificates.
-I signature_information
(for customer-managed use products only) Information about the user
issuing the command, to be stored with the signature stamp.
-S { serial_number | bundle_id }
The serial number of a custom configuration license, or the bundle
identifier for a bundle. The number is a string of up to 31 alphanumeric
characters that uniquely identifies a custom configuration or a bundle.
Examples: Add a customer-managed use product:
i4blt -a
-v "Venus 4ca0fd5cf000.0d.00.02.1a.9a.00.00.00 kz5esmu69hzyw"
-p "timer 1.1 wzx3ewdfrvu4v64d53bbrkzhheaaaaa"
-R "Alex IBM Rome" -T 100
-I "Alex using root userid"

Add a vendor-managed use product:

i4blt -a -n thelma
-p "scena 1.0 suf0fpeixfi5v78a22xxrkzhheaaaaa"
-v "Operatix 7gp4ac8jj000.0d.00.02.1a.9a.00.00.00 lb7usud93jdna"

i4blt -A Authorize
Use this option to create an authorization for either a concurrent, or a
concurrent-offline license. i4blt must be run on the same machine where the license
is enrolled.
Note: To add an authorization for a high-availability license, you must repeat the
command on each license server in the cluster.
Syntax:
i4blt -A action_type
{ { a -v vendor_name -p product_name product_version
-u user_name user_group target ID [ -w password ] -T mode [-t timestamp]}
|
{ l -v vendor_name -p product_name product_version [-t timestamp]}
|
{ d -v vendor_name -p product_name product_version
-u user_name user_group target ID -t timestamp}
|
{ m -v vendor_name -p product_name product_version -t timestamp
-T mode [ -w password ] } }
Parameters:
action_type
Specifies the action to be taken:
a

144

Adds an authorization for a product. With action type a, the -v, -p,
-u, and -T parameters are all required. The -t and -w parameters
are optional.

Using License Use Management Runtime

i4blt - Basic License Tool

To add an authorization for a high-availability license, you must
repeat the command on each license server in the cluster.
l

Lists the authorizations for a product. With action type l, the -v

and -p parameters are required. The -t parameter is optional.

To delete an authorization for a product. With action type d, the -v,

-p, -u, and -t parameters are all required.
To delete an authorization for a high-availability license, you must
repeat the command on each license server in the cluster.

To modify an authorization for a product. With action type m, the

-v, -p, -t, and -T parameters are all required. The -w parameter is
optional.
You can modify only the default authorization from the CLI. To
modify any authorization that is already created, you must use the
GUI.

-u user_name user_group target ID

The user name and user group for the user to be authorized, and target ID
of the machine where the license is to be authorized. The target ID applies
only to concurrent-offline licenses that are to be used in the offline mode.
The target ID is ignored for concurrent licenses, and also for
concurrent-offline licenses that are used as concurrent licenses.
The wildcard character (*) can also be used to denote any.
-w password
The initial password for the authorized user. This is for concurrent-offline
licenses only. The password cannot contain spaces. The password must be
enclosed in double quotation marks. It is for concurrent-offline licenses that
are to be used for offline mode. The password is ignored for concurrent
licenses, and also for concurrent-offline licenses that are used as concurrent
licenses.
The wildcard character (*) can be used to clear (unset) the password.
-v vendor_name
The vendor of the licensed product that you intend to update. Enclose the
vendor_name with single quotation marks () when the vendor_name contains
spaces, for example "IBM Corporation".
-p product_name product_version
The information on the licensed product that you intend to update.
product_name
The name of the product for which you have acquired the new
licenses. Enclose the product_name with single quotation marks ()
when the product_name contains spaces.
product_version
The version of the product that you specified in the product_name
parameter.
-T mode
Set to one of:
yes

A user can start using the license as a concurrent license or can

reserve it for nodelocked-offline use.

no

The license cannot be granted in any mode.

Chapter 6. License Use Management Runtime Command Line Interface

145

i4blt - Basic License Tool

concurrent
This is for concurrent-offline licenses only. A user can start using
the license in a concurrent mode only. The user cannot reserve the
license for nodelocked-offline use.
-t timestamp
Unique timestamp of the product license that you intend to create, modify,
list, or delete. To get the timestamp, issue the following command:
i4blt -lp -p "product_info" -i

Examples: To create an authorization record for the DataMaster license for the
user Sandra, for any group and target ID:
i4blt -A a -v "IBM Corporation" -p "DataMaster 3.1" -T yes
-u "Sandra * *" w "lum_group"

To create an authorization record for the DataMaster license for the user Sandra for
a specific machine with target id 57f48e93:
i4blt -A a -v "IBM Corporation" -p "DataMaster 3.1" -T yes
-u "Sandra * 57f48e93" w "lum_group"

i4blt -C Clean Up Stale Licenses

Use i4blt -C to update the number of in-use concurrent, reservable, per-server, and
concurrent nodelocked licenses.
When you issue this command, License Use Management Runtime polls all the
license servers that have granted licenses of these types and verifies that the
licenses are still in use. If any stale licenses are found, they are removed from the
number of in use licenses.
Syntax:
i4blt -C
[ -F server_type { l | w | a } ]
[ -n server_names ]
[ -v vendor_names ]
[ -p product_names ]
Parameters:
-F server_type
A filter on the type of server to be searched. Specify l for nodelocked
license servers, w for network license servers, or a (the default) for both
network license servers and nodelocked license servers.
-n server_names
The names of the servers where the products are enrolled.
-v vendor_names
The name of the vendors that manufactured the products whose licenses
are in use.
-p product_names
The names of the products whose stale licenses you want to clean up.
Examples: Clean up stale licenses for the Graphics product of vendor Alpha on
servers Thelma, Hall, and Louise:
i4blt -C -n "Thelma Hall Louise" -v "Alpha" -p "Graphics"

146

Using License Use Management Runtime

i4blt - Basic License Tool

Clean up stale licenses for the Graphics product of vendor Alpha on all
nodelocked license servers in the network.
i4blt -C -F l -v "Alpha" -p "Graphics"

i4blt -d Delete a Product License or Bundle

This option deletes a product license or bundle from the license database on the
license server that you specify, or an Application Client Identifier from the central
registry.
Syntax:
i4blt -d
-n server_name
-v vendor_name
-p product_name product_version
{ -t timestamp | -A ACID | -b bundle_id }
[ -I signature_information ]
Parameters:
-n server_name
Either of the following:
v The name of the license server from which you intend to delete the
product license.
v To delete a high-availability license, the name of one of the servers in the
cluster on which the license is enrolled.
To delete a high-availability license, issue the command:
i4blt -d -n server_name -v vendor_name -p product_name
product_version -t timestamp

where server_name identifies one of the servers in the cluster on which the
license is enrolled. You must repeat the command for each license server in
the cluster.
-v vendor_name
Name of the vendor whose product license you intend to delete.
-p product_name product_version
The information on the licensed product whose licenses you intend to
delete.
product_name
Name of the product whose license you intend to delete.
product_version
Version of the product whose license you intend to delete.
-t timestamp
Unique timestamp of the product license that you intend to delete. To get
the timestamp, issue the following command:
i4blt -lp -p "product_info" -i

Do not specify the timestamp when you delete an Application Client

Identifier.
-A ACID
Unique identifier of the Application Client Identifier of an application
client you want to delete from the central registry. After deletion the

Chapter 6. License Use Management Runtime Command Line Interface

147

i4blt - Basic License Tool

application client no longer has the license to use the specified product. To
get the Application Client Identifier, issue the following command:
i4blt -s -lpt -v "vendor_name" -p "product_info"

Do not specify -A when you delete a product.

-b bundle_id
The identifier of the bundle you want to delete.
-I signature_information
(for customer-managed use products only) Information about the user
issuing the command, to be stored with the signature stamp. Use this
parameter when deleting a product license.
When the last license for the only remaining product of a vendor is deleted, the
vendor is automatically deleted from the license database. Vendor-managed
compound passwords and use-once licenses cannot be deleted until they expire.
Examples: Delete a bundle whose ID is AZ57561C:
i4blt -d -b AZ57561C

Delete an expired license for a VectorComp Corporation product called EZ-Vectors

Version 1.0. The unique timestamp of the license to be deleted from the database
on server saturn is 781401788:
i4blt -d -n saturn -v "VectorComp Corporation" -p
"EZ-Vectors 1.0" -t 781401788

Delete an application client whose Application Client Identifier is thelma from the
central registry. After this command the application client will no longer have
licenses for the product EZ-Vectors Version 1.0 of VectorComp Corporation vendor:
i4blt -d -v "VectorComp Corporation" -p "EZ-Vectors 1.0"
-A thelma

i4blt -E Extract and Distribute Licenses

Use the i4blt -E command to extract licenses from an installed network compound
password and distribute them to the network license servers.
Syntax:
i4blt -E
-n origin_server_name
-v vendor_name
-p product_name product_version
-A license_number_per_server
-w target_server_names
[-I signature_information ]
Parameters:
-n origin_server_name
The name of the server where the network compound password is
enrolled.
-v vendor_name
The name of the vendor that manufactured the product whose licenses you
want to distribute.

148

Using License Use Management Runtime

i4blt - Basic License Tool

-p product_name product_version
The information on the licensed product whose licenses you intend to
distribute.
product_name
The name of the product whose licenses you want to distribute.
product_version
The version of the product that you specified in the product_name
parameter.
-A license_number_per_server
The number of licenses for the specified product you want to distribute on
each of the servers specified after the -w parameter.
-w target_server_names
The servers on which you want to distribute the licenses.
-I signature_information
(For customer-managed use products only) Information about the user
issuing the command, to be stored with the signature stamp.
Examples: Extract and distribute 10 licenses to each of the servers Louise and
Hall, for the Test Compiler product, Version 1.1 of vendor Psychosync, installed on
server Thelma:
i4blt -E -n "Thelma" -v "Psychosync" -p "Test Compiler 1.1"
-A 10 -w "Louise Hall" -I "Paula"

i4blt -h Display Help

This option displays general syntax information for the basic license tool CLI.
Syntax:
i4blt -h
Examples: Display the i4blt syntax:
i4blt -h

i4blt -H Administer High-Availability Licensing

This option creates a cluster of network license servers; adds servers to an existing
cluster; displays cluster status; and activates and deactivates servers in a cluster.
Syntax:
i4blt -H action_type
{ { c -N cluster_name -n server_names -T initial_number_of_servers }
|
{ a | d } -N cluster_name -n server_names }
|
{ s { -N cluster_name | -n server_names } } }
Parameters:
action_type
Specifies the action to be taken:
c

To create a cluster. With action type c, the -N, -T, and -n

parameters are all required.

Chapter 6. License Use Management Runtime Command Line Interface

149

i4blt - Basic License Tool

a

To add a server to a cluster, or to activate a server in a cluster.

With action type a, the -N and -n parameters are required.

To deactivate a server in a cluster. With action type d, the -N and

-n parameters are required.

To request cluster status. With action type s, the -N or -n

parameter is required. Use the -N parameter to get an overall view
of cluster status. If you are having problems with cluster operation
and you want to see a view of the cluster from the perspective of
an individual server, use action type s with the -n parameter. In
either case, the cluster status display includes the following
information about the cluster:
v Cluster name
v Cluster ID
v Cluster status:
Active

Running, serving licenses

Change Pending
Waiting for a change in the status of a server, or
of the cluster, to be propagated to all the servers
Inactive

Not enough servers up and running

Incomplete
Not enough servers activated
v Initial number of servers
v Minimum number of members, maximum number of members,
and minimum up and running for the cluster to work
v For each server in the cluster:
Server name
Server status:
Serving

Running, serving licenses

Waiting

Server is ready, but cluster is in incomplete or

inactive state

Unavailable

Not started or not reachable

Reserve

In reserve in case a serving server becomes

unavailable

Defined as a member of the cluster but

administrator has not yet activated the server
or has deactivated the server
Percentage of licenses being served
Target ID
Not activated

-N cluster_name
The name of the cluster to which the command is directed. The -N
parameter is required if action type is c, a, or d, and it is recommended
when action type is s.
-T initial_number_of_servers
The initial number of servers in the cluster that you are creating. The -T
parameter is required if action type is c, and is not valid if action type is
not c. The -n parameter must specify a number of servers equal to the
value of -T.

150

Using License Use Management Runtime

i4blt - Basic License Tool

-n server_names
The names of the servers to which the command is directed. The -n
parameter is required if action type is c, a, or d, and it can be used when
action type is s. If action type is c, this is the list of initial members of the
cluster. You must specify a number of servers equal to the value of -T.
After this command has been processed, the first server in the list is
automatically activated. Issue i4blt -H again, using action type a, to
activate each additional server. At the time the i4blt -H c command is
processed, all the servers specified must be up and running. If not, the
command fails. If action type is a or d, this is the name of the server to be
activated or deactivated. You must specify exactly one server. If action type
is a, the server must be up and running when the command is processed.
If not, the command fails. If action type is s, this is the name of any server
that is currently activated in the cluster. The command returns cluster
status from the perspective of this server.
Note: When the cluster is in Change pending status, different servers may
return different data.
Examples: Create a cluster named ruth that has three members: anthony,
germaine, and costanza:
i4blt -H c -N ruth -T 3 -n "anthony germaine costanza"

Activate the servers germaine and costanza:

i4blt -H a -N ruth -n germaine
i4blt -H a -N ruth -n costanza

Add the server sandra to the cluster:

i4blt -H a -N ruth -n sandra

Deactivate the server germaine:

i4blt -H d -N ruth -n germaine

Get an overall report of the status of the cluster nobel:

i4blt -H s -N nobel

Get a report of the status of the cluster nobel from the perspective of one of its
activated members, pirandello (recommended only for troubleshooting purposes):
i4blt -H s -n pirandello

i4blt -l Display a List

All users can use this option to display a list of servers, vendors, bundles,
products, or licenses. You can also use it to display details about individual
products or individual licenses.
Syntax:
i4blt -l list_type { n | s | v | p [ -i ] | b | l [-k] [-Z] d | r }
[ -b bundle_id ]
[ -F server_type { l | w | a } ]
[ -n server_names ]
[ -v vendor_names ]
[ -p { product_name[product_version ] } ... ]
[ -u user_names ]

Chapter 6. License Use Management Runtime Command Line Interface

151

i4blt - Basic License Tool

Parameters:
list_type
Indicates the type of information that you want to list. You can specify any
one of the following list types:
-ln or -ls
To display a list of active license servers. Also displays information
about trace level, load percentage and load threshold percentage.
The load percentage and load threshold percentage are not
applicable for a nodelocked license server or for a central registry
license server or for any server older than License Use
Management Runtime Version 4.6.8.
Filters:
v You can use the -F filter option to display a list of active
network license servers or nodelocked license servers.
v Do not specify the b, -n, -v, -p, or -u filter option with this
parameter.
-lb

To display a list of bundles.

Filters:
v To list only the contents of a specified bundle, use the b filter
option, followed by the bundle identifier.
v To list bundles or bundle components for a specific type of
license server, use the -F filter option to specify nodelocked
license servers or network license servers.
v To list bundles or bundle components for servers that you
specify, use the -n filter option followed by one or more server
names.
v To list bundles or bundle components from particular vendors,
use the -v filter option, followed by one or more vendor names.
v Do not specify the -p, -u, or -t filter option with this parameter.

-lv

To create a vendor list.

Filters:
v To list vendor information gathered from a specific type of
license server, use the -F filter option to specify nodelocked
license servers or network license servers.
v To list vendor information gathered from servers that you
specify, use the -n filter option followed by one or more server
names.
v Do not specify the -b, -v, -p, or -u filter option with this
parameter.

-lp [-i] To create a product list.

Filters:
v To list product information gathered from a specific type of
license server, use the -F filter option to specify nodelocked
license servers or network license servers.
v To list product information gathered from servers that you
specify, use the -n filter option followed by one or more server
names.

152

Using License Use Management Runtime

i4blt - Basic License Tool

v To list product information on products from particular vendors,
use the -v filter option, followed by one or more vendor names.
v To list product information on particular products, use the -p
filter option, followed by one or more product names.
v To list information on users who are currently using the
products that you specify, use the -u filter option, followed by
one or more user names.
v Do not specify the -b filter option with this parameter.
v Specify the -k option to remove expired licenses from the list.
Specify the -i option to display detailed information about each
product (for example, the number of reserved and unreserved
licenses) in a product list.
i4blt -ld
To display a list of databases and their states (provides information
about the databases that are corrupted).
i4blt -lr
To display a list and repair databases. However, database
corruption occurs very rarely during day-to-day operation and this
command should be used sparingly.
-ll [-k][-Z]
To create a list of individual licenses. The output includes all the
information you get by specifying lp with the -i option, plus, for
products with concurrent licenses that are administered in a
high-availability environment, information about the cluster and
servers within the cluster.
Filters:
v To list only the contents of a specified bundle, use the b filter
option, followed by the bundle identifier.
v To list license information gathered from a specific type of
license server, use the -F filter option to specify nodelocked
license servers or network license servers.
v To list license information gathered from servers that you
specify, use the -n filter option followed by one or more server
names.
v To list license information on products from particular vendors,
use the -v filter option, followed by one or more vendor names.
v To list license information on particular products, use the -p
filter option, followed by one or more product names.
v To list information on users who are currently using the licenses
that you specify, use the -u filter option, followed by one or
more user names.
v Specify the -k option to remove expired licenses from the list.
v Specify the -Z option to display a table containing value units
annotation information.
Value Units Output:
v Capacity Type. Shows a list of items for which a capacity type
(metric) has been assigned.
v Value Units. Shows the number of value units assigned to a
specific capacity type.
Chapter 6. License Use Management Runtime Command Line Interface

153

i4blt - Basic License Tool

v Value Units Calculation. Indicates the method by which the
value units are calculated from capacity units:
Within Range. Specifies the same value units for all capacity
units in the specified range.
Linear Increment. The number of value units required is
proportional to the number of capacity units requested.
v From. Indicates the beginning of the range.
v To. Indicates the end of the range (if any).
High-Availability Output:
v Cluster name
v For each server in the cluster:
Server name
Server status:
Serving
Running, serving licenses
Waiting
Server is ready, but the cluster is in incomplete or
inactive state
Unavailable
Server is unavailable to other members of the cluster
Reserve
In reserve in case a serving server becomes
unavailable

Not activated
Defined as a member of the cluster but the
administrator has not yet activated the server or has
deactivated the server
Percentage of licenses being served by this server
Target ID
Number of licenses served by this server
Number of in-use licenses served by this server

-F server_type
A filter on the type of server to be searched. Specify l for nodelocked
license servers, w for network license servers, or a (the default) for both
network license servers and nodelocked license servers.
-n server_names
Names of the servers about which you want to display information in a
vendor or product list.
-v vendor_names
Names of the vendors about whose products you want to display
information in a product list.
-p { product_name[?product_version ] } ...
Names of the products and, optionally, their versions about which you
want to display information in a product list. If product_name or
product_version contains blank characters, enclose the product name and
product version in quotation marks, for example:
-p product name?product_version

154

Using License Use Management Runtime

i4blt - Basic License Tool

-b bundle_id
To list the contents of a specific bundle, use the b filter option, followed
by the bundle identifier.
-u user_names
Names of users about whom you want to display license usage
information in a product list.
-i

Specify the -i option in conjunction with a product list (i4blt -lp) to display
the following detailed license usage information about an individual
licensed product in a product list:
v Vendor name
v Vendor ID
v Product name
v Product version
v
v
v
v

v
v

Product ID
Licenses (total on all the selected servers)
In-use licenses (total on all the selected servers)
For each license instance:
Number of licenses
License type
Capacity type
Bundle component
Server on which the license is installed
License annotation (if any)
Serial number or bundle ID (if any)
Start date
Expiration date
Time stamp
Password use control level
For products with customer-managed use control and per-server,
per-seat, or concurrent nodelocked licenses, the following information
is also displayed:
High-water mark licenses
Threshold value
Soft stop
Soft stop enabled
For products with customer-managed use control and use-once
nodelocked licenses, the following information is also displayed:
Threshold
For per-seat licenses, the following information is also displayed:
Enablement flag
For reservable licenses, the following information is also displayed:
Number of reserved licenses
Number of unreserved licenses
For reserved licenses, the following information is also displayed:
User for whom licenses are reserved
Group for which licenses are reserved
Chapter 6. License Use Management Runtime Command Line Interface

155

i4blt - Basic License Tool

Node for which licenses are reserved
v For concurrent, concurrent nodelocked, and per-server licenses, the
following information is also displayed:
Multiuse rules (if any)
For try-and-buy licenses, the following information is also displayed:
Try-and-buy flag
v For compound passwords, the following information is also displayed:
Derived license type
Aggregate duration
Derived start type
Derived expiration date
For products with customer-managed use control and concurrent or
reservable licenses, the following information is also displayed:
- Enrolled licenses
- Distributed licenses
- To be distributed licenses
- High-water mark licenses
- Threshold value
- Soft stop
- Soft stop enabled
For products with customer-managed use control and use-once
licenses, the following information is also displayed:
- Enrolled licenses
- Distributed licenses
- To be distributed licenses
- Threshold value
Examples: List all servers:
i4blt -ln

List all vendors on all servers:

i4blt -lv

List all vendors on all network license servers:

i4blt -lv -F w

List all vendors on server Hall:

i4blt -lv -n Hall

List all products on server Hall:

i4blt -lp -n Hall

List all products on server mercury provided by vendors Opticon, Inc. and
Cybertronics Ltd.:
i4blt -lp -n mercury -v "Opticon, Inc. Cybertronics Ltd."

List detailed information for the product PsychoSynch on server venus:

i4blt -lp -n venus -p PsychoSynch -i

156

Using License Use Management Runtime

i4blt - Basic License Tool

List information for the 1.2 version only of the product PsychoSynch and any
version of the Megamail product:
i4blt -lp -p"PsychoSynch?1.2 Megamail"

List information for the 1.2 version only of the product Sync Psycho and any
version of the Megamail product:
i4blt -lp -p"Sync Psycho?1.2 Megamail"

List all of the products on the server neptune that are currently being used by the
user Alex:
i4blt -lp -n "neptune" -u Alex

i4blt -m Monitor and Log Threshold Events

This option displays the threshold messages and logs them if the threshold logging
option is specified.
Syntax:
i4blt -m
[ -T percentage [ 1...100 ] ]
[ -A periodic_mode [ yes | no ] ]
[ -X frequency [ 1...1440 ] ]
[ -l log [ yes | no ] ]
Parameters:
-T percentage
Specifies the level of threshold value. It can be any number between 1 and
100. The default is 80. This is the percentage over which you want to log
the level of usage of each product installed on all the servers. For instance,
if you have 100 licenses of the product Icon Editor Version 1.5, and you set
the level of threshold to 10, a message appears in the vendor messages
report only if more than 10 licenses are in use. If 20 licenses are being
used, the message will say:
The 20% of licenses of Icon Editor 1.5 is in use.

Note that a customer-managed product may have its own threshold value,
set with the i4blt -U command. Such a threshold value overrides the -T
value.
-A periodic_mode
Specifies whether to check the license usage of the products only once, or
periodically. Its values can be:
v no To check the threshold conditions on the products once, immediately.
If -A is omitted, this is the default.
v yes To check the threshold conditions on the products periodically, with
the frequency specified with the -X parameter.
-X frequency
Specifies the number of minutes between one license usage check and the
next. Enter a value between 1 and 1440. It is mandatory if you set the A
parameter to yes.
-l log

Specifies whether or not the threshold messages must be logged on the

license server to be reviewed with the report function.

Chapter 6. License Use Management Runtime Command Line Interface

157

i4blt - Basic License Tool

Examples: Set the threshold percentage to 50% and set the check on the products
usage to every 4 hours:
i4blt -m -T 50 -A yes -X 240

i4blt -r Generate a Report

All users can use this option to list server, event, vendor, product, and user
information on specified license servers.
Syntax:
i4blt -r report_type [ 1 | 2 | 3 | 4 | 5 | 6 ]
[ -b start_date ]
[ -g end_date ]
[ -e event_filter ]
[ -F server_type { l | w | a } ]
[ -n server_names ]
[ -v vendor_names ]
[ -p { product_name[?product_version ] } ... ]
[ -u user_names ]
Parameters:
-r report_type
Specifies the type of report to generate. The following report types are
available:
1 - Standard Event Report
Displays detailed information about significant events occurring on
the license servers that you specify. Available for all license types.
2 - License Request by Product Report
Displays statistical information about the use of the licenses of a
product, on the license server that you specify, for the time interval
you specify. For each product, it reports the licenses requested, the
licenses granted, and the percentage of rejections. Not available for
simple nodelocked or use-once (nodelocked or network) licenses.
You can specify only one server for each report.
3 - License Request by User Report
Displays statistical information about the use of products by users,
on the license server that you specify, in the time interval you
specify. For each user, it reports the licenses requested, the licenses
granted, and the percentage of rejections for each product the
person is using. Not available for simple nodelocked or use-once
(nodelocked or network) licenses. You can specify only one server
for each report.
4 - License Use by Product Report
Displays statistical information about the use of the licenses of a
product, on the license server that you specify, in the time interval
you specify. For each product, it lists the maximum number of
concurrent nodes that used the product, the maximum number of
concurrent users, and the average time of use of the product.
Statistical information about events appears after the license
release. Not available for per-seat, simple nodelocked, or use-once
(nodelocked or network) licenses. You can specify only one server
for each report.

158

Using License Use Management Runtime

i4blt - Basic License Tool

5 - License Use by User Report
Displays statistical information about the use of the licenses of a
product, on the license server that you specify, in the time interval
you specify. For each user, it lists the number of times each product
was invoked, and the average time the user used each product.
Statistical information about events appears after the license
release. Not available for per-seat, simple nodelocked, or use-once
(nodelocked or network) licenses.You can specify only one server
for each report.
6 - Customer-Managed Use Audit
Reports the following information for customer-managed use
product transactions:
v Vendor name
v Product name
Product version
Administrator information
Time stamp of the event
Number of licenses involved in the transaction
Event list (product enrolled, license distributed, license deleted,
license updated, per-server/per-seat license migrated)
v Signature stamp (user, group, and node)
v Signature information
v
v
v
v
v

Available for all license types.

-b start_date
Specifies the start date of a report. Be sure to express the date using the
mm/dd/yyyy format. If you specify a start date and do not specify an end
date, the report will include all information logged from the specified start
date until the present.
-g end_date
Specifies the end date of a report. Be sure to express the date using the
mm/dd/yyyy format. If you specify an end date and do not specify a start
date, the report will include all information logged prior to (and including)
the specified end date.
-e event_filter
You can use the event_filter argument to generate a Standard Event report
on the following types of events which you specify, by number, on the
command line. (Separate multiple event type arguments with a comma.)
1

All events

License-related events

Database-related events

Errors general errors, but not including unrecoverable errors

Server-related events start/stop events, threshold events, vendor

events, unrecoverable errors

-F server_type
A filter on the type of server to be searched. Specify l for nodelocked
license servers, w for network license servers, or a (the default) for both
network license servers and nodelocked license servers.

Chapter 6. License Use Management Runtime Command Line Interface

159

i4blt - Basic License Tool

-n server_names
Names of the servers about which you want to display information. If you
want to generate a report for report types 2, 3, 4, or 5, you can specify only
one server name.
-v vendor_names
Names of the vendors about whose products you want to display
information.
-p { product_name[?product_version ] } ...
Names of the products and, optionally, their versions about which you
want to display information. If product_name or product_version contains
blank characters, enclose the product name and product version in
quotation marks, for example:
-p product name?product_version

-u user_names
Names of users about whom you want to display license usage
information.
Examples: Standard Event Report:
Report on license-related events (2) and server start and stop events (5) that were
logged on server neptune since May 21, 2004:
i4blt -r1 -n "neptune" -b 05/21/2004 -e 2,5

License Use by Product Report:

Report current license usage information on server saturn for the products NetLS
Test Product, Compiler, PsychoSynch, Megamail/2, EZ-Vectors, and DataVision:
i4blt -r4 -n "saturn" -p "NetLS Test Product Compiler
PsychoSynch Megamail/2 EZ-Vectors DataVision"

License Request by User Report:

Report current license usage information on server mercury for users alex, ann,
mary, christine, paul, and alby:
i4blt -r3 -n "mercury" -u "alex ann mary christine paul alby"

Customer-Managed Use Audit Report:

Report information about customer-managed use product transactions on all
nodelocked license servers from May 1, 2004 to July 31, 2004:
i4blt -r6 -F l -b 05/01/2004 -g 07/31/2004

i4blt -R Reserve Licenses; Delete or Update Reserved Licenses

Use i4blt -R to reserve reservable licenses and to delete or update the reservation
status of reserved licenses.
Syntax:
i4blt -R action_type [ r | d | u ]
-n server_name
-v vendor_name
-p product_info
[ -t timestamp ]
[ -A license_number ]

160

Using License Use Management Runtime

i4blt - Basic License Tool

[ -g end_date ]
[ -H end_time ]
[ -u user_id user_group user_node ]
Parameters:
action_type
To reserve licenses, r; to delete licenses, d; to update an existing
reservation, u.
-n server_name
The name of the server where the product license is enrolled.
-v vendor_name
The name of the vendor that manufactured the product.
-p product_name product_version
The information on the licensed product whose licenses you intend to
reserve, delete, or update.
product_name
The name of the product.
product_version
The version of the product.
-t timestamp
Unique timestamp of the product license from which you intend to reserve,
or that you intend to delete or update. To get the timestamp, issue the
following command:
i4blt -lp -p "product_info" -i

If you are reserving licenses (option -R r), the timestamp is optional. If it is

omitted, the first usable reservable license is used.
-A license_number
The number of licenses you intend to reserve. If you are updating a
reservation (-R -u) or deleting licenses (-R -d), do not specify -A.
-g end date
The end date of the new or updated reservation (mm/dd/yyyy). The latest
allowed expiration date of a reservation is 12/31/2037. If you are deleting
licenses (-R -d), do not specify -g.
-H end time
The end time of the new or updated reservation (hh:mm). If you are
deleting licenses (-R -d), do not specify -H.
-u user_id user_group user_node
The identification of the user, group, and node for which a license is being
reserved or a reservation is being changed. Any of these values may be *,
meaning any, unless you are using the named user policy. In this case
the user_id must be explicitly declared. If you are deleting licenses (-R -d),
do not specify -u.
Examples: Reserve three licenses for Test Compiler product, taken from the
reservable license identified by the timestamp 389588975, Version 1.1 of vendor
Psychosync for any member of the testers group. They expire March 2, 2004, at
11:00.
i4blt -R r -v "Psychosync" -p "Test Compiler 1.1"
-t 389588975 -A 3 -g 03/02/2004 -H 11:00 -u "* testers *"

Chapter 6. License Use Management Runtime Command Line Interface

161

i4blt - Basic License Tool

i4blt -s Display Product License Status

All users can use this option to display information about current product usage
on specified license servers.
Syntax:
i4blt -s
[ -l list_type [ c | pt | ps | ru | rr | cn | co ] ]
[ -n server_names ]
[ -v vendor_names ]
[ -p { product_name[?product_version ] } ... ]
[ -u user_names ]
Parameters:
-l list_type
Indicates the type of license usage you want to list. You can specify one of
the following list types:
-c

To display information related to concurrent users of concurrent

and concurrent-offline licenses. Because concurrent-offline licenses
can also be used as a concurrent license, you can see which users
are using concurrent-offline licenses in a concurrent mode.

-pt

To display information related to application clients that use

per-seat licenses.

-ps

To display information related to users of per-server licenses.

-ru

To display information related to users of unreserved reservable

licenses

-rr

To display information related to users of reserved licenses.

-cn

To display information related to users of concurrent nodelocked

licenses. If you omit -l, its default value is c.

-co

To display information related to users who have reserved

concurrent-offline licenses in offline mode.

-n server_names
The name of each of the license servers for which you want to display
product usage information.
If you omit the -n parameter, the display defaults to all servers in your cell.
This parameter is not used if you use pt, ps, rr, or cn as the list type.
-v vendor_names
The name of the vendor (or vendors) about whose products you want to
display information.
-p { product_name[?product_version ] } ...
Names of the products and, optionally, their versions about which you
want to display information. If product_name or product_version contains
blank characters, enclose the product name and product version in
quotation marks, for example:
-p product name?product_version

-u user_names
Use the optional -u user_names argument to display product usage
information for the specified products that are currently in use by the
named users.

162

Using License Use Management Runtime

i4blt - Basic License Tool

This command displays the following information for the servers, vendors,
products, and users that you specify:
v Vendor name
v Product name
v
v
v
v
v
v

Product version
Total number of installed licenses
Number of licenses currently in use
Number of soft stop licenses currently in use
Number of licenses not in use
Number of queued users

For each user who currently holds a license, the following information is
displayed:
v
v
v
v
v

User name
Node name
Group name
Number of licenses the user has been granted
Check-out date for each granted license

Examples: Display current license availability and usage information for

concurrent licenses of the Monolith Inc. product Megamail/2 on server uranus:
i4blt -s -lc -n "uranus" -v "Monolith Inc." -p "Megamail/2"

i4blt -S Set the Stress Threshold

Use this option to set the network license server load threshold.
Syntax:
i4blt -S threshold_value -n

server_name

Parameters:
threshold_value
Indicates the level of the load threshold. The range for this parameter is
from 1 to 100.
-n server_name
The name of the license server for which you want to set the load
threshold.
Examples: Set the workload threshold to 70% for network license server uranus.
i4blt -S 70 -n uranus

i4blt -T Activate or Deactivate Tracing

Use this option to set the trace level on a specified network license server, or to
change to a different level of tracing. Traces are written to output files whose file
names have the format:
i4lmd.trcxx

where xx identifies a particular file in the sequence. For example, the first file
would be named i4lmd.trc1, the last file would be named i4lmd.trc99. When
i4lmd.trc99 is full, the license server begins writing traces to i4lmd.trc1 again.
The current trace file has an underscore appended (for example, i4lmd.trc4_). By
default the trace files are stored in the following directories:
Chapter 6. License Use Management Runtime Command Line Interface

163

i4blt - Basic License Tool

AIX

/var/ifor

HP-UX, Solaris
/var/lum
Windows
C:\ifor\ls\conf\
Syntax:
i4blt -T level-of-tracing -n

server_name

Parameters:
level-of-tracing
Indicates the level of tracing, as follows:
0 No trace
1 High (high level trace). Server logic and database transactions.
2 Low (low level trace). Network communication.
3 Low & high (low and high level trace)
-n server_name
The name of the network license server for which you want to activate or
deactivate the trace. You can activate or deactivate tracing for one server at
a time. If you omit the -n server_name parameter, the tracing will be
activated or deactivated on the local network license server (if there is
one).
Examples: Set a high trace level for the network license server plato.
i4blt -T 1 -n plato

i4blt -U Update a Product

This option is valid only for customer-managed use products. It is issued for the
following purposes:
v To update the number of licenses you enrolled. Use it when you acquire new
licenses for an already enrolled customer-managed use product, to update the
total number of licenses you are entitled to use. In the case of a network
compound password, the licenses must be distributed after the update to make
them available to end users.
v For a product with per-server/per-seat licenses, to switch from per-server to
per-seat licenses.
v For a product with the hard stop/soft stop policy enabled, to change the hard
stop/soft stop policy and to reset the high-water mark.
v To update the threshold value of a product.
v Set the maximum allowed period that a concurrent-offline license can be
reserved.
Syntax:
i4blt -U
-v vendor_name
-p product_name product_version
[ -n server_name ]
[ -T enrolled_licenses ]
[ -S enable_switch [ yes ] ]
[ -H hard_soft_mode [ yes | no ] ]

164

Using License Use Management Runtime

i4blt - Basic License Tool

[
[
[
[

-M hwm_reset ]
-t threshold [ 1...100 ] ]
-I signature_information ]
-O MaxOfflinePeriod ]

Parameters:
-v vendor_name
The name of the vendor that manufactured the product that you intend to
update.
-p product_name product_version
The information on the licensed product that you intend to update.
product_name
The name of the product for which you have acquired the new
licenses.
product_version
The version of the product that you specified in the product_name
parameter.
-n server_name
Name of the license server on which you want to update product
information. This parameter is required if the product has nodelocked
licenses and you are updating the product on a remote nodelocked license
server. It is the name of the nodelocked license server. If you are updating
the product on the local nodelocked license server, omit the -n parameter.
If the product has network licenses, this parameter need not be specified,
because the server is the central registry license server.
-T enrolled_licenses
The total number of licenses you have for the specified product; that is, the
number of licenses you had, plus the new ones.
-S enable_switch
Use this parameter to migrate the license from per-server to per-seat. To
use the per-seat license remember also to enroll the per-seat certificate. The
only allowed value for -S is yes. When the licenses have been changed to
per-seat, you cannot go back to per-server licenses.
-H hard_soft_mode
Use this parameter to switch the product behavior from hard stop to soft
stop and vice versa. You can do it only on products the vendor has
enabled to allow hard stop/soft stop switching. Allowed values for -H are:
no

Set the soft stop

yes

Set the hard stop

-M hwm_reset
Use this parameter to reset the high-water mark to 0. You can do it only on
products the vendor has enabled to soft stop.
-t threshold
Use this parameter to set a specific value for the threshold value of a
customer-managed product. Allowed values are 1 to 100.
-I signature_information
Information about the user issuing the command, to be stored with the
signature stamp. Use this parameter with the -T parameter.

Chapter 6. License Use Management Runtime Command Line Interface

165

i4blt - Basic License Tool

-O MaxOfflinePeriod
The maximum allowed period that a concurrent-offline license can be
reserved. Use this parameter with the -v and -p parameters.
Examples: The Test Compiler product (version 1.1, vendor Psychosync) has
network licenses. Update the number of licenses to 50.
i4blt -U -v "Psychosync" -p "Test Compiler 1.1"
-T 50 -I "Paula"

For the same product, set the soft stop policy and reset the high-water mark.
i4blt -U -v "Psychosync" -p "Test Compiler 1.1" -H no -M

For the ScreenPic product (version 2, vendor ArtTools), update to 5 the number of
nodelocked licenses on server Virginia:
i4blt -U -n Virginia -v "ArtTools" -p "ScreenPic 2" -T 5

To update (to 50) the maximum number of days a product can be reserved:
i4blt -U -v "IBM Corporation" -p "DataMaster"-O 50

i4blt -x Delete Server Log Entries

This option deletes all entries before a specified delete date from the log file of the
license servers that you specify. If one of the specified license servers has the
central registry, the central registry log entries are also deleted. If the specified
license server is the local node, the nodelocked license server log entries are also
deleted.
Syntax:
i4blt -x delete_date
[ -F server_type { l | w | a } ]
[ -n server_names ]
Parameters:
-x delete_date
Specifies an end date for the delete operation. All log entries recorded
before the delete date are removed from the log file. You must specify a
delete date in the mm/dd/yyyy format. If you do not specify a delete_date
value, all entries in the log file are deleted.
-F server_type
A filter on the type of server to be searched. Specify l for nodelocked
license servers, w for network license servers, or a (the default) for both
network license servers and nodelocked license servers.
-n server_names
Specifies the license servers from whose log file you want to delete the
entries.
Examples: Delete all the log file entries recorded on server neptune before August
25, 2004:
i4blt -x 08/25/2004 -n neptune

Delete all the log file entries recorded on all nodelocked license servers before
August 25, 2004:
i4blt -x 08/25/2004 -F l

166

Using License Use Management Runtime

i4cfg - Configuration Tool

i4cfg - Configuration Tool

Use the i4cfg command as an alternative to the Configuration Tool GUI or to the
Configuration Tool script to configure your workstation. Before coding the i4cfg
command, see Before You Configure on page 73 to plan your configuration
requirements. If issued with no options, the i4cfg command starts the
Configuration Tool GUI.

Syntax
i4cfg [ -a { { c,n,s,r } | { C,N,S,R } } ]
[ -b { binding_list | null } ]
[ -d { option_string | all } ]
[ -e { a | A | { e,t,w,c,g,v,m,p,s } } ]
[ -h ]
[ -l logfile_path ]
[ -list ]
[ -R { a,n,s } ]
[ -S { a,n,s } ]
[ -start ]
[ -stop ]
[ -t transport_list ]
AIX

Windows

[
[
[
[
[

-c { d | a | cell_uuid } ]
-G { site_list | null } ]
-n { c | l | g | n } ]
-r { first | from:ip:host_name } ]
-script ]

[ -g group_name ]

Parameters
ALL

-a

The roles the workstation is to play in your licensing environment. Code

any combination of these values, optionally separated by commas:
c

Reset the current role of the workstation to network license client.

Reset the current role of the workstation to nodelocked license

server.

Reset the current role of the workstation to network license server.

Reset the current role of the workstation to central registry license

server.

Update the current role of the workstation to include network

license client.

Update the current role of the workstation to include nodelocked

license server.

Update the current role of the workstation to include network

license server.

Update the current role of the workstation to include central

registry license server.

-b binding_list
The complete list of servers (network license servers, nodelocked license
servers, and central registry license server) with which this workstation
Chapter 6. License Use Management Runtime Command Line Interface

167

i4cfg - Configuration Tool

will communicate in a direct binding environment. Enclose the complete
list in double quotes. Specify the network license servers, nodelocked
license servers, and central registry license server as follows:
network ip:network_address1 [ port_number1 ] ip:network_address2
[ port_number2 ] ...
nodelocked ip:network_address1 [ port_number1 ]
ip:network_address2 [ port_number2 ] ...
registry ip:network_address [ port_number ]

Code -b null to delete all previously specified entries from the binding
list.
-d option_string
Display the current configuration settings for the i4cfg options specified in
option_string. Code all to see the current settings of all the options.
For example, i4cfg -d elS requests a display of which events are being
logged, the path to the log databases, and a list of startup options showing
which are enabled and which are disabled.
-e

The list of events you want to be logged. Code a to log all events, A to
disable logging of all events or any combination of these values, optionally
separated by commas:
c - License checkin
Tells you when a licensed product has sent a check-in call to the
server to notify that the product is running. This is not logged by
default.
w - License wait
Tells you when a license request cannot be satisfied because no
licenses are available, and the user is added to a queue. This is not
logged by default.
t - License timeout
Tells you that the server has canceled the request for a license
because the check period expired. This is not logged by default.
e - Errors
Describes all types of server errors that do not stop the server. This
is logged by default.
g - License grant/release
Tells you when a license was granted or released. This is not
logged by default.
v - Vendor added/deleted
Tells you when a product of a new vendor was registered or
deleted. This is logged by default.
m - Vendor messages
Provides the log messages the vendor inserted in the enabled
product. This is logged by default.
p - Product added/deleted
Tells you when a new product was registered or deleted. This is
logged by default.
s - Server start/stop/threshold
Logs the successful start or stop of the license server, and when the
threshold on the workload is exceeded or regained. This is not
logged by default.

168

Using License Use Management Runtime

i4cfg - Configuration Tool

-h

Displays command syntax and usage information about the Configuration

Tool CLI.

-l logfile_path
The path in which you want log files to be stored.
-list

Displays a list of active subsystems.

-R

Startup options that you want to disable. Code any combination of these
values, optionally separated by commas:
a

Automatic startup of subsystems at system startup (disabled by

default).

Remote administration of nodelocked license server (disabled by

default).

Remote administration of network license server (enabled by

default).

Note: This parameter is not valid for network clients.

-S

Startup options that you want to enable. Code any combination of these
values, optionally separated by commas:
a

Automatic startup of subsystems at system startup (disabled by

default).

Remote administration of nodelocked license server (disabled by

default)

Remote administration of network license server (enabled by

default)

Note: This parameter is not valid for network clients.

-start

Starts all the subsystems you have configured to run on the workstation.
Note: If you are running in a Solaris environment and are using a
non-Korn shell, you can start the server using i4cfg -x -start. This
will close the terminal window from which this command was run
and the server will continue to work in background.

-stop

Stops all the subsystems that are running on your workstation.

-t transport_list
Use this parameter to change the default port numbers, as follows:
"ip netls_port,crls_port,nodls_port"

The three subparameters for port numbers are positional. If you omit one,
its value is reset to the default. For example:
"ip "
"ip 1516,10999,1215"
"ip ,,11999"
AIX

-c

The NCS cell the workstation is to join. This parameter is meaningful only
if namespace binding support is enabled (see the -n parameter). Code one
of the following:
d

The default cell.

A new alternate cell. The Configuration Tool creates the UUID. You
can retrieve the UUID from the glb_obj.txt file.
Chapter 6. License Use Management Runtime Command Line Interface

169

i4cfg - Configuration Tool

cell_uuid
An alternate cell with the specified UUID.
If you are configuring as a GLB replica (-r from), code this parameter to
specify which cell this server is to join.
Note: The glbd replica is not available on Linux operating systems.
-G site_list
This parameter is meaningful only if namespace binding support is
enabled (see the -n parameter). If your system does not support
broadcasting or if the global location broker is running on a workstation in
a different subnetwork, use this parameter to set the list of hosts running
the global location broker. Clients can contact the servers using the site_list.
List each server that runs the global location broker, in the form:
ip:network_address

Separate the entries with spaces, and enclose the entire list in double
quotes. Code -G null to delete a previously-specified site list. In this case,
clients must locate global location brokers by broadcasting. Before
configuring a workstation to join an existing cell, check that there is no
glb_site.txt file, or, if the file exists, that it includes a server that is in the
cell being joined. Otherwise, use -G null to delete the existing site list.
-n

-r

Specifies namespace binding support. Code one of the following:

c

Namespace binding support as a network license client only.

This workstation is to run the local location broker but not the
global location broker.

This workstation is to run the global location broker and the local
location broker.

No namespace binding support (direct binding only).

This parameter is meaningful only if namespace binding support is

enabled and this workstation is to run the global location broker (see the
-n parameter). Code first if this is to be the first global location broker in a
cell. Code from:ip:host_name to replicate the global location broker that
already exists on host_name. If you code -r from, you must also code the -c
parameter to specify which cell this server is to join.
Note: The glbd replica is not available on Linux operating systems.

-script Starts the interactive script to configure your workstation using a guided
step-by-step procedure.
Windows

-g group_name
The name of the group to which the user of this workstation belongs.

Examples
1. Configure a standalone nodelocked license server, specifying automatic startup
of the server and customizing the path to the log files and the selection of
events logged.
For example, on UNIX and AIX:
i4cfg -a n -S a -e evmps -l /home/maveret

170

Using License Use Management Runtime

i4cfg - Configuration Tool

For example, on Windows:
i4cfg -a n -S a -e evmps -l c:\ifor\ls\maveret

2. Configure a nodelocked license server in a network. Specify automatic startup

of the server, make it possible to administer licenses on another nodelocked
licensed server (louise) remotely, and customize the path to the log files and
the selection of events logged.
With direct binding on UNIX and AIX:
i4cfg -a n -S a,n -e evmps -l /home/maveret -b nodelocked ip:louise -n n

With direct binding on Windows:

i4cfg -a n -S a,n -e evmps -l c:\ifor\ls\maveret -g Infotech
-b nodelocked ip:louise

3. With namespace binding on UNIX and AIX, joining an existing cell that has
UUID 456b91c50000.0d.00.00.87.84.00.00.00:
i4cfg -a n -S a,n -e evmps -l /home/maveret -b null -n l
-c 456b91c50000.0d.00.00.87.84.00.00.00

The nodelocked license server louise must belong to the same cell.
4. Configure a network license server (thelma). Specify automatic startup of the
server, and customize the path to the log files and the selection of events
logged. Configure to communicate with:
v Network license server louise
v Nodelocked license server louise
v Nodelocked license server speedy
v Central registry license server speedy
With direct binding on UNIX and AIX:
i4cfg -a s -S a,s -e cegvp -l /home/maveret -b "network
ip:thelma ip:louise nodelocked ip:speedy ip:louise
registry ip:speedy" -n n

With direct binding on Windows:

i4cfg -a s -S a,s -e cegvp -l c:\ifor\ls\maveret -g Infotech
-t "ip" -b "network ip:thelma ip:louise
nodelocked ip:speedy ip:louise
registry ip:speedy"

With namespace binding on UNIX and AIX, starting a new alternate cell:
i4cfg -a s -S a,s -e cegvp -l /home/maveret -b null -n g -r first

Note that speedy and louise must join this new cell.
5. Configure a network license client that will communicate with a workstation
named thelma that is configured as both a network license server and the
central registry license server. For Windows specify the user group.
With direct binding on UNIX and AIX:
i4cfg -a c -b "network ip:thelma registry ip:thelma" -n n

With direct binding on Windows:

i4cfg -a c -g Infotech -b "network ip:thelma
registry ip:thelma"

With namespace binding, joining an existing cell that has UUID

456b91c50000.0d.00.00.87.84.00.00.00:
i4cfg -a c -b null -n c -c 456b91c50000.0d.00.00.87.84.00.00.00

Note that thelma must belong to the same cell.

Chapter 6. License Use Management Runtime Command Line Interface

171

i4cfg - Configuration Tool

6. Configure a workstation named thelma as the central registry license server
and a network license server. Configure to communicate with a network license
server named hydra. Specify automatic startup of the servers, and for Windows
specify the user group.
With direct binding on UNIX and AIX:
i4cfg -a s,r -S a,s -b "network ip:thelma ip:hydra
registry ip:thelma" -n n

With direct binding on Windows:

i4cfg -a s,r -S a,s -g Infotech -b "network ip:thelma ip:hydra
registry ip:thelma"

With namespace binding on UNIX and AIX, joining an existing alternate cell
that has UUID 789b91c50000.0d.00.00.87.84.00.00.00 and replicating the global
location broker at the server hydra:
i4cfg -a s,r -S a,s -b null -n g -r from:ip:hydra
-c 789b91c50000.0d.00.00.87.84.00.00.00

Note: The glbd replica is not available on Linux operating systems.

7. Cancel all entries previously made in the direct binding servers list:
i4cfg

-b null

8. Display the command syntax and usage:

i4cfg

172

-h

Using License Use Management Runtime

i4tv - Test Verification Tool

i4tv - Test Verification Tool

ALL

Use the i4tv tool after the license servers are started to verify that they are running
properly.
A message describing a completed license transaction and a list of all license
servers will be displayed. If an HAL cluster has been configured and activated,
i4tv tries to request all the 10,000 licenses of the HAL Test Product in order to
contact all the servers in serving state.

Syntax
i4tv { [ -n hostname ] [ -z ] [ -v ] | { -h | -usage | -version }
[ -p number_of_transactions ] }

Parameters
-n hostname

Checks that the specified workstation is running a network license

server. It returns 0 if the hostname is running a network license
server and 1 if the hostname is not running a network license
server.

-z

Turns on NCS remote procedure call (RPC) tracing messages,

which can be used to diagnose problems.

-v

Displays progress messages during the license request operation.

-h

Displays command usage information (same as -usage). This

parameter is valid only when issued without other parameters.

-usage

Displays command usage information (same as -h). This parameter

is valid only when issued without other parameters.

-version

Displays command version information. This parameter is valid

only when issued without other parameters.

-p [number_of_transactions]
Specifies the number of transactions to be completed before
performance information is displayed. This information provides
averages for the specified period. It can be used for tuning the
system and for troubleshooting performance problems. The default
value is 1000.

Examples
Run the i4tv test and verification tool:
i4tv

Check for the presence of the license server pluto:

i4tv -n pluto

Chapter 6. License Use Management Runtime Command Line Interface

173

i4target - Target View Tool

i4target - Target View Tool

ALL

Use the i4target tool to display the target ID of your workstation.

Syntax
i4target [ -O | -V | -o | -l | -h ]
(on AIX, and Solaris)
i4target [ -O | -V | -o | -l | -h | -v ]
(on Linux)
i4target [ -O | -V | -o | -c | -h ] [ -v ] [ -q ]
(on HP-UX)
i4target [ -O | -V | -o | -l | -h | -d devicename ] [ -z ] [ -v ]
(on Windows)

Parameters
-O

Displays the target identifier of the workstation on which you issue the
command, in the form that the license creation tool accepts.

-V

Displays command version information.

-o

Displays the operating system name of your workstation.

-c

Displays multiple target IDs for workstations, that have more than one
network connection, and enables you to change from one that is currently
in use to another (HP-UX only).

-h

Displays command usage information.

-v

Displays information in verbose mode. On Windows, the information that

this parameter displays includes the NDIS level of the device driver.

-q

Displays information in quite mode, comments are not displayed before

the output (HP-UX only).

-d devicename
Specifies that the device driver devicename is to be used to retrieve the
target ID (Windows only).

Windows

-z

Displays all the devices on the workstation; use it to check the available
network devices before using the -d parameter to select a device driver
manually (Windows only).

-l

Displays all target IDs of the workstation, starting with the most secure
(the one based on the network adapter, if it is available).

For Windows, the hardware-based (win32mac) target ID is retrieved from the

device driver that controls the network adapter, rather than from the operating
system. This mechanism results in the highest level of security and makes it
possible for the target ID to work even when the workstation is not connected to
the network.
For this mechanism to work, the following must be installed on the workstation
where the license will be installed:
v A device that complies with NDIS 4.
v The latest level of the device driver. For IBM device drivers, you can check at
http://www.networking.ibm.com to determine the latest level.

174

Using License Use Management Runtime

i4target - Target View Tool

v TCP/IP.
v If License Use Management Runtime is not yet installed on the workstation, you
can download it from the License Use Management Web site
(http://www.ibm.com/software/lum), or the vendor of the license-enabled
products can supply it to customers.
The target ID is retrieved from the device driver that controls the network adapter.
You may want to specify explicitly the device driver to be used to determine the
target ID. You would do this if either of the following points were true:
v Your workstation has multiple network adapters and you prefer to use an
adapter other than that automatically selected as the basis for the target ID.
v The target -Ol command did not return a target ID.
Perform the following steps:
1. Get the device name of the adapter you want to use, in one of the following
ways:
v For Windows 2000, Windows XP, and Windows Server 2003, to get the device
name of the adapter you want to use, enter the command:
ipconfig /all

For example, for IBM token ring adapter IBMTRP1, the information returned
includes the line:
Token ring adapter IBMTRP1:

v Alternatively for Windows, enter the command:

i4target -z

This displays all the devices on the workstation, and be sure the network
device you want to use is listed.
2. Enter the command:
i4target -d devicename

For example, i4target -d IBMTP1.

Note: The AIX PREFERRED LUM Target ID is only compatible with License Use
Management Version 4.6.6 or later. If you need a license to be installed on
an older license server, or a nodelock license for an application enabled with
an older License Use Management toolkit, then request the license using the
LUM Target ID shown second in the output of the i4target -Ol command.

Chapter 6. License Use Management Runtime Command Line Interface

175

i4lmd - Network License Server

i4lmd - Network License Server

ALL

The i4lmd subsystem starts the network license server on the local node. If the
workstation is not configured to run the network license server, i4lmd has no
effect.
The parameters of i4lmd override the corresponding settings in the i4ls.ini file.

Syntax
startprc i4lmd [ -no event_list ] [ -v ] [ -z ] [ -l log_name ]
[ -s ] [ -r ] [ -c ] [ -p ]
(on UNIX)
startsrc -s i4lmd [ -a [ -no event_list ] [ -v ] [ -z ] [ -l log_name ]
[ -s ] [ -r ] [ -c ] [ -p ]
] (on AIX)
i4ls [ -no event_list ] [ -v ] [ -z ] [ -l log_name ] [ -s ] [ -r ] [ -c ] [ -p ]
(on Windows)

Parameters
-no event_list Turns off logging of the events specified in event_list. Any
combination of events is valid, but items in the list of events must
not be separated by spaces or other characters. Following are the
event types that you can specify:

176

Grant and release licenses.

Check in licenses. (Licensed products usually check in with

the license server at regular intervals while a user is using
the product.)

Waiting events: these include wait events (a user was

waiting for a license), wait grant events (a user was
waiting for and then was granted a license), and wait
remove events (a user was waiting for a license and then
asked to be removed from the queues before a license was
granted.)

Vendor events: a vendor was added, renamed or deleted.

Product events: a product was added, renamed, or deleted.

Errors.

Messages.

Logs the successful start or stop of the license server, and

when the threshold on the workload is exceeded or
regained.

License timeout events. (When a licensed product fails to

check in with the license server, it may stop running after
it times out. The vendor of the product sets the timeout
interval, which is how long a product can run after it has
lost contact with the license server.)

-v

License Use Management Runtime library verbose mode.

-z

Debugging flag. Prints RPC debugging information.

Using License Use Management Runtime

i4lmd - Network License Server

-l log_name

Overrides the default name and location of the file used to store
log information. This allows the I/O activity to the files used by
the license server to be spread across multiple file systems that
may become important for large installations.

-s

Instructs the license server to ignore attempts from administrators

on remote systems to modify the license database. Records in the
database remain readable by all instances of the License Use
Management Runtime Administration Tool.

-r

Recovers files from the automatic backup version.

-c

Specifies that this is a cold start, meaning that the license server
restarts from scratch, as if it had granted no licenses before
stopping.

-p

Specifies that i4lmd is to display performance information at

specified intervals. The default and maximum interval is 1000 calls
received from clients. To change the frequency of reporting, change
the environment variable I4_POLL_FREQ. This option is linked to
the DebugProc tag in the i4ls.ini file.

Examples
Start a license server on UNIX and do not log checkin, vendor, product, timeout, or
message events:
startprc i4lmd -no cvptm

To start a license server, changing the default log-file on AIX:

startsrc -s i4lmd -a "-l /home/smith/my_log"

To start a license server, changing the default log-file on Windows:

i4ls -l \ifor\ls\my_log

Chapter 6. License Use Management Runtime Command Line Interface

177