Document revision date: 30 March 2001

## OpenVMS License Management Utility Manual

Previous | Contents | Index

    $! 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

## LICENSE 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 OpenVMS DCL Dictionary, displays information from the License Database in memory.

### Format

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

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

### Qualifiers

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

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

> #### /BRIEF (default)

> Specifies a listing from the License Database that includes only the license product and producer names.

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

> #### /FULL

> Specifies a listing from the License Database that includes a full display of the specified license or licenses.

> #### /HISTORY

> Specifies a listing from the License Database that includes the history records in the License Database for the specified license or licenses.

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

> #### /OUTPUT[=filespec]

> Specifies the name of the file to which your list is written. If you do not specify the /OUTPUT qualifier, or if you do not supply a file specification with this qualifier, the output is sent to SYS$OUTPUT.

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

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

> #### /SELECTION_WEIGHT

> Produces a full display that includes the current selection weights assigned to individual PAKs.

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

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

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

### 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:
> - After you enter LICENSE LIST with the /BRIEF qualifier, you can scroll through the display with the arrow keys on your keyboard.
> - 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.

### Examples

#1
    $ LICENSE LIST /FULL

> This command displays a list of the names of product licenses in the License Database. Note that the LMF Version shown refers to the software that created the database.

>     Use CTRL/Z to exit, PF3-PF4 for Previous-Next Screen, Arrow Keys 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 /HISTORY FORTRAN

> This example displays a listing with full information of a current Fortran license issued by Compaq.

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

>     Use CTRL/Z to exit, PF3-PF4 for Previous-Next Screen, Arrow Keys 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

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

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

### Qualifiers

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

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

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

> #### /LOG (default)

> #### /NOLOG

> Controls whether or not LICENSE LOAD displays a message to acknowledge the loading of each license.

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

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

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

> - Log in to each OpenVMS Cluster node, and enter LICENSE LOAD.
> - Invoke the OpenVMS SYSMAN utility to execute the LICENSE LOAD command on the desired OpenVMS Cluster nodes. See the 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:

> - Insufficient license units are registered for the current node.
> - The current date is later than the license termination date.
> - 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.

###

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

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

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

### Qualifiers

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

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

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

> #### /COMBINE

> #### /NOCOMBINE

> Modifies a PAK by adding or removing the COMBINE option. If the PAKs are combinable, LMF combines them during license loading.

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

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

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

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

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

> #### /LOG

> #### /NOLOG (default)

> Controls whether LICENSE MODIFY displays the name of each license that it modifies.

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

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

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

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

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

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

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

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

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

> Previous | Next | Contents | Index

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