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

1214 lines
34 KiB
HTML

<!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>List Program Temporary Fixes (QpzListPTF) 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. -->
<!-- QPZLSTFX SCRIPT A converted by B2H R4.1 (346) (CMS) by KENTALA -->
<!-- at RCHVMW2 on 7 Oct 1998 at 18:35:55 -->
<!-- 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 type="text/javascript" language="Javascript" src="../rzahg/synch.js">
</script>
<h2>List Program Temporary Fixes (QpzListPTF) 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%">Qualified user space name</td>
<td align="left" valign="top" width="20%">Input</td>
<td align="left" valign="top" width="20%">Char(20)</td>
</tr>
<tr>
<td align="center" valign="top">2</td>
<td align="left" valign="top">Product information</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(50)</td>
</tr>
<tr>
<td align="center" valign="top">3</td>
<td align="left" valign="top">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">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;Service Program: QPZLSTFX<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Default Public Authority: *EXCLUDE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: No<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The List Program Temporary Fixes (QpzListPTF) API returns a list of PTFs for
the specified product, option, load, and release. The product must be supported
or installed before the list of PTFs is returned.</p>
<br>
<h3>Authorities and Locks</h3>
<dl>
<dt><em>User Space Authority</em></dt>
<dd>*CHANGE<br>
<br>
</dd>
<dt><em>User Space Library Authority</em></dt>
<dd>*EXECUTE<br>
<br>
</dd>
<dt><em>User Space Lock</em></dt>
<dd>*EXCLRD</dd>
</dl>
<br>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>Qualified user space name</strong></dt>
<dd>INPUT; CHAR(20)
<p>The user space that is to receive the generated list. The first 10
characters contain the user space name. The second 10 characters contain the
name of the library where the user space is located. You can use these special
values for the library name:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*CURLIB</em></td>
<td align="left" valign="top">The job's current library.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*LIBL</em></td>
<td align="left" valign="top">The library list.</td>
</tr>
</table>
<br>
<br>
</dd>
<dt><strong>Product information</strong></dt>
<dd>INPUT; CHAR(50)
<p>The attributes of the product for which information is being requested. For
more information on this parameter, see <a href="#HDRPRDINF4">Format of Product
Information</a>.</p>
</dd>
<dt><strong>Format name</strong></dt>
<dd>INPUT; CHAR(8)
<p>The content and format of the information that is returned for each PTF. The
possible format names are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>PTFL0100</em></td>
<td align="left" valign="top">List of PTFs for product, option, load, and
release. For more information, see <a href="#HDRPTFL010">PTFL0100 Format List
Section</a>.</td>
</tr>
</table>
<br>
<br>
</dd>
<dt><strong>Error code</strong></dt>
<dd>I/O; CHAR(*)</dd>
<dd>
<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="HDRPRDINF4">Format of Product Information</a></h3>
<p>For the detailed descriptions of each field, see the <a href=
"#HDRPZFNDFO">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">Option</td>
</tr>
<tr>
<td align="CENTER" valign="top">17</td>
<td align="CENTER" valign="top">11</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Load ID</td>
</tr>
<tr>
<td align="CENTER" valign="top">27</td>
<td align="CENTER" valign="top">1B</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Include superseded PTFs</td>
</tr>
<tr>
<td align="CENTER" valign="top"><img src="delta.gif" alt="Start of change">28</td>
<td align="CENTER" valign="top">1C</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Include permanently removed PTFs
<img src="deltaend.gif" alt="End of change"></td>
</tr>
<tr>
<td align="CENTER" valign="top"><img src="delta.gif" alt="Start of change">29</td>
<td align="CENTER" valign="top">1D</td>
<td align="left" valign="top">CHAR(21)<img src="deltaend.gif" alt="End of change"></td>
<td align="left" valign="top">Reserved</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRPZFNDFO">Field Descriptions</a></h3>
<p><img src="delta.gif" alt="Start of change"><strong>Include permanently removed PTFs.</strong> Whether to include PTFs that have a status of permanently removed
in the list. A PTF that has been permanently removed and also requires a server IPL, is on order, or has a save file or cover letter will be included in the list regardless of the value specified. Valid values follow:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">Do not include permanently removed PTFs in the list.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Include permanently removed PTFs in the list.<img src="deltaend.gif" alt="End of change"></td>
</tr>
</table>
<p><strong>Include superseded PTFs.</strong> Whether to include superseded PTFs
in the list. Valid values follow:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">Do not include superseded PTFs in the list.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Include superseded PTFs in the list.</td>
</tr>
</table>
<p><strong>Load ID.</strong> The load ID for which PTFs are being requested.
Load IDs are 10 characters in length. For example, 2924 is the load ID for an
English national language version (NLV). You can use the following special
value for the load ID:</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>*ALL</em></td>
<td align="left" valign="top">The list of PTFs contains PTFs for all loads for
the product specified.</td>
</tr>
</table>
<p><strong>Option.</strong> The option number for which PTFs are being
requested. Use 0000 for the base option. Valid values are 0000 through 0099,
where each character is a digit. You can use this special value for the
option:</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>*ALL</em></td>
<td align="left" valign="top">The list of PTFs contains PTFs for all options of
the specified product.</td>
</tr>
</table>
<p><strong>Product ID.</strong> The product ID for which PTFs are being
requested.</p>
<p><strong>Release level.</strong> The release of the product for which PTFs
are requested.</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>VxRyMz</em></td>
<td align="left" valign="top">The release for which PTFs are being requested.
The release must be in the format VxRyMz. Valid entries for x and y are any
number between 0 and 9. A valid entry for z is a number between 0 and 9 or a
character between A and Z.</td>
</tr>
</table>
<p>You can use this special value for the release:</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>*ALL</em></td>
<td align="left" valign="top">The generated list of PTFs contains PTFs for all
releases of the specified product.</td>
</tr>
</table>
<p><strong>Reserved.</strong> This field must contain hexadecimal zeros.<br>
<br>
</p>
<h3>Format of the Generated Lists</h3>
<p>The user space will contain:</p>
<ul>
<li>A user area</li>
<li>A generic header</li>
<li>An input parameter section</li>
<li>A header section</li>
<li>A list data section:
<ul>
<li>PTFL0100 format</li>
</ul>
</li>
</ul>
<p>For details about the user area and generic header, see <a href=
"../apiref/usf.htm">User Space Format for List APIs</a>. For details about the remaining
items, see the following sections. For detailed descriptions of the fields in
the generated list returned, see <a href="#HDRPZFNDFD">Field
Descriptions</a>.</p>
<p>When you retrieve the list entry information from a user space, you must use
the entry size returned in the generic header. The size of each entry may be
padded at the end. If you do not use the entry size, the result may not be
valid. For examples of how to process lists, see <a href="../apiref/apiexmp.htm">API
examples</a>.</p>
<br>
<h3><a name="HDRSCDLIPX">Input Parameter Section</a></h3>
<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(10)</td>
<td align="left" valign="top" width="60%">User space name specified</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">User space library name specified</td>
</tr>
<tr>
<td align="CENTER" valign="top">20</td>
<td align="CENTER" valign="top">14</td>
<td align="left" valign="top">CHAR(50)</td>
<td align="left" valign="top">Product information</td>
</tr>
<tr>
<td align="CENTER" valign="top">70</td>
<td align="CENTER" valign="top">46</td>
<td align="left" valign="top">CHAR(8)</td>
<td align="left" valign="top">Format name</td>
</tr>
</table>
<br>
<br>
<h3>Header Section</h3>
<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(10)</td>
<td align="left" valign="top" width="60%">User space library name used</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">User space name used</td>
</tr>
<tr>
<td align="CENTER" valign="top">20</td>
<td align="CENTER" valign="top">14</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">
Current IPL source
</td>
</tr>
<tr>
<td align="CENTER" valign="top">21</td>
<td align="CENTER" valign="top">15</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">
Current server IPL source
</td>
</tr>
<tr>
<td align="CENTER" valign="top"><img src="delta.gif" alt="Start of change">22</td>
<td align="CENTER" valign="top">16</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">
Server firmware status
<img src="deltaend.gif" alt="End of change">
</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRPTFL010">PTFL0100 Format List Section</a></h3>
<table border width="70%">
<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%">PTF 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 of the PTF</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">Product option of the PTF</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">Product load of the PTF</td>
</tr>
<tr>
<td align="CENTER" valign="top">21</td>
<td align="CENTER" valign="top">15</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Loaded status</td>
</tr>
<tr>
<td align="CENTER" valign="top">22</td>
<td align="CENTER" valign="top">16</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Save file status</td>
</tr>
<tr>
<td align="CENTER" valign="top">23</td>
<td align="CENTER" valign="top">17</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Cover letter status</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">On-order status</td>
</tr>
<tr>
<td align="CENTER" valign="top">25</td>
<td align="CENTER" valign="top">19</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">IPL action</td>
</tr>
<tr>
<td align="CENTER" valign="top">26</td>
<td align="CENTER" valign="top">1A</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Action pending</td>
</tr>
<tr>
<td align="CENTER" valign="top">27</td>
<td align="CENTER" valign="top">1B</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Action required</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">IPL required</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">PTF is released</td>
</tr>
<tr>
<td align="CENTER" valign="top">30</td>
<td align="CENTER" valign="top">1E</td>
<td align="left" valign="top">CHAR(2)</td>
<td align="left" valign="top">Minimum level</td>
</tr>
<tr>
<td align="CENTER" valign="top">32</td>
<td align="CENTER" valign="top">20</td>
<td align="left" valign="top">CHAR(2)</td>
<td align="left" valign="top">Maximum level</td>
</tr>
<tr>
<td align="CENTER" valign="top">34</td>
<td align="CENTER" valign="top">22</td>
<td align="left" valign="top">CHAR(13)</td>
<td align="left" valign="top">Status date and time</td>
</tr>
<tr>
<td align="CENTER" valign="top">47</td>
<td align="CENTER" valign="top">2F</td>
<td align="left" valign="top">CHAR(7)</td>
<td align="left" valign="top">Superseded by PTF ID</td>
</tr>
<tr>
<td align="CENTER" valign="top">54</td>
<td align="CENTER" valign="top">36</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">
Server IPL required
</td>
</tr>
<tr>
<td align="CENTER" valign="top">55</td>
<td align="CENTER" valign="top">37</td>
<td align="left" valign="top">CHAR(13)</td>
<td align="left" valign="top">
Creation date and time
</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRPZFNDFD">Field Descriptions</a></h3>
<p><strong>Action pending.</strong> Indicates whether a required action has yet
to be performed to make this PTF active. This field reflects the current status
of any required actions.</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">No required actions are pending for this
PTF.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">A required action needs to occur for this PTF to
be active. Check the Activation Instructions section of the cover letter to
determine what the action is.
<p>If the action required field is 2 and you have performed the activation
instructions, then the PTF is active. However, this field will not be updated
until the next IPL.</p>
</td>
</tr>
</table>
<p><strong>Action required.</strong> An action is required to make this PTF
active when it is applied. See the cover letter to determine what action needs
to be taken. The following values are valid:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">No activation instructions are needed for this
PTF.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">This PTF was shipped with activation instructions
in the cover letter. This value is returned for all PTFs that have an exit
program to update the status of the PTF after the activation instructions have
been performed.</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">This PTF was shipped with activation instructions
in the cover letter. No exit program exists to verify the activation
instructions were performed.</td>
</tr>
</table>
<p><strong>Cover letter status.</strong> Whether a cover letter exists for the
PTF. The following values are valid.</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">The PTF has no cover letter.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The PTF has a cover letter.</td>
</tr>
</table>
<p><strong>Creation date and time.</strong> The date and time that the PTF was created.
This value will be blanks when the creation date and time cannot be determined.
The date and time field is in the CYYMMDDHHMMSS format:</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>C</em></td>
<td align="left" valign="top">Century, where 0 indicates years 19xx and 1
indicates years 20xx.</td>
</tr>
<tr>
<td align="left" valign="top"><em>YY</em></td>
<td align="left" valign="top">Year</td>
</tr>
<tr>
<td align="left" valign="top"><em>MM</em></td>
<td align="left" valign="top">Month</td>
</tr>
<tr>
<td align="left" valign="top"><em>DD</em></td>
<td align="left" valign="top">Day</td>
</tr>
<tr>
<td align="left" valign="top"><em>HH</em></td>
<td align="left" valign="top">Hour</td>
</tr>
<tr>
<td align="left" valign="top"><em>MM</em></td>
<td align="left" valign="top">Minute</td>
</tr>
<tr>
<td align="left" valign="top"><em>SS</em></td>
<td align="left" valign="top">Second</td>
</tr>
</table>
<p><strong>Current IPL source.</strong> The copy of Licensed Internal Code that the
system is currently operating from. The previous IPL of the system used this copy of
Licensed Internal Code.</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>A</em></td>
<td align="left" valign="top">The system is currently operating on the A IPL source.</td>
</tr>
<tr>
<td align="left" valign="top"><em>B</em></td>
<td align="left" valign="top">The system is currently operating on the B IPL source.</td>
</tr>
<tr>
<td align="left" valign="top"><em>Blank</em></td>
<td align="left" valign="top">The current IPL source could not be determined.</td>
</tr>
</table>
<p><img src="delta.gif" alt="Start of change"><strong>Current server IPL source.</strong> The copy of the server firmware that was used on the previous server IPL.<img src="deltaend.gif" alt="End of change"></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 server IPL source because the system is not operating as a service partition.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The server is currently operating on the T server IPL source.</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">The server is currently operating on the P server IPL source.</td>
</tr>
</table>
<p><img src="delta.gif" alt="Start of change"><strong>Server firmware status.</strong> The status of the server firmware that is currently
active.</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 server firmware status information because the system is not operating as a service partition.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The server firmware that is currently active is at the same level as the server firmware portion of the Licensed Internal Code that is installed on the system.</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">A server IPL is required to activate PTFs that have been applied for the server firmware portion of the Licensed Internal Code.</td>
</tr>
<tr>
<td align="left" valign="top"><em>3</em></td>
<td align="left" valign="top">A server IPL is required to activate a new level of the server firmware portion of the Licensed Internal Code that has been installed on the system.</td>
</tr>
<tr>
<td align="left" valign="top"><em>4</em></td>
<td align="left" valign="top">The server firmware that is currently active is at a later level than the server firmware portion of the Licensed Internal Code that is installed on the system. This can occur when PTFs for the server firmware have been permanently removed, but are still currently active. When a server IPL occurs, a lower level of the server firmware may be activated.</td>
</tr>
<tr>
<td align="left" valign="top"><em>5</em></td>
<td align="left" valign="top">The server firmware that is currently active is at a different level than the server firmware portion of the Licensed Internal Code that is installed on the system. The service partition is currently configured to not allow the system to make changes to the server firmware.</td>
</tr>
</table><img src="deltaend.gif" alt="End of change">
<p><strong>IPL action.</strong> The action to be taken on this PTF during the
next unattended IPL. The following values are valid:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">No action occurs at the next IPL.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The PTF is temporarily applied at the next
IPL.</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">The PTF is temporarily removed at the next
IPL.</td>
</tr>
<tr>
<td align="left" valign="top"><em>3</em></td>
<td align="left" valign="top">The PTF is permanently applied at the next
IPL.</td>
</tr>
<tr>
<td align="left" valign="top"><em>4</em></td>
<td align="left" valign="top">The PTF is permanently removed at the next
IPL.</td>
</tr>
</table>
<p><strong>IPL required.</strong> An IPL is required to apply this PTF. The
following values are valid:</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">The PTF is delayed. The PTF must be applied
during an IPL.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The PTF is immediate. No IPL is needed to apply
the PTF.</td>
</tr>
<tr>
<td align="left" valign="top"><em>Blank</em></td>
<td align="left" valign="top">The type of the PTF is not known.</td>
</tr>
</table>
<p><strong>Loaded status.</strong> The current loaded status of the PTF. A PTF
can have any of the following statuses:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">The PTF has never been loaded.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The PTF has been loaded.</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">The PTF has been applied.</td>
</tr>
<tr>
<td align="left" valign="top"><em>3</em></td>
<td align="left" valign="top">The PTF has been applied permanently.</td>
</tr>
<tr>
<td align="left" valign="top"><em>4</em></td>
<td align="left" valign="top">The PTF has been permanently removed.</td>
</tr>
<tr>
<td align="left" valign="top"><em>5</em></td>
<td align="left" valign="top">The PTF is damaged. An error occurred while
applying the PTF. It needs to be reloaded and applied.</td>
</tr>
<tr>
<td align="left" valign="top"><em>6</em></td>
<td align="left" valign="top">The PTF is superseded. A PTF will have a status of
superseded when one of the
following situations occurs:
<ul>
<li>Another PTF with a more recent correction for the problem has been loaded
on the system. The PTF ID that has been loaded can be found in the superseded
by PTF ID field.</li>
<li>The PTF save file for another PTF with a more recent correction for the
problem has been logged into *SERVICE on the system.</li>
</ul>
</td>
</tr>
</table>
<p><strong>Note:</strong> These fields are returned as numbers instead of text
because statuses are translatable text instead of special values. The text
message that contains these values is CPX3501.</p>
<p><strong>Maximum level.</strong> The indicator of the highest level of the
product to which this PTF can be applied. The level can be AA to 99. This field
will be blank if the product does not have a level.</p>
<p><strong>Minimum level.</strong> The indicator or the lowest level of the
product to which this PTF can be applied. The level can be AA to 99. This field
will be blank if the product does not have a level.</p>
<p><strong>On-order status.</strong> Whether the PTF has been ordered. The
following values are valid:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">The PTF has not been ordered or has already been
received.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The PTF has been ordered.</td>
</tr>
</table>
<p><strong>Product load of the PTF.</strong> The load ID of the product load
for the PTF.</p>
<p><strong>Product option of the PTF.</strong> The option of the product to
which the PTF applies.</p>
<p><strong>PTF ID.</strong> The identifier of the PTF.</p>
<p><strong>PTF is released.</strong> Whether the PTF save file is available for
distribution to another system. This is only set to 1 when the System Manager
for iSeries licensed program is on the system and the product is supported. The
user needs to check the PTF save file status before using this field. Possible
values follow:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">The PTF save file cannot be distributed.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The PTF save file is released and can be
distributed to another system.</td>
</tr>
</table>
<p><strong>Release level of the PTF.</strong> The release of the PTF.</p>
<p><strong>Save file status.</strong> Whether a save file exists for the PTF.
This field should always be checked to determine if a save file exists. The
following values are valid.</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">The PTF has no save file.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The PTF has a save file.</td>
</tr>
</table>
<p><strong>Server IPL required.</strong> Indicates whether or not a server IPL must be
performed in order to activate the changes for the PTF. The possible values are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">No server IPL is required to activate the changes for the PTF.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">A server IPL must be performed using the T server IPL source in order to activate the changes for the PTF.</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">A server IPL must be performed using the P server IPL source in order to activate the changes for the PTF.</td>
</tr>
</table>
<p><strong>Status date and time.</strong> The date and time that the PTF status
was last changed. This value will be blank when the status date and time is not
available. The date and time field is in the CYYMMDDHHMMSS format:</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>C</em></td>
<td align="left" valign="top">Century, where 0 indicates years 19xx and 1
indicates years 20xx.</td>
</tr>
<tr>
<td align="left" valign="top"><em>YY</em></td>
<td align="left" valign="top">Year</td>
</tr>
<tr>
<td align="left" valign="top"><em>MM</em></td>
<td align="left" valign="top">Month</td>
</tr>
<tr>
<td align="left" valign="top"><em>DD</em></td>
<td align="left" valign="top">Day</td>
</tr>
<tr>
<td align="left" valign="top"><em>HH</em></td>
<td align="left" valign="top">Hour</td>
</tr>
<tr>
<td align="left" valign="top"><em>MM</em></td>
<td align="left" valign="top">Minute</td>
</tr>
<tr>
<td align="left" valign="top"><em>SS</em></td>
<td align="left" valign="top">Second</td>
</tr>
</table>
<p><strong>Superseded by PTF
ID.</strong> The identifier of the PTF that has replaced this PTF. This field
will be blank when the PTF is not superseded or when the superseding PTF has
not been loaded on the system.</p>
<p><strong>User space library name specified.</strong> The name specified for
the library that contains the user space to receive the generated list.</p>
<p><strong>User space library name used.</strong> The actual name of the
library that is used to contain the user space that received the list.</p>
<p><strong>User space name specified.</strong> The name specified for the user
space that is to receive the generated list.</p>
<p><strong>User space name used.</strong> The actual name of the user space
that received the list.</p>
<br>
<h3>Error Messages</h3>
<table width="100%" 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">CPF24B4 E</td>
<td width="85%" 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">CPF3CF2 E</td>
<td align="left" valign="top">Error(s) occurred during running of &amp;1
API.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C1E E</td>
<td align="left" valign="top">Required parameter &amp;1 omitted.</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">CPF3C39 E</td>
<td align="left" valign="top">Value for reserved field not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C4A E</td>
<td align="left" valign="top">Value not valid for field &amp;1.</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">CPF35BE E</td>
<td align="left" valign="top">Product &amp;1 &amp;3 not supported or
installed.</td>
</tr>
<tr>
<td align="left" valign="top">CPF6601 E</td>
<td align="left" valign="top">No PTF activity exists for product &amp;1.</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">CPF9802 E</td>
<td align="left" valign="top">Not authorized to object &amp;2 in &amp;3.</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">CPF9820 E</td>
<td align="left" valign="top">Not authorized to use library &amp;1.</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>
</table>
<br>
<hr>
API introduced: V4R1
<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>