The License Management utility (LICENSE) is a DCL-level interface
to the License Management Facility (LMF). LMF provides tools for
managing software license information in the License Database
and controlling the loading of licenses registered there. This
database is located in SYS$COMMON:[SYSEXE]LMF$LICENSE.LDB.
Most VSI software products require license registration as part
of the normal product installation before users can access the
product. The LICENSE commands are:
LICENSE COPY LICENSE LOAD
LICENSE CREATE LICENSE MODIFY
LICENSE DELETE LICENSE MOVE
LICENSE DISABLE LICENSE REGISTER
LICENSE ENABLE LICENSE START
LICENSE ISSUE LICENSE UNLOAD
LICENSE LIST SHOW LICENSE
1 – Usage Summary
To use the License Management utility (LICENSE), enter a LICENSE
command and subcommand at the DCL prompt ($). For example, you can
enter short commands on one line:
$ LICENSE LIST /FULL VAX-VMS /AUTHORIZATION=USA12345
Or you can enter long command strings followed by a hyphen (-)
before pressing Return each time:
$ LICENSE REGISTER FORTRAN /ISSUER=DEC /AUTHORIZATION=USA-1957 -
_$ /PRODUCER=DEC /UNITS=1200 /VERSION=7.0 -
_$ /AVAILABILITY=F /CHECKSUM=1-GEAD-MIDJ-IDNC-DLAC
NOTE
Enter the LICENSE commands carefully. LICENSE command
strings can be long. If so, type a hyphen (-) at the end
of a screen line to continue entering the same command.
LMF may return only a checksum error when you omit or
incorrectly enter information. Therefore, before you press
Return, carefully check the characters you typed on each
line.
For most of the LICENSE commands, you can eliminate
some typing by using the command procedure
SYS$UPDATE:VMSLICENSE.COM
All the LICENSE commands except LICENSE START, LICENSE LOAD, and
LICENSE UNLOAD manipulate only the LMF databases. Thus, to enter
most LICENSE commands, you need only the privileges required
to access the License Databases. The License Database is file-
based; normal file protection applies. LMF provides the License
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) and to create system logical names (SYSNAM) and system
privileges (SYSPRV).
Some commands change license record fields in the License
Database. LMF writes a history record when you use the following
commands:
LICENSE AMEND
LICENSE COPY
LICENSE DISABLE
LICENSE ENABLE
LICENSE ISSUE
LICENSE MODIFY
To display a listing of current and history records of licenses
registered in the License Database, use LICENSE LIST. To display
the licenses active on the current node, use the DCL command SHOW
LICENSE.
In some special circumstances, OpenVMS licenses are in a separate
License Database located in SYS$SPECIFIC:[SYSEXE]LMF$SYSTEM.LDB.
Your LICENSE commands must identify this database with the
/DATABASE qualifier.
Many of the LICENSE commands can affect more than one license
simultaneously. You can control which licenses a command
affects by adding more than one product name in the product-
name parameter, using the /ALL qualifier, or using the standard
DCL wildcard characters (* and %) in your command strings. Using
the wildcard character (*) in the product-name parameter implies
the use of /ALL.
Many of the qualifiers are positional, allowing further control
for the management of large License Databases. With multiple
parameters, positional qualifiers affect only the preceding
parameter. A positional qualifier that precedes every parameter,
however, affects them all equally.
2 – COPY
Copies licenses from one License Database to another. When you
use LICENSE COPY, LMF disables the source license and registers
a copy in the destination License Database as if it were a new
license. If the terms and conditions of your license contract
allow it, you can re-enable the source database license by using
LICENSE ENABLE.
LICENSE COPY cannot be used to create a copy of a license in the
same database as the source of the copy.
Format
LICENSE COPY product-name[,...] output-database
2.1 – Parameters
product-name[,...]
Name or names of products with a license to be copied to the
output License Database.
output-database
File specification of the License Database to which the license
or licenses should be copied. This database must have been
created previously using LICENSE CREATE.
If you enter a partial file specification (for example,
specifying only a directory), LMF$LICENSE is the default file
name, and .LDB is the default file type. If you do not specify a
device or directory, the current default device and directory are
used.
2.2 – Qualifiers
2.2.1 /ALL
Positional qualifier.
Specifies that all licenses with the given product name should
be copied. This qualifier affects only the product name that
immediately precedes it in the command string.
2.2.2 /AUTHORIZATION
/AUTHORIZATION=string
Positional qualifier.
Specifies a string that helps identify the license you want to
copy. You must enter the authorization string exactly as it
appears on your PAK. Use this optional qualifier only if you
need it to identify the license. This qualifier affects only the
product name that immediately precedes it in the command string.
2.2.3 /DATABASE
/DATABASE=filespec
Specifies the location of the License Database from which
the license should be copied. The default file specification
is defined by the logical name LMF$LICENSE, which points to
SYS$COMMON:[SYSEXE]LMF$LICENSE.LDB on an unmodified OpenVMS
system. Use this optional qualifier only if you do not use the
default License Database name and location.
2.2.4 /ISSUER
/ISSUER=string
Positional qualifier.
Specifies the name of the company (for example, VSI) that issued
the PAK for the product. Use this optional qualifier only if you
need to identify the license. This qualifier affects only the
product name that immediately precedes it in the command string.
2.2.5 /LOG
/LOG
/NOLOG (default)
Controls whether LICENSE COPY displays the name of each license
that it copies.
2.2.6 /PRODUCER
/PRODUCER=string
Positional qualifier.
Specifies the name of the company (for example, VSI) that owns the
product for which you have a license. Use this optional qualifier
only if you need to identify the license. This qualifier affects
only the product name that immediately precedes it in the command
string.
2.3 – Description
To copy a license from one database to another, use LICENSE COPY.
The following conditions apply to a LICENSE COPY transaction:
o The status of the source database license changes to disabled.
o Network copies are supported within the limits of remote
FAL access. If you use access control strings, such as
"USERNAME password" within the file specification, the actual
password string is not stored.
o LICENSE COPY does not transfer any user-supplied data such as
reservation lists, modified termination dates, modified units,
include or exclude node lists, or comments.
2.4 – Examples
1.$ LICENSE COPY FORTRAN BACKUP_DATA:BACKUP.LDB
This command copies the Fortran license in the default License
Database to the BACKUP_DATA:BACKUP.LDB License Database. This
command fails if there is more than one Fortran license in the
default database.
2.$ LICENSE COPY FORTRAN /DATABASE=BACKUP_DATA:BACKUP.LDB -
_$ BACKUP_DATA2:BACKUP2.LDB
This command copies the Fortran license in the source License
Database to the BACKUP_DATA2:BACKUP2.LDB License Database. This
command fails if there is more than one Fortran license in the
source database.
3.$ LICENSE COPY FORTRAN /ALL BACKUP_DATA:BACKUP.LDB
This command copies all Fortran licenses in the default License
Database to the BACKUP_DATA:BACKUP.LDB License Database.
4.$ LICENSE COPY FOR* BACKUP_DATA:BACKUP.LDB
This command copies all licenses whose product names begin
with the string "FOR" from the default License Database to the
BACKUP_DATA:BACKUP.LDB License Database. In this case, using
the wildcard character (*) implies the use of /ALL.
5.$ LICENSE COPY * BACKUP_DATA:BACKUP.LDB
This command copies all licenses from the default License
Database to the BACKUP_DATA:BACKUP.LDB License Database. In
this case, using the wildcard character (*) implies the use of
/ALL.
6.$ LICENSE COPY * /PRODUCER=DEC BACKUP_DATA:BACKUP.LDB
This command copies all licenses with the producer name DEC
from the default License Database to the BACKUP_DATA:BACKUP.LDB
License Database. In this case, using the wildcard character
(*) implies the use of /ALL.
7.$ LICENSE COPY D%% BACKUP_DATA:BACKUP.LDB
This command copies all licenses beginning with a "D" followed
by exactly two characters from the default License Database
to the BACKUP_DATA:BACKUP.LDB License Database. In this case,
using the wildcard character (%) implies the use of /ALL.
3 – CREATE
Creates a License Database with no license records.
Because LMF provides a default License Database in
SYS$COMMON:[SYSEXE]LMF$LICENSE.LDB when OpenVMS is installed,
you do not typically need to use this command.
To use LMF, you must have a License Database file and the
appropriate number of units for your system. On OpenVMS Alpha
and VAX, the units are located in the License Unit Requirement
Table (LURT) file (SYS$COMMON:[SYSEXE]LMF$LURT.DAT), which comes
installed with OpenVMS. On OpenVMS Integrity servers, the units
are based on the number of processor cores and the class of the
machine specified in the PAK you receive with the license.
Format
LICENSE CREATE
3.1 – Qualifier
3.1.1 /DATABASE
/DATABASE=filespec
Specifies the location of the License Database. The default file
specification is defined by the logical name LMF$LICENSE, which
points to SYS$COMMON:[SYSEXE]LMF$LICENSE.LDB on an unmodified
OpenVMS system.
3.2 – Example
$ LICENSE CREATE /DATABASE=SYS$MANAGER:LMF$LICENSE.LDB
This command creates the License Database named LMF$LICENSE.LDB
in the directory SYS$MANAGER.
4 – DELETE
Deletes one or more licenses and all history information for
those licenses from the License Database.
Format
LICENSE DELETE product-name[,...]
4.1 – Parameter
product-name[,...]
Name or names of products with a license to be removed from the
License Database. You can delete only licenses that have been
registered.
4.2 – Qualifiers
4.2.1 /ALL
Positional qualifier.
Specifies that all licenses with the given product name should
be deleted. This qualifier affects only the product name that
immediately precedes it in the command string.
4.2.2 /AUTHORIZATION
/AUTHORIZATION=string
Positional qualifier.
Specifies a string that helps identify the license you want to
delete. You must enter the authorization string exactly as it
appears on your PAK. Use this optional qualifier only if you
need it to identify the license. This qualifier affects only the
product name that immediately precedes it in the command string.
4.2.3 /DATABASE
/DATABASE=filespec
Specifies the location of the License Database from which
the license or licenses should be deleted. The default file
specification is defined by the logical name LMF$LICENSE, which
points to SYS$COMMON:[SYSEXE]LMF$LICENSE.LDB on an unmodified
OpenVMS system. Use this optional qualifier only if you do not
use the default License Database name and location.
4.2.4 /ISSUER
/ISSUER=string
Positional qualifier.
Specifies the name of the company (for example, VSI) that issued
the PAK for the product. Use this optional qualifier only if you
need it to identify the license. This qualifier affects only the
product name that immediately precedes it in the command string.
4.2.5 /LOG
/LOG
/NOLOG (default)
Controls whether LICENSE DELETE displays the name of each license
that it deletes.
4.2.6 /PRODUCER
/PRODUCER=string
Positional qualifier.
Specifies the name of the company (for example, VSI) that owns the
product for which you have a license. Use this optional qualifier
only if you need it to identify the license. This qualifier
affects only the product name that immediately precedes it in
the command string.
4.2.7 /STATUS
/STATUS=[(keyword)[,...]]
Positional qualifier.
Selects licenses to be deleted according to the product-name
parameter specified and one or more license status keywords from
the following list:
o ALL (default)-Deletes all specified licenses in the database.
o ACTIVE-Deletes all specified enabled licenses in the database.
ACTIVE status means that the registered license is enabled for
loading. For backward compatibility, the LICENSE LIST command
identifies enabled licenses as having a status of active.
o DISABLED-Deletes all specified disabled licenses in the
database.
o EXTINCT-Purges specified license information by deleting all
extinct license records in the database. Extinct records are
history records retained after a license is modified.
o CANCELED-Deletes all specified canceled licenses in the
database. Note that current versions of LMF do not set license
status to canceled. Old licenses may have this status.
If you enter more than one keyword, separate them with commas,
and enclose the list in parentheses. You can abbreviate each
option to the minimum number of characters needed to uniquely
identify it.
4.3 – Description
Use LICENSE DELETE to delete licenses from the License Database.
To tailor your command, use options to the /STATUS qualifier and
wildcard characters in product name strings.
File space is not released following LICENSE DELETE commands.
For information on retrieving Record Management Services (RMS)
file space, see the OpenVMS Record Management Utilities Reference
Manual.
4.4 – Examples
1.$ LICENSE DELETE FORTRAN
This command deletes the Fortran license from the default
License Database.
2.$ LICENSE DELETE FORTRAN, COBOL, PASCAL
This command deletes the Fortran, COBOL and Pascal licenses
from the default License Database.
3.$ LICENSE DELETE FORTRAN /DATABASE=MY$DISK:MYDATA.LDB
This command deletes the Fortran license from the
MY$DISK:MYDATA.LDB License Database.
4.$ LICENSE DELETE FORTRAN /ISSUER=XYLASOFT
This command deletes all licenses for the product named Fortran
issued by XYLASOFT from the default License Database. If there
are licenses for products named Fortran issued by companies
other than XYLASOFT, they are not deleted.
5.$ LICENSE DELETE * /STATUS=(EXTINCT)
This command deletes all license records with a status of
EXTINCT from the database. This is effectively a purge of all
historical information.
5 – DISABLE
Disables a license currently registered in the License Database.
Format
LICENSE DISABLE product-name[,...]
5.1 – Parameter
product-name[,...]
Name or names of products with a license that you want to
disable. You can disable only licenses that currently exist
in the License Database. Enter the product name exactly as it
appears on your Product Authorization Key (PAK).
5.2 – Qualifiers
5.2.1 /ALL
Positional qualifier.
Specifies that all licenses with the given product name should
be disabled. This qualifier affects only the product name that
immediately precedes it in the command string.
5.2.2 /AUTHORIZATION
/AUTHORIZATION=string
Positional qualifier.
Specifies a string that helps identify the license you want to
disable. You must enter the authorization string exactly as it
appears on your PAK. Use this optional qualifier only if you
need it to identify the license. This qualifier affects only the
product name that immediately precedes it in the command string.
5.2.3 /DATABASE
/DATABASE=filespec
Specifies the location of the License Database. The default file
specification is defined by the logical name LMF$LICENSE, which
points to SYS$COMMON:[SYSEXE]LMF$LICENSE.LDB on an unmodified
OpenVMS system. Use this optional qualifier only if you do not
use the default License Database name and location.
5.2.4 /ISSUER
/ISSUER=string
Positional qualifier.
Specifies the name of the company (for example, VSI) that issued
the PAK for the product. Use this optional qualifier only if you
need it to identify the license. This qualifier affects only the
product name that immediately precedes it in the command string.
5.2.5 /LOG
/LOG
/NOLOG (default)
Controls whether LICENSE DISABLE displays the name of each
license that it disables.
5.2.6 /PRODUCER
/PRODUCER=string
Positional qualifier.
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. This
qualifier affects only the product name that immediately precedes
it in the command string.
5.3 – Description
LICENSE DISABLE does not immediately affect loaded licenses. To
affect a loaded license, you must first enter a LICENSE UNLOAD
command, which unloads the license, but allows current processes
to finish using the product. Note that to immediately disable all
loaded licenses, you must shut down the system.
You cannot use LICENSE LOAD to activate a disabled license; you
must first use LICENSE ENABLE.
LMF does not display error messages when either you or the system
attempts to unload a disabled license.
5.4 – Example
$ LICENSE DISABLE ABCD /PRODUCER=DEC
This command disables the license for ABCD software produced
by VSI. Because no database is specified, LMF uses the default
database.
6 – ENABLE
Enables an existing license in the License Database so that you
can load it with LICENSE LOAD. This command cancels the effect
of LICENSE DISABLE, LICENSE COPY, and LICENSE ISSUE, which leave
the license disabled. Newly registered licenses are enabled by
default.
Format
LICENSE ENABLE product-name[,...]
6.1 – Parameter
product-name[,...]
Name or names of products with a license to enable. You can
enable only licenses that currently exist in the License
Database. Enter the product name exactly as it appears on your
PAK.
6.2 – Qualifiers
6.2.1 /ALL
Positional qualifier.
Specifies that all licenses with the given product name should
be enabled. This qualifier affects only the product name that
immediately precedes it in the command string.
6.2.2 /AUTHORIZATION
/AUTHORIZATION=string
Positional qualifier.
Specifies a string that helps identify the license you want to
enable. You must enter the authorization string exactly as it
appears on your PAK. Use this optional qualifier only if you
need it to identify the license. This qualifier affects only the
product name that immediately precedes it in the command string.
6.2.3 /DATABASE
/DATABASE=filespec
Specifies the location of the License Database. The default file
specification is defined by the logical name LMF$LICENSE, which
points to SYS$COMMON:[SYSEXE]LMF$LICENSE.LDB on an unmodified
OpenVMS system. Use this optional qualifier only if you do not
use the default License Database name and location.
6.2.4 /ISSUER
/ISSUER=string
Positional qualifier.
Specifies the name of the company (for example, VSI) that issued
the PAK for the product. Use this optional qualifier only if you
need it to identify the license. This qualifier affects only the
product name that immediately precedes it in the command string.
6.2.5 /LOG
/LOG
/NOLOG (default)
Controls whether LICENSE ENABLE displays the name of each license
that it enables.
6.2.6 /PRODUCER
/PRODUCER=string
Positional qualifier.
Specifies the name of the company (for example, VSI) that owns the
product for which you have a license. Use this optional qualifier
only if you need it to identify the license. This qualifier
affects only the product name that immediately precedes it in
the command string.
6.3 – Description
Use LICENSE ENABLE to reestablish disabled licenses as available
for loading with a LICENSE LOAD command.
Enabled licenses can combine with other licenses when loaded for
use. Do not enable a license that has expired, and be sure that
all include, exclude, and reservation lists are up to date.
Use LICENSE LIST to inspect each license before you enable it.
Use LICENSE MODIFY to change include, exclude, and reservation
lists.
Because errors do not occur until enabled licenses are loaded,
consider entering LICENSE LOAD immediately to load each newly
enabled license on each appropriate node in an OpenVMS Cluster.
If another combinable license for the same product is already
loaded, first unload it with LICENSE UNLOAD. Use the DCL command
SHOW LICENSE to see which licenses are currently active on your
system. After you unload the other license, enter LICENSE LOAD
to load the combination of the newly enabled license and the
previously active license.
6.4 – Example
$ LICENSE ENABLE DECSET /PRODUCER=DEC
This command enables the license for DECset software. Because
no database is specified, LMF uses the default database. Next,
load the license with LICENSE LOAD.
7 – ISSUE
Produces a replica of a Product Authorization Key (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 LICENSE ISSUE, LMF disables
the license in the current License Database and marks the license
DISABLED. To enable a license that has been marked ISSUED, enter
LICENSE ENABLE.
For License Databases connected to a network, consider using
LICENSE MOVE.
Format
LICENSE ISSUE product-name[,...]
7.1 – Parameter
product-name[,...]
Name or names of products with a license to be issued. You can
issue only licenses that currently exist in the License Database.
Enter the product name exactly as it appears on your PAK.
7.2 – Qualifiers
7.2.1 /ALL
Positional qualifier.
Specifies that all licenses with the given product name should
be issued. This qualifier affects only the product name that
immediately precedes it in the command string.
7.2.2 /AUTHORIZATION
/AUTHORIZATION=string
Positional qualifier.
Specifies a string that helps identify the license you want to
issue. You must enter the authorization string exactly as it
appears on your PAK. Use this optional qualifier only if you
need it to identify the license. This qualifier affects only the
product name that immediately precedes it in the command string.
7.2.3 /DATABASE
/DATABASE=filespec
Specifies the location of the License Database. The default file
specification is defined by the logical name LMF$LICENSE, which
points to SYS$COMMON:[SYSEXE]LMF$LICENSE.LDB on an unmodified
OpenVMS system. Use this optional qualifier only if you do not
use the default License Database name and location.
7.2.4 /ISSUER
/ISSUER=string
Positional qualifier.
Specifies the name of the company (for example, VSI) that issued
the PAK for the product. Use this optional qualifier only if you
need it to identify the license. This qualifier affects only the
product name that immediately precedes it in the command string.
7.2.5 /LOG
/LOG
/NOLOG (default)
Controls whether LICENSE ISSUE displays the name of each license
that it issues.
7.2.6 /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.
If you specify a file name that already exists, this command
creates a new version of the file. If you specify a complete file
name and version that already exists, this command appends the
PAK replica to the existing file.
7.2.7 /PROCEDURE
/PROCEDURE
/NOPROCEDURE (default)
Specifies that the PAK replica is to be written in the form of a
DCL command procedure. Use /PROCEDURE with the /OUTPUT qualifier
to create a command procedure in a file. Then you can invoke the
procedure to register the PAK replica in the License Database of
another processor.
If you do not specify the /OUTPUT qualifier with /PROCEDURE,
or if you do not supply a file specification with the /OUTPUT
qualifier, the procedure is sent to SYS$OUTPUT.
7.2.8 /PRODUCER
/PRODUCER=string
Positional qualifier.
Specifies the name of the company (for example, VSI) that owns the
product for which you have a license. Use this optional qualifier
only if you need it to identify the license. This qualifier
affects only the product name that immediately precedes it in
the command string.
7.3 – Description
If your license contract allows it, use LICENSE ISSUE to
move a license from a License Database on one processor (or
OpenVMS Cluster environment) to a License Database on another
processor. To move a license, enter LICENSE ISSUE, including
enough PAK information to clearly identify the license. LICENSE
ISSUE automatically disables the current license but does
not immediately unload it; LMF does not terminate any active
processes. To unload the license, enter a LICENSE UNLOAD command.
After you issue the PAK replica, read the information, and
register it on the new processor as you would any PAK, or, if
you used the /PROCEDURE qualifier with the /OUTPUT qualifier,
invoke the new DCL command procedure to register the license.
Note that the PAK replica includes only PAK information
registered with a LICENSE REGISTER command. The replica does
not include any changes made with other LICENSE commands.
7.4 – Examples
1.$ LICENSE ISSUE /OUTPUT=SYS$MANAGER:FORTRAN.PAK -
_$ /PRODUCER=DEC FORTRAN
This command issues a PAK replica, which you can use to
register the Fortran license on a new processor (or OpenVMS
Cluster environment), and puts it into the file named
FORTRAN.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 in the License
Database of the new processor. The Fortran license in the
current License Database is marked ISSUED and is disabled.
2.$ LICENSE ISSUE /PRODUCER=DEC VOLSHAD
This command displays, at the current terminal, a PAK replica
with the information from the VOLSHAD (Volume Shadowing)
license. This display is reproduced below. The license
registered in the current License Database is marked ISSUED
and is disabled. You can register the data from this replica of
a PAK in the License Database of another processor using either
VMSLICENSE.COM or LICENSE REGISTER.
Software Product Authorization Key Replica
Issued by CASPER
Issued on 24-FEB-2001 14:23
-----------------------------------
Issuer: DEC
Authorization: ALS-WM-93166-5573
Product Name: VOLSHAD
Producer: DEC
Units: 460
Version: 5.4
PAK Termination Date: 31-DEC-2001
Availability: E
Options: MOD_UNITS
Checksum: 1-ADEB-DOCJ-NENC-KDBM
3.$ LICENSE ISSUE /PROCEDURE /OUTPUT=FORTRAN-USA10.COM -
_$FORTRAN /AUTHORIZATION=USA-10
This command generates a DCL command procedure such as the
following to be used for registering the specified license in a
License Database:
$! Software Product Authorization Key Replica
$! Issued by CASPER
$! Issued on 23-Oct-2001 14:23
$ LICENSE REGISTER FORTRAN -
/ISSUER=DEC -
/PRODUCER=DEC -
/AUTHORIZATION=USA-10 -
/UNITS=400 -
/VERSION=5.4 -
/AVAILABILITY=F -
/CHECKSUM=1-HIDN-INDA-COMP-DAHH
8 – LIST
Displays information from the License Database on disk about
the specified license or licenses. Use one or more qualifiers to
control the form, content, and location of information displayed.
The SHOW LICENSE command, described in the VSI OpenVMS DCL
Dictionary and in this help, displays information from the
License Database in memory.
Format
LICENSE LIST [product-name[,...]]
8.1 – Parameter
product-name[,...]
Name or names of products with a license that you want to
list. You can list only licenses that currently exist on disk
in the License Database. You can specify one product name or
use wildcard characters to display licenses. The product-name
parameter is optional; the default is to display all of the
licenses.
8.2 – Qualifiers
8.2.1 /AUTHORIZATION
/AUTHORIZATION=string
Positional qualifier.
Specifies a string that helps identify the license you want to
list. You must enter the authorization string exactly as it
appears on your PAK. Use this optional qualifier only if you
need it to identify the license.
This qualifier affects only the product name that immediately
precedes it in the command string.
8.2.2 /BEFORE
Used with /TERMINATION_DATE and /RELEASE_DATE, selects only those
licenses whose times are before the time specified with the other
qualifiers.
The /BEFORE qualifier cannot be used with the /SINCE qualifier.
8.2.3 /BRIEF
/BRIEF (default)
Specifies a listing from the License Database that includes only
the license product and producer names.
8.2.4 /DATABASE
/DATABASE=filespec
Specifies the location of the License Database. The default file
specification is defined by the logical name LMF$LICENSE, which
points to SYS$COMMON:[SYSEXE]LMF$LICENSE.LDB on an unmodified
OpenVMS system. Use this optional qualifier only if you do not
use the default License Database name and location.
8.2.5 /FULL
Specifies a listing from the License Database that includes a
full display of the specified license or licenses.
8.2.6 /HISTORY
Specifies a listing from the License Database that includes the
history records in the License Database for the specified license
or licenses.
8.2.7 /ISSUER
/ISSUER=string
Positional qualifier.
Specifies the name of the company (for example, VSI) that issued
the PAK for the product. Use this optional qualifier only if you
need it to identify the license. This qualifier affects only the
product name that immediately precedes it in the command string.
8.2.8 /OUTPUT
/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.
8.2.9 /PRODUCER
/PRODUCER=string
Positional qualifier.
Specifies the name of the company (for example, VSI) that owns the
product for which you have a license. Use this optional qualifier
only if you need it to identify the license.
This qualifier affects only the product name that immediately
precedes it in the command string.
8.2.10 /RELEASE_DATE
/RELEASE_DATE=date
Used with /BEFORE or /SINCE, specifies a listing from the License
Database that includes only licenses with a release date on
or after the date specified. The date must be presented in the
standard OpenVMS format: dd-mmm-yyyy. The default value is /SINCE
/RELEASE_DATE=TODAY.
8.2.11 /SELECTION_WEIGHT
Produces a full display that includes the current selection
weights assigned to individual PAKs.
8.2.12 /SINCE
Used with /TERMINATION_DATE and /RELEASE_DATE, selects only those
licenses whose times are after the time specified with the other
qualifiers.
/SINCE cannot be used with /BEFORE.
8.2.13 /TERMINATION_DATE
/TERMINATION_DATE[=date]
Used with /BEFORE or /SINCE, specifies a listing from the License
Database that includes only licenses with a termination date on
or after the date specified. The date must be presented in the
standard OpenVMS format: dd-mmm-yyyy. The default value is /SINCE
/TERMINATION_DATE=TODAY.
8.2.14 /VERSION
/VERSION=nn.nn
Positional qualifier.
Specifies the version number of the product for which you have
a license. Versions use the format integer.integer. You can
specify wildcard syntax as *.* but not * alone. Use this optional
qualifier only if you need it to identify the license. This
qualifier affects only the product name that immediately precedes
it in the command string.
8.3 – Description
LICENSE LIST displays license records as they appear on disk
in the License Database. LICENSE LIST /BRIEF does not produce
a display with history records. You can control the displays as
follows:
o After you enter LICENSE LIST with the /BRIEF qualifier, you
can scroll through the display with the arrow keys on your
keyboard.
o After you enter LICENSE LIST with the /FULL or /HISTORY
qualifier, which displays the first LICENSE record, you can
see the other records one at a time by pressing Return. You
can also scroll through the license records using the Previous
Screen key (or PF3) and the Next Screen key (or PF4).
For any LICENSE LIST display, use the arrow keys to scroll
vertically or horizontally one line at a time. Press Ctrl/Z to
exit from the display.
Note that a LICENSE LIST command may display the status of a
registered license as Active. This means the registered license
is enabled for loading; it has not been disabled. It does not
necessarily mean the license was loaded with a LICENSE LOAD
command. The LICENSE LIST command displays only information on
disk in the License Database; enter SHOW LICENSE to determine all
active licenses on the current system.
You can also list licenses using the VMSLICENSE.COM command
procedure.
8.4 – Examples
1.$ LICENSE LIST /FULL
This example displays a list of the names of product licenses
in the License Database on an OpenVMS Alpha system. Note that
the LMF Version shown refers to the software that created the
database.
CTRL/Z to exit, PF3-PF4 for Prev-Next Screen, ArrowKeys to scroll.
License Management Facility V1.2
License Database File: WORK2:[BACKUP]LMF$LICENSE.LDB;1
Created on: 20-JUL-2000
Created by user: USER_1
Created by LMF Version: V1.1
-----------------------------------
Issuer: DEC
Authorization:
Product Name: OPENVMS-ALPHA
Producer: DEC
Units: 500
Version: 0.0
Release Date: 4-MAY-2001
PAK Termination Date: (none)
Availability: 0
Activity: 000000100
Options: MOD_UNITS
Product Token:
Hardware ID:
Revision Level: 1
Status: Active
Command: REGISTER
2.$ LICENSE LIST /FULL
This example displays a list of the names of product licenses
in the License Database on an OpenVMS Integrity server system.
CTRL/Z to exit, PF3-PF4 for Prev-Next Screen, ArrowKeys to scroll.
License Management Facility V2.0
License Database File: SYS$COMMON:[SYSEXE]LMF$LICENSE.LDB;1
Created on: 11-MAR-2010
Created by user: SYSTEM
Created by LMF Version: V2.0
-----------------------------------
Issuer: VSI
Authorization: USA-1715
Product Name: C
Producer: VSI
Units: 3
Version: 0.0
Release Date: (none)
PAK Termination Date: 31-DEC-2012
Availability: 0
Activity: 000000001
Options: IA64_ALPHA
Product Token:
Hardware ID:
Revision Level: 1
Status: Active
Command: REGISTER
Modified by user: SYSTEM
Modified on: 11-MAR-2010 12:18:59.95
-----------------------------------
Issuer: VSI
Authorization: I64-AB-001
Product Name: DVNETEXT
Producer: VSI
Units: 20
Modified Units: 4
Version: 0.0
Release Date: (none)
PAK Termination Date: 31-DEC-2012
Options: IA64, PCL
Product Token:
Hardware ID:
Revision Level: 2
Status: Active
Command: MODIFY
Modified by user: SYSTEM
Modified on: 11-MAR-2010 12:29:42.18
-----------------------------------
Issuer: VSI
Authorization: I64-AB-004
Product Name: OPENVMS-I64-BOE
Producer: VSI
Units: 2
Version: 0.0
Release Date: (none)
PAK Termination Date: 31-DEC-2012
Options: IA64, PCL
Product Token:
Hardware ID:
Revision Level: 1
Status: Active
Command: REGISTER
Modified by user: SYSTEM
Modified on: 11-MAR-2010 12:33:26.19
3.$ LICENSE LIST /HISTORY FORTRAN
This example displays a listing with full information of a
current Fortran license issued by VSI.
The first screen, shown here, displays the most recent license
record for the Fortran license. To see the history records
one screen at a time, press Return. The revision level of
the displayed record is 2, and the status is Active. The
next screen would display the previous license record with a
revision level of 1 and a status of Extinct.
CTRL/Z to exit, PF3-PF4 for Prev-Next Screen, ArrowKeys to scroll.
License Management Facility V1.2
License Database File: ART::SYS$COMMON:[SYSEXE]LMF$LICENSE.LDB
Created on: 17-AUG-2000
Created by user: USER_2
Created by LMF Version: V1.2
-----------------------------------------------------
Issuer: DEC
Authorization: USA-2468
Product Name: FORTRAN
Producer: DEC
Units: 0
Modified Units: 2000
Version: 5.4
Release Date: (none)
PAK Termination Date: 31-DEC-2000
Modified Termination Date: 30-NOV-2001
Availability: F (Layered Products)
Activity: 0
Options: MOD_UNITS
Hardware ID:
Revision Level: 2
Status: Active
Command: MODIFY
Modified by user: DEGAS
Modified on: 19-AUG-2000 14:32:23.41
Include: ART
4.$ LICENSE LIST /FULL
This example displays the full listing of a license that has
been modified using the /VIRTUAL qualifier, for an OpenVMS
guest system.
License Management Facility V2.0
License Database File: SYS$COMMON:[SYSEXE]LMF$LICENSE.LDB;1
Created on: 1-MAR-2010
Created by user: SYSTEM
Created by LMF Version: V2.0
-----------------------------------
Issuer: VSI
Authorization: I64-AB-001
Product Name: OPENVMS-I64-HAOE
Producer: VSI
Units: 4
Version: 0.0
Release Date: (none)
PAK Termination Date: 10-MAR-2011
Options: IA64, PCL, VIRTUAL
Product Token:
Hardware ID:
Revision Level: 2
Status: Active
Command: MODIFY
Modified by user: SYSTEM
Modified on: 8-MAR-2010 16:45:00.32
9 – LOAD
Loads licenses, making them available for product authorization
on the current node. The product licenses must be registered and
current in the License Database. That is, they must not have been
disabled or issued.
If the license is already loaded, LMF returns an informational
message, unloads the license, and then loads the license.
To use this command, you need CMKRNL, SYSNAM, and SYSPRV
privileges.
Format
LICENSE LOAD [product-name][,...]
9.1 – Parameter
[product-name][,...]
Name or names of products with a license to be loaded. You can
load only licenses that are currently registered and enabled
in the License Database. Enter the product name exactly as it
appears on your Product Authorization Key (PAK). If you do not
specify a product name, LICENSE LOAD loads all of the products
that are registered and enabled.
You cannot use wildcard characters for product-name.
9.2 – Qualifiers
9.2.1 /AUTHORIZATION
/AUTHORIZATION=string
Positional qualifier.
Specifies a string that helps identify the license you want to
register. You must enter the authorization string exactly as it
appears on your PAK. This qualifier affects only the product name
that immediately precedes it in the command string.
9.2.2 /DATABASE
/DATABASE=filespec
Location of the License Database. The default file specification
is defined by the logical name LMF$LICENSE, which points to
SYS$COMMON:[SYSEXE]LMF$LICENSE.LDB on an unmodified OpenVMS
system. Use this optional qualifier only if you do not use the
default License Database name and location.
9.2.3 /ISSUER
/ISSUER=string
Positional qualifier.
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.
This qualifier affects only the product name that immediately
precedes it in the command string.
9.2.4 /LOG
/LOG (default)
/NOLOG
Controls whether or not LICENSE LOAD displays a message to
acknowledge the loading of each license.
9.2.5 /OEDB
/OEDB - Integrity servers only
Using this qualifier refreshes the contents of the OE database.
The contents of the OE database are described in a datafile
(LMF$OE.DAT). If new variants of operating environments become
available, VSI will provide a new datafile with information on the
new or changed operating environments. Using LICENSE LOAD/OEDB
updates your OE database without having to reboot the system.
9.2.6 /PRODUCER
/PRODUCER=string
Positional qualifier.
Name of the company that owns the product for which you have
a license. Use this optional qualifier only if you need it to
identify the license. This qualifier affects only the product
name that immediately precedes it in the command string.
9.2.7 /UNLOAD
/UNLOAD (default)
/NOUNLOAD
When requested to load a license that is currently loaded, LMF
first automatically unloads it and then loads the latest license.
You can specify /NOUNLOAD to verify whether or not there is
already a license loaded; LMF issues the warning LICENSE-W-
ALREADYLOADED and does not load the license. To then load the
license, follow these steps:
1. Manually unload the current license with the LICENSE UNLOAD
command.
2. Reissue the LICENSE LOAD command.
9.3 – Description
The LICENSE LOAD command loads licenses registered in the License
Database. To use a licensed product, ensure that the system
loads the registered license. When you register a license with
VMSLICENSE.COM, you can confirm an option to load the license,
whereas if you register a license with LICENSE REGISTER, you must
also load it with LICENSE LOAD.
Use LICENSE LOAD only after you register a new license; LMF
automatically loads all registered licenses at each subsequent
system startup. You can enter LICENSE LOAD at other times to load
modifications made with other LICENSE commands.
You can enter one LICENSE LOAD command without product-name to
load all the available registered licenses.
NOTE
Registered licenses are enabled for loading by default.
You can, however, disable a registered license to prevent
loading.
A LICENSE START command entered interactively or when the system
reboots also loads all licenses that are registered and enabled.
If you register multiple licenses for a single product, LICENSE
LOAD loads all of the matching licenses. You do not typically
load individual licenses, and you cannot unload individual
licenses for a product. The Availability, Activity, Personal Use,
and User license units of the multiple licenses work in concert
to provide more product availability.
In an OpenVMS Cluster environment, each system loads licenses
when it reboots. If you need to load a license for all assigned
nodes of a running cluster, you can do one of the following:
o Log in to each OpenVMS Cluster node, and enter LICENSE LOAD.
o Invoke the OpenVMS SYSMAN utility to execute the LICENSE
LOAD command on the desired OpenVMS Cluster nodes. See the
VSI OpenVMS System Manager's Manual for details on defining
your management environment and executing commands on a list
of nodes.
A LICENSE LOAD command can fail, sending a message to the
operator communication manager (OPCOM) for any of the following
reasons:
o Insufficient license units are registered for the current
node.
o The current date is later than the license termination date.
o A license checksum does not match the rest of the license
data. Check for data corruption in the License Database.
If you attempt to load a disabled license or a license modified
to exclude the current node in an OpenVMS Cluster environment,
OPCOM does not display an error message.
If licenses for more than one product are being loaded, LICENSE
LOAD continues with the next license following a failure.
9.4 – Examples
1.$ LICENSE MODIFY /INCLUDE=MUSIC FORTRAN
$ LICENSE LOAD FORTRAN
The commands in this example illustrate a situation in which
you enter a LICENSE LOAD command interactively. LICENSE LOAD
loads the product Fortran on the node MUSIC. Data in the
License Database determines whether the license is successfully
loaded on the specified node.
2.$ LICENSE LOAD BASIC
%LICENSE-W-NOLOAD, license was not loaded for BASIC
-LICENSE-F-EXCEEDED, attempted usage exceeds active license limits
This command attempts to load the product BASIC, but LICENSE
LOAD fails because too few license units are registered to
authorize use on the current processor.
10 – MODIFY
Modifies a license for system management and license-sharing
purposes. Immediately changes data in the License Database, but
your modifications do not affect the running system until you
load the modified license.
Format
LICENSE MODIFY qualifier[,...] product-name[,...]
10.1 – Parameter
product-name[,...]
Name or names of products with a license to be modified. You
can modify only licenses that currently exist in the License
Database.
10.2 – Qualifiers
10.2.1 /ADD
Used with the /INCLUDE or /EXCLUDE qualifier, specifies that the
node names provided are to be added to the previously established
include or exclude lists.
Used with the /RESERVE qualifier, specifies that the user
names provided are to be added to the previously established
reservation lists.
When you use /ADD, you do not need to retype the entire list to
add a new node name or user name.
10.2.2 /ALL
Positional qualifier.
Modifies all the licenses with the given product name. This
qualifier affects only the product name that immediately precedes
it in the command string.
10.2.3 /AUTHORIZATION
/AUTHORIZATION=string
Positional qualifier.
Specifies a string that helps identify the license you want to
modify. You must enter the authorization string exactly as it
appears on your PAK. Use this optional qualifier only if you
need it to identify the license. This qualifier affects only the
product name that immediately precedes it in the command string.
10.2.4 /COMBINE
/COMBINE
/NOCOMBINE
Modifies a PAK by adding or removing the COMBINE option. If the
PAKs are combinable, LMF combines them during license loading.
10.2.5 /COMMENT
/COMMENT=string
Specifies a string of text. Use this comment field of up to 63
characters to associate information for this transaction with
the license. History records for the license retain this license
information. If you specify more than one word, enclose the text
in quotation marks (""). This qualifier is optional.
The text in the comment field is replaced only when you enter new
comments with another LICENSE MODIFY command. At this point the
old comment text is available as a history record.
10.2.6 /DATABASE
/DATABASE=filespec
Specifies the location of the License Database. The default file
specification is defined by the logical name LMF$LICENSE, which
points to SYS$COMMON:[SYSEXE]LMF$LICENSE.LDB on an unmodified
OpenVMS system. Use this optional qualifier only if you do not
use the default License Database name and location.
10.2.7 /EXCLUDE
/EXCLUDE=(node-name[,node-name,...])
Specifies that the named node or nodes in an OpenVMS Cluster
environment cannot access the licensed product. The excluded
nodes cannot load (with a LICENSE LOAD or LICENSE START command)
the license registered in the License Database. Each node-name
argument must be a System Communications Services (SCS) node
name or a system parameter set with the System Generation utility
(SYSGEN). The node name might not be the same as the DECnet node
name. If you specify more than one node name, separate them with
commas, and enclose the list in parentheses. This qualifier is
optional.
To modify previously defined lists without having to retype
all of the node names, use the /ADD or /REMOVE qualifiers with
/EXCLUDE.
You can control license access to nodes with /EXCLUDE and control
user access with /RESERVE, but you cannot use these qualifiers on
the same command line. To use both types of control with the same
license, you must enter separate LICENSE MODIFY commands.
10.2.8 /INCLUDE
/INCLUDE=(node-name[,node-name,...])
Specifies that the named node or nodes in an OpenVMS Cluster
environment can access the licensed product. Only the included
nodes can load (with a LICENSE LOAD or LICENSE START command)
the license registered in the License Database. Each node-name
argument must be an SCS node name, or a system parameter set with
SYSGEN. The node name might not be the same as the DECnet node
name.
Licenses for the OpenVMS operating system usually specify the
NO_SHARE option on their PAKs. In a cluster environment you must
restrict each of these OpenVMS licenses to a single node. If
you did not do this when registering with VMSLICENSE.COM, enter
LICENSE MODIFY/INCLUDE=node-name, specifying one SCS node name
for each OpenVMS license.
To specify more than one SCS node name for a license that does
not specify NO_SHARE, separate the names with commas, and enclose
the list in parentheses. This qualifier is optional.
To modify previously defined lists without having to retype
all of the node names, use the /ADD or /REMOVE qualifiers with
/INCLUDE.
You can control license access to nodes with /INCLUDE and control
user access with /RESERVE, but you cannot use these qualifiers on
the same command line. To use both types of control with the same
license, you must enter separate LICENSE MODIFY commands.
10.2.9 /ISSUER
/ISSUER=string
Positional qualifier.
Specifies the name of the company (for example, DEC) that
issued the PAK for the product. Use this qualifier only if it is
required to identify the license. This qualifier affects only the
product name that immediately precedes it in the command string.
10.2.10 /LOG
/LOG
/NOLOG (default)
Controls whether LICENSE MODIFY displays the name of each license
that it modifies.
10.2.11 /NO_SHARE
/NO_SHARE
/NONO_SHARE
Specifies whether to add or subsequently remove /NO_SHARE from a
PAK. Adding /NO_SHARE prevents the sharing of the PAK units with
other cluster nodes.
PAKs with /NO_SHARE require you to provide the SCS node name of
the cluster node that will be using this particular license. See
the /INCLUDE qualifier for more information.
Note that if /NO_SHARE is present on your PAK when you register
it, you cannot remove the option using /NONO_SHARE. Only if
you add /NO_SHARE with the MODIFY command, can you subsequently
remove it.
10.2.12 /PRODUCER
/PRODUCER=string
Positional qualifier.
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. This
qualifier affects only the product name that immediately precedes
it in the command string.
10.2.13 /REMOVE
Used with the /INCLUDE or /EXCLUDE qualifier, specifies that
the node names provided are to be removed from the previously
established include or exclude lists.
Used with the /RESERVE qualifier, specifies that the user names
provided are to be removed from the previously established
reservation lists.
When you use /REMOVE, you do not need to retype the entire list
to remove a node name or user name.
10.2.14 /RESERVE
/RESERVE=(user-name[,user-name,...])
Specifies that the license or licenses are to be reserved for use
by the users listed in the user-name parameter. Users not listed
are denied access to the product. The value applied to user-
name differs from product to product. See your Software Product
Description (SPD) for details.
Most products define user-name to be the user name OpenVMS
maintains for each account. This is the name you type at the
Username prompt during login.
If your PAK specifies the RESERVE_UNITS option, you must assign
one or more users to a reservation list. On OpenVMS Alpha and VAX
systems, the number of user names allowed per list depends on the
number of activity units available and a constant value or the
License Unit Requirement Tables (LURTs). Calculate this number
as you would for any Activity License. For example, a 200-unit
license with a constant value of 100 is a two-user license. On
OpenVMS Integrity server systems, units are expressed in single
units that directly correlate to the constant value listed.
You can also create and modify a reservation list for
Availability and regular Activity Licenses that do not specify
the RESERVE_UNITS option. Because these licenses do not limit
the number of names on the list, you can assign as many names as
you like to the reservation list. All users not on the list are
denied access.
Although you can control license access to nodes with /INCLUDE
and /EXCLUDE qualifiers and control user access with the /RESERVE
qualifier, you cannot use these qualifiers on the same command
line. If you want to use both types of control with the same
license, you must enter separate LICENSE MODIFY commands.
Use the /ADD and /REMOVE qualifiers for further control in
modifying previously established reservation lists.
10.2.15 /SELECTION_WEIGHT
/SELECTION_WEIGHT=number
Modifies the selection weight. Selection-weight values determine
the order in which LMF checks multiple licenses when a product
makes a license grant request. LMF checks higher-weighted
licenses before lower-weighted ones. Specify arbitrary numbers
between 1 and 1000.
NOTE
You cannot modify selection weights for Availability
Licenses.
To restore the selection weight of a PAK to the default value,
enter the LICENSE MODIFY command with /SELECTION_WEIGHT=0. For
example, you can use either of the following commands:
$ LICENSE MODIFY FORTRAN /SELECTION_WEIGHT=0
$ LICENSE MODIFY FORTRAN /NOSELECTION_WEIGHT
10.2.16 /TERMINATION_DATE
/TERMINATION_DATE=date
Date at which the product license is to be terminated. If
your PAK supplied a license termination date, LMF uses the
earliest date to determine the termination date. The date must
be presented in the standard OpenVMS format: dd-mmm-yyyy. If
you want to restrict a product from further use today, enter
yesterday's date; LMF terminates the license at the end of the
day specified.
10.2.17 /UNITS
/UNITS=n
Number of license units you want on a license that includes the
MOD_UNITS option. If your PAK allows you to modify the license
units, use this qualifier to change the value in the License
Database.
10.2.18 /VIRTUAL
/VIRTUAL
/NOVIRTUAL
Specifies that the modified license must only be loaded on
OpenVMS guests. Virtual licenses are ignored during physical
machine LICENSE LOAD command processing. To see the licenses
that are ignored, use the /LOG qualifier with the LICENSE LOAD
command. Use the /NOVIRTUAL qualifier to remove the virtual
option from the license.
The /VIRTUAL qualifier is valid for licenses with the IA64 and
PCL options.
Licenses that you intend to load on OpenVMS guest cluster members
must be modified with the /VIRTUAL qualifier. It is optional,
but recommended to modify licenses for standalone OpenVMS guest
systems with the /VIRTUAL qualifier.
VSI recommends that you use /INCLUDE or /EXCLUDE lists on your
virtual machine host licenses to define all the OpenVMS guest
cluster members from a host that must load the license. In
future, VSI may limit the usage of a Virtual license to one host,
which is the first host that loads the license.
10.3 – Description
Use the LICENSE MODIFY command to modify a license. To control
which nodes in a cluster environment have access to what
software, use LICENSE MODIFY with the /INCLUDE or /EXCLUDE
qualifier. For example, you can load licenses for products used
less often or requiring limited access on one node.
If you do not specify which nodes can load a license (with a
LICENSE LOAD or LICENSE START command), LMF loads a license
on a first-come, first-served basis. When your license has
insufficient license units for full cluster environment use,
control product access with an include list.
Because most OpenVMS PAKs use the /NO_SHARE option, in a cluster
environment you must restrict these operating system licenses to
one node. Enter LICENSE MODIFY/INCLUDE=node-name, specifying only
one SCS node name for each OpenVMS license.
To control which users have access to a product, use LICENSE
MODIFY with the /RESERVE qualifier. You can create and modify
a reservation list for any kind of license. Only users on the
reservation lists are allowed access to the product.
If your PAK specifies the RESERVE_UNITS option, you must assign
one or more users to a reservation list. The number of user
names allowed per list depends on the number of activity units
available and a constant value or the License Unit Requirement
Tables (LURTs). Calculate this number as you would for any
Activity License. For example, a 200-unit license with a constant
value of 100 is a two-user license.
Use the /ADD and /REMOVE qualifiers in conjunction with the
/INCLUDE, /EXCLUDE, and /RESERVE qualifiers when you modify
existing include, exclude, and reservation lists.
To add comments about a license in the License Database, use
LICENSE MODIFY with the /COMMENT qualifier.
If your PAK includes the MOD_UNITS option, you can use the /UNITS
qualifier to specify the number of license units you want for
your registered license.
Use the other LICENSE MODIFY command qualifiers only as needed to
identify the correct license.
You can also modify a license record using the VMSLICENSE.COM
command procedure.
List Size Restrictions
Two restrictions apply to the size of lists (reservation lists,
include lists, or exclude lists). These restrictions apply to
PAKs of all license types.
o On any single PAK, the sum of characters contained in all
lists must not exceed 5000 characters.
Because the length of names varies and some overhead is
used for each name, this 5000-character limit cannot be
expressed as an exact number of permissible names. However,
VSI guarantees that at least 400 names, in total, can be
specified in the various types of lists. For example, each
of the following represents the minimally guaranteed number of
names:
- Reservation list with up to 400 user names
- Reservation list with up to 200 user names plus an include
list with up to 200 node names (totaling up to 400)
- Reservation list with up to 200 user names plus an exclude
list with up to 200 node names (totaling up to 400)
- Include list with up to 400 node names
- Exclude list with up to 400 node names
NOTE
If you enter more names than are permitted, LICENSE LIST
might not be able to display all names entered. In this
case, you receive the error message LICENSE-F-CORRUP.
However, the License Database is not actually corrupt,
and the PAKs can still be loaded into memory (though the
names are not displayed).
o The LICENSE LOAD and LICENSE START commands can load into
memory a reservation list with no more than 30,000 characters.
(Include and exclude lists, which are not loaded into memory,
are irrelevant to the 30,000-character limit.)
Because the length of names varies and some overhead is used
for each name, this 30,000-character limit cannot be expressed
as an exact number of permissible names. But VSI guarantees
that, for each product, at least 2000 user names can appear on
reservation lists. In the case of an OpenVMS Cluster, this is
a per-node limit.
Note that, because 2000 user names is a per-product limit and
because there can be more than one PAK per product, the number
of user names on a per-product basis is the sum of the user
names specified on each PAK.
For example, if three activity PAKs for the DECwrite
product were registered on a system and each PAK specified
a reservation list with 200 user names, the total number of
user names for that product is 600. This is safely below the
30,000-character (2000 user name) limit and below the 5000-
character (400 user name) limit.
10.4 – Examples
1.$ LICENSE MODIFY /EXCLUDE=(DANCE,THEATR) -
_$ /COMMENT="Modified to exclude nodes DANCE & THEATR 10/23/04" -
_$ 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.
2.$ LICENSE MODIFY /ADD /INCLUDE=(DRAMA) -
_$ /COMMENT="Modified to add node named DRAMA 10/23/04" -
_$ FORTRAN
This command modifies the Fortran license in the License
Database so that users can access Fortran from the node DRAMA
in addition to any nodes previously named in the license
include list.
3.$ LICENSE MODIFY /UNITS=1200 FORTRAN
$ LICENSE LOAD FORTRAN
This command changes the license units on a license with the
MOD_UNITS option.
4.$ LICENSE MODIFY /TERMINATION_DATE=1-JAN-2005 FORTRAN
Unless an earlier termination date exists, this command sets a
new termination date of 1-JAN-2005 for the Fortran license.
5.$ LICENSE MODIFY /EXCLUDE="" FORTRAN
This command removes all nodes from the previously established
exclude list. All nodes now have access to the Fortran license.
11 – MOVE
Moves one or more licenses from one License Database to another.
When you use LICENSE MOVE, LMF deletes those licenses from the
source License Database.
For License Databases not connected to a network, consider using
the LICENSE ISSUE /PROCEDURE command.
Format
LICENSE MOVE product-name[,...] output-database
11.1 – Parameters
product-name[,...]
Name or names of products with a license to be moved to the
output License Database.
output-database
File specification of the License Database to which the license
or licenses should be moved. This database must have been
previously created using LICENSE CREATE.
If you enter a partial file specification (for example,
specifying only a directory), LMF$LICENSE is the default file
name, and .LDB is the default file type. If you do not specify a
device or directory, the current default device and directory are
used.
11.2 – Qualifiers
11.2.1 /ALL
Positional qualifier.
Specifies that all licenses with the given product name should
be moved. This qualifier affects only the product name that
immediately precedes it in the command string.
11.2.2 /AUTHORIZATION
/AUTHORIZATION=string
Positional qualifier.
Specifies a string that helps identify the license you want to
modify. You must enter the authorization string exactly as it
appears on your PAK. Use this optional qualifier only if you
need it to identify the license. This qualifier affects only the
product name that immediately precedes it in the command string.
11.2.3 /DATABASE
/DATABASE=filespec
Specifies the location of the License Database from which
the license or licenses should be moved. The default file
specification is defined by the logical name LMF$LICENSE, which
points to SYS$COMMON:[SYSEXE]LMF$LICENSE.LDB on an unmodified
OpenVMS system. Use this optional qualifier only if you do not
use the default License Database name and location.
11.2.4 /ISSUER
/ISSUER=string
Positional qualifier.
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. This qualifier affects only the
product name that immediately precedes it in the command string.
11.2.5 /LOG
/LOG
/NOLOG (default)
Controls whether LICENSE MOVE displays the name of each license
that it moves.
11.2.6 /PRODUCER
/PRODUCER=string
Positional qualifier.
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. This
qualifier affects only the product name that immediately precedes
it in the command string.
11.3 – Description
If your license contract allows it, use LICENSE MOVE to move a
license from one License Database to another. To move a license,
enter LICENSE MOVE, including enough PAK information to clearly
identify the license. LICENSE MOVE automatically deletes the
license from the source License Database.
Note that the moved license includes only the general PAK
information normally provided by LICENSE REGISTER. LICENSE MOVE
does not transfer any user-supplied data such as reservation
lists, modified termination dates, modified units, include or
exclude node lists, or comments.
11.4 – Examples
1.$ LICENSE MOVE FORTRAN ALT_SYS2:LMF$LICENSE.LDB
This command moves the Fortran license in the default License
Database to the ALT_SYS2:LMF$LICENSE.LDB output License
Database. This command fails if the default database contains
more than one Fortran license.
2.$ LICENSE MOVE FORTRAN /DATABASE=LMFDATA:LMF$LICENSE.LDB -
_$ ALT_SYS:LMF$LICENSE.LDB
This command moves the Fortran license in the source License
Database, LMFDATA:LMF$LICENSE.LDB, to the destination License
Database, ALT_SYS:LMF$LICENSE.LDB. This command fails if the
source License Database contains more than one Fortran license.
3.$ LICENSE MOVE FORTRAN /ALL ALT_SYS2:LMF$LICENSE.LDB
This command moves all Fortran licenses in the default
License Database to the output License Database, ALT_
SYS2:LMF$LICENSE.LDB.
4.$ LICENSE MOVE * ALT_SYS2:LMF$LICENSE.LDB
This command merges two databases by moving all licenses in
the default License Database to the output License Database,
ALT_SYS2:LMF$LICENSE.LDB.
12 – 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 it appears.
You can also 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
12.1 – Parameter
product-name
Name of the product with a license to register. You can register
only licenses that do not currently exist in the License
Database. You can register multiple licenses for the same product
when they have different authorization numbers. Enter the product
name exactly as it appears on your PAK.
You cannot use wildcard characters for the product-name parameter
with this command.
12.2 – Qualifiers
12.2.1 /ACTIVITY
/ACTIVITY=code | CONSTANT=integer
Specifies a license unit code that corresponds to a License Unit
Requirement Table (LURT) or to a constant value. If your PAK
supplies an activity code, you must enter the code exactly as
it appears. The current codes are A, B, C, D, E, F, G, H, and I.
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.
12.2.2 /AUTHORIZATION
/AUTHORIZATION=string
Specifies a string that helps identify the license you want to
register. You must enter the authorization string exactly as it
appears on your PAK.
12.2.3 /AVAILABILITY
/AVAILABILITY= code | CONSTANT=integer
Specifies a license unit code that corresponds to a License Unit
Requirement Table (LURT) or to a constant value. If your PAK
supplies an availability code, you must enter the code exactly
as it appears. The current codes are A, B, C, D, E, F, G, H, and
I. If your PAK specifies the keyword CONSTANT, then you must also
specify the integer value from your PAK. PAK issuers determine
the value for this element.
12.2.4 /CHECKSUM
/CHECKSUM=string
Specifies a 17-character verification string created by the PAK
issuer for each PAK. The checksum string is presented in the
format n-cccc-cccc-cccc-cccc, where n is an integer and c is
an alphabetic character from A through P. A PAK presents the
checksum string with hyphen (-) characters for readability.
Because LMF does not count hyphens for authorization, you do not
have to enter them. Otherwise, you must enter the checksum string
exactly as it appears on your PAK.
12.2.5 /DATABASE
/DATABASE=filespec
Specifies the location of the License Database. The default file
specification is defined by the logical name LMF$LICENSE, which
points to SYS$COMMON:[SYSEXE]LMF$LICENSE.LDB in an unmodified
OpenVMS system. Use this optional qualifier only if you do not
use the default database.
12.2.6 /HARDWARE_ID
/HARDWARE_ID=string
Specifies the identification number of the hardware on which
the product is licensed. If your PAK supplies a hardware
identification number, you must enter the information exactly as
it appears. On Integrity server systems, the HARDWARE_ID string
is in the format SOCKETS=n.
12.2.7 /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 appears on your PAK.
12.2.8 /OPTIONS
/OPTIONS=[(keyword[,...])]
Specifies LICENSE REGISTER options. If your PAK supplies any
license options, you must enter this information exactly as it
appears.
The following table describes the available keywords.
Keyword Meaning
ALPHA Identifies Availability Licenses for Alpha
systems.
HARD_COMPLIANCE Identifies a license that will enforce
compliance to license terms.
IA64 Identifies Licenses for Integrity server
systems.
IA64_ALPHA Identifies Activity Licenses that are valid
for OpenVMS Integrity servers and OpenVMS Alpha
systems.
IA64_ALPHA_VAX Identifies Activity Licenses that are valid for
OpenVMS Integrity servers, OpenVMS Alpha, and
OpenVMS VAX systems.
MOD_UNITS You can modify the number of license units.
NO_SHARE You cannot use the license on more than one
processor in an OpenVMS Cluster environment.
To use this license in a cluster, designate
it for one node. Issue LICENSE MODIFY with the
/INCLUDE qualifier.
PCL Designates a Per Core License on an OpenVMS
Integrity server system.
RESERVE_UNITS The license must be assigned to one or more
users. Reserve the license using LICENSE MODIFY
with the /RESERVE qualifier.
USER Designates a User License.
VAX_ALPHA Identifies Availability Licenses that are valid
for both OpenVMS VAX and OpenVMS Alpha systems.
If you enter more than one keyword, separate them with commas,
and enclose the list in parentheses. You can abbreviate each
option to the minimum number of characters needed to uniquely
identify it.
12.2.9 /PRODUCER
/PRODUCER=string
Specifies the name of the company (for example, VSI) that owns
the product for which you have a license. You must enter the
information exactly as it appears on your PAK.
12.2.10 /RELEASE_DATE
/RELEASE_DATE=date
Specifies a product release date such that the license authorizes
use of all product versions released on or before the date. If
your PAK supplies a product release date, you must enter the
information exactly as it appears. The date must be presented in
the standard OpenVMS format: dd-mmm-yyyy.
12.2.11 /TERMINATION_DATE
/TERMINATION_DATE=date
Specifies the date on which the product license terminates. If
your PAK supplies a license termination date, you must enter it
exactly as it appears. The date must be presented in the standard
OpenVMS format: dd-mmm-yyyy.
12.2.12 /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 it appears.
12.2.13 /UNITS
/UNITS=number
Specifies the number of license units for your license. You must
enter the number exactly as it appears on your PAK even if your
PAK specifies the MOD_UNITS option.
12.2.14 /VERSION
/VERSION=nn.nn
Limits the version number of the product for which you have a
license. Use the format integer.integer. If your PAK supplies
version information, you must enter it exactly as it appears.
12.3 – Description
LICENSE REGISTER is the primary LICENSE command. Before you enter
a LICENSE REGISTER command, you need a PAK that supplies the
information required to enter a license in the License Database.
You can register additional licenses for products that already
exist in the License Database. If you register another combinable
license in the License Database, LMF combines the license units
during a LICENSE LOAD or LICENSE START command. This allows more
product availability or activity for the same product.
The checksum number supplied with your PAK is calculated from
the other information supplied with the PAK. Thus, you must
enter each qualifier necessary to supply information from your
particular PAK. If you enter LICENSE REGISTER without a required
qualifier, LMF returns a checksum error.
12.4 – Examples
1.$ LICENSE REGISTER FORTRAN /ISSUER=DEC /AUTHORIZATION=USA-10 -
_$ /PRODUCER=DEC /UNITS=400 /VERSION=5.4 -
_$ /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
for OpenVMS Routing) to the default License Database. In the
example, DVNETRTG is licensed using the availability formula
with 1000 license units.
13 – START
This command loads all licenses that are registered and enabled
in the License Database into memory. On OpenVMS Alpha and VAX
systems, it sets up the License Unit Requirement Table (LURT)
for your system. On OpenVMS Integrity server systems, it loads
the operating environment table and all per core licenses into
memory. Because the OpenVMS operating system issues a LICENSE
START command during system startup, you should need this command
only if system startup fails.
To use this command, you need CMKRNL, SYSNAM, and SYSPRV
privileges on OpenVMS Alpha systems. In addition to those three,
you also need SYSLCK privilege on OpenVMS Integrity server
systems.
To load the licenses in the License Database of a system with LMF
already started, use LICENSE LOAD.
Format
LICENSE START
13.1 – Parameters
None.
13.2 – Qualifiers
13.2.1 /DATABASE
/DATABASE=filespec
Specifies the location of the License Database. The default file
specification is defined by the logical name LMF$LICENSE, which
points to SYS$COMMON:[SYSEXE]LMF$LICENSE.LDB on an unmodified
OpenVMS system. Use this optional qualifier only if you do not
use the default database.
13.2.2 /LOG
/LOG (default)
/NOLOG
Controls whether LICENSE START displays a message to acknowledge
the loading of each product license.
13.3 – Example
$ LICENSE START
On OpenVMS Alpha and VAX systems, this command sets up the LURT
for your system and loads all the licenses that are registered
and enabled in the License Database. On OpenVMS Integrity
server systems, this command loads the operating environment
table and all PCL licenses into memory.
14 – UNLOAD
Unloads 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 loaded
with an interactive or automatic LICENSE LOAD command. Running
processes are allowed to continue to completion.
To use this command, you need CMKRNL, SYSNAM, and SYSPRV
privileges.
Format
LICENSE UNLOAD product-name[,...]
14.1 – Parameter
product-name[,...]
Name of the product to be unloaded. You can unload only licenses
that have been loaded. Enter each product name exactly as it
appears on its Product Authorization Key (PAK). You cannot use
wildcard characters for product-name.
14.2 – Qualifiers
14.2.1 /LOG
/LOG
/NOLOG (default)
Controls whether LICENSE UNLOAD lists the name of each unloaded
license.
14.2.2 /PRODUCER
/PRODUCER=string
Positional qualifier.
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 on Alpha and VAX is DEC. On Integrity servers,
the default string is VSI. If DEC or VSI is not the producer of
the product, you must use this qualifier to identify the product.
This qualifier affects only the product name that immediately
precedes it in the command string. Wildcard characters are not
allowed.
14.3 – Description
LICENSE UNLOAD affects all units for a single product even if
the loaded units are combined from multiple licenses. In such a
case, you cannot unload the units from a single license. You must
unload all the units.
You are not required to unload a loaded license before modifying
data in the License Database. To maximize product availability,
modify licenses in the License Database first, and then load
the changes by entering a LICENSE UNLOAD command followed by a
LICENSE LOAD command.
14.4 – Examples
1.$ LICENSE UNLOAD /PRODUCER=DEC FORTRAN
This command unloads the VSI Fortran license on the node from
which it is entered.
2.$ LICENSE UNLOAD PASCAL,FORTRAN
This command unloads the VSI Pascal and VSI Fortran licenses on
the node from which it is entered.
15 – SHOW
15.1 – LICENSE
Displays software product licenses active on the current node
and lists the names attached to a license (known as the RESERVE
list). The SHOW LICENSE command displays the license database
information currently in your system's memory. Use the License
Management utility command, LICENSE LIST, when you want to view
the license database information that is on disk.
Format
SHOW LICENSE [product-name [,...]]
15.1.1 – Parameter
product-name
Specifies the name or names of activated software product
licenses to display. The asterisk (*) and the percent sign (%)
wildcard characters are allowed. If you do not specify a product
name, information is displayed about all active product name
licenses. The product-name parameter is incompatible with the
/UNIT_REQUIREMENTS qualifier.
15.1.2 – Description
The DCL command SHOW LICENSE displays software product licenses
active on the current node. An active license is one that has
been registered in the LICENSE database and has been loaded
into system memory. To register and activate software product
licenses, use the License Management utility (LICENSE) or
VMSLICENSE.COM. Some licenses are registered automatically during
product installation.
To display licenses registered in the LICENSE database, use the
LICENSE LIST command.
15.1.3 – Qualifiers
15.1.3.1 /BEFORE
Use with /TERMINATION_DATE and /RELEASE_DATE qualifiers. Selects
only those licenses whose times are before the time specified
with the other qualifiers.
The /BEFORE qualifier cannot be used with the /SINCE qualifier.
15.1.3.2 /BRIEF
/BRIEF (default)
Displays a summary of information about the specified active
product licenses. Use the /FULL qualifier to obtain a complete
product license listing.
15.1.3.3 /CHARGE_TABLE
Synonym for the /UNIT_REQUIREMENTS qualifier.
15.1.3.4 /CLUSTER
Use with the /UNIT_REQUIREMENTS qualifier to display the license
unit requirements for every node in an OpenVMS Cluster.
15.1.3.5 /EXACT
Use with the /PAGE=SAVE and /SEARCH qualifiers to specify a
search string that must match the search string exactly and must
be enclosed with quotation marks (" ").
If you specify the /EXACT qualifier without the /SEARCH
qualifier, exact search mode is enabled when you set the search
string with the Find (E1) key.
15.1.3.6 /FULL
Displays a summary of information about the specified active
product licenses, including Product Authorization Key (PAK)
options and the reserve list (if any). On Integrity server
systems, lists the licenses for OEs currently active on the
system.
15.1.3.7 /HIERARCHY
/HIERARCHY - Integrity servers only
Displays the hierarchy of licenses for operating environments
active on the current node.
15.1.3.8 /HIGHLIGHT
/HIGHLIGHT[=keyword]
Use with the /PAGE=SAVE and /SEARCH qualifiers to specify the
type of highlighting you want when a search string is found. When
a string is found, the entire line is highlighted. You can use
the following keywords: BOLD, BLINK, REVERSE, and UNDERLINE. BOLD
is the default highlighting.
15.1.3.9 /OE
/OE[=OE name] - Integrity servers only
When an OE name is specified, displays the contents the of named
operating environment. Currently, valid OE names are BOE and
HA-OE. When no OE name is specified, displays the operating
environment currently active on the node.
15.1.3.10 /OUTPUT
/OUTPUT[=filespec]
/NOOUTPUT
Controls where the output of the SHOW LICENSE command is sent.
By default, the output of the SHOW LICENSE command is sent to the
current SYS$OUTPUT device (usually your terminal). To send the
output to a file, use the /OUTPUT qualifier followed by a file
specification.
The asterisk (*) and the percent sign (%) wildcard characters
are not allowed in the file specification. If you enter a partial
file specification (for example, specifying only a directory),
SHOW is the default file name and .LIS is the default file type.
If you enter the /NOOUTPUT qualifier, output is suppressed.
15.1.3.11 /PAGE
/PAGE[=keyword]
/NOPAGE (default)
Controls the display of license information on the screen.
You can use the following keywords with the /PAGE qualifier:
CLEAR_SCREEN Clears the screen before each page is displayed.
SCROLL Displays information one line at a time.
SAVE[=n] Enables screen navigation of information, where n
is the number of pages to store.
The /PAGE=SAVE qualifier allows you to navigate through screens
of information. The /PAGE=SAVE qualifier stores up to 5 screens
of up to 255 columns of information. When you use the /PAGE=SAVE
qualifier, you can use the following keys to navigate through the
information:
Key Sequence Description
Up arrow key, Scroll up one line.
Ctrl/B
Down arrow key Scroll down one line.
Left arrow key Scroll left one column.
Right arrow key Scroll right one column.
Find (E1) Specify a string to find when the
information is displayed.
Insert Here (E2) Scroll right one half screen.
Remove (E3) Scroll left one half screen.
Select (E4) Toggle 80/132 column mode.
Prev Screen (E5) Get the previous page of information.
Next Screen (E6), Get the next page of information.
Return, Enter,
Space
F10, Ctrl/Z Exit. (Some utilities define these
differently.)
Help (F15) Display utility help text.
Do (F16) Toggle the display to oldest/newest page.
Ctrl/W Refresh the display.
The /PAGE qualifier is not compatible with the /OUTPUT qualifier.
15.1.3.12 /PRODUCER
/PRODUCER=producer-name
Displays software product licenses active on the current node
and supplied by the specified producer. The asterisk (*) and
the percent sign (%) wildcard characters are allowed for the
producer-name parameter. You cannot use the /PRODUCER qualifier
with the /UNIT_REQUIREMENTS qualifier.
FOR VSI PRODUCTS ONLY
On OpenVMS VAX and Alpha systems, the producer is shown as
DEC. On OpenVMS Integrity server systems, the producer is
shown as VSI.
15.1.3.13 /RELEASE_DATE
/RELEASE_DATE=[date_time]
Allows listing licenses using release dates as selection
criteria.
15.1.3.14 /SEARCH
/SEARCH="string"
Use with the /PAGE=SAVE qualifier to specify a string that you
want to find in the information being displayed. Quotation marks
are required for the /SEARCH qualifier, if you include spaces in
the text string.
You can also dynamically change the search string by pressing the
Find key (E1) while the information is being displayed. Quotation
marks are not required for a dynamic search.
15.1.3.15 /SINCE
/SINCE(default)
Use with the /TERMINATION_DATE and /RELEASE_DATE qualifiers.
Selects only those licenses whose times are on or after the time
specified with the other qualifiers.
The /SINCE qualifier cannot be used with the /BEFORE qualifier.
15.1.3.16 /TERMINATION_DATE
/TERMINATION_DATE=date_time
Allows listing licenses using termination dates as selection
criteria.
15.1.3.17 /UNIT_REQUIREMENTS
On Alpha and VAX systems, displays information in the License
Unit Requirement Table (LURT). On Integrity server systems,
displays information about the type of system, the number of
CPUs active, and the number of sockets. The /UNIT_REQUIREMENTS
qualifier is incompatible with the product-name parameter and
with the /BRIEF and /PRODUCER qualifiers.
15.1.3.18 /USAGE
Tells you how many license units are loaded, how many are
currently allocated, and how many are currently available, as
well as the license type for each product on the system. Use with
the /FULL qualifier to display complete information-including the
PID, process name, node, or user name-for each instance of use
of the product. You need group privilege to see the list of users
in your group who have allocated license units; you need world
privilege to see the list of users in all groups.
In an OpenVMS Cluster, if you own multiple license types for a
single product, you are limited to viewing the usage information
for the license type loaded on the node from which you are
executing the SHOW LICENSE/USAGE command. To find out the usage
of the other license type loaded on another node, issue the
command on that node. You can also use the System Management
(SYSMAN) utility to do this.
In an OpenVMS Cluster, usage information is limited to the local
license type. For example, VAX and Alpha availability licenses
are considered by LMF to be different license types. If you
are running both VAX and Alpha systems in a cluster, usage
information for availability licenses is limited to the local
system type. For example, if you have DEC C installed on all
nodes in your OpenVMS Cluster, you can display DEC C license
allocation on all the VAX nodes in the cluster from any VAX node
with DEC C installed, but you cannot display the DEC C license
allocation on the Alpha nodes.
Usage information is not available for unlimited licenses (a
license with 0 units). Clusterwide usage information is not
available for personal use or NO_SHARE licenses. Refer to the
VSI OpenVMS License Management Utility Manual for more information
on license types.
15.1.3.19 /WARNING_INTERVAL
/WARNING_INTERVAL=n
NOWARNING_INTERVAL
Displays a warning stating the number of licenses that will
terminate in n days. The default is 30 days.
15.1.3.20 /WRAP
/WRAP
/NOWRAP (default)
Use with the /PAGE=SAVE qualifier to limit the number of columns
to the width of the screen and to wrap lines that extend beyond
the width of the screen to the next line.
The /NOWRAP qualifier extends lines beyond the width of the
screen and can be seen when you use the scrolling (left and
right) features provided by the /PAGE=SAVE qualifier.
15.1.4 – Examples
1.$ SHOW LICENSE/FULL
Active licenses on node WTPOOH:
DVNETEND
Producer: DEC
Units: 0
Version: 0.0
Release Date: (none)
Termination Date: 31-DEC-2012
Availability: 0
Activity: 100
MOD_UNITS
Product Token:
OPENVMS-ALPHA
Producer: DEC
Units: 0
Version: 0.0
Release Date: (none)
Termination Date: 31-DEC-2012
Availability: 0
Activity: 100
MOD_UNITS
Product Token:
The SHOW LICENSE command in this example displays all the
active licenses on the current Alpha node, WTPOOH.
2.$ SHOW LICENSE/FULL
Active licenses on node MACCHU:
C
Producer: VSI
Units: 3
Version: 0.0
Release Date: (none)
Termination Date: 31-DEC-2012
Availability: 0
Activity: 1
MOD_UNITS
IA64_ALPHA
Product Token:
DVNETEXT
Producer: VSI
Units: 4
Version: 0.0
Release Date: (none)
Termination Date: 31-DEC-2012
Per Core License
Activity: 0
IA64
Product Token:
OPENVMS-I64-BOE
Producer: VSI
Units: 4
Version: 0.0
Release Date: (none)
Termination Date: 31-DEC-2012
Per Core License
Activity: 0
IA64
Product Token:
The SHOW LICENSE command in this example displays all the
active licenses on the current Integrity server node, MACCHU.
3.$ SHOW LICENSE/BRIEF
Active licenses on node WTPOOH:
--- Product ID ---- ---- Rating ----- -- Version --
Product Producer Units Avail Activ Version Release Termination
DVNETEND DEC 0 0 100 0.0 (none) (none)
VAX-VMS DEC 0 0 100 0.0 (none) (none)
The SHOW LICENSE command in this example displays a summary of
all the active licenses on the current VAX node, WTPOOH.
4.$ SHOW LICENSE/OUTPUT=SYS$LOGIN:ACTIVE_LICENSES_OCT30.DAT
The SHOW LICENSE command in this example writes all the active
licenses to the file named SYS$LOGIN:ACTIVE_LICENSES_OCT30.DAT.
5.$ SHOW LICENSE/FULL PERSONAL
Active licenses on node PICCHU:
PERSONAL
Producer: DEC
Units: 100
Version: 0.0
Release Date: (none)
Termination Date: (none)
Availability: 0
Activity: 100
RESERVE_UNITS
Reserve: RANCE
The SHOW LICENSE command in this example displays information
about the product PERSONAL, as well as the name RANCE attached
to the product license (known as the RESERVE list).
6.$ SHOW LICENSE/TERM=10-JAN-2014 test0%
Active licenses on node PICCHU:
--- Product ID ---- ---- Rating ----- -- Version --
Product Producer Units Avail Activ Version Release Termination
TEST01 VSI 0 A 0 0.0 (none) (none)
TEST02 VSI 0 B 0 0.0 10-JAN-2014 12-NOV-2014
TEST03 VSI 0 C 0 0.0 30-DEC-2014 (none)
TEST04 VSI 0 D 0 0.0 (none) 25-AUG-2015
TEST05 VSI 0 E 0 0.0 14-NOV-2016 14-AUG-2016
$ SHOW LICENSE/RELEASE=10-JAN-2014/SINCE test0%
Active licenses on node PICCHU:
--- Product ID ---- ---- Rating ----- -- Version --
Product Producer Units Avail Activ Version Release Termination
TEST02 VSI 0 B 0 0.0 10-JAN-2014 12-NOV-2014
TEST03 VSI 0 C 0 0.0 30-DEC-2014 (none)
TEST05 VSI 0 E 0 0.0 14-NOV-2016 14-AUG-2016
$ SHOW LICENSE/RELEASE=10-JAN-2014/BEFORE test0%
Active licenses on node PICCHU:
--- Product ID ---- ---- Rating ----- -- Version --
Product Producer Units Avail Activ Version Release Termination
TEST01 VSI 0 A 0 0.0 (none) (none)
TEST04 VSI 0 D 0 0.0 (none) 25-AUG-2015
In these examples, the SHOW LICENSE command uses the /TERM,
/RELEASE, /SINCE and /BEFORE qualifiers.
7.$ SHOW LICENSE/UNIT_REQUIREMENTS
VMS/LMF Charge Information for node PICCHU
This is a AlphaServer 8400 5/440, hardware model type 1567
Type: A, Units Required: 2700 (VAX/VMS Capacity or OpenVMS
Unlimited or Base)
Type: B, * Not Permitted * (VAX/VMS F&A Server)
Type: C, * Not Permitted * (VAX/VMS Concurrent User)
Type: D, * Not Permitted * (VAX/VMS Workstation)
Type: E, * Not Permitted * (VAX/VMS System Integrated Products)
Type: F, * Not Permitted * (VAX Layered Products)
Type: G, * Not Permitted * (Reserved)
Type: H, Units Required: 1150 (Alpha Layered Products)
Type: I, Units Required: 1150 (Layered Products)
In this example, the /UNIT_REQUIREMENTS qualifier displays
information in the License Unit Requirement Table (LURT) for
the Alpha node PICCHU.
8.$ SHOW LICENSE/CHARGE_TABLE
OpenVMS I64/LMF Charge Information for node MACCHU
This is an HP rx2600(900MHz/1.5MB), with 2 CPUs active, 2 socket(s)
Type: PPL, Units Required: 2 (I64 Per Processor)
Type: PCL, Units Required: 2 (I64 Per Core)
This example displays the CHARGE_TABLE information for an
Integrity server node MACCHU with two active processor cores.
9.$ SHOW LICENSE/CHAR/CLUSTER
VMS/LMF Cluster License Unit Requirements Information 14-MAR-2010
06:39:41.54
Node A B C D E F G H I PCL
FISH 20 - - - - - - 1050 1050 -
SWORD 15 - - - - - - 1050 1050 -
SALMON 12 - - - - - - 1050 1050 -
MONGER 12 - - - - - - 1050 1050 -
GORDON 15 - - - - - - 1050 1050 -
ARTIST - - - - - - - - - 2
PAINTS - - - - - - - - - 1
Total Cluster Unit Requirements
Type: A, Units Required: 74 (VAX/VMS Capacity or OpenVMS
Unlimited or Base)
Type: B, * Not Permitted * (VAX/VMS F&A Server)
Type: C, * Not Permitted * (VAX/VMS Concurrent User)
Type: D, * Not Permitted * (VAX/VMS Workstation)
Type: E, * Not Permitted * (VAX/VMS System Integrated Products)
Type: F, * Not Permitted * (VAX Layered Products)
Type: G, * Not Permitted * (Reserved)
Type: H, Units Required: 5250 (Alpha Layered Products)
Type: I, Units Required: 5250 (Layered Products)
Type: PPL, Units Required: 3 (I64 Per Processor)
Type: PCL, Units Required: 3 (I64 Per Core)
In this example, the display shows how many license units are
required for each license type (A, B, etc. on Alpha and VAX
and PCL on Integrity servers) on each node in the cluster. If a
row of three asterisks (***) is displayed for a node, it means
that the node is in the process of booting.
10$ SHOW LICENSE/OE
Current Operating Environment on node MACCHU at 8-MAR-2010
16:12:51.72
--------- Operating Environment ---------- ------ Units ------
Name Description Type Level Loaded Total
HAOE High Availability H 5 4 4
This example shows the currently operating environment (HAOE)
on an Integrity server node MACCHU.
11$ SHOW LICENSE/HIER/FULL
Operating Environment Hierarchy
-------------------------------
--------- Operating Environment ---------- ------ Units ------
Name Description Type Level Loaded Total
HAOE High Availability H 5 2 2
GWLM
MCOE Mission Critical H 4 - 2
RTR-SVR
VMSCLUSTER
VMSCLUSTER-CLIENT
EOE Enterprise H 3 - 2
AVAIL-MAN
RMSJNL
VOLSHAD
BOE Base H 2 - 2
DECRAM
OMS
FOE Foundation H 1 - 2
OPENVMS-I64
OPENVMS-USER
DVNETEND
DW-MOTIF
UCX
TDC
X500-ADMIN-FACILITY
X500-DIRECTORY-SERVER
CIFS
This example displays information about the available operating
environments, the hierarchy among them, and the products
contained in each OE on an Integrity servers system.
12$ SHOW LICENSE/OE=BOE/FULL
--------- Operating Environment ---------- ------ Units ------
Name Description Type Level Loaded Total
BOE Base H 2 4 7
DECRAM
OMS
OPENVMS-I64
OPENVMS-USER
DVNETEND
DW-MOTIF
UCX
TDC
X500-ADMIN-FACILITY
X500-DIRECTORY-SERVER
CIFS
This example shows all the products included in the Base
Operating Environment (BOE) on an Integrity server node.
13$ SHOW LICENSE OPENVMS-I64-HAOE
Active licenses on node MACCHU:
------- Product ID -------- ---- Rating ----- -- Version --
Product Producer Units PCL Activ Version Release Termination
OPENVMS-I64-HAOE VSI 4 1 0 0.0 (none) 10-MAR-2011
This example shows licensing information for the HA-OE
environment currently active on an Integrity server node
MACCHU.
14$ SHOW LICENSE/WARNING_INTERVAL=8000 test0%
Active licenses on node PICCHU:
--- Product ID ---- ---- Rating ----- -- Version --
Product Producer Units Avail Activ Version Release Termination
TEST01 VSI 0 A 0 0.0 (none) (none)
TEST02 VSI 0 B 0 0.0 10-JAN-2014 12-NOV-2014
TEST03 VSI 0 C 0 0.0 30-DEC-2014 (none)
TEST04 VSI 0 D 0 0.0 (none) 25-AUG-2015
TEST05 VSI 0 E 0 0.0 14-NOV-2016 14-AUG-2016
%SHOW-I-TERMIMM, 3 licenses will terminate in 8000 days
The /WARNING_INTERVAL qualifier in this example displays three
licenses that will terminate in 8000 days.
15$ SHOW LICENSE/USAGE/FULL DECWRITE-USER
View of loaded licenses from node SLTG24 29-DEC-2001 13:36:22.23
ACTIVITY license DECWRITE-USER usage information:
Pid Process Name Units Username Node
416000E6 MACAHAY 100 MACAHAY SLTG24
416000E7 MACAHIGH 100 MACAHIGH SLTG24
416000E8 ALICE 100 ALICE SLTG24
416000E9 MORGEN 100 MORGEN SLTG24
416000F1 ANGEL 100 ANGEL SLTG24
416000F2 ANGEL_1 100 ANGEL SLTG24
Units loaded: 2000 Units allocated: 600 Units available: 1400
The SHOW LICENSE command in this example lists the current
users of the activity license for the product DECwrite. For
each instance of use of the product, the process identification
(PID), process name, node, and user name are identified. The
units column shows the number of units allocated for each
particular invocation of the product. The last line displays
the units loaded when the LICENSE LOAD command was given, the
total number of units currently allocated, and the total of
unused (available for others to use) units.
16$ SHOW LICENSE/USAGE/FULL TEST_PER
View of loaded licenses from node: SLTG24 30-DEC-2001 15:45:59
PERSONAL USE license VSI TEST_PER usage information:
Units Reserved for:
100 UNCLE
100 AUNT
100 NEPHEW
100 NIECE
Units loaded: 600 Units reserved: 400 Units available: 200
This example shows a personal use license. The VSI TEST_PER
product has enough units for six reservations with 100 units
for each reservation. The license database (LDB) only has
a total of four names in the reserve list attached to this
product. If the license administrator (usually the system
manager) wants to take full advantage of this license and adds
2 more names to the reserve list, he should use the following
commands to update the product information:
$ LICENSE MODIFY TEST_PER/RESERVE=(NAME, ANOTHER_NAME)/ADD
$ LICENSE UNLOAD TEST_PER
$ LICENSE LOAD TEST_PER
If this product is used in a cluster environment, you may use
the SYSMAN utility to unload and load the license.
17$ SHOW LICENSE/USAGE/FULL TEST_CAP
View of loaded licenses from node: SLTG24 30-DEC-2001 15:45:59
Availability license VSI TEST_CAP usage information:
Units Node
10 SLTG24
10 SLTG43
600 TORN8O
600 LTNUP
Units loaded: 620 Units allocated: 1220 Units available: ***
In this example, the number of units allocated appears to be
greater than the total units loaded and the units available
value is three asterisks (***).
When you see three asterisks (***) as the number of units
available, it is generally not a cause for alarm. This
situation might arise when the license database (LDB) has
been updated on disk, but the new information has not been
propagated to the license database in memory on all nodes in
the cluster. This node, SLTG24, happens to be one of the nodes
that has not received the latest LDB information.
To update the information in the license database in memory for
the TEST_CAP product, enter the following commands:
$ LICENSE UNLOAD TEST_CAP
$ LICENSE LOAD TEST_CAP
The next time you issue the SHOW LICENSE/USAGE command the
three asterisks (***) in display should disappear. If,
however, you are using multiple LDB files in a cluster, you
should read the section on the license database in the VSI
OpenVMS License Management Utility Manual.
18$ SHOW LICENSE/UNIT_REQUIREMENT/CLUSTER
VMS/LMF Cluster License Unit Requirements Information 24-DEC-2001
14:05:51.65
Node A B C D E F G H I
KARBO - - - 100 50 10 - - 10
JENJON - - - 100 50 10 - - 10
HELENA 143 - - - 600 2400 - - 2400
SHAKTI - - - 100 50 10 - - 10
Total Cluster Unit Requirements
Type: A, Units Required: 143 (VMS Capacity)
Type: B, * Not Permitted * (VMS Server)
Type: C, * Not Permitted * (VMS Concurrent User)
Type: D, Units Required: 300 (VMS Workstation)
Type: E, Units Required: 750 (System Integrated Products)
Type: F, Units Required: 2430 (Layered Products)
Type: G, * Not Permitted * (VMS Reserved)
Type: H, * Not Permitted * (Alpha Layered Products)
Type: I, Units Required: 2430 (Layered Products)
In this example, the display shows how many license units are
required for each license type (A, B, etc.) on each node in the
cluster. If a row of three asterisks (***) is displayed for a
node, it means that the node is in the process of booting.
19.$ SHOW LICENSE/USAGE
View of loaded licenses from node REDSOX 8-MAR-2010 16:20:11.14
------- Product ID ---- ---- Unit usage information ------
Product Producer Loaded Allocated Available Compliance
C VSI 250 0 250 Yes
DVNETEXT VSI 4 3 1 Yes
OPENVMS-I64-BOE VSI 2 2 0 Yes
OPENVMS-I64-HAOE VSI 20 8 12 Yes
VAXSET VSI 10 8 2 Yes
This example shows how many license units are loaded, how many
are currently allocated, and how many are available on REDSOX,
an Integrity servers system. The last column in the display
shows that are products are in compliance with their license
unit requirements.
20.$ SHOW LICENSE/USAGE
View of loaded licenses from node HOVMS2 8-MAR-2010 08:38:17.13
------- Product ID -------- ---- Unit usage information --------
Product Producer Loaded Allocated Available Compliance
OPENVMS-I64-HAOE VSI Virtual Machine guest, no usage information
Issuing the SHOW LICENSE/USAGE command from an OpenVMS guest
cluster member displays the text "Virtual Machine guest, no
usage information" for PCL licenses loaded on the system. There
is essentially no usage charge against the license units for
OpenVMS guest nodes since multiple guests can run on the same
host using the same license units.