Document revision date: 30 March 2001

## OpenVMS License Management Utility Manual

Previous | Contents | Index

## Appendix A
Command Reference

This appendix describes the syntax of the following License Management utility (LICENSE) and SHOW LICENSE commands:

- LICENSE COPY
- LICENSE CREATE
- LICENSE DELETE
- LICENSE DISABLE
- LICENSE ENABLE
- LICENSE ISSUE
- LICENSE LIST
- LICENSE LOAD
- LICENSE MODIFY
- LICENSE MOVE
- LICENSE REGISTER
- LICENSE START
- LICENSE UNLOAD
- SHOW LICENSE

## LICENSE 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 reenable 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

### 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.

### Qualifiers

> #### /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.

> #### /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.

> #### /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.

> #### /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 to identify the license. This qualifier affects only the product name that immediately precedes it in the command string.

> #### /LOG

> #### /NOLOG (default)

> Controls whether LICENSE COPY displays the name of each license that it copies.

> #### /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 to identify the license. This qualifier affects only the product name that immediately precedes it in the command string.

### Description

> To copy a license from one database to another, use LICENSE COPY. The following conditions apply to a LICENSE COPY transaction:
> - The status of the source database license changes to disabled.
> - 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.
> - 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.

###

#### 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.

## LICENSE 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 License Unit Requirement Table (LURT) file (SYS$COMMON:[SYSEXE]LMF$LURT.DAT), which comes installed with OpenVMS.

### Format

> LICENSE CREATE

### Parameters

> None.

### Qualifier

> #### /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.

### Example

    $ LICENSE CREATE /DATABASE=SYS$MANAGER:LMF$LICENSE.LDB

> This command creates the License Database named LMF$LICENSE.LDB in the directory SYS$MANAGER.

## LICENSE DELETE

> Deletes one or more licenses and all history information for those licenses from the License Database.

### Format

> LICENSE DELETE product-name[,...]

### 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.

### Qualifiers

> #### /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.

> #### /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.

> #### /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.

> #### /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.

> #### /LOG

> #### /NOLOG (default)

> Controls whether LICENSE DELETE displays the name of each license that it deletes.

> #### /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.

> #### /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:

> - ALL (default)---Deletes all specified licenses in the database.
> - 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.
> - DISABLED---Deletes all specified disabled licenses in the database.
> - 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.
> - 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.

### 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.

###

#### 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.

## LICENSE DISABLE

> Disables a license currently registered in the License Database.

### Format

> LICENSE DISABLE product-name[,...]

### 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).

### Qualifiers

> #### /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.

> #### /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.

> #### /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.

> #### /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.

> #### /LOG

> #### /NOLOG (default)

> Controls whether LICENSE DISABLE displays the name of each license that it disables.

> #### /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.

### 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 licences, 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.

### Example

    $ LICENSE DISABLE ABCD /PRODUCER=DEC

> This command disables the license for ABCD software produced by Compaq. Because no database is specified, LMF uses the default database.

## LICENSE 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[,...]

### 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.

### Qualifiers

> #### /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.

> #### /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.

> #### /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.

> #### /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.

> #### /LOG

> #### /NOLOG (default)

> Controls whether LICENSE ENABLE displays the name of each license that it enables.

> #### /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.

### 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.

### 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.

## LICENSE 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[,...]

### 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.

### Qualifiers

> #### /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.

> #### /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.

> #### /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.

> #### /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.

> #### /LOG

> #### /NOLOG (default)

> Controls whether LICENSE ISSUE displays the name of each license that it issues.

> #### /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.

> #### /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.

> #### /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.

### 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.

###

#### 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:

> Previous | Next | Contents | Index

> | privacy and legal statement |
> 4584PRO_005.HTML