ibm-information-center/dist/eclipse/plugins/i5OS.ic.cl_5.4.0.1/wrkappnsts.htm

274 lines
9.4 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">
<title>Work with APPN Status (WRKAPPNSTS)</title>
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
</head>
<body bgcolor="white">
<script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<a name="WRKAPPNSTS.Top_Of_Page"></a>
<h2>Work with APPN Status (WRKAPPNSTS)</h2>
<table width="100%">
<tr>
<td valign="top" align="left"><b>Where allowed to run: </b>Interactive environments (*INTERACT *IPGM *IREXX *EXEC)<br>
<b>Threadsafe: </b>No
</td>
<td valign="top" align="right">
<a href="#WRKAPPNSTS.PARAMETERS.TABLE">Parameters</a><br>
<a href="#WRKAPPNSTS.COMMAND.EXAMPLES">Examples</a><br>
<a href="#WRKAPPNSTS.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="WRKAPPNSTS"></a>
<p>The Work with APPN Status (WRKAPPNSTS) command allows you to display and work with information about the status of APPN and HPR network sessions, and RTP connections on your local system. The controller (CTL) parameter and either the RMTLOCNAME parameter or the RMTCPNAME parameter (if specified), are used to select the information to display. Note that RMTLOCNAME and RMTCPNAME cannot both be specified.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#WRKAPPNSTS.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="WRKAPPNSTS.PARAMETERS.TABLE">Parameters</a></h3>
<table border="1" cellpadding="4" cellspacing="0">
<!-- col1="10" col2="15" col3="30" col4="10" -->
<tr>
<th bgcolor="aqua" valign="bottom" align="left">Keyword</th>
<th bgcolor="aqua" valign="bottom" align="left">Description</th>
<th bgcolor="aqua" valign="bottom" align="left">Choices</th>
<th bgcolor="aqua" valign="bottom" align="left">Notes</th>
</tr>
<tr>
<td valign="top"><a href="#WRKAPPNSTS.OPTION"><b>OPTION</b></a></td>
<td valign="top">Option</td>
<td valign="top"><b><u>*SELECT</u></b>, *LOC, *RTP</td>
<td valign="top">Optional, Positional 1</td>
</tr>
<tr>
<td valign="top"><a href="#WRKAPPNSTS.CTL"><b>CTL</b></a></td>
<td valign="top">Attached controller</td>
<td valign="top"><i>Generic name, name</i>, <b><u>*ALL</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#WRKAPPNSTS.RMTNETID"><b>RMTNETID</b></a></td>
<td valign="top">Remote network identifier</td>
<td valign="top"><i>Communications name</i>, <b><u>*ALL</u></b>, *NETATR</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#WRKAPPNSTS.RMTLOCNAME"><b>RMTLOCNAME</b></a></td>
<td valign="top">Remote location</td>
<td valign="top"><i>Generic name, name</i>, <b><u>*ALL</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#WRKAPPNSTS.RMTCPNAME"><b>RMTCPNAME</b></a></td>
<td valign="top">Remote control point</td>
<td valign="top"><i>Generic name, name</i>, <b><u>*ALL</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#WRKAPPNSTS.MODE"><b>MODE</b></a></td>
<td valign="top">Mode</td>
<td valign="top"><i>Generic name, name</i>, <b><u>*ALL</u></b>, *NETATR</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#WRKAPPNSTS.TCID"><b>TCID</b></a></td>
<td valign="top">Transport connection ID</td>
<td valign="top"><i>Character value</i>, <b><u>*ALL</u></b></td>
<td valign="top">Optional</td>
</tr>
</table>
<table width="100%">
<tr><td align="right"><a href="#WRKAPPNSTS.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="WRKAPPNSTS.OPTION"></a>
<h3>Option (OPTION)</h3>
<p>Specifies the type of information that you can work with.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><u>*SELECT</u></b></dt>
<dd>A list of options is shown that allows a user to select the information with which to work.
</dd>
<dt><b>*LOC</b></dt>
<dd>The Work with APPN Locations panel is displayed.
</dd>
<dt><b>*RTP</b></dt>
<dd>The Work with RTP Connections panel is displayed.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#WRKAPPNSTS.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="WRKAPPNSTS.CTL"></a>
<h3>Attached controller (CTL)</h3>
<p>Specifies the controller name for which status is shown. Only sessions using the specified controller are listed on the Work with APPN Status display.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><u>*ALL</u></b></dt>
<dd>All controllers with active APPN sessions are shown.
</dd>
<dt><b><i>generic*-controller-name</i></b></dt>
<dd>Specify the generic name of the controller.
</dd>
<dt><b><i>controller-name</i></b></dt>
<dd>Specify the name of the controller.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#WRKAPPNSTS.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="WRKAPPNSTS.RMTNETID"></a>
<h3>Remote network identifier (RMTNETID)</h3>
<p>Specifies the name of the remote network in which the remote control point or remote location reside.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><u>*ALL</u></b></dt>
<dd>All remote locations and all remote control points with active APPN sessions are shown. If *ALL is specified for RMTNETID, then RMTCPNAME and RMTLOCNAME must be *ALL.
</dd>
<dt><b>*NETATR</b></dt>
<dd>The LCLNETID value specified in the system network attributes is used.
</dd>
<dt><b><i>remote-network-identifier</i></b></dt>
<dd>Specify the remote network identifier.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#WRKAPPNSTS.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="WRKAPPNSTS.RMTLOCNAME"></a>
<h3>Remote control point (RMTLOCNAME)</h3>
<p>Specifies the remote location name of active APPN sessions for which status is shown. Only sessions with the specified remote location name are listed on the Work with APPN Status display.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><u>*ALL</u></b></dt>
<dd>All remote locations with active APPN sessions are shown.
</dd>
<dt><b><i>generic*-remote-location-name</i></b></dt>
<dd>Specify the generic name of the remote location.
</dd>
<dt><b><i>remote-location-name</i></b></dt>
<dd>Specify the full name of a remote location.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#WRKAPPNSTS.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="WRKAPPNSTS.RMTCPNAME"></a>
<h3>Remote control point (RMTCPNAME)</h3>
<p>Specifies the remote control point name of active APPN sessions for which status is shown. Only sessions with the specified remote control point name are listed on the Work with APPN Status display.
</p>
<p>For the OPTION(*RTP) view, RMTCPNAME is used to specify the control point name for the RTP connection partner. For the OPTION(*LOC) view, RMTCPNAME is used to specify the control point name for the attached controller.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><u>*ALL</u></b></dt>
<dd>All remote control points with active APPN sessions are shown.
</dd>
<dt><b><i>generic*-remote-control-point-name</i></b></dt>
<dd>Specify the generic name of the remote control point.
</dd>
<dt><b><i>remote-control-point-name</i></b></dt>
<dd>Specify the full name of a remote control point.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#WRKAPPNSTS.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="WRKAPPNSTS.MODE"></a>
<h3>Mode (MODE)</h3>
<p>Specifies the name of the mode by which to subset all list entries.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><u>*ALL</u></b></dt>
<dd>All active sessions are shown.
</dd>
<dt><b>*NETATR</b></dt>
<dd>The DFTMODE value specified in the system network attributes is used.
</dd>
<dt><b><i>generic*-mode-point-name</i></b></dt>
<dd>Specify the generic name of the mode.
</dd>
<dt><b><i>mode-name</i></b></dt>
<dd>Specify the full name of a mode.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#WRKAPPNSTS.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="WRKAPPNSTS.TCID"></a>
<h3>Transport connection ID (TCID)</h3>
<p>Specifies the transport connection identifier (TCID) of an RTP connection. Only sessions running over an RTP connection with the specified TCID are listed on the Work with Sessions for RTP Connections panel. This parameter is valid only when OPTION(*RTP) is specified.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><u>*ALL</u></b></dt>
<dd>All TCIDs with active sessions are shown.
</dd>
<dt><b><i>transport-connection-identifier</i></b></dt>
<dd>Specify the TCID to be shown. When the TCID parameter is not equal to *ALL, both the CTL and RMTCPNAME parameters must be *ALL
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#WRKAPPNSTS.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="WRKAPPNSTS.COMMAND.EXAMPLES">Examples</a> </h3>
<p><b>Example 1: Working with RTP Connections</b>
</p>
<p>
<pre>
WRKAPPNSTS OPTION(*RTP) TCID(*ALL)
</pre>
</p>
<p>This command enables the user to display all active RTP connections.
</p>
<p><b>Example 2: Working with APPN Locations</b>
</p>
<p>
<pre>
WRKAPPNSTS OPTION(*LOC) RMTNETID(ROCV) RMTCPNAME(ROCAS*)
</pre>
</p>
<p>For the specified remote control point name, this command allows the user to display all APPN location pairs that have active APPN sessions.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#WRKAPPNSTS.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="WRKAPPNSTS.ERROR.MESSAGES">Error messages</a> </h3>
<p>None
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#WRKAPPNSTS.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>