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

307 lines
12 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>Display License Key Info (DSPLICKEY)</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="DSPLICKEY.Top_Of_Page"></a>
<h2>Display License Key Info (DSPLICKEY)</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="#DSPLICKEY.PARAMETERS.TABLE">Parameters</a><br>
<a href="#DSPLICKEY.COMMAND.EXAMPLES">Examples</a><br>
<a href="#DSPLICKEY.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="DSPLICKEY"></a>
<p>The Display License Key Information (DSPLICKEY) command can be used to show the software license key information from 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 is used to store 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>The information shown includes the processor group, the serial number, the software license key, the usage limit, the expiration date, and the vendor data.
</p>
<p>The Display License Key Information (DSPLICKEY) command also can be used to create an output file, which can be used as input to the Add License Key Information (ADDLICKEY) command or the Remove License Key Information (RMVLICKEY) 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="#DSPLICKEY.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="DSPLICKEY.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="#DSPLICKEY.PRDID"><b>PRDID</b></a></td>
<td valign="top">Product identifier</td>
<td valign="top"><i>Character value</i>, <b><u>*ALL</u></b></td>
<td valign="top">Optional, Positional 1</td>
</tr>
<tr>
<td valign="top"><a href="#DSPLICKEY.LICTRM"><b>LICTRM</b></a></td>
<td valign="top">License term</td>
<td valign="top"><i>Character value</i>, <b><u>*ALL</u></b></td>
<td valign="top">Optional, Positional 2</td>
</tr>
<tr>
<td valign="top"><a href="#DSPLICKEY.FEATURE"><b>FEATURE</b></a></td>
<td valign="top">Feature</td>
<td valign="top"><i>Character value</i>, <b><u>*ALL</u></b></td>
<td valign="top">Optional, Positional 3</td>
</tr>
<tr>
<td valign="top"><a href="#DSPLICKEY.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="#DSPLICKEY.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="#DSPLICKEY.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="#DSPLICKEY.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 to receive output</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>*REPLACE</u></b>, *ADD</td>
</tr>
</table>
<table width="100%">
<tr><td align="right"><a href="#DSPLICKEY.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="DSPLICKEY.PRDID"></a>
<h3>Product identifier (PRDID)</h3>
<p>Specifies the seven-character identifier of the product for which software license key information is shown.
</p>
<dl>
<dt><b><u>*ALL</u></b></dt>
<dd>The software license key information for all product identifiers is shown.
</dd>
<dt><b><i>generic*-product-identifier</i></b></dt>
<dd>Specify the generic identifier for the products to be shown. A generic product identifier is specified in the same manner as a generic name.
<p>A generic name is a character string of one or more characters followed by an asterisk (*); for example, ABC*. The asterisk substitutes for any valid characters. A generic name specifies all objects with names that begin with the generic prefix for which the user has authority. If an asterisk is not included with the generic (prefix) name, the system assumes it to be the complete object name.
</p>
</dd>
<dt><b><i>product-identifier</i></b></dt>
<dd>Specify the seven-character identifier of the product.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPLICKEY.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="DSPLICKEY.LICTRM"></a>
<h3>License term (LICTRM)</h3>
<p>Specifies the license term for which software license key information is shown.
</p>
<dl>
<dt><b><u>*ALL</u></b></dt>
<dd>The software license key information for all license terms found on the system is shown.
</dd>
<dt><b><i>license-term</i></b></dt>
<dd>Specify the license term in Vx, VxRy, or VxRyMz format, where x or y can be a number from 0 through 9, and z can be a number 0 through 9 or a letter A through Z.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPLICKEY.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="DSPLICKEY.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 shown.
</p>
<dl>
<dt><b><u>*ALL</u></b></dt>
<dd>The software license key information for all features of the product specified on the PRDID parameter is shown.
</dd>
<dt><b><i>feature</i></b></dt>
<dd>Specify the number of the feature for which software license key information is shown.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPLICKEY.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="DSPLICKEY.SERIAL"></a>
<h3>System serial number (SERIAL)</h3>
<p>Specify the serial number of the system for which software license key information is shown.
</p>
<dl>
<dt><b><u>*LOCAL</u></b></dt>
<dd>The software license key information for the local system is shown.
</dd>
<dt><b>*REMOTE</b></dt>
<dd>The software license key information for all systems except the local system is shown.
</dd>
<dt><b>*ALL</b></dt>
<dd>The software license key information for all systems is shown.
</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 shown.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPLICKEY.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="DSPLICKEY.OUTPUT"></a>
<h3>Output (OUTPUT)</h3>
<p>Specifies whether the output from this command is displayed, printed, or directed to a database file.
</p>
<dl>
<dt><b><u>*</u></b></dt>
<dd>The output is shown on the display if requested by an interactive job, or printed with the job's spooled output if requested by a batch job.
</dd>
<dt><b>*PRINT</b></dt>
<dd>The output is printed with the job's spooled output.
</dd>
<dt><b>*LICKEYFILE</b></dt>
<dd>The software license key information is written to an output file.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPLICKEY.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="DSPLICKEY.LICKEYFILE"></a>
<h3>License key file (LICKEYFILE)</h3>
<p>Specifies the qualified name of the file where the software license key information is written. If this file does not exist, it is created using the file QSYS/QALZAKEY as a template. If this file exists it must be in the format of QSYS/QALZAKEY.
</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 to which the software license key information is written.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPLICKEY.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="DSPLICKEY.LICKEYMBR"></a>
<h3>License key member (LICKEYMBR)</h3>
<p>Specifies the name of the database file member to which the output is written. The member is used or created, as follows:
</p>
<ul>
<li>If the member exists, the system uses the second element of this parameter to determine whether the member is cleared before the new records are added.
</li>
<li>If the member does not exist and a member name is not specified, the system creates a member with the name of the output file specified on the LICKEYFILE parameter.
</li>
<li>If the member does not exist and a database file member name is specified, the system creates the member.
</li>
</ul>
<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.
</dd>
<dt><b><i>member-to-receive-output</i></b></dt>
<dd>Specify the name of the member to receive the output.
</dd>
</dl>
<p>The possible Operation to Perform on Member values are:
</p>
<dl>
<dt><b><u>*REPLACE</u></b></dt>
<dd>The system clears the existing member and adds the new records.
</dd>
<dt><b>*ADD</b></dt>
<dd>The system adds the new records to the end of the existing records.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPLICKEY.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="DSPLICKEY.COMMAND.EXAMPLES">Examples</a> </h3>
<p>
<pre>
DSPLICKEY PRDID(*ALL) LICTRM(*ALL) FEATURE(*ALL)
SERIAL(*REMOTE) OUTPUT(*LICKEYFILE)
LICKEYFILE(KEYS) LICKEYMBR(REMOTE *REPLACE)
</pre>
</p>
<p>This command shows the software license key information for all of the products, features, and license terms for all of the systems except this system. The output is put in the member REMOTE of the file KEYS. Any existing records are replaced.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPLICKEY.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="DSPLICKEY.ERROR.MESSAGES">Error messages</a> </h3>
<p><b><u>*ESCAPE Messages</u></b>
</p>
<dl>
<dt><b>CPF9E58</b></dt>
<dd>License key information not found.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPLICKEY.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>