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

229 lines
6.0 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>End PM eServer iSeries (Q1PENDPM) 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. -->
<!-- Created by ALF = Alfredo Saras (ALF at IBMMX) -->
<!-- Modified by ROYAN = Royan Bartley 5D10 12196.8 -->
<!-- Modified by ROYAN = Royan Bartley 5D30 3255.2 Changed PM/400 -->
<!-- to PM eServer iSeries -->
<!--File Edited Oct 2001 by v2cdijab -->
<!-- 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>End PM eServer iSeries (Q1PENDPM) API</h2>
<div class="box" style="width: 65%;">
<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%">End type</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">Delay time</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Binary(4)</td>
</tr>
<tr>
<td align="center" valign="top">3</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;Default Public Authority: *EXCLUDE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;Threadsafe: No<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The End PM <img src="eserver.gif" alt="eServer"> iSeries<SUP>(TM)</SUP> (Q1PENDPM) API ends IBM Performance Management
for eServer iSeries jobs. PM eServer iSeries
jobs will not run again until the Start API (Q1PSTRPM) is issued or the product
is configured using the CFGPM400 command.</p>
<br>
<h3>Authorities and Locks</h3>
<dl>
<dt><em>Public Authority</em></dt>
<dd>*EXCLUDE</dd>
<dt><em>Special authorities</em></dt>
<dd>You must have *JOBCTL special authority to use this API.</dd>
</dl>
<br>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>End type</strong></dt>
<dd>Input; Char(10)
<p>The PM <img src="eserver.gif" alt="eServer"> iSeries<SUP>(TM)</SUP>
jobs to have controlled endings or the jobs that
are to be ended immediately. The possible values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*CNTRLD</em></td>
<td align="left" valign="top">The PM eServer iSeries jobs end in a
controlled manner.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*IMMED</em></td>
<td align="left" valign="top">The PM eServer iSeries jobs end
immediately. The programs that are running do not get time to perform cleanup.
This option may cause undesirable results if data has been partially updated.
Therefore, this option should be used only if a controlled end was
unsuccessful.</td>
</tr>
</table>
</dd>
<dt><strong>Delay time</strong></dt>
<dd>Input; Binary(4)
<p>The delay time when "End type" is *CNTRLD. This parameter is ignored if "End
type" is *IMMED. The possible values are:</p>
<table cellpadding="5">
<!-- cols="20 80" -->
<tr>
<td align="left" valign="top"><em>-1</em></td>
<td align="left" valign="top">The PM eServer iSeries jobs continue
processing until the activity processing currently is complete.</td>
</tr>
<tr>
<td align="left" valign="top"><em>Delay&nbsp;time&nbsp;(seconds)</em></td>
<td align="left" valign="top">The PM eServer iSeries jobs end
immediately after the delay time.</td>
</tr>
</table>
</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>. If this
parameter is omitted, diagnostic and escape messages are issued to the
application.</p>
</dd>
</dl>
<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 align="left" valign="top" width="15%">CPFB03A E</td>
<td align="left" valign="top" width="85%">Range of parameter &amp;2 does not
include &amp;4.</td>
</tr>
<tr>
<td align="left" valign="top">CPFB03D E</td>
<td align="left" valign="top">PM eServer iSeries not active.</td>
</tr>
<tr>
<td align="left" valign="top">CPFB03E E</td>
<td align="left" valign="top">PM eServer iSeries already ending
with *IMMED option.</td>
</tr>
<tr>
<td align="left" valign="top">CPFB03F E</td>
<td align="left" valign="top">PM eServer iSeries already ending
with *CNTRLD option.</td>
</tr>
<tr>
<td align="left" valign="top">CPF24B4 E</td>
<td align="left" valign="top">Severe error addressing parameter list.</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">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>
</table>
<br>
<hr>
API introduced: V5R1
<hr>
<center>
<table cellpadding="2" cellspacing="2">
<tr align="center">
<td valign="middle" align="center"><a href="qypscsca.htm">Top</a> | <a href=
"perfmgmt.htm">Performance Management APIs</a> | <a href="aplist.htm">APIs by
category</a></td>
</tr>
</table>
</center>
</body>
</html>