Document revision date: 19 July 1999

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

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.

Qualifiers

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

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

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

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

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

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

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

/OPTIONS=[(keyword[,...])]

Specifies LICENSE REGISTER options. If your PAK supplies any license options, you must enter this information exactly as it appears.

Table A-1 describes the available keywords.

Table A-1 LICENSE REGISTER /OPTIONS Keywords

Keyword	Meaning
ALPHA	Identifies Availability Licenses for Alpha 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.
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.

/PRODUCER=string

Specifies the name of the company (for example, DEC) that owns the product for which you have a license. You must enter the information exactly as it appears on your PAK.

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

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

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

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

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

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.

Examples

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

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

Sets up the License Unit Requirement Table (LURT) for your system and loads all licenses that are registered and enabled in the License Database. 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.

To load the licenses in the License Database of a system with LMF already started, use LICENSE LOAD.

Format

LICENSE START

Parameters

None.

Qualifiers

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

/LOG (default)

/NOLOG

Controls whether LICENSE START displays a message to acknowledge the loading of each product license.

Example

$ LICENSE START
      

This command sets up the LURT for your system and loads all the licenses that are registered and enabled in the License Database.

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

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.

Qualifiers

/LOG

/NOLOG (default)

Controls whether LICENSE UNLOAD lists the name of each unloaded license.

/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 is DEC. If DEC 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.

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.

Examples

$ LICENSE UNLOAD/PRODUCER=DEC FORTRAN
      

This command unloads the Digital Fortran license on the node from which it is entered.

$ LICENSE UNLOAD PASCAL,FORTRAN
 
      

This command unloads the DEC Pascal and Digital Fortran licenses on the node from which it is entered.

This appendix provides the following examples of license-related management tasks using the LICENSE commands:

• Registering a system integrated product ( Section B.1)
• Issuing LICENSE LIST and SHOW LICENSE commands ( Section B.2)
• Restricting product use ( Section B.3)

The following example provides a step-by-step procedure for registering a PAK for Volume Shadowing, which is a System Integrated Product (SIP). This example uses command procedure VMSLICENSE.COM and the following PAK information:

ISSUER: DEC AUTHORIZATION NUMBER: ALS-WM-45789-6666 PRODUCT NAME: VOLSHAD PRODUCER: DEC NUMBER OF UNITS: 400 VERSION: 7.1 PRODUCT RELEASE DATE: KEY TERMINATION DATE: 31-DEC-1997 AVAILABILITY TABLE CODE: E ACTIVITY TABLE CODE: KEY OPTIONS: MOD_UNITS PRODUCT TOKEN: HARDWARE I.D.: CHECKSUM: 2-EBID-GOOD-NIGH-OJJG

Execute the VMSLICENSE.COM command procedure to register the Volume Shadowing PAK as follows:

1. Log in to the system manager's account, SYSTEM. Enter the command:

   $ @SYS$UPDATE:VMSLICENSE

   
   The procedure displays the following menu:

   VMS License Management Utility Options: 1. REGISTER a Product Authorization Key 2. AMEND an existing Product Authorization Key 3. CANCEL an existing Product Authorization Key 4. LIST the Product Authorization Keys 5. MODIFY an existing Product Authorization Key 6. DISABLE an existing Product Authorization Key 7. DELETE an existing Product Authorization Key 8. COPY an existing Product Authorization Key 9. MOVE an existing Product Authorization Key 10. ENABLE an existing Product Authorization Key 11. SHOW the licenses loaded on this node 12. SHOW the unit requirements for this node 99. EXIT this procedure Type '?' at any prompt for a description of the information requested. Press Ctrl/Z at any prompt to return to the main menu. Enter one of the above choices [1]

2. Enter 1. The procedure displays the following message:

   * Do you have your Product Authorization Key? [YES]:

3. Enter Y. The procedure displays the following information and prompts:

   Use the REGISTER option to add a new license to a license database. A Product Authorization Key (PAK) provides the product name and information you need to register the license. You must enter all the information provided by your PAK exactly as it appears. Type '?' at any prompt for a description of the information requested. Press CTRL/Z at any prompt to return to the main menu. Issuer [DEC]: Authorization Number []:

4. Press Return to specify DEC as the issuer.
   Enter the authorization number from the PAK, ALS-WM-45789-6666. The procedure prompts for the following information:

   Product Name []:

5. Enter the product name string, VOLSHAD from the PAK. The procedure prompts for the producer:

   Producer [DEC]:

6. Press Return to specify DEC as the producer. The procedure prompts for the number of units:

   Number of Units []:

7. Enter the number of units, 400. The procedure prompts for the version:

   Version []:

8. Enter the version number from the PAK, 7.1. The procedure prompts for the key termination date:

   Key Termination Date []:

9. Enter the key termination date, 31-DEC-1997. The procedure prompts for the following information:

   Availability Table Code []: Activity Table Code []:

10. Enter the availability table code, E. Press Return after the Activity Table Code prompt. The procedure prompts for the following information:

    Key Options []: Product Token []: Hardware-Id []:

11. Enter the option MOD_UNITS after the Key Options prompt. Press Return after the Product Token prompt and the Hardware-ID prompt. The procedure prompts for the checksum:

    Checksum []:

12. Enter the checksum, 1-EBID-GOOD-NIGH-OJJG.

    Note The checksum string always begins with a number. The other 16 characters are always alphabetic characters from A through P.

    
    The procedure displays the information you entered. For example:

    Here is a list of the license information just entered: Issuer: DEC Authorization: ALS-WM-45789-6666 Producer: DEC Product Name: VOLSHAD Units: 400 Release Date: Version: 7.1 Termination Date: 31-DEC-1997 Availability: E Activity: Options: MOD_UNITS Token: Hardware ID: Checksum: 1-EBID-GOOD-NIGH-OJJG Is that correct? [YES]:

    
    

13. Compare the information on the screen with the information on the PAK. If the information is correct, enter Y. Otherwise enter N.

    Note If you enter any of the information incorrectly, you receive an error message, and the license is not registered. A checksum error can result when you enter incorrect information for other items on the PAK. If you get an error, carefully check all the data that you entered.

14. When the procedure displays the following question, enter Y.

    Do you wish to make corrections? [YES]:

15. To make corrections, the procedure steps you through all of the questions again with the data you just entered as defaults for each data field. For correct data, press Return. To replace incorrect data, enter the new data. To cancel data without entering new data, enter the backslash (\) character.
    If you entered all the information correctly, the procedure displays the following message:

    Registering VOLSHAD license in SYS$COMMON:[SYSEXE]LMF$LICENSE.LDB...

16. After the license is successfully registered, the procedure asks if you want to load the license on the current node, as follows:

    Do you want to LOAD this license on this system? [YES]:

    • If you registered the PAK on a standalone system and want to make the software available (active) immediately, enter Y.
    • If you registered the license in an OpenVMS Cluster environment but do not want to make it available (active) on the current node, enter N.
    
    In this example, assume the license is being registered in an OpenVMS Cluster environment and that you do not want it loaded on the current node. Enter N to complete this license registration. Note that you must load the Volume Shadowing license before you can use the product. See Step 18.
    The procedure returns you to the first menu and prompt as follows:

    VMS License Management Utility Options: 1. REGISTER a Product Authorization Key 2. AMEND an existing Product Authorization Key 3. CANCEL an existing Product Authorization Key 4. LIST the Product Authorization Keys 5. MODIFY an existing Product Authorization Key 6. DISABLE an existing Product Authorization Key 7. DELETE an existing Product Authorization Key 8. COPY an existing Product Authorization Key 9. MOVE an existing Product Authorization Key 10. ENABLE an existing Product Authorization Key 11. SHOW the licenses loaded on this node 12. SHOW the unit requirements for this node 99. EXIT this procedure Type '?' at any prompt for a description of the information requested. Press Ctrl/Z at any prompt to return to the main menu. Enter one of the above choices [1]

17. To register another PAK, enter 1. Then respond to the questions, again entering information from a license PAK. For this example assume you are finished. Enter 99 to exit the procedure. You have registered the license for Volume Shadowing.
18. Load the license on the desired node by logging in to that node and entering the LICENSE LOAD VOLSHAD command at the DCL prompt ($).

	privacy and legal statement
4584PRO_007.HTML