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

279 lines
8.3 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>Allocate Licensed Internal Code (LIC) Space (QLPALCSP) API</title>
<!-- Begin Header records -->
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
</head>
<body>
<!--End Header Records ================================================ -->
<!-- Java sync-link =================================================== -->
<script type="text/javascript" language="Javascript" src="../rzahg/synch.js">
</script>
<a name="Top_Of_Page"></a>
<h2><img src="delta.gif" alt="Start of change">Allocate Licensed Internal Code (LIC) Space (QLPALCSP) 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%">Allocate space for release</td>
<td align="left" valign="top" width="20%">Input</td>
<td align="left" valign="top" width="20%">Char(10)</td>
</tr>
<tr>
<td align="center" valign="top">2</td>
<td align="left" valign="top">Start space allocation</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(1)</td>
</tr>
</table>
<br>
&nbsp;&nbsp;Optional Parameter Group:<br>
<!-- iddvc RMBR -->
<br>
<table width="100%">
<tr>
<td align="center" valign="top" width="10%">3</td>
<td align="left" valign="top" width="50%">IPL required</td>
<td align="left" valign="top" width="20%">Output</td>
<td align="left" valign="top" width="20%">Char(1)</td>
</tr>
<tr>
<td align="center" valign="top">4</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;Default Public Authority: *EXCLUDE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: No<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>This API should be used prior to upgrading to the next release of
the operating system to have licensed internal code (LIC) allocate any additional LIC
space required for that release. The space will be be allocated during the next IPL. To save IPL time, the process to free space that will be allocated during IPL can be started immediately.
</p>
<p><strong>Note:</strong> Once the additional LIC space has been allocated,
the space cannot be returned to the user. This API can be used to toggle on and off the action for LIC to allocate this space during the next IPL as many times as necessary prior to performing the IPL.</p>
<p>To determine whether or not the release being installed requires any additional
space, review the iSeries Information Center for information about
allocating additional LIC space. See the topic on preparation tasks for
upgrading or replacing software.</p>
<br>
<h3>Authorities and Locks</h3>
<p>You are required to have system configuration (*IOSYSCFG) special authority
to use this API.</p>
<br>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>Allocate space for release</strong></dt>
<dd>INPUT; CHAR(10)
<p>Indicates whether or not additional space should be allocated, and
if it should be allocated, the release of the operating system that needs the
additional space.</p>
<p>The valid values are:</p>
<dl>
<dt><strong>*NONE</strong></dt>
<dd>No additional space should be allocated for LIC at this time or during the next IPL for any release. If space was already being freed, that action will be stopped. If the space was already allocated during an IPL, it cannot be undone. Any space freed during a previous call to this API will be returned to the user.<br>
<br>
</dd>
<dt><strong>VxRyMz</strong></dt>
<dd>The version, release, and modification level of the operating system that will be installed.
The release must be in the format VxRyMz. Valid values for x and y are 0 through 9.
Valid values for z are 0 through 9 or A through Z. For example, V5R4M0 is version 5,
release 4, modification 0. <br>
<br>
</dd>
</dl>
</dd>
<dt><strong>Start space allocation</strong></dt>
<dd>INPUT; CHAR(1)
<p>Determines whether the space will be allocated during the
next IPL or if some of the space should be freed in a background
task with the allocation process being completed during the next IPL. This
parameter must be '0' when *NONE is specified for the Allocate space
for release parameter.</p>
<p>Not all of the additional LIC space can be freed while the server is
operational. The rest of the space will be freed during the next IPL.</p>
<p>The valid values are:</p>
<dl>
<dt><strong>0</strong></dt>
<dd>Licensed Internal Code is
to allocate all of the additional space required for the specified release
during the next IPL. This value will also cause LIC to stop any space
allocation requests due to a previous call to QLPALCSP with the Start
space allocation parameter set to '1'.<br>
<br>
</dd>
<dt><strong>1</strong></dt>
<dd>Licensed Internal Code is to begin freeing space for the
specified release immediately. The space can be allocated more
quickly during the next IPL as LIC does not need to free that
space during the IPL process. This option is recommended to minimize the
length of time the next IPL will take to complete the operation.<br>
<br>
</dd>
</dl>
</dd>
</dl>
<br>
<h3>Optional Parameter Group</h3>
<dl>
<dt><strong>IPL required</strong></dt>
<dd>OUTPUT; CHAR(1)
<p>This parameter will let you know whether or not an IPL is needed to
allocate the additional LIC space. If the release you are currently using
already has sufficient space needed to upgrade, there will be no need to
perform an IPL. If an IPL is not necessary and if this parameter is not specified, informational message
CPI3DBF (Allocating additional space is not necessary) will be sent to the joblog. </p>
<dl>
<dt><strong>0</strong></dt>
<dd>An IPL is not required. Sufficient LIC space exists for the specified
release.<br>
<br>
</dd>
<dt><strong>1</strong></dt>
<dd>An IPL is required for LIC to allocate the additional required space.
This IPL must occur prior to installing the specified release.<br>
<br>
</dd>
</dl>
</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><a name="header_9">Error Messages</a></h3>
<p>The following messages may be sent from this function:</p>
<table width="100%">
<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">CPF222E E</td>
<td width="85%" valign="top">&1. special authority is required.</td>
</tr>
<tr>
<td width="15%" valign="top">CPF24B4 E</td>
<td width="85%" valign="top">Severe error while addressing parameter list.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C36 E</td>
<td align="left" valign="top">Number of parameters, &1., entered for this API was not valid.</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">CPF3DF7 E</td>
<td align="left" valign="top">Load source to small for &1.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3DF8 E</td>
<td align="left" valign="top">Not enough free space on load source.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3DF9 E</td>
<td align="left" valign="top">Allocate space for release value not valid</td>
</tr>
<tr>
<td align="left" valign="top">CPF3DFA E</td>
<td align="left" valign="top">Information not available for release &1.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3DFB E</td>
<td align="left" valign="top">Start space allocation parameter not valid.</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>
<img src="deltaend.gif" alt="End of change">
<hr>
API introduced: V5R4
<hr>
<center>
<table cellpadding="2" cellspacing="2">
<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>
</center>
</body>
</html>