Set up the IBM Common Licensing token service key
on a Jazz® Team Server.
Before you begin
Verify the following items:
- You have installed the latest version of IBM License Key
Server. For instructions on how to install the product, see the IBM Common Licensing
documentation.
- You have administrative access to Jazz Team Server.
- You have the license.dat and JazzTokens.zip files that
you downloaded from the IBM
License Key Center.
For more details about token licensing, contact your local IBM marketing representative.
Note: The IBM License
Key Server does not run on IBM i, Linux for System z, or z/OS. If you use IBM Common
Licensing, you need to set up a separate Jazz Team Server
on any other supported platform and connect it to the Common Licensing token server to manage your
token licenses. You can then use this Jazz Team Server
as a floating license key server for your Jazz Team Server
running on IBM i, Linux for System z, or z/OS.
About this task
The IBM Common Licensing Token Service is an
extension of the Jazz Team Server
that allows token requests to be forwarded to a IBM License
Key Server. When the Jazz Team Server
requests a certain number of tokens, the extension checks out the tokens from a IBM License Key Server. This integration allows Jazz-based products and non-Jazz based products to
share the same tokens.Note: This integration is only available for IBM
Rational products.
Procedure
- If you are using IBM i, Linux for System Z, or z/OS, install a
Jazz Team Server and IBM License Key Server on a supported platform. For more information on installing Jazz Team Server, see the interactive install
guide. In the topic Running the setup wizard, note the following changes:
- Disable email notification.
You will have no installed applications on this
Jazz Team Server.
- Do not register any additional applications.
You will only be using this
Jazz Team Server
as a floating license server.
- Configure IBM License Key Server:
- Launch the License Key Administrator.
- Download the license.dat file that contains tokens from the
License Key Center.
- In the License Key Administrator, click .
- Select the license.dat file.
- Stop and restart the License Key Server. You will be prompted to do this after
importing the license.dat file.
- Close the License Key Administrator.
- Install the token client access licenses on your Jazz Team Server:
-
Extract the JazzTokens.zip file to a temporary location on your
drive.
- Log in to the Administration page of the Jazz Team Server.
Point your web browser to
https://[fully qualified
hostname]:9443/jts/admin
Remember: The [fully qualified hostname]
is the host name
along with the DNS domain reference of the machine on which the Jazz Team Server
is installed.
- On the Administration page, click the
Server tab.
- In the Licensing section, click License Key management.
- Scroll down to the Floating License Server section.
- In the Floating License Server section, click Add.
-
In the Upload License Files window, click Choose File and browse for the
temporary location that you extracted the JazzTokens.zip file and choose one of
the license .jar files.
-
Click Finish.
You must accept the license agreement for each license that you upload.
-
Repeat steps g. and h. to upload other license files.
After the license keys have been uploaded, you will see the licenses listed under the
Floating License Server section.
- Enable the token license service on your Jazz Team Server:
- Hover over IBM Common Licensing Service
until you see the icon in the Actions column. Click the icon to view the server
configuration dialog.
- Configure the following two properties in the dialog:
- IBM License Key Server: Provide the URL (in the
format
license_key_port_number@license_key_hostname)
for the IBM License Key Server you installed.
Tip: In the License Key Administrator application, click to display identification information for the server. You can also run the
LMTOOLS program (located at
License_Key_Server_install_directory/common) and click
to verify the connection information).
- Token Lease Timeout: Specify how long (in milliseconds) a user can be inactive before the
token lease expires.
- Click Finish.
If the connection succeeds, you'll see
a green checkmark (
) in the Status column.
- To clear the settings, click the Edit icon again. Clear the
hostname field and enter 1800000 in the timeout field. Click Finish.
Note: The default timeout for token license is 1800000 milliseconds (30 minutes) and the default
timeout for floating license is 3600 seconds (60 minutes). The minimum amount of time that can be
set for both token and floating licenses timeout is 30 minutes, 1800000 milliseconds for token and
1800 seconds for floating. Note that the timeout is measured differently for these licenses. Token
license timeout is measured in milliseconds and floating license timeout is measured in
seconds.
- Optional: Configure other Jazz Team Servers to
point to the floating license server:
-
Before you can configure your Jazz Team Server to
point to a floating licensing server, you must add friend relationship between the two servers and
create a functional user ID that is associated with the friend operation. You can use the
-createFriend repotools command to create the friend relationship and associate a
functional user ID. For more information about the usage of the repotools command, see Repository
tools command to create a friend relationship.
- On the Administration page of the Jazz Team Server,
click the Server tab.
- In the Licensing pane, click License Key
Management.
- In the Server Information section, hover over the Floating
License Server row and click the icon.
- In the Configure Floating License Server dialog box, in the
Floating License Server field, type the path to the server. For example,
http://floating-license-server:9443/jts, where
floating-license-server must be replaced with the fully qualified host name of
your server.
- To test the server connection, click Test
Connection.
- Click Finish.
What to do next
For users to participate in the pool of Token licenses, you must assign users one of the Token
license types. For more information on assigning licenses, see Assigning client access licenses to users or Assigning default licenses to new users.