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

377 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>Add License Information (ADDPRDLICI)</title>
</head>
<body bgcolor="white">
<a name="ADDPRDLICI.Top_Of_Page"></a>
<h2>Add License Information (ADDPRDLICI)</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="#ADDPRDLICI.PARAMETERS.TABLE">Parameters</a><br>
<a href="#ADDPRDLICI.COMMAND.EXAMPLES">Examples</a><br>
<a href="#ADDPRDLICI.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="ADDPRDLICI"></a>
<p>The Add Product License Information (ADDPRDLICI) command adds license information to the product or feature. This command can be used before or after the product or options belonging to a feature are packaged using the Package Product Option (PKGPRDOPT) command, but before the product or options belonging to a feature are installed. If the product has keyed (*KEYED) compliance, a product license information handle is included in the completion message received from this command.
</p>
<p>For more information about the Add Product License Information (QLZADDLI) API is also available in 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="#ADDPRDLICI.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="ADDPRDLICI.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="#ADDPRDLICI.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="#ADDPRDLICI.RLS"><b>RLS</b></a></td>
<td valign="top">Release level</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Required, Positional 2</td>
</tr>
<tr>
<td valign="top"><a href="#ADDPRDLICI.FEATURE"><b>FEATURE</b></a></td>
<td valign="top">Feature</td>
<td valign="top"><i>Character value</i>, <b><u>5001</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#ADDPRDLICI.USGTYPE"><b>USGTYPE</b></a></td>
<td valign="top">Usage type</td>
<td valign="top"><b><u>*CONCURRENT</u></b>, *REGISTERED</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#ADDPRDLICI.COMPLIANCE"><b>COMPLIANCE</b></a></td>
<td valign="top">Compliance type</td>
<td valign="top"><b><u>*OPRACTION</u></b>, *WARNING, *KEYED</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#ADDPRDLICI.DFTUSGLMT"><b>DFTUSGLMT</b></a></td>
<td valign="top">Default 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="#ADDPRDLICI.LICTRM"><b>LICTRM</b></a></td>
<td valign="top">License term</td>
<td valign="top"><b><u>*VERSION</u></b>, *RELEASE, *MOD</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#ADDPRDLICI.MSGID"><b>MSGID</b></a></td>
<td valign="top">Feature message ID</td>
<td valign="top"><i>Name</i>, <b><u>*BASEOPT</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#ADDPRDLICI.ALWLICRLS"><b>ALWLICRLS</b></a></td>
<td valign="top">Allow license release</td>
<td valign="top"><b><u>*NO</u></b>, *YES</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#ADDPRDLICI.VNDPWD"><b>VNDPWD</b></a></td>
<td valign="top">Vendor password</td>
<td valign="top"><i>Simple name</i>, <b><u>*NONE</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top" rowspan="3"><a href="#ADDPRDLICI.GRACE"><b>GRACE</b></a></td>
<td valign="top">Grace period</td>
<td valign="top"><i>Element list</i></td>
<td valign="top" rowspan="3">Optional</td>
</tr>
<tr>
<td valign="top">Element 1: Number of days</td>
<td valign="top">
0-999, <b><u>0</u></b></td>
</tr>
<tr>
<td valign="top">Element 2: Allow for default usage limit</td>
<td valign="top">
<b><u>*NO</u></b>, *YES</td>
</tr>
</table>
<table width="100%">
<tr><td align="right"><a href="#ADDPRDLICI.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="ADDPRDLICI.PRDID"></a>
<h3>Product ID (PRDID)</h3>
<p>Specifies the product identifier of the product loads to which the license information is being added.
</p>
<p>
<b>Note: </b>The identifier must be exactly 7 characters long.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDPRDLICI.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDPRDLICI.RLS"></a>
<h3>Release level (RLS)</h3>
<p>Specifies the version, the release, and the modification level of the product or feature to which the license information is being added.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><i>version-release-modification</i></b></dt>
<dd>Specify the version, release, and modification level of the product or feature where the license information is being added. The release level must be in the format VxRyMz, where valid values for x and y range from 0 through 9 and valid values for z range from 0 through 9 and A through Z
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDPRDLICI.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDPRDLICI.FEATURE"></a>
<h3>Feature (FEATURE)</h3>
<p>Specifies the feature for which the license information is being added. The license information is added to all product loads with the specified product ID and feature.
</p>
<dl>
<dt><b><u>5001</u></b></dt>
<dd>License information for the 5001 feature of the product specified on the PRDID parameter is added.
</dd>
<dt><b><i>load-ID</i></b></dt>
<dd>Specify that the license information for the feature on the PRDID parameter associated with this number is to be added. Valid values range from 5001 through 9999.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDPRDLICI.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDPRDLICI.USGTYPE"></a>
<h3>Usage type (USGTYPE)</h3>
<p>Specifies the type of license usage.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><u>*CONCURRENT</u></b></dt>
<dd>The usage limit is for the number of unique jobs accessing the product or feature at one time.
</dd>
<dt><b>*REGISTERED</b></dt>
<dd>The usage limit is for the number of unique license users registered by the product or feature.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDPRDLICI.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDPRDLICI.COMPLIANCE"></a>
<h3>Compliance type (COMPLIANCE)</h3>
<p>Specifies the action that must be taken when the usage limit is exceeded.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><u>*OPRACTION</u></b></dt>
<dd>The usage limit cannot be exceeded. If you attempt to use the product or feature after the usage limit has been reached, you are prevented from accessing the product or feature until the appropriate action is taken by the system administrator to increase the usage limit.
</dd>
<dt><b>*WARNING</b></dt>
<dd>If you attempt to use the product or feature after the usage limit has been reached, you are allowed access. A warning message indicating that the usage limit has been exceeded is sent to the licensing information owner for notification.
</dd>
<dt><b>*KEYED</b></dt>
<dd>A license key is required from the software provider to install or to increase the usage limit of the product or feature. The software provided can permit a grace period which allows the usage limit of a product or feature to be exceeded for n days before a new license key is required to allow additional users access to the product. If a new key with an increased usage limit is not installed prior to the end of the grace period, the usage limit of the product reverts back to the entitled usage limit.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDPRDLICI.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDPRDLICI.DFTUSGLMT"></a>
<h3>Default usage limit (DFTUSGLMT)</h3>
<p>Specifies the usage limit that is in effect the first time the product or feature is installed for a license term.
</p>
<p>
<b>Note: </b>For *KEYED compliance, this is the number of users that are able to use the product or feature before the license key is installed using the Add License Key (ADDLICKEY) command or Add License Key Information (QLZAADDK) API. To prevent any access to the product or feature without a key, the default usage limit should be set to 0.
</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>Any number of users are allowed to access the product or feature.
</dd>
<dt><b><i>default-usage-limit</i></b></dt>
<dd>Specify the default usage limit number. The valid values range from 0 through 999&amp;finespace.999.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDPRDLICI.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDPRDLICI.LICTRM"></a>
<h3>License term (LICTRM)</h3>
<p>Specifies which levels of the product or feature share license information.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><u>*VERSION</u></b></dt>
<dd>All VxRx levels of the product, where Vx is the version level and Rx is the release level, specified on the RLS parameter whose license term is also *VERSION share the same license information. When the version level of the product or feature changes, customers installing the new release must use the Change License Information (CHGLICINF) command for a compliance type of *WARNING or *OPRACTION, or the Add License Key (ADDLICKEY) command for a compliance type of *KEYED, to set the license information.
</dd>
<dt><b>*RELEASE</b></dt>
<dd>All VxRx levels of the product, where Vx is the version level and Rx is the release level, specified on the RLS parameter whose license term is also *RELEASE share the same license information. When the version level or the release level of the product or feature changes, customers installing the new release must use the Change License Information (CHGLICINF) command for a compliance type of *WARNING or *OPRACTION or the Add License Key (ADDLICKEY) command for a compliance type of *KEYED to set the license information.
</dd>
<dt><b>*MOD</b></dt>
<dd>Each level of the product or feature is licensed. No license information is shared between levels. Customers installing a new level of the product or feature must use the Change License Information (CHGLICINF) command for compliance type of *WARNING or *OPRACTION, or the Add License Key (ADDLICKEY) command for compliance type of *KEYED to set the license information.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDPRDLICI.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDPRDLICI.MSGID"></a>
<h3>Feature message ID (MSGID)</h3>
<p>Specifies the message identifier of the message that describes the product feature. The message file for this message ID is specified in the product definition.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><u>*BASEOPT</u></b></dt>
<dd>There is no message describing this product feature. The message used for describing the base option of this product is used instead.
</dd>
<dt><b><i>feature-message-id</i></b></dt>
<dd>Specify the message identifier of the message that describes this product feature.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDPRDLICI.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDPRDLICI.ALWLICRLS"></a>
<h3>Allow license release (ALWLICRLS)</h3>
<p>Specifies whether a license that is previously requested can be released using the WRKLICINF command. When the license is released, the usage count is decreased. This value can only be specified for a registered license type.
</p>
<p>If it is necessary for the product to be notified that a license has been released, *NO should be specified and the product must provide its own mechanism for releasing a license.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><u>*NO</u></b></dt>
<dd>A license cannot be released using the WRKLICINF command.
</dd>
<dt><b>*YES</b></dt>
<dd>A license can be released using the WRKLICINF command.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDPRDLICI.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDPRDLICI.VNDPWD"></a>
<h3>Vendor password (VNDPWD)</h3>
<p>Specifies the software vendor's password. This password is encrypted and stored with the product. It is used in validating Add License Key requests and must be the same password used to generate keys for this product and feature on the Generate License Key (GENLICKEY) command.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><u>*NONE</u></b></dt>
<dd>There is no vendor password needed for the Add License Key Information (ADDLICKEY) command.
</dd>
<dt><b><i>vendor-password</i></b></dt>
<dd>Specify the vendor password. It must begin with an alphabetic character such as A through Z, $, # or @. It is then followed by no more than 9 alphanumeric characters such as A through Z, 0 through 9, $, # @ or _.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDPRDLICI.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDPRDLICI.GRACE"></a>
<h3>Grace period (GRACE)</h3>
<p>Specifies the number of days after a product first exceeds its usage limit that you have to obtain a new license key. If a new license key is not obtained from the software vendor by the time the grace period is expired, no users over the usage limit are allowed to access the product or feature. When the usage limit is first exceeded, the date the grace period expires is calculated by adding the number of days in the grace period to today's date.
</p>
<p>The possible number grace period days values are:
</p>
<dl>
<dt><b><u>0</u></b></dt>
<dd>There is no grace period. The user is not allowed to exceed the usage limit.
</dd>
<dt><b><i>grace-period</i></b></dt>
<dd>Specify the number of days in the grace period. Valid values range from 0 through 999.
</dd>
</dl>
<p>The possible values for allowing for a default usage limit are:
</p>
<dl>
<dt><b><u>*NO</u></b></dt>
<dd>The grace period is not allowed for use with the default usage limit. This means that you are not allowed to exceed the default usage limit before the license key is installed using the Add License Key command (ADDLICKEY) or Add License Key Information (QLZAADDK) API.
</dd>
<dt><b>*YES</b></dt>
<dd>The grace period is allowed for use with the default usage limit. This means that you can exceed the default usage limit for the number of days in the grace period before the license key is installed.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDPRDLICI.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="ADDPRDLICI.COMMAND.EXAMPLES">Examples</a> </h3>
<p><b>Example 1: Adding Product License Information</b>
</p>
<p>
<pre>
ADDPRDLICI PRDID(1MYPROD) RLS(V5R2M0)
</pre>
</p>
<p>This command adds product license information to the product with product identifier 1MYPROD for release V5R2M0.
</p>
<p><b>Example 2: Adding Product License Information for the V5R2M0 Release</b>
</p>
<p>
<pre>
ADDPRDLICI PRDID(2MYPROD) RLS(V5R2M0) COMPLIANCE(*KEYED)
VNDOWD(PRODUCTPWD) GRACE(30 *YES)
</pre>
</p>
<p>This command adds product license information to the product with the product identifier 1MYPROD for release V5R2M0. This product supports keyed compliance. It can exceed its usage limit and default usage for 30 days.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDPRDLICI.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="ADDPRDLICI.ERROR.MESSAGES">Error messages</a> </h3>
<p><b><u>*ESCAPE Messages</u></b>
</p>
<dl>
<dt><b>CPF9E1A</b></dt>
<dd>License information conflict found.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDPRDLICI.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>