HELP LICENSE — VMS 5.0
Invokes the License Management Utility (LICENSE), used to manage
software licenses on the VMS operating system. For a complete
description of the License Utility, see the VMS License Management
Utility Manual.
The License Management Utility (LICENSE) is a DCL-level interface to
the License Management Facility (LMF) on the VMS operating system.
The LMF provides a variety of system-level software components used
to maintain software license information in the LICENSE database
located in SYS$COMMON:[SYSEXE]LMF$LICENSE.LDB.
Use LICENSE to manage and modify the LICENSE database, and to
control run-time activation of the licenses registered there. Some
software products require license registration as part of the normal
product installation before users can access the product.
Format:
LICENSE subcommand parameter
Additional information available:
AMENDCANCELCREATEDISABLEENABLEISSUELIST
LOADMODIFYREGISTERSTARTUNLOAD
Usage summary
To use the License Management Utility (LICENSE), enter the LICENSE command and the desired LICENSE subcommand and qualifiers at the DCL prompt ($). For example, you can enter short commands on one line: $ LICENSE LIST VAX-VMS/AUTHORIZATION=USA12345 Or you can enter long command strings followed by a a hyphen (-) before pressing each RETURN. $ LICENSE REGISTER FORTRAN /ISSUER=DEC /AUTHORIZATION=USA-1957 - _$ /PRODUCER=DEC /UNITS=1200 /VERSION=4.6 - _$ /AVAILABILITY=F /CHECKSUM=1-GEAD-MIDJ-IDNC-DLAC Enter the LICENSE commands carefully. LICENSE command strings can be very long and can require hyphen (-) characters at the end of each line. Because LMF may return only a checksum error when you omit or incorrectly enter information, carefully check the characters typed on each line before you press RETURN. The command procedure SYS$UPDATE:VMSLICENSE.COM eliminates some typing needed for the LICENSE REGISTER and LICENSE AMEND commands. All the LICENSE commands except LICENSE START, LICENSE LOAD, and LICENSE UNLOAD manipulate only the LMF database. Thus, to enter most LICENSE commands, you need only the privileges required to access the LICENSE database. The LICENSE database is file based; normal VMS file protection applies. The LMF provides the database with a default file access of read and write privileges to system-level processes (S:RW). To enter the LICENSE START, LICENSE LOAD, and LICENSE UNLOAD commands, you need the privilege to change mode to kernel (CMKRNL), to create system logical names (SYSNAM), and system privileges (SYSPRV). To display a listing of current and history records of licenses registered in the LICENSE database, use the LICENSE LIST command. To display the licenses active on the current node, use the DCL command SHOW LICENSE. Some products automatically register a license when you install the product. Although in this case you do not need to use the LICENSE REGISTER command, you can use other LICENSE commands with these automatically registered licenses. The automatically registered licenses appear in the LICENSE database along with other licenses.
AMEND
Changes a license currently in the LICENSE database. A Product
Authorization Amendment (PAAM) provides the product name and
information you need to amend the license. You must enter all
information provided by your PAAM exactly as it is specified.
Use THE LICENSE AMEND command only when you have new data to enter
from a PAAM. Use the LICENSE MODIFY command to make all other
license changes.
Format: LICENSE AMEND product-name
Additional information available:
Parameter
product-name Name of the product with a license to amend. You can only amend licenses that currently exist in the LICENSE database. Enter the product name exactly as it is specified on your PAAM.
Qualifiers
Additional information available:
/AUTHORIZATION/CHECKSUM/DATABASE/DATE
/HARDWARE_ID/ISSUER/OPTIONS/PRODUCER/TERMINATION
/TOKEN/UNITS/VERSION
/AUTHORIZATION
/AUTHORIZATION = string Specifies a string that along with ISSUER uniquely identifies the license you want to amend. If the PAAM supplies an authorization string, you must enter the string exactly as it is specified on your PAAM.
/CHECKSUM
/CHECKSUM = string Specifies a 17-character verification string created by the PAK Issuer for each PAAM. The checksum string is presented in the format n-cccc-cccc-cccc-cccc, where n is an integer and c is a character from A through P. A PAAM presents the checksum string with hyphen (-) characters for readability. Because LMF does not count them for authorization, you can leave them out. Otherwise, you must enter the checksum string exactly as specified on your PAAM.
/DATABASE
/DATABASE = filespec Specifies the location of the LICENSE database file. The default file specification is SYS$COMMON:[SYSEXE]LMF$LICENSE.LDB.
/DATE
/DATE = date Specifies a product date such that the license authorizes use of all product versions released on or before the date. If your PAAM supplies a product date, you must enter the information exactly as specified. The data must be presented in the standard VMS syntax: dd-mmm-yyyy.
/HARDWARE_ID
/HARDWARE_ID = string Specifies the identification number of the hardware on which the product is licensed. If your PAAM supplies hardware identification, you must enter the information exactly as specified.
/ISSUER
/ISSUER = string Specifies the name of the company (for example, DEC) that issued the PAK for the product. Note that the PAK issuer is often the same as the producer. If your PAAM supplies a PAK issuer, you must enter the information exactly as it is specified on your PAAM.
/OPTIONS
/OPTIONS = [(keyword[,...])]
Specifies a LICENSE option or a list of LICENSE options. If your
PAAM supplies license option information, you must enter the
information exactly as it is specified on your PAAM.
Current option keywords include the following:
Keyword Meaning
------- -------
MOD_UNITS The number of license units can be modified.
NO_SHARE The license cannot be used by more than one processor
in a VAXcluster. If this license is used in a
VAXcluster, you must designate it for one node using
LICENSE MODIFY with an /INCLUDE qualifier.
If you enter more than one keyword, separate each with a comma and
enclose them in parentheses.
/PRODUCER
/PRODUCER = string Specifies the name of the company (for example, DEC) that owns the product for which you have a license. If your PAAM supplies a producer, you must enter the information exactly as it is specified on your PAAM.
/TERMINATION
/TERMINATION = date Specifies the date at which the product license terminates. If your PAAM supplies a license termination date, you must enter it exactly as specified. The data must be presented in the standard VMS syntax: dd-mmm-yyyy.
/TOKEN
/TOKEN = string Specifies a string of information associated with some products. This option can enable or disable certain product features. See your product documentation for details. If your PAAM provides TOKEN information, you must enter it exactly as specified.
/UNITS
/UNITS = number Specifies the number of units that you want to amend. If your PAAM supplies the number of units, you must enter them exactly as they are specified on your PAAM.
/VERSION
/VERSION = nn.nn Limits the version number of the product for which you have a license. Use the syntax integer.integer. If your PAAM supplies version information, you must enter it exactly as specified.
Examples
1. $ LICENSE AMEND FORTRAN /PRODUCER=DEC /ISSUER=DEC -
_$ /AUTHORIZATION=USA4321 -
_$ /CHECKSUM=1-GEAD-OODA-HIDN-PLAC /VERSION=4.6
This command amends the license for the DIGITAL software product
named FORTRAN. Entering this command upgrades an existing FORTRAN
license to Version 4.6. The producer name, issuer name,
authorization number, and checksum number are typed exactly as they
appear on the PAAM for FORTRAN.
2. $ LICENSE AMEND VAXINFO /PRODUCER=DEC /ISSUER=DEC -
_$ /AUTHORIZATION=USA1234 /CHECKSUM=1-FFFL-ONNA-DAHH-BCKK -
_$ /TERMINATION=12-DEC-1989
This command amends the license for the DIGITAL software product
named VAXINFO. Entering this command changes the current termination
date to December 12, 1989. The producer name, issuer name,
authorization number, checksum number, and termination date are
typed exactly as they appear on the PAAM for VAXINFO.
CANCEL
Specifies a new termination date for a product currently in the
LICENSE database. You must use the /TERMINATION=date qualifier. Use
only as many of the other qualifiers as needed to identify the
license. For example, if the product name is not unique, add the
producer name or authorization string to identify the license.
To enable a license you have cancelled, use the LICENSE CANCEL
command again to specify a new, later cancellation date.
Format: LICENSE CANCEL /TERMINATION=date product-name
Additional information available:
Parameter
product-name Name of the product with a license to be set for cancellation. You can only cancel licenses currently in the LICENSE database.
Qualifiers
Additional information available:
/AUTHORIZATION/DATABASE/ISSUER/PRODUCER
/TERMINATION
/AUTHORIZATION
/AUTHORIZATION = string Specifies a string that along with ISSUER uniquely identifies the license you want to cancel. This qualifier is optional.
/DATABASE
/DATABASE = filespec Specifies the location of the LICENSE database file. The default file specification is SYS$COMMON:[SYSEXE]LMF$LICENSE.LDB. This qualifier is optional; use it only if you do not use the default LICENSE database name and location.
/ISSUER
/ISSUER = string Specifies the name of the company (for example, DEC) that issued the PAK for the product. Note that the PAK issuer is often the same as the producer. Use this optional qualifier only if you need it to identify the license.
/PRODUCER
/PRODUCER = string Specifies the name of the company (for example, DEC) that owns the product for which you have a license. Use this optional qualifier only if you need it to identify the license.
/TERMINATION
/TERMINATION = date Specifies the date at which the product license is to be terminated. This qualifier is required with the LICENSE CANCEL command. If your PAK or most recent PAAM supplied a license termination date, LMF uses the earliest date to determine the termination date. The data must be presented in the standard VMS syntax: dd-mmm-yyyy.
Example
$ LICENSE CANCEL/AUTHORIZATION=USA1776 -
_$ /TERMINATION=04-JUL-1989 VAX-VMS
Unless an earlier termination date exists, this command sets a new
cancellation date of July 4, 1989 for the license on VAX/VMS. Note
that the product name is entered with a hyphen (-) character as it
was specified on the PAK.
CREATE
Creates a LICENSE database with no license records. LMF creates a
default LICENSE database in SYS$COMMON:[SYSEXE]LMF$LICENSE.LDB. Thus
you do not typically need to specify this command. Note that you
must have a LICENSE database file, and the License Unit Requirement
Table file, SYS$COMMON:[SYSEXE]LMF$LURT.DAT, before you can use LMF.
Format: LICENSE CREATE
Additional information available:
Qualifier
Additional information available:
/DATABASE
/DATABASE = filespec Specifies the location of the LICENSE database file. The default file specification is SYS$COMMON:[SYSEXE]LMF$LICENSE.LDB.
Example
$ LICENSE CREATE/DATABASE=SYS$MANAGER:LMF$LICENSE.LDB
This command creates the LICENSE database file in the directory
SYS$MANAGER.
DISABLE
Disables an existing license in the LICENSE database. A disabled
license cannot be activated to authorize product use. The LICENSE
DISABLE command does not immediately affect any active processes.
Active processes are affected only if you enter a LICENSE UNLOAD
command or if the system shuts down.
Format: LICENSE DISABLE product-name
Additional information available:
Parameter
product-name Name of the product with a license to be disabled. You can only disable licenses that currently exist in the LICENSE database. Enter the product name exactly as it was specified on your PAK.
Qualifiers
Additional information available:
/AUTHORIZATION/DATABASE/ISSUER/PRODUCER
/AUTHORIZATION
/AUTHORIZATION = string Specifies a string that along with ISSUER uniquely identifies the license you want to disable. Use this optional qualifier only if you need it to identify the license.
/DATABASE
/DATABASE = filespec Specifies the location of the LICENSE database file. The default file specification is SYS$COMMON:[SYSEXE]LMF$LICENSE.LDB. This qualifier is optional; use it only if you do not use the default LICENSE database name and location.
/ISSUER
/ISSUER = string Specifies the name of the company (for example, DEC) that issued the PAK for the product. Use this optional qualifier only if you need it to identify the license.
/PRODUCER
/PRODUCER = string Specifies the name of the company (for example, DEC) that owns the product for which you have a license. Use this optional qualifier only if you need it to identify the license.
Example
$ LICENSE DISABLE VAXSET /PRODUCER=DEC
This command disables the license for VAXSET, produced by Digital
Equipment Corporation (DEC). Because no database is specified, LMF
uses the default database.
ENABLE
Enables an existing license in the LICENSE database so that it can
be activated with the LICENSE LOAD command. This command cancels the
effect of the LICENSE DISABLE and LICENSE ISSUE commands. Newly
registered licenses are enabled by default.
Format: LICENSE ENABLE product-name
Additional information available:
Parameter
product-name Name of the product with a license to be enabled. You can only enable licenses that currently exist in the LICENSE database. Enter the product name exactly as it was specified on your PAK.
Qualifiers
Additional information available:
/AUTHORIZATION/DATABASE/ISSUER/PRODUCER
/AUTHORIZATION
/AUTHORIZATION = string Specifies a string that along with ISSUER uniquely identifies the license you want to enable. Use this optional qualifier only if you need it to identify the license.
/DATABASE
/DATABASE = filespec Specifies the location of the LICENSE database file. The default file specification is SYS$COMMON:[SYSEXE]LMF$LICENSE.LDB. This qualifier is optional; use it only if you do not use the default LICENSE database name and location.
/ISSUER
/ISSUER = string Specifies the name of the company (for example, DEC) that issued the PAK for the product. Use this optional qualifier only if you need it to identify the license.
/PRODUCER
/PRODUCER = string Specifies the name of the company (for example, DEC) that owns the product for which you have a license. Use this optional qualifier only if you need it to identify the license.
Example
$ LICENSE ENABLE VAXSET /PRODUCER=DEC This command enables the license for VAXSET, produced by Digital Equipment Corporation (DEC). Because no database is specified, LMF uses the default database.
ISSUE
Produces a replica of a PAK that is sent to a file or displayed on
your terminal (the default). If the terms and conditions of your
license contract allow it, you can then enter this PAK replica in
the LICENSE database of another processor. When you enter a LICENSE
ISSUE command, LMF disables the license in the current LICENSE
database and marks the license ISSUED. To enable a license that has
been marked ISSUED, enter the LICENSE ENABLE command.
Format: LICENSE ISSUE product-name
Additional information available:
Parameter
product-name Name of the product with a license to be issued. You can only issue licenses that currently exist in the LICENSE database. Enter the product name exactly as it was specified on your PAK.
Qualifiers
Additional information available:
/AUTHORIZATION/DATABASE/ISSUER/OUTPUT/PRODUCER
/AUTHORIZATION
/AUTHORIZATION = string Specifies a string that along with ISSUER uniquely identifies the license you want to issue. Use this optional qualifier only if you need it to identify the license.
/DATABASE
/DATABASE = filespec Specifies the location of the LICENSE database file. The default file specification is SYS$COMMON:[SYSEXE]LMF$LICENSE.LDB. This qualifier is optional; use it only if you do not use the default LICENSE database name and location.
/ISSUER
/ISSUER = string Specifies the name of the company (for example, DEC) that issued the PAK for the product. Use this optional qualifier only if you need it to identify the license.
/OUTPUT
/OUTPUT[=filespec] Specifies the name of the file to which your PAK replica is written. If you do not specify the /OUTPUT qualifier, or if you do not supply a file specification with this qualifier, the output is sent to SYS$OUTPUT.
/PRODUCER
/PRODUCER = string Specifies the name of the company (for example, DEC) that owns the product for which you have a license. Use this optional qualifier only if you need it to identify the license.
Example
$ LICENSE ISSUE /OUTPUT=SYS$MANAGER:VOLSHAD.PAK -
_$ /PRODUCER=DEC VOLSHAD
Software Product Authorization Key Replica
Issued by BEGLEY
Issued on 24-FEB-1988 14:23
-----------------------------------
Issuer: DEC
Authorization: USA126087
Product Name: VOLSHAD
Producer: DEC
Units: 460
Version: 5.0
Termination Date: 31-DEC-1988
Availability: E
Options: MOD_UNITS
Checksum: 1-ADEB-DOCJ-NENC-KDBM
This command issues a PAK replica, which you can use to register the
VOLSHAD (Volume Shadowing) license on a new processor (or
VAXcluster), to the file named VOLSHAD.PAK. The next step is to
print the file, read the information and, using a LICENSE REGISTER
command, or VMSLICENSE.COM, enter the correct information into the
LICENSE database of the new processor. The VOLSHAD license in the
current LICENSE database is marked ISSUED.
LIST
Displays information from the LICENSE database about the specified
license or licenses. You can control the form, content, and location
of information displayed with the /BRIEF, /FULL, /HISTORY, and
/OUTPUT qualifiers. Note that when you use the /BRIEF qualifier,
LICENSE LIST does not produce a display with history records. When
you use the /HISTORY qualifier, a full license records are
displayed.
You use the other qualifiers only as needed to
identify the license.
Format: LICENSE LIST [product-name]
Additional information available:
Parameter
product-name Name or names of products with licenses to list. You can only list licenses that currently exist in the LICENSE database. You can specify one product name, or the wildcard character (*) to display all the licenses, but cannot specify partial wildcards (combinations of characters with the wildcard character), or a list of product names. This parameter is optional; the default is to display all of the licenses.
Qualifiers
Additional information available:
/AUTHORIZATION/BRIEF/DATABASE/DATE/FULL
/HISTORY/ISSUER/OUTPUT/PRODUCER/VERSION
/AUTHORIZATION
/AUTHORIZATION = string Specifies a string that along with ISSUER uniquely identifies the license you want to list. Use this optional qualifier only if you need it to identify the license.
/BRIEF
/BRIEF (default) Specifies a listing from the LICENSE database that includes product names and producers only.
/DATABASE
/DATABASE = filespec Specifies the location of the LICENSE database file. The default file specification is SYS$COMMON:[SYSEXE]LMF$LICENSE.LDB. This qualifier is optional; use it only if you do not use the default LICENSE database name and location.
/DATE
/DATE = date Specifies a listing from the LICENSE database that includes only licenses with a release date on or after the date specified. The data must be presented in the standard VMS syntax: dd-mmm-yyyy.
/FULL
/FULL Specifies a listing from the LICENSE database that includes a full display of the specified license or licenses.
/HISTORY
/HISTORY Specifies a listing from the LICENSE database that includes the history records in the LICENSE database for the specified license or licenses.
/ISSUER
/ISSUER = string Specifies the name of the company (for example, DEC) that issued the PAK for the product. Use this optional qualifier only if you need it to identify the license.
/OUTPUT[=filespec]
/OUTPUT[=filespec] Specifies the name of the file to which your list is written. If you do not specify the /OUTPUT qualifier, or if you do not supply a file specification with this qualifier, the output is sent to SYS$OUTPUT.
/PRODUCER
/PRODUCER = string Specifies the name of the company (for example, DEC) that owns the product for which you have a license. Use this optional qualifier only if you need it to identify the license.
/VERSION
/VERSION = nn.nn Specifies the version number of the product for which you have a license. Versions use the syntax integer.integer. Use this optional qualifier only if you need it to identify the license.
Examples
1. $ LICENSE LIST
Press CTRL/Z to exit, use arrow keys to scroll.
Product Name: Producer
-----------------------------------
FORTRAN DEC
COBOL DEC
PASCAL DEC
[End of List]
This command displays a list of the names of product licenses in the
LICENSE database. This command is equivilent to LICENSE LIST/BRIEF *.
2. $ LICENSE LIST /FULL /HISTORY FORTRAN
Press CTRL/Z to exit, use arrow keys to scroll.
License Management Facility
LICENSE database File: ART::SYS$COMMON:[SYSEXE]LMF$LICENSE.LDB
Created on: 17-AUG-1988
Created by user: MONET
LMF Version: V1.0
------------------------------------------------------
Issuer: DEC
Authorization: USA-2468
Product Name: FORTRAN
Producer: DEC
Units: 0
Modified Units: 2000
Version: V4.5
Date: (none)
Termination Date: 21-DEC-1990
Modified Termination Date: 10-NOV-1989
Availability: F (Layered Products)
Activity: 000000000
Options: MOD_UNITS
Hardware ID:
Revision Level: 2
Status: Active
Command: MODIFY
Modified by user: DEGAS
Modified on: 19-AUG-1989 14:32:23.41
Include: ART
-----------------------------------
Issuer: DEC
Authorization: USA-2468
Product Name: FORTRAN
Producer: DEC
Units: 0
Modified Units: 9999
Version: V4.5
Date: (none)
Termination Date: 21-DEC-1990
Availability: F (Layered Products)
Activity: 000000000
Options: MOD_UNITS
Hardware ID:
Revision Level: 1
Status: History
Command: AMEND
Modified by user: DEGAS
Modified on: 29-AUG-1988 12:12:27.33
[End of List]
This command displays a listing with full information of a current
and past FORTRAN license issued by DIGITAL.
LOAD
Activates a license or licenses making them available for product
authorization for the current node. The product license or licenses
must currently exist and be active in the LICENSE database. If the
license is already loaded, the LMF returns an error message and
makes no changes.
To use this command you need the privileges to change mode to kernel
(CMKRNL), to create system logical names (SYSNAM), and system
privileges (SYSPRV).
Format: LICENSE LOAD [product-name]
Additional information available:
Parameter
product-name Name of the licensed product to be activated. You can only load a licensed product name that currently exists in the LICENSE database. Enter the product name exactly as it was specified on your PAK. If you do not specify a product name, LICENSE LOAD activates all of the products that are registered and enabled.
Qualifiers
Additional information available:
/DATABASE
/DATABASE = filespec Specifies the location of the LICENSE database file. The default file specification is SYS$COMMON:[SYSEXE]LMF$LICENSE.LDB. This qualifier is optional; use it only if you do not use the default LICENSE database name and location.
/PRODUCER
/PRODUCER = string Specifies the name of the company (for example, DEC) that owns the product for which you have a license. Use this optional qualifier only if you need it to identify the license.
Examples
1. $ LICENSE UNLOAD FORTRAN
$ LICENSE MODIFY/INCLUDE=MUSIC FORTRAN
$ LICENSE LOAD FORTRAN
The commands in this example illustrate a situation where you enter
a LICENSE LOAD command interactively. The LICENSE LOAD command
activates the product FORTRAN on the node MUSIC. Data in the LICENSE
database determines how much product use is available to users.
2. $ LICENSE LOAD BASIC
%LMF-F-NOLOAD, License not loaded -- BASIC
$
This command attempts to activate the product BASIC, but the LICENSE
LOAD command fails because too few license units are registered to
authorize use on the current processor.
MODIFY
Modifies a license for system management and license sharing
purposes. The LICENSE MODIFY command changes data in the LICENSE
database immediately, but the modifications do not affect a running
system until you activate the modified license with a LICENSE LOAD
command.
Use the LICENSE AMEND command to change a license when you have a
PAAM.
Format: LICENSE MODIFY product-name
Additional information available:
Parameter
product-name Name of the product with a license to be modified. You can only modify licenses that currently exist in the LICENSE database. Enter the product name exactly as it was specified on your PAK.
Qualifiers
Additional information available:
/AUTHORIZATION/COMMENT/DATABASE/EXCLUDE
/INCLUDE/ISSUER/PRODUCER/UNITS
/AUTHORIZATION
/AUTHORIZATION = string Specifies a string that along with ISSUER uniquely identifies the license you want to modify. Use this optional qualifier only if you need it to identify the license.
/COMMENT
/COMMENT=string
Specifies a string of text. Use this comment field of up to 63
characters to associate license management information with the
license. If you specify more than one word, enclose the text in
quotation marks (""). This qualifier is optional.
/DATABASE
/DATABASE = filespec Specifies the location of the LICENSE database file. The default file specification is SYS$COMMON:[SYSEXE]LMF$LICENSE.LDB. This qualifier is optional; use it only if you do not use the default LICENSE database name and location.
/EXCLUDE
/EXCLUDE=(node-name[,node-name,...]) Specifies that the named node or nodes in a VAXcluster cannot access the licensed product. The excluded nodes cannot activate (with a LICENSE LOAD or LICENSE START command) the license registered in the LICENSE database. If you specify more than one node name, separate each with commas and enclose the list in parentheses. This qualifier is optional.
/INCLUDE
/INCLUDE=(node-name[,node-name,...]) Specifies that the named node or nodes in a VAXcluster can access the licensed product. Only the included nodes can activate (with a LICENSE LOAD or LICENSE START command) the license registered in the LICENSE database. If you specify more than one node name, separate each with commas and enclose the list in parentheses. This qualifier is optional.
/ISSUER
/ISSUER = string Specifies the name of the company (for example, DEC) that issued the PAK for the product. Use this optional qualifier only if you need it to identify the license.
/PRODUCER
/PRODUCER = string Specifies the name of the company (for example, DEC) that owns the product for which you have a license. Use this optional qualifier only if you need it to identify the license.
/UNITS
/UNITS = number Specifies the number of license units you want on a license that includes the MOD_UNITS option. If your PAK, most recent PAAM, or automatically registered license allows you to modify the license units, use this qualifier to change the value in the LICENSE database.
Example
$ LICENSE MODIFY /EXCLUDE=(DANCE,THEATR) - _$ /COMMENT="Modified to exclude nodes DANCE & THEATR 10/23/89" - _$ FORTRAN This command modifies the FORTRAN license in the LICENSE database so that users cannot access FORTRAN from the nodes named DANCE and THEATR. A comment is added to the database record for future reference.
REGISTER
Adds a new license to the LICENSE database. A Product Authorization Key (PAK) provides the product name and information you need to register the license. You must enter all information provided by your PAK exactly as specified. Often you register a new product license with the command procedure SYS$UPDATE:VMSLICENSE.COM, which provides a prompt-based interface to the LICENSE REGISTER command. Format: LICENSE REGISTER product-name
Additional information available:
Parameter
product-name Name of the product with a license to register. You can only register licenses that do not currently exist in the LICENSE database. Enter the product name exactly as it is specified on your PAK.
Qualifiers
Additional information available:
/ACTIVITY/AUTHORIZATION/AVAILABILITY/CHECKSUM
/DATABASE/DATE/HARDWARE_ID/ISSUER/OPTIONS
/PRODUCER/TERMINATION/TOKEN/UNITS/VERSION
/ACTIVITY
/ACTIVITY = code
[CONSTANT = integer]
Specifies a license unit code that corresponds to a license unit
requirement table or to a constant value. If your PAK supplies an
activity code, you must enter the code exactly as specified. The
current codes are A, B, C, D, E, and F. If your PAK specifies the
keyword CONSTANT, then you must also specify the integer value. This
denotes a constant requirement for all System Marketing Models
(SMMs) equal to the value given. If your PAK specifies the decimal
value 0, then the license has no requirement for that license type.
PAK issuers determine the value for this element.
/AUTHORIZATION
/AUTHORIZATION = string Specifies a string that along with ISSUER uniquely identifies the license you want to register. You must enter the authorization string exactly as it is specified on your PAK.
/AVAILABILITY
/AVAILABILITY = code
[CONSTANT = integer]
Specifies a license unit code that corresponds to a license unit
requirement table or to a constant value. If your PAK supplies an
availability code, you must enter the code exactly as specified. The
current codes are A, B, C, D, E, and F. If you specify the keyword
CONSTANT, then you must also specify the integer value from your
PAK. PAK issuers determine the value for this element.
/CHECKSUM
/CHECKSUM = string Specifies a 17-character verification string created by the PAK Issuer for each PAK. A PAK presents the checksum string in the format n-cccc-cccc-cccc-cccc, where n is an integer and c is a character from A through P. A PAK presents the checksum string with hyphen (-) characters for readability. Because LMF does not count them for authorization, you can leave them out. Otherwise, you must enter the checksum string exactly as it is specified on your PAK.
/DATABASE
/DATABASE = filespec Specifies the location of the LICENSE database file. The default file specification is SYS$COMMON:[SYSEXE]LMF$LICENSE.LDB.
/DATE
/DATE = date Specifies a product date such that the license authorizes use of all product versions released on or before the date. If your PAK supplies a product date, you must enter the information exactly as specified. The data must be presented in the standard VMS syntax: dd-mmm-yyyy. Specifies the date on which the product was released. If your PAK supplies a product date, you must enter the information exactly as specified. The data must be presented in the standard VMS syntax: dd-mmm-yyyy.
/HARDWARE_ID
/HARDWARE_ID = string Specifies the identification number of the hardware on which the product is licensed. If your PAK supplies hardware identification, you must enter the information exactly as specified.
/ISSUER
/ISSUER = string Specifies the name of the company (for example, DEC) that issued the PAK for the product. Note that the PAK issuer is often the same as the producer. You must enter the information exactly as it is specified on your PAK.
/OPTIONS
/OPTIONS = [(keyword[,...])]
Specifies a LICENSE option or a list of LICENSE options. If your PAK
supplies any license options, you must enter the information exactly
as specified.
Current option keywords include the following:
Keyword Meaning
------- -------
MOD_UNITS The number of license units can be modified.
NO_SHARE The license cannot be used by more than one processor
in a VAXcluster. If this license is used in a
VAXcluster, you must designate it for one node using
LICENSE MODIFY with an /INCLUDE qualifier.
If you enter more than one keyword, separate each with a comma and
enclose them in parentheses.
/PRODUCER
/PRODUCER = string Specifies the name of the company (for example, DEC) that owns the product for which you have a license. You must enter the information exactly as it is specified on your PAK.
/TERMINATION
/TERMINATION = date Specifies the date on which the product license terminates. If your PAK supplies a license termination date, you must enter it exactly as specified. The data must be presented in the standard VMS syntax: dd-mmm-yyyy.
/TOKEN
/TOKEN = string Specifies a string of information associated with some products. This option can enable or disable certain product features. See your product documentation for details. If your PAK provides TOKEN information, you must enter it exactly as specified.
/UNITS
/UNITS = number Specifies the number of units that you want to register. You must enter the number exactly as specified on your PAK.
/VERSION
/VERSION = nn.nn Limits the version number of the product for which you have a license. Use the syntax integer.integer. If your PAK supplies version information, you must enter it exactly as specified.
Examples
1. $ LICENSE REGISTER FORTRAN /ISSUER=DEC /AUTHORIZATION=USA-10 -
_$ /PRODUCER=DEC /UNITS=400 /VERSION=4.6 -
_$ /AVAILABILITY=F /CHECKSUM=1-HIDN-INDA-COMP-DAHH
This command adds the license for the product FORTRAN to the default
LICENSE database. FORTRAN becomes licensed using the availability
formula with 400 license units available.
2. $ LICENSE REGISTER DVNETRTG /ISSUER=DEC -
_$ /AUTHORIZATION=USA-15 -
_$ /PRODUCER=DEC /UNITS=1000 /VERSION=4.0 -
_$ /AVAILABILITY=E /CHECKSUM=1-COOD-AGON-EFIC-HING
This command adds the license for the product DVNETRTG DECnet-Vax
Routing) to the default LICENSE database. In the example, DVNETRTG
is licensed using the availability formula with 1000 license units.
START
Sets up the License Unit Requirement Table (LURT) for your system, and activates all licenses that are registered and enabled in the LICENSE database. Because the VMS operating system issues a LICENSE START command during system startup, you should need this command only if startup fails. To use this command you need the privileges to change mode to kernel (CMKRNL), and to create system logical names (SYSNAM), and system privileges (SYSPRV). To activate any licenses in the LICENSE database of a system with LMF already started, use LICENSE LOAD. Format: LICENSE START
Additional information available:
Qualifier
Additional information available:
/DATABASE
/DATABASE = filespec Specifies the location of the LICENSE database file. The default file specification is SYS$COMMON:[SYSEXE]LMF$LICENSE.LDB.
Example
$ LICENSE START
This command sets up the LURT for your system, and activates all the
licenses that are registered and enabled in the LICENSE database.
UNLOAD
Deactivates a license, making the product unavailable from
the current node. The product license or licenses must be registered
in the LICENSE database, and must have been previously activated
with an interactive or automatic LICENSE LOAD command. The LICENSE
UNLOAD command has no affect on active processes.
To use this command you need the privileges to change mode to kernel
(CMKRNL) and, to create system logical names (SYSNAM), and system
privileges (SYSPRV).
Format: LICENSE UNLOAD product-name
Additional information available:
Parameter
product-name Name of the licensed product to be deactivated. You can only unload the licenses that have been activated. Enter the product name exactly as it was specified on your PAK.
Qualifier
Additional information available:
/PRODUCER
/PRODUCER = string Specifies the name of the company (for example, DEC) that owns the product for which you have a license. The default string for this qualifier is "DEC." If DEC is not the producer of the product, you must use this qualifier to identify the product.
Example
$ LICENSE UNLOAD/PRODUCER=DEC FORTRAN This command deactivates the FORTRAN license on the node from which it is entered.
Messages
Following is a listing of messages generated by the License Management Utility (LICENSE), explanations of the messages, and recommended user actions.
Additional information available:
Enabling messagesALREADYLOADED, ’producer’ ’product’ license has already been loaded
ALREADYSTARTED, the License Management Facility has already beenAMBIG, information provided was ambiguous; multiple licenses were
BADCHECKCHAR, invalid checksum character was specified --BADCHK, checksum does not validate
BADLDB, error reading LICENSE database ’database-name’BADLDBWRIT, error writing to license database ‘database-name’
BADLURT, error reading License Unit Requirement Table ’table-name’BADOPTION, invalid option was specified -- ’option-name’
BADOUT, error writing to output file ‘file-name’CORRUP, consistency error was found in LICENSE database
DUPREC, license is already registeredEMTLDB, LICENSE database contains no license records
EXCEEDED, attempted usage exceeds active license limitsILLSELECT, invalid table selector was specified -- ’table-selector’
INTERINJ, internal LMF error was encounteredINVALID DATE, license is invalid for this product release date
INVALID VERSION, license is invalid for this version of the productLDBPRES, LICENSE database already present
LOADED, ‘producer’ ‘product’ was successfully loaded with ‘unit-total’MODUNITS, number of units cannot be modified for this license
NOAUTH, ’producer’ ’product’ use is not authorized on this nodeNOCOMB, multiple licenses could not be combined for ‘producer’
NOENABLE, a license that has been cancelled cannot be enabledNOENT, no license was loaded for this product
NOINC, INCLUDE list must specify exactly one node for ‘product’ toNOLDB, error opening LICENSE database ’database-name’
NOLIC, no license was found for this productNOLICENSE, no license is active for this software product
NOLOAD, license was not loaded for ’product’NOLURT, error opening License Unit Requirement Table ’table-name’
NOMODUNITS, number of units cannot be modified for this licenseNOPRIV, insufficient privileges for this operation. CMKRNL, SYSNAM,
NOSTART, licensing cannot be startedNOTSTARTED, License Management Facility is not started
RNF, the specified license was not foundSYSMGR, please see your system manager
TERM, ’product’ ’authorization number’ license has terminatedTERMINATED, license has terminated
Enabling messages
To ensure that LMF messages are displayed through the Operator's
Communication Facility (OPCOM), you must define the logical name
LMF$DISPLAY_OPCOM_MESSAGE as follows:
$ DEFINE/EXECUTIVE_MODE/SYSTEM LMF$DISPLAY_OPCOM_MESSAGE TRUE
You can define this logical name interactively at the DCL prompt, or
include the command line in SYSTARTUP_V5.COM. You need system
privileges (SYSPRV), however, to enter this command or to modify
SYSTARTUP_V5.COM.
Although the default value is to have no messages displayed, some
products and licenses may produce opcom messages even if the logical
is set to FALSE.
ALREADYLOADED, 'producer' 'product' license has already been loaded
Message text: You attempted to activate a license that was already activated with an automatic or interactive LICENSE LOAD command. For example, if you amend a license and then try to activate it, you receive this message; before activating the amended license, you must first deactivate it with a LICENSE UNLOAD command.
ALREADYSTARTED, the License Management Facility has already been
started Message text: You attempted to start the License Management Facility that had been previously started. By default, LMF starts at system startup time. Message action: None.
AMBIG, information provided was ambiguous; multiple licenses were
found Message text: You attempted to execute an LMF command, but did not specify enough information to uniquely identify the product. Message action: Specify more information about the product. You always uniquely identify a product when you specify the product name, issuer, and authorization string.
BADCHECKCHAR, invalid checksum character was specified --
'checksum-character' Message text: You entered an invalid checksum. This message displays the invalid character. Message action: Enter the correct checksum string.
BADCHK, checksum does not validate
Message text: When you attempted to register a license, the checksum did not validate the other license information you entered. The checksum contains, in encrypted form, all license information from the PAK. If you enter inaccurate license information, you receive this message. Message action: Carefully review all licensing information on the PAK. When you register the license, you must enter all information exactly as it appears on the PAK.
BADLDB, error reading LICENSE database 'database-name'
Message text: LMF encountered an error while attempting to read the license database. An RMS message follows this message. Message action: See your system manager. The system manager should analyze the RMS message and, if necessary, restore the database from a backup copy.
BADLDBWRIT, error writing to license database `database-name'
Message text: LMF encountered an error while trying to write to the LICENSE database. An RMS message follows this message. Message action: See your system manager. The system manager should analyze the RMS message and respond appropriately. The appropriate action depends on the RMS message; the appropriate action could be only to wait a few minutes and enter the command again (for example, if the file is locked).
BADLURT, error reading License Unit Requirement Table 'table-name'
Message text: LMF encountered an error while attempting to read the License Unit Requirement Table. An RMS message follows this message. Message action: See your system manager. The system manager should analyze the RMS message and, if necessary, restore the License Unit Requirement Table (SYS$COMMON:[SYSEXE]LMF$LICENSE.LDB) from a backup copy.
BADOPTION, invalid option was specified -- 'option-name'
Message text: You specified an invalid keyword for licensing options. Message action: Review the options listed on the PAK, and reenter the code correctly.
BADOUT, error writing to output file `file-name'
Message text: You entered a LICENSE ISSUE command with the /OUTPUT qualifier; LMF encountered an error while attempting to write to the specified output file. An RMS message follows this message. Message action: Analyze the RMS message to determine the appropriate action.
CORRUP, consistency error was found in LICENSE database
Message text: LMF detected an inconsistency in the LICENSE database. You may have been attempting to activate a license (as occurs during system startup) while another process is changing a record in the LICENSE database. There can also be data corruption in the LICENSE database. Message action: If the problem occured because of simultaneous attempts to change and activate a license, you must ensure no records are being changed when you re-enter the LICENSE LOAD command. If you continue to receive this message, see your system manager. If necessary, the system manager can restore the database (SYS$COMMON:[SYSEXE]LMF$LICENSE.LDB) from a backup copy.
DUPREC, license is already registered
Message text: You attempted to register a license that was already registered. Message action: None.
EMTLDB, LICENSE database contains no license records
Message text: You attempted to activate a license, but no license records exist in the LICENSE database. Message action: You must register licenses before you can activate them. You receive this message at system startup if you have not yet registered any licenses.
EXCEEDED, attempted usage exceeds active license limits
Message text: A license exist for the product, but one of the following two problems occurred: You attempted to activate a license on a CPU that requires more license units to provide availability than the units authorized or currently available from the product. This message can be generated at system startup or when you enter a LICENSE LOAD command. You attempted to access a product with an activity license. The product license specifies activity authorization, and there were insufficient units on your system to permit another user of the product. Message action: For first case described, see your system manager. For the second case described, access the product when other users are finished using it.
ILLSELECT, invalid table selector was specified -- 'table-selector'
Message text: You entered an invalid activity or availability code. You enter activity and availability codes using the /ACTIVITY and /AVAILABILITY qualifiers to LICENSE commands, or in response to prompts from the command procedure VMSLICENSE.COM. Message action: Review the activity or availability code listed on the PAK, and reenter the code.
INTERINJ, internal LMF error was encountered
Message text: An internal LMF problem exists. Message action: Submit a Software Performance Report (SPR) and contact your system manager.
INVALID DATE, license is invalid for this product release date
Message text: The license release date is earlier than the product release date; the license does not authorize use of this version of the product. Message action: See your system manager. A Product Authorization Amendment (PAAM) may not be registered and loaded, or a new license for the product may have been obtained but not registered.
INVALID VERSION, license is invalid for this version of the product
Message text: The version number on the license is lower than the product version; the license does not authorize use of this version of the product. Message action: See your system manager. A Product Authorization Amendment (PAAM) may not have been registered and loaded, or a new license for the product may have been obtained but not registered.
LDBPRES, LICENSE database already present
Message text: You are attempting to create a LICENSE database that already exists. Message action: None.
LOADED, `producer' `product' was successfully loaded with `unit-total'
units. Message text: LMF successfully activated the license. This message displays the total number of units for the product. Message action: None.
MODUNITS, number of units cannot be modified for this license
Message text: You attempted to change the number of units for a license that does not include the MOD_UNITS option. Message action: Verify that you are modifying the correct license. You cannot change the number of units for a license that does not include the MOD_UNITS option. Use a LICENSE LIST command to check for this option.
NOAUTH, 'producer' 'product' use is not authorized on this node
Message text: You do not have an active license that authorizes use of this product. Message action: See your system manager to find out if a license exists for the product.
NOCOMB, multiple licenses could not be combined for `producer'
`product' Message text: LMF could not combine licenses. Licenses combine only if information on the licenses is identical. Following are the only fields that can differ among licenses: units, termination date, release date, comments, and include/exclude lists. Message action: See your system manager to determine if all licenses for the product are still valid.
NOENABLE, a license that has been cancelled cannot be enabled
Message text: You cannot use the LICENSE ENABLE command to reverse the actions of the LICENSE CANCEL command. Message action: Use the LICENSE CANCEL command with a new date to change the status of a user-cancelled license.
NOENT, no license was loaded for this product
Message text: You attempted to deactivate a license with a LICENSE UNLOAD command. However, no license that matches the one specified in the command is currently active. Message action: Use the SHOW LICENSE command to verify that a license for the product has been activated. One of the following two actions is appropriate: If you think you made an error specifying the license, reenter the command. If you are deactivating the license for a product and the producer is not DEC, you must specify the name of the producer in the LICENSE UNLOAD command. (DEC is the default value for producer).
NOINC, INCLUDE list must specify exactly one node for `product' to
be loaded Message text: You attempted to activate a NO_SHARE license that you modified using the LICENSE MODIFY command; when you entered the LICENSE MODIFY command, you did not specify an include list of exactly one node. Message action: Specify exactly one node name with the LICENSE MODIFY/INCLUDE=node-name command.
NOLDB, error opening LICENSE database 'database-name'
Message text: LMF could not find the license database you specified. Message action: Check the name of the database, and reenter the command.
NOLIC, no license was found for this product
Message text: You attempted to activate, amend, or modify a license, but no license matches the one you specified. Message action: Use the LICENSE LIST command to verify that the license exists, and then reenter the command.
NOLICENSE, no license is active for this software product
Message text: A license for the product has not been activated with an automatic or interactive LICENSE LOAD command. Message action: See your system manager to determine if the required license has been obtained. If so, ask the system manager to register and activate the license.
NOLOAD, license was not loaded for 'product'
Message text: You entered a LICENSE LOAD or LICENSE START command, and LMF was unable to activate a license. Typically, LMF displays this message when it finds insufficient units to activate the license. Message action: If you expected the license to be activated successfully, review the license information for the product. If the license is a clusterwide license, units might have been previously allocated to other nodes.
NOLURT, error opening License Unit Requirement Table 'table-name'
Message text: LMF could not find the License Unit Requirement Table. Message action: See your system manager. The table might have been deleted or renamed. If necessary, the system manager can restore the table (SYS$COMMON:[SYSEXE]LMF$LICENSE.LDB) from a backup copy.
NOMODUNITS, number of units cannot be modified for this license
Message text: You attempted to change the number of units for a license that does not include the MOD_UNITS option. Message action: Verify that you are modifying the correct license. You cannot change the number of units for a license that does not include the MOD_UNITS option. Use a LICENSE LIST command to check for this option.
NOPRIV, insufficient privileges for this operation. CMKRNL, SYSNAM,
and SYSPRV are required Message text: You attempted to enter a LICENSE command for which you have insufficient privileges. Message action: See your system manager. You must obtain the following privileges to successfully enter the command: CMKRNL, SYSNAM, and SYSPRV.
NOSTART, licensing cannot be started
Message text: LMF encountered an error while attempting to load the LURT entry or create the logical name table. You can receive this message at system startup or when entering a LICENSE START command. An RMS message follows this message. Message action: See your system manager. The system manager should analyze the RMS message to determine the appropriate action.
NOTSTARTED, License Management Facility is not started
Message text: The License Management Facility has not been started. By default, the facility starts when STARTUP.COM is executed. The system manager can also start the facility using the LICENSE START command. Message action: Ask your system manager to start the License Management Facility.
RNF, the specified license was not found
Message text: You entered a LICENSE command but no license record matches the one you specified in the command. Message action: Use the LICENSE LIST command to verify that the license exists, and then reenter the command.
SYSMGR, please see your system manager
Message text: A licensing problem has occurred that should be discussed with your system manager. See your system manager.
TERM, 'product' 'authorization number' license has terminated
Message text: The current date of an active license is later than the license termination date; the license is no longer valid. Message action: See your system manager. The system manager may have canceled the license or obtained a new license without registering and loading it.
TERMINATED, license has terminated
Message text: The current date of an active license is later than the license termination date; the license is no longer valid. Message action: See your system manager. The system manager may have canceled the license or obtained a new license without registering and loading it. Alternatively, you can verify the product name and producer. If you entered the wrong product name, activate the license again. If you have products with the same name but different producers, specify the name of the producer in the LICENSE LOAD command. If you amend a license, make sure you deactivate the license with a LICENSE UNLOAD command before you attempt to activate (with the LICENSE LOAD command) the license again.