OpenVMS License Management Utility Manual

Document revision date: 30 March 2001

OpenVMS License Management Utility Manual

Order Number: AA--PVXUF--TK

April 2001

This manual describes the use of the License Management Facility (LMF), the software license management tool for the OpenVMS operating system.

Revision/Update Information: This is a revised manual. This manual supersedes OpenVMS License Management Utility Manual, OpenVMS AXP Version 7.1 and OpenVMS VAX Version 7.1.

Software Version: OpenVMS Alpha Version 7.3 OpenVMS VAX Version 7.3

Compaq Computer Corporation
Houston, Texas

Compaq, VAX, VMS, and the Compaq logo Registered in U.S. Patent and Trademark Office.

OpenVMS is a trademarks of Compaq Information Technologies Group, L.P. in the United States and other countries.

All other product names mentioned herein may be trademarks of their respective companies.

Confidential computer software. Valid license from Compaq required for possession, use, or copying. Consistent with FAR 12.211 and 12.212, Commercial Computer Software, Computer Software Documentation, and Technical Data for Commercial Items are licensed to the U.S. Government under vendor's standard commercial license.

Compaq shall not be liable for technical or editorial errors or omissions contained herein. The information in this document is provided "as is" without warranty of any kind and is subject to change without notice. The warranties for Compaq products are set forth in the express limited warranty statements accompanying such products. Nothing herein should be construed as constituting an additional warranty.

ZK4584

The Compaq OpenVMS documentation set is available on CD-ROM.

Contents Index

Preface

The License Management Facility (LMF) is the software license management tool for the OpenVMS operating system. To run any software product on OpenVMS systems, you must register and load its license. To perform these tasks, use LMF.

Intended Audience

This manual is for managers of licenses for software products that run on the OpenVMS operating system. Typically, the system manager has this responsibility.

Document Structure

This manual consists of the following parts:

Chapter 1 provides an introduction to the OpenVMS LMF and to the licensing of OpenVMS layered products.
Chapter 2 describes each task required to manage software product licenses. This chapter also discusses the License Management utility (LICENSE) commands and shows how to use them.
Chapter 3 describes licensing for OpenVMS Galaxy systems.
Appendix A describes the syntax of the LICENSE commands.
Appendix B provides examples.
The Glossary defines the LMF-related terms used in this manual.

Reader's Comments

Compaq welcomes your comments on this manual. Please send comments to either of the following addresses:

Internet openvmsdoc@compaq.com

Mail Compaq Computer Corporation
OSSG Documentation Group, ZKO3-4/U08
110 Spit Brook Rd.
Nashua, NH 03062-2698

How To Order Additional Documentation

Use the following World Wide Web address to order additional documentation:

http://www.openvms.compaq.com

If you need help deciding which documentation best meets your needs, call 800-282-6672.

Conventions

The following conventions are used in this manual:

Ctrl/ x A sequence such as Ctrl/ x indicates that you must hold down the key labeled Ctrl while you press another key or a pointing device button.

PF1 x or A sequence such as PF1 x indicates that you must first press and release the key labeled PF1 and then press and release another key or a pointing device button.

[Return] In examples, a key name enclosed in a box indicates that you press a key on the keyboard. (In text, a key name is not enclosed in a box.)
In the HTML version of this document, this convention appears as brackets, rather than a box.

... A horizontal ellipsis in examples indicates one of the following possibilities:

Additional optional arguments in a statement have been omitted.
The preceding item or items can be repeated one or more times.
Additional parameters, values, or other information can be entered.

.
.
. A vertical ellipsis indicates the omission of items from a code example or command format; the items are omitted because they are not important to the topic being discussed.

( ) In command format descriptions, parentheses indicate that you must enclose choices in parentheses if you specify more than one.

[ ] In command format descriptions, brackets indicate optional choices. You can choose one or more items or no items. Do not type the brackets on the command line. However, you must include the brackets in the syntax for OpenVMS directory specifications and for a substring specification in an assignment statement.

{ } In command format descriptions, braces indicate required choices; you must choose at least one of the items listed. Do not type the braces on the command line.

bold text This typeface represents the introduction of a new term. It also represents the name of an argument, an attribute, or a reason.

italic text Italic text indicates important information, complete titles of manuals, or variables. Variables include information that varies in system messages (Internal error number), in command lines (/PRODUCER= name), and in command parameters in text (where dd represents the predefined code for the device type).

UPPERCASE TEXT Uppercase text indicates a command, the name of a routine, the name of a file, or the abbreviation for a system privilege.

Monospace text

Monospace type indicates code examples and interactive screen displays.
In the C programming language, monospace type in text identifies the following elements: keywords, the names of independently compiled external functions and files, syntax summaries, and references to variables or identifiers introduced in an example.

- A hyphen at the end of a command format description, command line, or code line indicates that the command or statement continues on the following line.

numbers All numbers in text are assumed to be decimal unless otherwise noted. Nondecimal radixes---binary, octal, or hexadecimal---are explicitly indicated.

Chapter 1
Overview

This overview introduces the OpenVMS License Management Facility (LMF) and outlines the tasks required to manage software licenses for software products.

A product license protects the intellectual property of the software vendor and provides customers with access to the product. Product authorization is usually defined in a contract with specific terms and conditions agreed upon by the software license issuer and the software user.

Compaq Computer Corporation and other software vendors provide software to their customers under an agreement called a license. In this document the term license means the authorization you have to run a software product on the OpenVMS operating system.

License Management Facility and License Agreements

The terms and conditions of your license agreement determine your legal use of software.

LMF is a management tool that can help you comply with your license agreement, but use of LMF does not indemnify you against noncompliance with the terms and conditions of your software license agreements. In other words, LMF offers options for many kinds of license agreements, but using some of these options may not be authorized by your specific license agreement. You must read your license carefully to determine which LMF options you can use legally.

This document describes some features of LMF that Compaq Computer Corporation does not currently authorize. Compaq may in the future authorize the use of some features described herein but makes no commitment beyond the current Software Business Practices.

1.1 License Management

To use a software product that requires a license, you must perform the following steps:

Obtain a Product Authorization Key (PAK), which provides information required to register the license.
Use LMF to register the license in the License Database.
Use LMF to load the license from the License Database into memory.
Install the product specified by the PAK.

LMF provides additional features to modify licenses to satisfy specific requirements of individual sites.

To manage software product licenses for OpenVMS layered software, you need to understand the following information about licenses and the tool to manage them on OpenVMS systems:

License Management utility (LICENSE) ( Section 1.2)
License Database ( Section 1.3)
License Unit Requirement Tables (LURTs) ( Section 1.4)
VMSLICENSE.COM command procedure ( Section 1.5)
Types of licenses ( Section 1.6)
Combining licenses ( Section 1.7)

1.2 License Management Utility (LICENSE)

The License Management utility (LICENSE) is the command line interface of the License Management Facility (LMF). Use LICENSE commands to interactively manage the licenses of OpenVMS layered software products and, in many cases, by third-party vendors.

LICENSE is a system-level tool that you use at the DCL prompt.

Example:
This example shows a LICENSE MODIFY command line at the DCL prompt. The command modifies the license for the Encryption for OpenVMS product in the License Database so that users can encrypt files from the node DRAMA.

$ LICENSE MODIFY ENCRYPTION - _$/ADD /INCLUDE=(DRAMA) - _$ /COMMENT="Modified to add node DRAMA 23-OCT-2000" -

For detailed information about using LICENSE commands, see Chapter 2.

1.2.1 Displaying LICENSE Information

Use the LICENSE LIST and the SHOW LICENSE commands to track and monitor your system's license information. For information about these commands, see Section 2.4.6.

1.3 License Database

The License Database is a collection of information stored in a file called the License Database on a disk that contains information about each license on your system. The default database file is SYS$COMMON:[SYSEXE]LMF$LICENSE.LDB, which is created by LMF when you install the OpenVMS software.

The terms of each license are stored in a collection of data fields in the database. You enter data by:

Issuing LICENSE commands
Executing the VMSLICENSE.COM command procedure

In addition, LMF enters data and keeps records. The collection of data fields representing a license at any one time is called a record. When you first register a license, you create the first record with data specified in your PAK. If you later modify the license, LMF creates a new record to define the modified terms of the license, and includes a notation that the license was modified.

Figure 1-1 illustrates the relationship between the LMF, the LUR and the License Database.

Figure 1-1 The Licensing Model

1.3.1 History Records

LMF keeps track of the licensing activity on your system by writing a history record to the License Database every time you modify a PAK. Each history record contains an exact copy of the following:

License record before modification
LICENSE command you used to modify the record
Date and time that you made the changes

The history record also logs the username of the person who made the changes to the PAK. For information about viewing and purging these records, see Section 2.2.2.

1.4 License Units and License Unit Requirement Tables

A license unit is a measurement of the authorization granted for use of a product. License units define the size of each license. Each license has a size, specified in license units. Each processor has a series of license unit requirements, also specified in license units.

The license unit requirements of a processor are expressed in a rating. LMF contains ratings (in license units) for all available and appropriate processors in a table called the License Unit Requirement Table (LURT). There is a LURT for each category of software products as identified on the PAK. The PAK contains two fields, the Activity Table Code and the Availability Table Code, that contain information to identify the category of the software product. Typically, processors that provide more performance have greater license unit requirements, but ratings may be unrelated to performance.

The size of a software product license must be large enough to support the number of either users or processes using the product and the processor on which the product is to run. LMF compares the size of a registered license to the rating of the current processor and authorizes product use when a license supplies sufficient license units.

A copy of each LURT is published in either the OpenVMS release notes or in the installation documentation. Use the following command to determine the license unit requirements of your system:

$ SHOW LICENSE/UNIT_REQUIREMENTS

LMF compares the size of a registered license to the license unit requirement for the current processor and authorizes product use when a license supplies sufficient license units.

To check whether your license has an appropriate license unit value (size) for your processor, LMF performs the following process:

It looks for a code (A, B, C, D, E, F, G, H or I) or a keyword (CONSTANT integer) next to either the Availability Table Code: field or the Activity Table Code: field in the registered license.
- If the license specifies CONSTANT and an integer value, LMF stops and defines the license unit requirement as equal to the stated integer value. This value could be the decimal value 0, which means the license has no unit limitations.
- If the license does not specify a constant unit requirement, LMF looks for a code that specifies license type and corresponds to a LURT.
Each LURT has a rating, in license units, for all available (and appropriate) processors. For example, the LURT for layered products includes the name of every processor that can run OpenVMS and associates a number of license units with each. The LURT for OpenVMS workstations includes the names of all OpenVMS workstations and their ratings. When Compaq releases new processors, OpenVMS updates the tables as part of the new processor support.
LMF determines the model name of your processor. Although this manual generally refers to computer systems as processors, LMF actually identifies a system by its System Marketing Model (SMM) name, which is the model name of a computer system used in marketing and pricing. The SMM is generally the name on the front panel of the processor cabinet.
LMF locates the SMM in the appropriate LURT and selects the value that specifies the number of units required for the named SMM and type of license.
LMF compares the number selected from the LURT to the number of units registered for your product license. If you have registered a value sufficient for your license and processor, the license is loaded successfully with the LICENSE LOAD command.

Table 1-1 shows an example of a License Unit Requirement Table. See either the OpenVMS release notes or the installation documentation for current LURTs.

Table 1-1 Sample License Unit Requirement Table F (Layered Products)
System Marketing Model Number of License Units Required

VAX 8800 2500

VAX 8700 1800

VAX 8650 1500

. .

. .

. .

MicroVAX A 135

MicroVAX 2000 135

**Table 1-1 Sample License Unit Requirement Table F (Layered Products)**
System Marketing Model	Number of License Units Required
VAX 8800	2500
VAX 8700	1800
VAX 8650	1500
.	.
.	.
.	.
MicroVAX A	135
MicroVAX 2000	135

The number of license units registered with any license should match or exceed the number of license units required for the specified product to run on the specified processor. For example, when you obtain a license for Compaq Pascal to run on a VAXstation 3100 system, that Pascal license must specify at least the same number of license units as the LURT requires for a VAXstation 3100 system. The same Pascal license may not provide enough license units to authorize use of Pascal on a VAX 9000 system. The size of the license to run a software product on an OpenVMS Cluster environment must reflect the total number of concurrent users or processes and the processors on which the product will run.

Not all licenses have a specific number of units. Some licenses specify zero units, which is equivalent to unlimited units.

1.5 VMSLICENSE.COM

LMF provides the command procedure VMSLICENSE.COM to register, manage, and track software licenses. VMSLICENSE.COM provides a menu-driven interface that allows you to easily register and load your licenses. VMSLICENSE.COM executes LICENSE commands, which you can also issue manually. See Appendix A for a full description of each LICENSE command.

1.6 Types of Licenses

Different types of software product licenses enable you to allow access to each product in ways that range from access for a specific user on a specific processor to general access for all users on all processors with in an OpenVMS Cluster. Table 1-2 describes the licenses that LMF supports.

Table 1-2 Types of Licenses
Type Identification on PAK License by See

Availability Availability Table Code has a nonzero value. Processor type (Requires Key Option ALPHA or VAX_ALPHA to load on Alpha processor.) Section 1.6.1

Activity Activity Table Code has a nonzero value. Concurrent uses (not users) Section 1.6.2

User Activity constant and Key Options: USER. Concurrent users (not uses) Section 1.6.4

Personal Use Activity constant and Key Options: RESERVE_UNITS. Named user Section 1.6.3

**Table 1-2 Types of Licenses**
Type	Identification on PAK	License by	See
Availability	Availability Table Code has a nonzero value.	Processor type (Requires Key Option ALPHA or VAX_ALPHA to load on Alpha processor.)	Section 1.6.1
Activity	Activity Table Code has a nonzero value.	Concurrent uses (not users)	Section 1.6.2
User	Activity constant and Key Options: USER.	Concurrent users (not uses)	Section 1.6.4
Personal Use	Activity constant and Key Options: RESERVE_UNITS.	Named user	Section 1.6.3

The license descriptions that follow provide information to help you understand and manage the product authorization process on VAX or Alpha computers using LMF, rather than to help you order software licenses. Compaq provides licenses in many ways that may not always correspond to the examples in this manual. Check with your Compaq support representative for ordering information, and check the terms and conditions of your license contracts for restrictions.

Contents

Index

privacy and legal statement

4584PRO.HTML

Internet	openvmsdoc@compaq.com
Mail	Compaq Computer Corporation OSSG Documentation Group, ZKO3-4/U08 110 Spit Brook Rd. Nashua, NH 03062-2698

Ctrl/ x	A sequence such as Ctrl/ x indicates that you must hold down the key labeled Ctrl while you press another key or a pointing device button.
PF1 x or	A sequence such as PF1 x indicates that you must first press and release the key labeled PF1 and then press and release another key or a pointing device button.
`[Return]`	In examples, a key name enclosed in a box indicates that you press a key on the keyboard. (In text, a key name is not enclosed in a box.) In the HTML version of this document, this convention appears as brackets, rather than a box.
...	A horizontal ellipsis in examples indicates one of the following possibilities: Additional optional arguments in a statement have been omitted. The preceding item or items can be repeated one or more times. Additional parameters, values, or other information can be entered.
. . .	A vertical ellipsis indicates the omission of items from a code example or command format; the items are omitted because they are not important to the topic being discussed.
( )	In command format descriptions, parentheses indicate that you must enclose choices in parentheses if you specify more than one.
[ ]	In command format descriptions, brackets indicate optional choices. You can choose one or more items or no items. Do not type the brackets on the command line. However, you must include the brackets in the syntax for OpenVMS directory specifications and for a substring specification in an assignment statement.
{ }	In command format descriptions, braces indicate required choices; you must choose at least one of the items listed. Do not type the braces on the command line.
bold text	This typeface represents the introduction of a new term. It also represents the name of an argument, an attribute, or a reason.
italic text	Italic text indicates important information, complete titles of manuals, or variables. Variables include information that varies in system messages (Internal error number), in command lines (/PRODUCER= name), and in command parameters in text (where dd represents the predefined code for the device type).
UPPERCASE TEXT	Uppercase text indicates a command, the name of a routine, the name of a file, or the abbreviation for a system privilege.
Monospace text	Monospace type indicates code examples and interactive screen displays. In the C programming language, monospace type in text identifies the following elements: keywords, the names of independently compiled external functions and files, syntax summaries, and references to variables or identifiers introduced in an example.
-	A hyphen at the end of a command format description, command line, or code line indicates that the command or statement continues on the following line.
numbers	All numbers in text are assumed to be decimal unless otherwise noted. Nondecimal radixes---binary, octal, or hexadecimal---are explicitly indicated.