ibm-information-center/dist/eclipse/plugins/i5OS.ic.apis_5.4.0.1/qlzaddli.htm

1026 lines
30 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">
<meta name="Copyright" content="Copyright (c) 2006 by IBM Corporation">
<title>Add Product License Information (QLZADDLI) API</title>
<!-- Begin Header Records ========================================== -->
<!-- All rights reserved. Licensed Materials Property of IBM -->
<!-- US Government Users Restricted Rights -->
<!-- Use, duplication or disclosure restricted by -->
<!-- GSA ADP Schedule Contract with IBM Corp. -->
<!-- QLZADDLI SCRIPT A converted by B2H R4.1 (346) (CMS) by KENTALA -->
<!-- at RCHVMW2 on 7 Oct 1998 at 18:07:49 -->
<!-- Change History: -->
<!-- YYMMDD USERID Change description -->
<!-- Edited by Kersten Jan 02 -->
<!--End Header Records -->
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
</head>
<body>
<a name="Top_Of_Page"></a>
<!-- Java sync-link -->
<script language="Javascript" src="../rzahg/synch.js" type="text/javascript">
</script>
<h2>Add Product License Information (QLZADDLI) API</h2>
<div class="box" style="width: 80%;">
<br>
&nbsp;&nbsp;Required Parameter Group:<br>
<!-- iddvc RMBR -->
<br>
<table width="100%">
<tr>
<td align="center" valign="top" width="10%">1</td>
<td align="left" valign="top" width="50%">Product identification</td>
<td align="left" valign="top" width="20%">Input</td>
<td align="left" valign="top" width="20%">Char(*)</td>
</tr>
<tr>
<td align="center" valign="top">2</td>
<td align="left" valign="top">Product identification format name</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(8)</td>
</tr>
<tr>
<td align="center" valign="top">3</td>
<td align="left" valign="top">License information</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(*)</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="left" valign="top">License information format name</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(8)</td>
</tr>
<tr>
<td align="center" valign="top">5</td>
<td align="left" valign="top">Error code</td>
<td align="left" valign="top">I/O</td>
<td align="left" valign="top">Char(*)</td>
</tr>
</table>
<br>
&nbsp;&nbsp;Optional Parameter Group:<br>
<!-- iddvc RMBR -->
<br>
<table width="100%">
<tr>
<td align="center" valign="top" width="10%">6</td>
<td align="left" valign="top" width="50%">Product license information
handle</td>
<td align="left" valign="top" width="20%">Output</td>
<td align="left" valign="top" width="20%">Char(16)</td>
</tr>
</table>
<br>
&nbsp;&nbsp;Default Public Authority: *USE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: No<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The Add Product License Information (QLZADDLI) API adds license information
to a product or a feature of a product. License information can be added at two
times:</p>
<ul>
<li>After the product definition object (*PRDDFN) has been created using the
Create Product Definition (CRTPRDDFN) command or the Create Product Definition
(QSZCRTPD) API.</li>
<li>Either before or after the product options have been packaged using the
Package Product Option (PKGPRDOPT) command or the Package Product Option
(QSZPKGPO) API.</li>
</ul>
<p>License information must be added before the product is installed.</p>
<br>
<h3>Authorities and Locks</h3>
<dl>
<dt><em>API QLZADDLI Authority</em></dt>
<dd>
<pre>
QPGMR(*USE)
QSRV(*USE)
QSRVBAS(*USE)
QSYSOPR(*USE)
</pre>
</dd>
<dt><em>Product Availability Lock</em></dt>
<dd>*SHRRD. The product availability object is in the QUSRSYS library.</dd>
<dt><em>Public Authority</em></dt>
<dd>*EXCLUDE</dd>
</dl>
<br>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>Product identification</strong></dt>
<dd>INPUT; CHAR(*)
<p>Information that uniquely identifies the product or feature to which license
information will be added. The structure of this information is determined by
the name of the format. For more information, see <a href=
"#HDRLICP100">LICP0100 Format</a> and <a href="#HDRLICP200">LICP0200
Format</a>.</p>
</dd>
<dt><strong>Product identification format name</strong></dt>
<dd>INPUT; CHAR(8)
<p>The name of the format containing the information to identify the
product.</p>
<p>The format names are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>LICP0100</em></td>
<td align="left" valign="top">Basic product information used as input to the
API. For details, see the <a href="#HDRLICP100">LICP0100 Format</a>.</td>
</tr>
<tr>
<td align="left" valign="top"><em>LICP0200</em></td>
<td align="left" valign="top">Basic product information plus the product
feature message ID are used as input to the API. For details, see the <a href=
"#HDRLICP200">LICP0200 Format</a>.</td>
</tr>
</table>
<br>
</dd>
<dt><strong>License information</strong></dt>
<dd>INPUT; CHAR(*)
<p>Information that is used to license the product or feature. The structure of
this information is determined by the name of the format. For more information,
see <a href="#HDRLICI100">LICI0100 Format</a> and <a href=
"#HDRLICI200">LICI0200 Format</a>.</p>
</dd>
<dt><strong>License information format name</strong></dt>
<dd>INPUT; CHAR(8)
<p>The name of the format containing the license information.</p>
<p>The format names are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>LICI0100</em></td>
<td align="left" valign="top">Basic license information used as input to the
API. For details, see <a href="#HDRLICI100">LICI0100 Format</a>.</td>
</tr>
<tr>
<td align="left" valign="top"><em>LICI0200</em></td>
<td align="left" valign="top">Basic license information plus count usage across
logical partitions used as input to the API. For details, see <a href=
"#HDRLICI200">LICI0200 Format</a>.</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Error code</strong></dt>
<dd>I/O; CHAR(*)
<p>The structure in which to return error information. For the format of the
structure, see <a href="../apiref/error.htm#hdrerrcod">Error Code Parameter</a>.</p>
</dd>
</dl>
<br>
<h3>Optional Parameter Group</h3>
<dl>
<dt><strong>Product license information handle</strong></dt>
<dd>OUTPUT; CHAR(16)
<p>A handle based on the product license information. This handle can be used
by the software vendor to help ensure asset protection. Specifically, it makes
sure that no unauthorized changes were made to the license information. This
handle can be used in conjunction with the Retrieve License Information
(QLZARTV) API. The information retrieved by the QLZARTV API includes the
product license information handle of the product and license information
currently installed on the system. If this handle does not match the one
returned by this command or API, then the product has been tampered with. It is
suggested that this handle be retrieved and checked before doing a request or
release when using keyed compliance. This handle is only returned if the
product has keyed compliance.</p>
</dd>
</dl>
<br>
<h3><a name="HDRLICP100">LICP0100 Format</a></h3>
<p>The following information uniquely describes the product or feature for
which the license information is to be added. For detailed descriptions of the
fields, see <a href="#HDRADDLIFD">Field Descriptions</a>.</p>
<table border width="80%">
<tr>
<th align="center" valign="bottom" colspan="2">Offset</th>
<th align="left" valign="bottom" rowspan="2">Type</th>
<th align="left" valign="bottom" rowspan="2">Field</th>
</tr>
<tr>
<th align="center" valign="bottom">Dec</th>
<th align="center" valign="bottom">Hex</th>
</tr>
<tr>
<td align="center" valign="top" width="10%">0</td>
<td align="center" valign="top" width="10%">0</td>
<td align="left" valign="top" width="20%">CHAR(7)</td>
<td align="left" valign="top" width="60%">Product ID</td>
</tr>
<tr>
<td align="center" valign="top">7</td>
<td align="center" valign="top">7</td>
<td align="left" valign="top">CHAR(6)</td>
<td align="left" valign="top">Release level</td>
</tr>
<tr>
<td align="center" valign="top">13</td>
<td align="center" valign="top">D</td>
<td align="left" valign="top">CHAR(4)</td>
<td align="left" valign="top">Feature</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRLICP200">LICP0200 Format</a></h3>
<p>The following information uniquely describes the product or feature for
which the license information is to be added. It also includes the message
identifier of the specified feature. For detailed descriptions of the fields,
see <a href="#HDRADDLIFD">Field Descriptions</a>.</p>
<table border width="80%">
<tr>
<th align="center" valign="bottom" colspan="2">Offset</th>
<th align="left" valign="bottom" rowspan="2">Type</th>
<th align="left" valign="bottom" rowspan="2">Field</th>
</tr>
<tr>
<th align="center" valign="bottom">Dec</th>
<th align="center" valign="bottom">Hex</th>
</tr>
<tr>
<td align="center" valign="top" width="10%">0</td>
<td align="center" valign="top" width="10%">0</td>
<td align="left" valign="top" width="20%">BIN(4)</td>
<td align="left" valign="top" width="60%">Size of structure</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="center" valign="top">4</td>
<td align="left" valign="top">CHAR(7)</td>
<td align="left" valign="top">Product ID</td>
</tr>
<tr>
<td align="center" valign="top">11</td>
<td align="center" valign="top">B</td>
<td align="left" valign="top">CHAR(6)</td>
<td align="left" valign="top">Release level</td>
</tr>
<tr>
<td align="center" valign="top">17</td>
<td align="center" valign="top">11</td>
<td align="left" valign="top">CHAR(4)</td>
<td align="left" valign="top">Feature</td>
</tr>
<tr>
<td align="center" valign="top">21</td>
<td align="center" valign="top">15</td>
<td align="left" valign="top">CHAR(7)</td>
<td align="left" valign="top">Feature message ID</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRLICI100">LICI0100 Format</a></h3>
<p>The following specifies the format for the license information that is being
added to the product or feature. The allow default usage grace period, vendor
password, and grace period fields must be specified if the compliance type is
03. For a compliance type of 01 or 02, these fields do not have to be
specified. For detailed descriptions of the fields, see <a href=
"#HDRADDLIFD">Field Descriptions</a>.</p>
<table border width="80%">
<tr>
<th align="center" valign="bottom" colspan="2">Offset</th>
<th align="left" valign="bottom" rowspan="2">Type</th>
<th align="left" valign="bottom" rowspan="2">Field</th>
</tr>
<tr>
<th align="center" valign="bottom">Dec</th>
<th align="center" valign="bottom">Hex</th>
</tr>
<tr>
<td align="center" valign="top" width="10%">0</td>
<td align="center" valign="top" width="10%">0</td>
<td align="left" valign="top" width="20%">CHAR(2)</td>
<td align="left" valign="top" width="60%">Usage type</td>
</tr>
<tr>
<td align="center" valign="top">2</td>
<td align="center" valign="top">2</td>
<td align="left" valign="top">CHAR(2)</td>
<td align="left" valign="top">Compliance</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="center" valign="top">4</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Default usage limit</td>
</tr>
<tr>
<td align="center" valign="top">8</td>
<td align="center" valign="top">8</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">License term</td>
</tr>
<tr>
<td align="center" valign="top">9</td>
<td align="center" valign="top">9</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Allow a license to be released</td>
</tr>
<tr>
<td align="center" valign="top">10</td>
<td align="center" valign="top">A</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Vendor password</td>
</tr>
<tr>
<td align="center" valign="top">20</td>
<td align="center" valign="top">14</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Grace period</td>
</tr>
<tr>
<td align="center" valign="top">24</td>
<td align="center" valign="top">18</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Allow default usage limit grace period</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRLICI200">LICI0200 Format</a></h3>
<p>The following specifies the format for the license information that is being
added to the product or feature. The allow default usage grace period, vendor
password, grace period, and count across logical partitions fields must be
specified if the compliance type is 03. For a compliance type of 01 or 02,
these fields do not have to be specified. For detailed descriptions of the
fields, see <a href="#HDRADDLIFD">Field Descriptions</a>.</p>
<table border width="80%">
<tr>
<th align="center" valign="bottom" colspan="2">Offset</th>
<th align="left" valign="bottom" rowspan="2">Type</th>
<th align="left" valign="bottom" rowspan="2">Field</th>
</tr>
<tr>
<th align="center" valign="bottom">Dec</th>
<th align="center" valign="bottom">Hex</th>
</tr>
<tr>
<td align="center" valign="top" width="10%">0</td>
<td align="center" valign="top" width="10%">0</td>
<td align="left" valign="top" width="20%">BINARY(4)</td>
<td align="left" valign="top" width="60%">Size of structure</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="center" valign="top">4</td>
<td align="left" valign="top">CHAR(2)</td>
<td align="left" valign="top">Usage type</td>
</tr>
<tr>
<td align="center" valign="top">6</td>
<td align="center" valign="top">6</td>
<td align="left" valign="top">CHAR(2)</td>
<td align="left" valign="top">Compliance</td>
</tr>
<tr>
<td align="center" valign="top">8</td>
<td align="center" valign="top">8</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Default usage limit</td>
</tr>
<tr>
<td align="center" valign="top">12</td>
<td align="center" valign="top">C</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">License term</td>
</tr>
<tr>
<td align="center" valign="top">13</td>
<td align="center" valign="top">D</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Allow a license to be released</td>
</tr>
<tr>
<td align="center" valign="top">14</td>
<td align="center" valign="top">E</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Vendor password</td>
</tr>
<tr>
<td align="center" valign="top">24</td>
<td align="center" valign="top">18</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Grace period</td>
</tr>
<tr>
<td align="center" valign="top">28</td>
<td align="center" valign="top">1C</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Allow default usage limit grace period</td>
</tr>
<tr>
<td align="center" valign="top">29</td>
<td align="center" valign="top">1D</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Count usage across logical partitions</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRADDLIFD">Field Descriptions</a></h3>
<p><strong>Allow default usage limit grace period.</strong> Whether a grace
period should be allowed on the default usage limit. If allowed, the default
usage limit could be exceeded for the number of days in the grace period for
the product or feature. The default usage limit is the number of users that are
able to use the product or feature before the license key is installed. Thus,
an unlimited number of users can use the product or feature for the number of
days in the grace period without having a key.</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">There is no grace period for the default usage
limit.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">There is a grace period for the default usage
limit.</td>
</tr>
</table>
<p><strong>Allow a license to be released.</strong> Whether a use of the
license that was previously requested can be released using the Work with
License Information (WRKLICINF) command. When a use of the license is released,
the usage count is decremented. This value can only be specified for a usage
type of registered.</p>
<p>The valid values are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">A use of the license cannot be released with the
WRKLICINF command.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">A use of the license can be released with the
WRKLICINF command.</td>
</tr>
</table>
<p><strong>Compliance.</strong> The action taken when the usage limit is
exceeded.</p>
<p>The valid values are:</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>01</em></td>
<td align="left" valign="top">The usage limit cannot be exceeded. After the
usage limit for a product or feature is reached, it cannot be accessed again
until the usage limit for it is increased. A message indicating an attempt was
made to exceed the usage limit is sent to:<br>
<ul>
<li>The QSYSOPR message queue.</li>
<li>The message queues specified on the Change License Information (CHGLICINF)
command.</li>
</ul>
</td>
</tr>
<tr>
<td align="left" valign="top"><em>02</em></td>
<td align="left" valign="top">The user who attempts to use the product or
feature after the usage limit has been reached is allowed access. A warning
message indicating that the usage limit has been exceeded is sent to:<br>
<ul>
<li>The QSYSOPR message queue.</li>
<li>The message queues specified on the CHGLICINF command.</li>
</ul>
</td>
</tr>
<tr>
<td align="left" valign="top"><em>03</em></td>
<td align="left" valign="top">To use a product or feature with keyed
compliance, the license must be installed using one of the following:<br>
<ul>
<li>A valid license key (through the Add License Key Information (ADDLICKEY)
command.</li>
<li>The Add License Key Information (QLZAADDK) API).</li>
</ul>
</td>
</tr>
<tr>
<td align="left" valign="top"></td>
<td align="left" valign="top">This license key is provided by the software
provider. The key ties the usage limit to the particular product or feature and
to a particular system serial number. To change the usage limit, a user must
get a new key from the software provider. A user who attempts to use the
product or feature after the usage limit has been reached is allowed access for
the number of days contained in the product's grace period. Once the grace
period expires, no users over the usage limit are able to use the product or
feature until one of the following happens:<br>
<ul>
<li>A new license key is received from the software vendor.</li>
<li>The numbers of users falls below the usage limit.</li>
</ul>
</td>
</tr>
<tr>
<td align="left" valign="top"></td>
<td align="left" valign="top">A warning message, indicating the usage limit is
exceeded, is sent to the QSYSOPR message queue and the message queues specified
on the CHGLICINF command.</td>
</tr>
</table>
<p><strong>Count usage across logical partitions.</strong> Whether usage is
counted across logical partitions.</p>
<table cellpadding="5">
<!-- cols="5 90" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">Usage is not counted across logical
partitions.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Usage is counted across logical partitions.</td>
</tr>
</table>
<p><strong>Default usage limit.</strong> The usage limit in effect when the
product or feature is initially installed.</p>
<p>The valid values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top" nowrap><em>0-999999</em></td>
<td align="left" valign="top">The number of users allowed to access the product
or feature.</td>
</tr>
<tr>
<td align="left" valign="top"><em>-1</em></td>
<td align="left" valign="top">Any number of users are allowed to access the
product or feature.</td>
</tr>
</table>
<p><strong>Note:</strong> For keyed compliance, this is the number of users
that will be able to use the product or feature before the license key is
installed using the Add License Key command (ADDLICKEY) or API (QLZAADDK).
Therefore, to prevent any access to the product or feature without a key, the
default usage limit must be set to 0. Also, 0 must be specified for the allow
default usage limit grace period.</p>
<p><strong>Feature.</strong> The feature of the product to which the license
information is being added. Valid values for the feature are 5001 through
9999.</p>
<p><strong>Feature message ID.</strong> The message identifier for the message
that describes the specified product or feature. If a message ID is not
specified, the message identifier used to describe the base product option is
used.</p>
<p><strong>Grace period.</strong> The number of days after a product first
exceeds its usage limit that a user has to obtain a new license key. If a new
license key is not obtained from the software provider 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 the current date. Valid values for the grace period are 0 through 999.</p>
<p>During the grace period, the number of users able to use the product or
feature is restricted to 50% greater than the current usage limit.</p>
<p><strong>License term.</strong> The length of time the authorized usage limit
for a product lasts.</p>
<p>The valid values are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The authorized usage limit is valid for the
entire version of the product or feature. Each time a new version is installed,
the authorized usage limit must be set by using one of the following:<br>
<ul>
<li>The Work with License Information (WRKLICINF) command.</li>
<li>The Change License Information (CHGLICINF) command.</li>
</ul>
</td>
</tr>
<tr>
<td align="left" valign="top"></td>
<td align="left" valign="top">In the case of keyed compliance (type 03), a new
license key must also be obtained from the software provider. However, products
with keyed compliance (type 03) must set the usage limit by using the ADDLICKEY
command. This command also requires that a license key be obtained from the
software provider to allow use of the product.</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">The authorized usage limit is valid for the
entire release of the product or feature. Each time a new release is installed,
the authorized usage limit must be set by using the WRKLICINF command or the
CHGLICINF command. In the case of keyed compliance (type 03), a new license key
must also be obtained from the software provider. However, products with keyed
compliance (type 03) must set the usage limit by using the ADDLICKEY command.
This command also requires that a license key be obtained from the software
provider to allow use of the product.</td>
</tr>
<tr>
<td align="left" valign="top"><em>3</em></td>
<td align="left" valign="top">The authorized usage limit is valid only for a
modification of the product. Each time a new modification is installed, the
authorized usage limit must be set by using the WRKLICINF command or the
CHGLICINF command. However, products with keyed compliance (type 03) must set
the usage limit by using the ADDLICKEY command. This command also requires that
a license key be obtained from the software provider to allow use of the
product.</td>
</tr>
</table>
<p><strong>Product ID.</strong> The product ID of the product or feature to
which the license information is being added.</p>
<p><strong>Release level.</strong> The version, release, and modification level
of the product or feature to which the license information is to be added. The
release level must be in the format V<em>x</em>R<em>y</em>M<em>z</em>. Valid
values for <em>x</em> and <em>y</em> are 0 through 9. Valid values for
<em>z</em> are 0 through 9 and A through Z.</p>
<p><strong>Size of structure.</strong> The size of the entire data passed in on
this structure.</p>
<p><strong>Usage type.</strong> The type of license usage.</p>
<p>The valid values are:</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>01</em></td>
<td align="left" valign="top">The usage type is concurrent. It is for the
number of unique jobs accessing the product or feature at one time.</td>
</tr>
<tr>
<td align="left" valign="top"><em>02</em></td>
<td align="left" valign="top">The usage type is registered. It is for the
number of unique users registered by the product or feature.</td>
</tr>
<tr>
<td align="left" valign="top"><em>03</em></td>
<td align="left" valign="top">The license usage is by processors. Counts the
number of processors that are assigned to the logical partition.</td>
</tr>
</table>
<p><strong>Vendor password.</strong> The software vendor's password. This
password is encrypted, stored with the product, and is used in validating Add
License Key (ADDLICKEY) requests. It must be the same password that is used to
generate keys for this product and feature on the Generate License Key command
or API. The password must begin with an alphabetic character (A through Z, $,
#, or @) followed by no more than 9 alphameric characters (A through Z, 0
through 9, $, #, @, or _).</p>
<br>
<h3>Error Messages</h3>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<th align="left" valign="top">Message ID</th>
<th align="left" valign="top">Error Message Text</th>
</tr>
<tr>
<td width="15%" valign="top">CPF0CB2 E</td>
<td width="85%" valign="top">Product identifier &amp;1 not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF0C4B E</td>
<td align="left" valign="top">Product availability object &amp;2/&amp;1
recovery required.</td>
</tr>
<tr>
<td align="left" valign="top">CPF0C4C E</td>
<td align="left" valign="top">Cannot allocate object &amp;1 in library
&amp;2.</td>
</tr>
<tr>
<td align="left" valign="top">CPF0C4D E</td>
<td align="left" valign="top">Error occurred while processing object &amp;1 in
library &amp;2.</td>
</tr>
<tr>
<td align="left" valign="top">CPF0C54 E</td>
<td align="left" valign="top">Data in product record not correct.</td>
</tr>
<tr>
<td align="left" valign="top">CPF24B4 E</td>
<td align="left" valign="top">Severe error while addressing parameter
list.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3CF1 E</td>
<td align="left" valign="top">Error code parameter not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C21 E</td>
<td align="left" valign="top">Format name &amp;1 is not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C90 E</td>
<td align="left" valign="top">Literal value cannot be changed.</td>
</tr>
<tr>
<td align="left" valign="top">CPF358A E</td>
<td align="left" valign="top">Release not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF8191 E</td>
<td align="left" valign="top">Product definition &amp;4 in &amp;9 damaged.</td>
</tr>
<tr>
<td align="left" valign="top">CPF8193 E</td>
<td align="left" valign="top">Product load object &amp;4 in &amp;9
damaged.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9E0A E</td>
<td align="left" valign="top">Allow license release not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9E0B E</td>
<td align="left" valign="top">Allow grace period value of &amp;1 not
valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9E0C E</td>
<td align="left" valign="top">Allow license release &amp;1 not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9E0D E</td>
<td align="left" valign="top">Grace period &amp;1 not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9E0E E</td>
<td align="left" valign="top">Feature message identifier &amp;1 not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9E0F E</td>
<td align="left" valign="top">Vendor password &amp;1 not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9E02 E</td>
<td align="left" valign="top">Cannot add license information.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9E03 E</td>
<td align="left" valign="top">License information already exists.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9E04 E</td>
<td align="left" valign="top">Product definition for product &amp;1 &amp;2
feature &amp;3 cannot be found.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9E05 E</td>
<td align="left" valign="top">Feature &amp;3 not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9E06 E</td>
<td align="left" valign="top">Usage type &amp;1 not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9E07 E</td>
<td align="left" valign="top">Compliance &amp;1 not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9E08 E</td>
<td align="left" valign="top">Default usage limit &amp;1 not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9E09 E</td>
<td align="left" valign="top">License term &amp;1 not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9E1A E</td>
<td align="left" valign="top">License information conflict found.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9E15 E</td>
<td align="left" valign="top">Error in license management function.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9801 E</td>
<td align="left" valign="top">Object &amp;2 in library &amp;3 not found.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9803 E</td>
<td align="left" valign="top">Cannot allocate object &amp;2 in library
&amp;3.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9810 E</td>
<td align="left" valign="top">Library &amp;1 not found.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9838 E</td>
<td align="left" valign="top">User profile storage limit exceeded.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9872 E</td>
<td align="left" valign="top">Program or service program &amp;1 in library
&amp;2 ended. Reason code &amp;3.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9872 E</td>
<td align="left" valign="top">Program or service program &amp;1 in library
&amp;2 ended. Reason code &amp;3.</td>
</tr>
</table>
<br>
<hr>
API introduced: V2R3
<hr>
<table cellpadding="2" cellspacing="2" align="center">
<tr align="center">
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
"sw1.htm">Software Product APIs</a> | <a href="aplist.htm">APIs by
category</a></td>
</tr>
</table>
</body>
</html>