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

528 lines
20 KiB
HTML
Raw Permalink 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>Add License Key Information (ADDLICKEY)</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="ADDLICKEY.Top_Of_Page"></a>
<h2>Add License Key Information (ADDLICKEY)</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="#ADDLICKEY.PARAMETERS.TABLE">Parameters</a><br>
<a href="#ADDLICKEY.COMMAND.EXAMPLES">Examples</a><br>
<a href="#ADDLICKEY.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="ADDLICKEY"></a>
<p>The Add License Key Information (ADDLICKEY) command can be used to add the software license key information to the license repository for products with keyed compliance. Products with "keyed compliance" require that you have a software license key from the software provider in order to change the usage limit or the expiration date of the license information.
</p>
<p>The license repository stores product license information for each unique product, license term, feature, and system. The repository can contain licenses for any system, and the product need not be installed.
</p>
<p>If the product is installed on the system and the license is for this system, this command installs the license, which changes the usage limit from the product's default usage limit to the licensed usage limit. The expiration date is also set.
</p>
<p>If a software license key already exists in the repository for the unique product, license term, feature, and system, the software license key information is replaced.
</p>
<p>If a license does not exist on the system, the added software license key uses the default values for its threshold (90 percent of the usage limit), message queue (*OPSYS), and log (usage limit violations are not logged) attributes. If a license exists, the values on these attributes do not change. To change any of these values, you can use the Change License Information (CHGLICINF) command.
</p>
<p><b>Restrictions:</b> This command is shipped with public *EXCLUDE authority.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDLICKEY.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="ADDLICKEY.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="#ADDLICKEY.LICKEYINP"><b>LICKEYINP</b></a></td>
<td valign="top">License key input</td>
<td valign="top"><b><u>*PROMPT</u></b>, *LICKEYFILE, *TAPE</td>
<td valign="top">Optional, Positional 1</td>
</tr>
<tr>
<td valign="top"><a href="#ADDLICKEY.PRDID"><b>PRDID</b></a></td>
<td valign="top">Product identifier</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Optional, Positional 2</td>
</tr>
<tr>
<td valign="top"><a href="#ADDLICKEY.LICTRM"><b>LICTRM</b></a></td>
<td valign="top">License term</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Optional, Positional 3</td>
</tr>
<tr>
<td valign="top"><a href="#ADDLICKEY.FEATURE"><b>FEATURE</b></a></td>
<td valign="top">Feature</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Optional, Positional 4</td>
</tr>
<tr>
<td valign="top"><a href="#ADDLICKEY.SERIAL"><b>SERIAL</b></a></td>
<td valign="top">System serial number</td>
<td valign="top"><i>Character value</i>, <b><u>*LOCAL</u></b>, *REMOTE, *ALL</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#ADDLICKEY.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</td>
</tr>
<tr>
<td valign="top" rowspan="4"><a href="#ADDLICKEY.LICKEY"><b>LICKEY</b></a></td>
<td valign="top">License key</td>
<td valign="top"><i>Element list</i></td>
<td valign="top" rowspan="4">Optional</td>
</tr>
<tr>
<td valign="top">Element 1: Characters 1 - 6</td>
<td valign="top">
<i>Character value</i></td>
</tr>
<tr>
<td valign="top">Element 2: Characters 7 - 12</td>
<td valign="top">
<i>Character value</i></td>
</tr>
<tr>
<td valign="top">Element 3: Characters 13 - 18</td>
<td valign="top">
<i>Character value</i></td>
</tr>
<tr>
<td valign="top"><a href="#ADDLICKEY.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="#ADDLICKEY.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="#ADDLICKEY.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" rowspan="3"><a href="#ADDLICKEY.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"><a href="#ADDLICKEY.LICKEYMBR"><b>LICKEYMBR</b></a></td>
<td valign="top">License key member</td>
<td valign="top"><i>Name</i>, <b><u>*FIRST</u></b>, *LAST</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#ADDLICKEY.DEV"><b>DEV</b></a></td>
<td valign="top">Device</td>
<td valign="top"><i>Name</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#ADDLICKEY.VOL"><b>VOL</b></a></td>
<td valign="top">Volume identifier</td>
<td valign="top"><i>Character value</i>, <b><u>*MOUNTED</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#ADDLICKEY.SEQNBR"><b>SEQNBR</b></a></td>
<td valign="top">Sequence number</td>
<td valign="top">1-9999, <b><u>*SEARCH</u></b>, *NEXT</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#ADDLICKEY.ENDOPT"><b>ENDOPT</b></a></td>
<td valign="top">End of tape option</td>
<td valign="top"><b><u>*REWIND</u></b>, *LEAVE, *UNLOAD</td>
<td valign="top">Optional</td>
</tr>
</table>
<table width="100%">
<tr><td align="right"><a href="#ADDLICKEY.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="ADDLICKEY.LICKEYINP"></a>
<h3>License key input (LICKEYINP)</h3>
<p>Specifies how the software license key information to be added is supplied.
</p>
<dl>
<dt><b><u>*PROMPT</u></b></dt>
<dd>The software license key information is supplied through prompting.
</dd>
<dt><b>*LICKEYFILE</b></dt>
<dd>The software license key information is taken from the file specified on the LICKEYFILE parameter.
</dd>
<dt><b>*TAPE</b></dt>
<dd>The software license key information is taken from a data file with the label QFILEPGMKEY on the tape device specified on the DEV parameter. The QFILEPGMKEY data file must be created on the tape using the Copy To Tape (CPYTOTAP) command, specifying a file in the format of QSYS/QALZAKEY on the FROMFILE parameter.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDLICKEY.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDLICKEY.PRDID"></a>
<h3>Product identifier (PRDID)</h3>
<p>Specifies the seven-character identifier of the product for which software license key information is added.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDLICKEY.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDLICKEY.LICTRM"></a>
<h3>License term (LICTRM)</h3>
<p>Specifies the license term for which software license key information is added. This information is supplied by the software provider. Specify the license term in Vx, VxRy, or VxRyMz format, where x and y can be a number from 0 through 9, and z can be a number 0 through 9 or a letter A through Z.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDLICKEY.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDLICKEY.FEATURE"></a>
<h3>Feature (FEATURE)</h3>
<p>Specifies the feature of the product specified on the PRDID parameter for which the software license key information is added.
</p>
<dl>
<dt><b><u>5001</u></b></dt>
<dd>The software license key information for feature 5001 is added.
</dd>
<dt><b><i>feature</i></b></dt>
<dd>Specify the number of the feature for which software license key information is added. Valid values range from 5001 through 9999.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDLICKEY.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDLICKEY.SERIAL"></a>
<h3>System serial number (SERIAL)</h3>
<p>Specifies the serial number of the system for which software license key information is added.
</p>
<p>
<b>Note: </b>The *REMOTE and *ALL values are valid only when *LICKEYFILE or *TAPE is specified for the <b>License key input (LICKEYINP)</b> parameter.
</p>
<dl>
<dt><b><u>*LOCAL</u></b></dt>
<dd>The software license key information for the local system is added.
</dd>
<dt><b>*REMOTE</b></dt>
<dd>The software license key information for all remote systems named in the file specified on the LICKEYFILE parameter or in the tape file with the label QFILEPGMKEY is added.
</dd>
<dt><b>*ALL</b></dt>
<dd>The software license key information for all systems named in the file specified on the LICKEYFILE parameter or in the tape file with the label QFILEPGMKEY is added.
</dd>
<dt><b><i>system-serial-number</i></b></dt>
<dd>Specify the serial number of the system for which software license key information is added.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDLICKEY.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDLICKEY.PRCGRP"></a>
<h3>Processor group (PRCGRP)</h3>
<p>Specifies the system processor group for which software license key information is added. The software provider supplies this information with the software license key.
</p>
<dl>
<dt><b><u>*ANY</u></b></dt>
<dd>The software license key is for any processor group.
</dd>
<dt><b><i>processor-group</i></b></dt>
<dd>Specify the processor group of the system for which software license key information is added.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDLICKEY.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDLICKEY.LICKEY"></a>
<h3>License key (LICKEY)</h3>
<p>Specifies the software license key that is supplied by the software provider. The license key has three elements, each of which are six characters long. Valid values for the characters are A-F and 0-9, and can be specified in the format: cccccc cccccc cccccc, where c is a valid character.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDLICKEY.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDLICKEY.USGLMT"></a>
<h3>Usage limit (USGLMT)</h3>
<p>Specifies the usage limit for this product or feature. The software provider authorizes the value of the usage limit. For a concurrent usage limit, this is the maximum number of jobs allowed to access the product or feature at any given time. For a registered usage limit, this is the maximum number of license users that can be registered to use this product or feature.
</p>
<dl>
<dt><b><u>1</u></b></dt>
<dd>The number of users is limited to one.
</dd>
<dt><b>*NOMAX</b></dt>
<dd>The number of users is not limited.
</dd>
<dt><b><i>usage-limit</i></b></dt>
<dd>Specify 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="#ADDLICKEY.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDLICKEY.EXPDATE"></a>
<h3>Expiration date (EXPDATE)</h3>
<p>Specifies the expiration date of the product license. After this date, no users over the default usage limit can use the product or feature in compliance with this software license key.
</p>
<p>The software provider supplies the expiration date with the software license key. To use the product after the expiration date, you must obtain a new software license key from the software provider.
</p>
<dl>
<dt><b><u>*NONE</u></b></dt>
<dd>The license has no expiration date.
</dd>
<dt><b><i>expiration-date</i></b></dt>
<dd>Specify the expiration date of the product license.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDLICKEY.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDLICKEY.VNDDTA"></a>
<h3>Vendor data (VNDDTA)</h3>
<p>Specifies the vendor data. The software provider supplies this information with the software license key.
</p>
<dl>
<dt><b><u>*NONE</u></b></dt>
<dd>No vendor data is specified.
</dd>
<dt><b><i>vendor-data</i></b></dt>
<dd>Specify a maximum of eight characters of vendor data.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDLICKEY.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDLICKEY.LICKEYFILE"></a>
<h3>License key file (LICKEYFILE)</h3>
<p>Specifies the qualified name of the file from which the software license key information is taken. This input file must be in the format of QSYS/QALZAKEY, and can be created by using the LICKEYFILE parameter on the Display License Key Information (DSPLICKEY) command.
</p>
<p>The name of the license key file can be qualified by one of the following library values:
</p>
<dl>
<dt><b><u>*LIBL</u></b></dt>
<dd>All libraries in the library list for the current thread are searched until the first match is found.
</dd>
</dl>
<dl>
<dt><b>*CURLIB</b></dt>
<dd>The current library for the thread is searched. If no library is specified as the current library for the thread, the QGPL library is searched.
</dd>
</dl>
<dl>
<dt><b><i>library-name</i></b></dt>
<dd>Specify the name of the library to be searched.
</dd>
</dl>
<p>The possible value is:
</p>
<dl>
<dt><b><i>license-key-file</i></b></dt>
<dd>Specify the name of the file that contains the software license key information.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDLICKEY.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDLICKEY.LICKEYMBR"></a>
<h3>License key member (LICKEYMBR)</h3>
<p>Specifies the name of the member in the file specified on the LICKEYFILE parameter from which the software license key information is taken.
</p>
<dl>
<dt><b><u>*FIRST</u></b></dt>
<dd>The oldest member in the file is used.
</dd>
<dt><b>*LAST</b></dt>
<dd>The newest member in the file is used.
</dd>
<dt><b><i>license-key-member</i></b></dt>
<dd>Specify the name of the member from which to get information.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDLICKEY.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDLICKEY.DEV"></a>
<h3>Device (DEV)</h3>
<p>Specifies the name of the tape device holding the tape from which the software license key information is copied.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDLICKEY.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDLICKEY.VOL"></a>
<h3>Volume identifier (VOL)</h3>
<p>Specifies the volume identifier of the tape from which the software license key information is copied.
</p>
<dl>
<dt><b><u>*MOUNTED</u></b></dt>
<dd>The volume currently placed in the device is used.
</dd>
</dl>
<dl>
<dt><b><i>volume-identifier</i></b></dt>
<dd>Specify the identifier of the volume from which the software license key information is copied.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDLICKEY.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDLICKEY.SEQNBR"></a>
<h3>Sequence number (SEQNBR)</h3>
<p>Specifies the sequence number of the data file from which the software license key information is copied.
</p>
<dl>
<dt><b><u>*SEARCH</u></b></dt>
<dd>A search is made for a data file with an identifier that matches the label QFILEPGMKEY.
</dd>
<dt><b>*NEXT</b></dt>
<dd>The next sequence is used if that sequence is for a file with the label QFILEPGMKEY.
</dd>
<dt><b><i>sequence-number</i></b></dt>
<dd>Specify the sequence number of the data file with the label QFILEPGMKEY to use for copying the software license key information.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDLICKEY.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDLICKEY.ENDOPT"></a>
<h3>End of tape option (ENDOPT)</h3>
<p>Specifies what positioning operation is done automatically on the tape volume after the software license key information is copied.
</p>
<dl>
<dt><b><u>*REWIND</u></b></dt>
<dd>The tape is automatically rewound, but not unloaded, after the operation has ended.
</dd>
</dl>
<dl>
<dt><b>*LEAVE</b></dt>
<dd>The tape does not rewind or unload after the operation ends. It remains at the current position on the tape drive.
</dd>
</dl>
<dl>
<dt><b>*UNLOAD</b></dt>
<dd>The tape is automatically rewound and unloaded after the operation ends.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDLICKEY.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="ADDLICKEY.COMMAND.EXAMPLES">Examples</a> </h3>
<p><b>Example 1: Adding License Key Information from Prompt Input</b>
</p>
<p>
<pre>
ADDLICKEY LICKEYINP(*PROMPT) PRDID(1MYPROD)
LICTRM(V3) SERIAL(1234567)
PRCGRP(P20) LICKEY(123456 7890AB CDEF12)
USGLMT(30) EXPDATE(*NONE) VNDDTA(12345678)
</pre>
</p>
<p>This command uses prompting to add the software license key information for feature 5001 of the product 1MYPROD to the license repository. The license term is Version 3. The license allows 30 users to use the system with serial number 1234567. That system is in the processor group of 20 or less. There is no expiration date on the license. Because the product is installed on a system with the specified serial number, the license also is installed.
</p>
<p><b>Example 2: Adding All License Key Information from File Input</b>
</p>
<p>
<pre>
ADDLICKEY LICKEYINP(*LICKEYFILE) SERIAL(*ALL)
LICKEYFILE(*LIBL/MYKEYFILE) LICKEYMBR(*LAST)
</pre>
</p>
<p>This command adds the software license key information for all of the systems in the newest member of the file MYKEYFILE to the license repository. If the product is installed on the system, and the license is for this system, the license also is installed.
</p>
<p><b>Example 3: Adding Local License Key Information from a License Key File</b>
</p>
<p>
<pre>
ADDLICKEY LICKEYINP(*LICKEYFILE) SERIAL(*LOCAL)
LICKEYFILE(*LIBL/MYKEYFILE) LICKEYMBR(*FIRST)
</pre>
</p>
<p>This command adds the software license key information found in the oldest member of the file MYKEYFILE to the license repository for this system only. If the product is installed on this system, the license is also installed.
</p>
<p><b>Example 4: Adding Local License Key Information from Tape</b>
</p>
<p>
<pre>
ADDLICKEY LICKEYINP(*TAPE) DEV(TAP01)
</pre>
</p>
<p>This command searches the mounted volume on device TAP01 for the label QFILEPGMKEY. This data file is used and all software license keys for the local system are added to the repository. The tape is rewound after the operation.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDLICKEY.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="ADDLICKEY.ERROR.MESSAGES">Error messages</a> </h3>
<p><b><u>*ESCAPE Messages</u></b>
</p>
<dl>
<dt><b>CPF9E2D</b></dt>
<dd>Usage limit cannot be less than current usage.
</dd>
<dt><b>CPF9E56</b></dt>
<dd>&amp;1 license key information records added, &amp;2 not added.
</dd>
<dt><b>CPF9E6C</b></dt>
<dd>The license key cannot be used for processor group &amp;2.
</dd>
<dt><b>CPF9E6E</b></dt>
<dd>Product identifier &amp;1 not valid.
</dd>
<dt><b>CPF9E69</b></dt>
<dd>License key information not found in license key file.
</dd>
<dt><b>CPF9E80</b></dt>
<dd>Error occurred during restoring license keys from tape.
</dd>
<dt><b>CPF9E83</b></dt>
<dd>Expiration date &amp;2 is not valid.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDLICKEY.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>