258 lines
6.7 KiB
HTML
258 lines
6.7 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>Clear LU6.2 Partners (QTNCLRLU) 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. -->
|
||
|
|
<!-- Change History: -->
|
||
|
|
<!-- YYMMDD USERID Change description -->
|
||
|
|
<!-- QTNCLRLU API created by RANDYJ -->
|
||
|
|
<!-- 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>Clear LU6.2 Partners (QTNCLRLU) API</h2>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<div class="box" style="width: 80%;">
|
||
|
|
<br>
|
||
|
|
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%">Partner LU remote network identifier</td>
|
||
|
|
<td align="left" valign="top" width="20%">Input</td>
|
||
|
|
<td align="left" valign="top" width="20%">Char(8)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top" width="10%">2</td>
|
||
|
|
<td align="left" valign="top" width="50%">Partner LU location name</td>
|
||
|
|
<td align="left" valign="top" width="20%">Input</td>
|
||
|
|
<td align="left" valign="top" width="20%">Char(8)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
Optional Parameter:<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
<table width="100%">
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top" width="10%">3</td>
|
||
|
|
<td align="left" valign="top" width="50%">Error code</td>
|
||
|
|
<td align="left" valign="top" width="20%">I/O</td>
|
||
|
|
<td align="left" valign="top" width="20%">Char(*)</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
Default Public Authority: *USE<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
Threadsafe: No<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<p>The Clear LU6.2 Partners (QTNCLRLU) API clears the specified
|
||
|
|
partner logical unit (LU) from the LU6.2 log on this system.
|
||
|
|
In terms of the LU6.2 Peer Protocols, this is known as forcing a
|
||
|
|
cold start with the partner LU during the next connection attempt.
|
||
|
|
This API can be used to eliminate connection problems after the
|
||
|
|
partner LU is moved to a backup system with the same SNA
|
||
|
|
configuration as the original system.
|
||
|
|
</p>
|
||
|
|
<p>The following informational message is sent to the joblog
|
||
|
|
of the job issuing the API to identify each partner that is cleared:
|
||
|
|
</p>
|
||
|
|
<table cellpadding="5">
|
||
|
|
<tr>
|
||
|
|
<td width="15%" valign="top">CPI83DB</td>
|
||
|
|
<td width="85%" valign="top">Partner LU &1.&2 cleared.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<p>Clearing a partner LU will be rejected if there is an active
|
||
|
|
protected conversation between this system and the partner, or if
|
||
|
|
resynchronization to the partner is pending due to a prior
|
||
|
|
communications or system failure. In such cases, the following
|
||
|
|
diagnostic messages will be sent to the joblog to identify any
|
||
|
|
partners that were not cleared, and the API will return error
|
||
|
|
message CPF83EF.
|
||
|
|
</p>
|
||
|
|
<table cellpadding="5">
|
||
|
|
<tr>
|
||
|
|
<td width="15%" valign="top">CPD83C3</td>
|
||
|
|
<td width="85%" valign="top">Partner LU &1.&2 not cleared due to active connection.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td width="15%" valign="top">CPD83C4</td>
|
||
|
|
<td width="85%" valign="top">Partner LU &1.&2 not cleared due to pending resynchronization.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<h3>Authorities and Locks</h3>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><em>Authority</em></dt>
|
||
|
|
|
||
|
|
<dd>*ALLOBJ special authority is required.<br>
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><em>Locks</em></dt>
|
||
|
|
|
||
|
|
<dd>None.</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
<h3>Required Parameters</h3>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
|
||
|
|
<dt><strong>Partner LU remote network identifier</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; CHAR(8)
|
||
|
|
|
||
|
|
<p>The remote network identifier of the partner that is to be cleared.
|
||
|
|
</p>
|
||
|
|
|
||
|
|
<table width="90%">
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td width="10%" valign="top">
|
||
|
|
<em>*ALL</em>
|
||
|
|
</td>
|
||
|
|
|
||
|
|
<td width="80%" valign="top">All partners with the specified partner LU location name
|
||
|
|
will be reset. All partners known to this system will be cleared if *ALL is specified
|
||
|
|
for both partner LU remote network identifier and partner LU location name.</td>
|
||
|
|
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<dt><strong>Partner LU location name</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; CHAR(8)
|
||
|
|
|
||
|
|
<p>The location name of the partner that is to be cleared.
|
||
|
|
</p>
|
||
|
|
<table width="90%">
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td width="10%" valign="top">
|
||
|
|
<em>*ALL</em>
|
||
|
|
</td>
|
||
|
|
|
||
|
|
<td width="80%" valign="top">All partners with the specified partner LU
|
||
|
|
remote network identifier will be cleared. All partners known to this system will be
|
||
|
|
cleared if *ALL is specified for both partner LU remote network identifier and
|
||
|
|
partner LU location name.</td>
|
||
|
|
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
</table>
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
<h3>Optional Parameter</h3>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<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
|
||
|
|
caller of the API.</p>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
<h3>Usage Notes</h3>
|
||
|
|
|
||
|
|
<p>This API was designed so that it would be easy to use from a CL command line.
|
||
|
|
For example, the following CL command will clear partner APPC.SYSTEM1 from the
|
||
|
|
LU6.2 log:</p>
|
||
|
|
<pre>
|
||
|
|
CALL PGM(QTNCLRLU) PARM(APPC SYSTEM1)
|
||
|
|
</pre>
|
||
|
|
<br>
|
||
|
|
|
||
|
|
<h3>Error Messages</h3>
|
||
|
|
|
||
|
|
<table width="100%" cellpadding="5">
|
||
|
|
<tr>
|
||
|
|
<th align="left" valign="top" nowrap>Message ID</th>
|
||
|
|
<th align="left" valign="top">Error Message Text</th>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td width="15%" valign="top">CPF3CF1 E</td>
|
||
|
|
<td width="85%" valign="top">Error code parameter not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td width="15%" valign="top">CPF83ED E</td>
|
||
|
|
<td width="85%" valign="top">&1 API requires &2 special authority.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td width="15%" valign="top">CPF83EE E</td>
|
||
|
|
<td width="85%" valign="top">Partner LU &1.&2 is not known to this system.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td width="15%" valign="top">CPF83EF E</td>
|
||
|
|
<td width="85%" valign="top">At least one partner LU was not cleared. See previous messages.
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9872 E</td>
|
||
|
|
<td valign="top">Program or service program &1 in library &2 ended.
|
||
|
|
Reason code &3.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<br>
|
||
|
|
<hr>
|
||
|
|
API introduced: V5R3
|
||
|
|
|
||
|
|
<hr>
|
||
|
|
<center>
|
||
|
|
<table cellpadding="2" cellspacing="2">
|
||
|
|
<tr align="center">
|
||
|
|
<td valign="middle" align="center"><a href="#top_Of_Page">Top</a> | <a href=
|
||
|
|
"jc1.htm">Journal and Commit APIs</a> | <a href="aplist.htm">APIs by
|
||
|
|
category</a></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</center>
|
||
|
|
</body>
|
||
|
|
</html>
|
||
|
|
|