ibm-information-center/dist/eclipse/plugins/i5OS.ic.cl_5.4.0.1/genlickey.htm

405 lines
16 KiB
HTML
Raw Normal View History

2024-04-02 14:02:31 +00:00
<!doctype html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head><META http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Generate License Key (GENLICKEY)</title>
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
</head>
<body bgcolor="white">
<script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<a name="GENLICKEY.Top_Of_Page"></a>
<h2>Generate License Key (GENLICKEY)</h2>
<table width="100%">
<tr>
<td valign="top" align="left"><b>Where allowed to run: </b>All environments (*ALL)<br>
<b>Threadsafe: </b>No
</td>
<td valign="top" align="right">
<a href="#GENLICKEY.PARAMETERS.TABLE">Parameters</a><br>
<a href="#GENLICKEY.COMMAND.EXAMPLES">Examples</a><br>
<a href="#GENLICKEY.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="GENLICKEY"></a>
<p>The Generate License Key (GENLICKEY) command generates a license key to enable users to access a product or a feature of a product. This key is specific to the product and system information entered in this command. The resulting key will be a combination of 18 characters and numbers, A-F and 0-9. To run this command, the product definition of the product you are generating the key for must exist on the system.
</p>
<p>This command also adds the license information to the license repository. The keys are saved in the repository to keep a history of all the keys generated. You can display the repository to see what keys were generated for a specific product or system. To work with the license repository, you can use the DSPLICKEY, ADDLICKEY, and RMVLICKEY commands.
</p>
<p>You can use the Add License Key Information (QLZAADDK) API or the Add Product License Information (QLZADDLI) API to add license information. For more specific details about these APIs, see the API topic in the iSeries Information Center at http://www.ibm.com/eserver/iseries/infocenter.
</p>
<p><b>Restriction:</b> This command is shipped with public *EXCLUDE authority.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#GENLICKEY.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="GENLICKEY.PARAMETERS.TABLE">Parameters</a></h3>
<table border="1" cellpadding="4" cellspacing="0">
<!-- col1="10" col2="15" col3="30" col4="10" -->
<tr>
<th bgcolor="aqua" valign="bottom" align="left">Keyword</th>
<th bgcolor="aqua" valign="bottom" align="left">Description</th>
<th bgcolor="aqua" valign="bottom" align="left">Choices</th>
<th bgcolor="aqua" valign="bottom" align="left">Notes</th>
</tr>
<tr>
<td valign="top"><a href="#GENLICKEY.PRDID"><b>PRDID</b></a></td>
<td valign="top">Product ID</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Required, Positional 1</td>
</tr>
<tr>
<td valign="top"><a href="#GENLICKEY.LICTRM"><b>LICTRM</b></a></td>
<td valign="top">License term</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Required, Positional 2</td>
</tr>
<tr>
<td valign="top"><a href="#GENLICKEY.FEATURE"><b>FEATURE</b></a></td>
<td valign="top">Feature</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Required, Positional 3</td>
</tr>
<tr>
<td valign="top"><a href="#GENLICKEY.VNDPWD"><b>VNDPWD</b></a></td>
<td valign="top">Vendor password</td>
<td valign="top"><i>Simple name</i>, *NONE</td>
<td valign="top">Required, Positional 4</td>
</tr>
<tr>
<td valign="top"><a href="#GENLICKEY.SERIAL"><b>SERIAL</b></a></td>
<td valign="top">System serial number</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Required, Positional 5</td>
</tr>
<tr>
<td valign="top"><a href="#GENLICKEY.PRCGRP"><b>PRCGRP</b></a></td>
<td valign="top">Processor Group</td>
<td valign="top"><i>Character value</i>, <b><u>*ANY</u></b></td>
<td valign="top">Optional, Positional 6</td>
</tr>
<tr>
<td valign="top"><a href="#GENLICKEY.EXPDATE"><b>EXPDATE</b></a></td>
<td valign="top">Expiration date</td>
<td valign="top"><i>Date</i>, <b><u>*NONE</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#GENLICKEY.USGLMT"><b>USGLMT</b></a></td>
<td valign="top">Usage limit</td>
<td valign="top">0-999999, <b><u>1</u></b>, *NOMAX</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#GENLICKEY.VNDDTA"><b>VNDDTA</b></a></td>
<td valign="top">Vendor data</td>
<td valign="top"><i>Character value</i>, <b><u>*NONE</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#GENLICKEY.OUTPUT"><b>OUTPUT</b></a></td>
<td valign="top">Output</td>
<td valign="top"><b><u>*</u></b>, *PRINT, *LICKEYFILE</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top" rowspan="3"><a href="#GENLICKEY.LICKEYFILE"><b>LICKEYFILE</b></a></td>
<td valign="top">License key file</td>
<td valign="top"><i>Qualified object name</i></td>
<td valign="top" rowspan="3">Optional</td>
</tr>
<tr>
<td valign="top">Qualifier 1: License key file</td>
<td valign="top"><i>Name</i></td>
</tr><tr>
<td valign="top">Qualifier 2: Library</td>
<td valign="top"><i>Name</i>, <b><u>*LIBL</u></b>, *CURLIB</td>
</tr><tr>
<td valign="top" rowspan="3"><a href="#GENLICKEY.LICKEYMBR"><b>LICKEYMBR</b></a></td>
<td valign="top">License key member</td>
<td valign="top"><i>Element list</i></td>
<td valign="top" rowspan="3">Optional</td>
</tr>
<tr>
<td valign="top">Element 1: Member</td>
<td valign="top">
<i>Name</i>, <b><u>*FIRST</u></b></td>
</tr>
<tr>
<td valign="top">Element 2: Replace or add records</td>
<td valign="top">
<b><u>*ADD</u></b>, *REPLACE</td>
</tr>
</table>
<table width="100%">
<tr><td align="right"><a href="#GENLICKEY.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="GENLICKEY.PRDID"></a>
<h3>Product ID (PRDID)</h3>
<p>Specifies the 7-character identifier (ID) of the product for which the license key is to be generated.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#GENLICKEY.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="GENLICKEY.LICTRM"></a>
<h3>License term (LICTRM)</h3>
<p>Specifies the license term for which license key is to be generated.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><i>license-term</i></b></dt>
<dd>Specify the license term of the product in one of the following formats:
<ul>
<li>Vx
</li>
<li>VxRy
</li>
<li>VxRyMz
</li>
</ul>
<p>where values for <i>x</i> and <i>y</i> range from 0 through 9, and values for <i>z</i> range from 0 through 9 and from A through Z. A license term of Vx means the authorized usage limit is valid for the entire version of the product or feature. A license term of VxRy means the authorized usage limit is valid for the entire release of the product or feature. A license term of VxRyMz means the authorized usage limit is valid only for a modification of the product.
</p>
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#GENLICKEY.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="GENLICKEY.FEATURE"></a>
<h3>Feature (FEATURE)</h3>
<p>Specifies the feature of the product specified on the PRDID parameter for which the license key is to be generated.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><i>feature</i></b></dt>
<dd>Specify the feature for which a license key is to be generated. Valid values range from 5001 through 9999.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#GENLICKEY.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="GENLICKEY.VNDPWD"></a>
<h3>Vendor password (VNDPWD)</h3>
<p>Specifies the software vendor's password. This password will be encrypted and stored with the product. It is used to validate the generate license key request and must be the same password you use on the Add Product License Information (ADDPRDLICI) command.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b>*NONE</b></dt>
<dd>There is no vendor password needed to generate a license key.
</dd>
<dt><b><i>vendor-password</i></b></dt>
<dd>Specify the vendor password. It must begin with an alphabetic character (A through Z, $, #, or @) followed by no more than 9 alphanumeric characters (A through Z, 0 through 9, $, #, @, or _).
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#GENLICKEY.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="GENLICKEY.SERIAL"></a>
<h3>System serial number (SERIAL)</h3>
<p>Specify the system serial number of the system the license key is being generated for.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><i>system-serial-number</i></b></dt>
<dd>Specifies the system serial number of the system the license key is being generated for.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#GENLICKEY.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="GENLICKEY.PRCGRP"></a>
<h3>Processor Group (PRCGRP)</h3>
<p>Specifies the processor group of the system the license key is being generated for.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><u>*ANY</u></b></dt>
<dd>The license key being generated will work with any processor group.
</dd>
<dt><b><i>processor-group</i></b></dt>
<dd>Specifies the processor group of the system the license key is being generated for. Use the Work with License Information (WRKLICINF) command on the system the key is being generated for to display the processor group.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#GENLICKEY.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="GENLICKEY.EXPDATE"></a>
<h3>Expiration date (EXPDATE)</h3>
<p>Specifies the date the product license expires. After this date, users over the default usage limit will not be allowed to access the product or feature. A new license key must be obtained from the software vendor to allow further use of the product.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><u>*NONE</u></b></dt>
<dd>There is no expiration date for the product or feature.
</dd>
<dt><b><i>expiration-date</i></b></dt>
<dd>Specify the date that the product or feature expires.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#GENLICKEY.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="GENLICKEY.USGLMT"></a>
<h3>Usage limit (USGLMT)</h3>
<p>Specifies the maximum number of users (usage limit) for the product or feature for which the license key is being generated. For concurrent usage, specifies the maximum number of jobs allowed to access the product or feature at the same time. For registered usage, this is the maximum number of license users that can be registered to use this product or feature.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><u>1</u></b></dt>
<dd>One user is allowed to access the product or feature.
</dd>
<dt><b>*NOMAX</b></dt>
<dd>The number of users is not limited.
</dd>
<dt><b><i>usage-limit</i></b></dt>
<dd>Specifies the maximum number of users for this product or feature. Valid values range from 0 through 999999.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#GENLICKEY.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="GENLICKEY.VNDDTA"></a>
<h3>Vendor data (VNDDTA)</h3>
<p>Specifies an 8-character data field to be defined and used by the vendor.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><u>*NONE</u></b></dt>
<dd>There is no vendor data for this product or feature.
</dd>
<dt><b><i>vendor-data</i></b></dt>
<dd>Specifies 8-characters that help define further information on the product or feature.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#GENLICKEY.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="GENLICKEY.OUTPUT"></a>
<h3>Output (OUTPUT)</h3>
<p>Specifies whether the license key that is generated is displayed in a completion message, printed in a spooled file, or saved in a file.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><u>*</u></b></dt>
<dd>The license key is only shown in a completion message.
</dd>
<dt><b>*PRINT</b></dt>
<dd>The license key is printed in a spooled file.
</dd>
<dt><b>*LICKEYFILE</b></dt>
<dd>The license key information is saved to the file specified on the LICKEYFILE parameter. This file can then be used as a key file for Distributed Systems License Option (DSLO) tapes.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#GENLICKEY.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="GENLICKEY.LICKEYFILE"></a>
<h3>License key file (LICKEYFILE)</h3>
<p>Specifies the file in which the license key information is saved. If this file does not exist, the system creates it. If it does exist, it must be in the format of QSYS/QALZAKEY.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><u>*LIBL</u></b></dt>
<dd>The library list is used to locate the file in which to save the license key.
</dd>
<dt><b>*CURLIB</b></dt>
<dd>The current job library is used to locate the file in which to save the license key. If no library is specified as the current library, the QGPL library is used.
</dd>
<dt><b><i>library-name</i></b></dt>
<dd>Specify the name of the library where the license key is to be saved.
</dd>
</dl>
<p>The possible file name value is:
</p>
<dl>
<dt><b><i>file-name</i></b></dt>
<dd>Specify the name of the file into which the license key information is to be saved.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#GENLICKEY.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="GENLICKEY.LICKEYMBR"></a>
<h3>License key member (LICKEYMBR)</h3>
<p>Specifies which member the license key information is saved into and how the information is saved.
</p>
<p><b>Note:</b>
</p>
<p>You can also use the Generate License Key (QLZAGENK) API to create the license key information. See the API topic in the iSeries Information Center at http://www.ibm.com/eserver/iseries/infocenter for more information about this API.
</p>
<p>The possible member to receive output values are:
</p>
<dl>
<dt><b><u>*FIRST</u></b></dt>
<dd>The first member in the file receives the output. If LICKEYMBR(*FIRST) is specified and the member does not exist, the system creates a member with the name of the file specified on the LICKEYFILE parameter.
</dd>
<dt><b><i>member-name</i></b></dt>
<dd>Specify the name of the file member that receives the output. If the name of the file member is specified and the member does not exist, the system creates it. If the member already exists, you have the option of either adding a new record to the end of the existing member or clearing the member and then adding the new records.
</dd>
</dl>
<p>The option to perform on member values are:
</p>
<dl>
<dt><b><u>*ADD</u></b></dt>
<dd>If the member exists, the system adds the new record to the end of the existing records.
</dd>
<dt><b>*REPLACE</b></dt>
<dd>If the member exists, the system clears it and then adds the new record.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#GENLICKEY.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="GENLICKEY.COMMAND.EXAMPLES">Examples</a> </h3>
<p>
<pre>
GENLICKEY PRDID(2MYPROD) LICTRM(V5R2M0) FEATURE(5001)
VNDPWD(PRODUCTPWD) EXPDATE(*NONE)
SERIAL(1234567) PRCGRP(P30) USGLMT(25)
</pre>
</p>
<p>This command generates a license key for product 2MYPROD, license term V5R2M0 and feature 5001. The key allows 25 users to be authorized to use this product and there is no expiration date. The key allows the product to only be used on a system with a serial number of 1234567 and a processor group of 01 and a processor group of P30 or less.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#GENLICKEY.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="GENLICKEY.ERROR.MESSAGES">Error messages</a> </h3>
<p>None
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#GENLICKEY.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>