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

353 lines
13 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>Display APPN Information (DSPAPPNINF)</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="DSPAPPNINF.Top_Of_Page"></a>
<h2>Display APPN Information (DSPAPPNINF)</h2>
<table width="100%">
<tr>
<td valign="top" align="left"><b>Where allowed to run: </b>All environments (*ALL)<br>
<b>Threadsafe: </b>No
</td>
<td valign="top" align="right">
<a href="#DSPAPPNINF.PARAMETERS.TABLE">Parameters</a><br>
<a href="#DSPAPPNINF.COMMAND.EXAMPLES">Examples</a><br>
<a href="#DSPAPPNINF.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="DSPAPPNINF"></a>
<p>The Display APPN Information (DSPAPPNINF) command provides the user with Advanced Peer-to-Peer Networking (APPN) network information which is used to assist in problem analysis. The user specifies one basic type of network information being shown, printed, or stored in an output file: information about the network topology, the local directory, or session information. More information on APPN functions is in found in the APPN Support information in the iSeries Information Center at http://www.iseries.ibm.com/infocenter book.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPAPPNINF.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="DSPAPPNINF.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="#DSPAPPNINF.INFTYPE"><b>INFTYPE</b></a></td>
<td valign="top">Type of information</td>
<td valign="top"><b><u>*TOPOLOGY</u></b>, *LCLNODE, *SSN</td>
<td valign="top">Optional, Positional 1</td>
</tr>
<tr>
<td valign="top"><a href="#DSPAPPNINF.NODES"><b>NODES</b></a></td>
<td valign="top">Nodes</td>
<td valign="top"><b><u>*ALL</u></b>, *ACTIVE, *INACTIVE</td>
<td valign="top">Optional, Positional 2</td>
</tr>
<tr>
<td valign="top"><a href="#DSPAPPNINF.SSNTYPE"><b>SSNTYPE</b></a></td>
<td valign="top">Session type</td>
<td valign="top"><b><u>*ENDPNT</u></b>, *INMSSN</td>
<td valign="top">Optional, Positional 3</td>
</tr>
<tr>
<td valign="top" rowspan="4"><a href="#DSPAPPNINF.JOB"><b>JOB</b></a></td>
<td valign="top">Job name</td>
<td valign="top"><i>Qualified job name</i></td>
<td valign="top" rowspan="4">Optional</td>
</tr>
<tr>
<td valign="top">Qualifier 1: Job name</td>
<td valign="top"><i>Name</i></td>
</tr><tr>
<td valign="top">Qualifier 2: User</td>
<td valign="top"><i>Name</i></td>
</tr><tr>
<td valign="top">Qualifier 3: Number</td>
<td valign="top">000000-999999</td>
</tr><tr>
<td valign="top"><a href="#DSPAPPNINF.CTL"><b>CTL</b></a></td>
<td valign="top">Controller description</td>
<td valign="top"><i>Name</i>, <b><u>*ALL</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#DSPAPPNINF.OUTPUT"><b>OUTPUT</b></a></td>
<td valign="top">Output</td>
<td valign="top"><b><u>*</u></b>, *PRINT, *OUTFILE</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top" rowspan="3"><a href="#DSPAPPNINF.OUTFILE"><b>OUTFILE</b></a></td>
<td valign="top">File to receive output</td>
<td valign="top"><i>Qualified object name</i></td>
<td valign="top" rowspan="3">Optional</td>
</tr>
<tr>
<td valign="top">Qualifier 1: File to receive output</td>
<td valign="top"><i>Name</i></td>
</tr><tr>
<td valign="top">Qualifier 2: Library</td>
<td valign="top"><i>Name</i>, <b><u>*LIBL</u></b>, *CURLIB</td>
</tr><tr>
<td valign="top" rowspan="3"><a href="#DSPAPPNINF.OUTMBR"><b>OUTMBR</b></a></td>
<td valign="top">Output member options</td>
<td valign="top"><i>Element list</i></td>
<td valign="top" rowspan="3">Optional</td>
</tr>
<tr>
<td valign="top">Element 1: Member to receive output</td>
<td valign="top">
<i>Name</i>, <b><u>*FIRST</u></b></td>
</tr>
<tr>
<td valign="top">Element 2: Replace or add records</td>
<td valign="top">
<b><u>*REPLACE</u></b>, *ADD</td>
</tr>
</table>
<table width="100%">
<tr><td align="right"><a href="#DSPAPPNINF.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="DSPAPPNINF.INFTYPE"></a>
<h3>Type of information (INFTYPE)</h3>
<p>Specifies the type of information given.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><u>*TOPOLOGY</u></b></dt>
<dd>The contents of the topology database is shown or printed. The local topology database contains the set of all nodes and their characteristics and, for each node, the set of link destination nodes along with the characteristics of the connecting links.
</dd>
<dt><b>*LCLNODE</b></dt>
<dd>The contents of the local directory is shown or printed. The local directory contains the local node and the names of all remote control points and their locations.
</dd>
<dt><b>*SSN</b></dt>
<dd>The information about intermediate sessions or sessions that have the local node as a session endpoint is shown or printed.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPAPPNINF.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="DSPAPPNINF.NODES"></a>
<h3>Nodes (NODES)</h3>
<p>Specifies the set of nodes that is requested. This parameter is valid only if *TOPOLOGY is specified on the <b>Type of information</b> prompt (INFTYPE parameter).
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><u>*ALL</u></b></dt>
<dd>All nodes in the topology database are shown or printed.
</dd>
<dt><b>*ACTIVE</b></dt>
<dd>Only the active nodes are shown or printed.
</dd>
<dt><b>*INACTIVE</b></dt>
<dd>Only the inactive nodes are shown or printed.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPAPPNINF.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="DSPAPPNINF.SSNTYPE"></a>
<h3>Session type (SSNTYPE)</h3>
<p>Specifies which type of session information is shown. This parameter is valid only when *SSN is specified on the <b>Type of information</b> prompt (INFTYPE parameter).
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><u>*ENDPNT</u></b></dt>
<dd>Information about sessions for which the local node is a session endpoint is shown or printed.
</dd>
<dt><b>*INMSSN</b></dt>
<dd>Information about intermediate sessions being routed through the local node is shown or printed.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPAPPNINF.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="DSPAPPNINF.JOB"></a>
<h3>Job name (JOB)</h3>
<p>Specifies the name of the job for which session information is shown or printed. If * is specified on the <b>Output</b> prompt (OUTPUT parameter) and no job name is specified, a list of APPN job names run since the most recent initial program load (IPL) of the system is displayed. You can select a job name from that list. If *PRINT or *OUTFILE is specified on the <b>Output</b> prompt (OUTPUT parameter) and no job name is specified, the session information for all APPN jobs is printed or stored in a specified output file.
</p>
<p>This parameter is valid only if *ENDPNT is specified on the <b>Session type</b> prompt (SSNTYPE parameter).
</p>
<dl>
<dt><b><i>job-name</i></b></dt>
<dd>Specify the job name for which session information is shown or printed.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPAPPNINF.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="DSPAPPNINF.CTL"></a>
<h3>Controller description (CTL)</h3>
<p>Specifies the controller for which intermediate sessions are requested. This parameter is valid only if *INMSSN is specified on the <b>Session type</b> prompt (SSNTYPE parameter).
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><u>*ALL</u></b></dt>
<dd>The intermediate sessions for all controllers are shown or printed.
</dd>
<dt><b><i>controller-description-name</i></b></dt>
<dd>Specify the name of the controller for which intermediate sessions are shown or printed.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPAPPNINF.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="DSPAPPNINF.OUTPUT"></a>
<h3>Output (OUTPUT)</h3>
<p>Specifies whether the output from the command is displayed at the requesting work station or printed with the job's spooled output.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><u>*</u></b></dt>
<dd>The output is displayed (if requested by an interactive job) or printed with the job's spooled output (if requested by a batch job).
</dd>
</dl>
<dl>
<dt><b>*PRINT</b></dt>
<dd>The output is printed with the job's spooled output.
</dd>
</dl>
<dl>
</dl>
<dl>
<dt><b>*OUTFILE</b></dt>
<dd>The output is directed to the database file specified for the <b>File to receive output (OUTFILE)</b> parameter.
</dd>
</dl>
<dl>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPAPPNINF.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="DSPAPPNINF.OUTFILE"></a>
<h3>File to receive output (OUTFILE)</h3>
<p>Specifies the name and library of the database file to which the output of the command is directed. If the file does not exist, this command creates a database file in the specified library.
</p>
<p>
<b>Note: </b>If a new file is created, the system uses file QAxxxxx in library QSYS with a format name of QLzzzz as a model, depending on the value specified on the <b>Type of information</b> prompt (INFTYPE parameter). The following table lists the possible values for that parameter and the output file and model that correspond to the values.
</p>
<p>
<pre>
Parameter Values Output File Created
OUTFILE FORMAT
*TOPOLOGY QALSTDB QLSTDB
*LCLNODE QALSDIR QLSDIR
*SSN - endpoint session QALSEND QLSEND
*SSN - intermediate session QALSINM QLSINM
</pre>
</p>
<p>The possible library values are:
</p>
<dl>
<dt><b><u>*LIBL</u></b></dt>
<dd>The library list is used to locate the file. If the file is not found, one is created in the current library.
</dd>
<dt><b>*CURLIB</b></dt>
<dd>The current library for the job is used to locate the file. If no library is specified as the current library list for the job, QGPL is used.
</dd>
<dt><b><i>library-name</i></b></dt>
<dd>Specify the name of the library where the file is located.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPAPPNINF.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="DSPAPPNINF.OUTMBR"></a>
<h3>Output member options (OUTMBR)</h3>
<p>Specifies the name of the database file member to which the output is directed when *OUTFILE is specified for the <b>Output (OUTPUT)</b> parameter.
</p>
<p>The possible values for output member options are:
</p>
<dl>
<dt><b><u>*FIRST</u></b></dt>
<dd>The requested APPN information is stored in the first member. If OUTMBR(*FIRST) is specified and the member does not exist, the system creates a member with the name of the file specified in the OUTFILE parameter.
</dd>
<dt><b><i>member-name</i></b></dt>
<dd>Specify the name of the member used to store the requested APPN information. If a member name is specified and the member does not exist, the system creates it. Valid values range from 1 through 10 characters.
</dd>
</dl>
<p>The optional values are:
</p>
<dl>
<dt><b><u>*REPLACE</u></b></dt>
<dd>The system clears the existing member and adds the new records.
</dd>
</dl>
<dl>
<dt><b>*ADD</b></dt>
<dd>The system adds the new records to the end of the existing records.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPAPPNINF.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="DSPAPPNINF.COMMAND.EXAMPLES">Examples</a> </h3>
<p><b>Example 1: Printing a List</b>
</p>
<p>
<pre>
DSPAPPNINF INFTYPE(*TOPOLOGY) NODES(*ALL) OUTPUT(*PRINT)
</pre>
</p>
<p>This command prints the list of all nodes currently existing in the APPN network, the set of links destination nodes associated with each node, and the link characteristics for each link.
</p>
<p><b>Example 2: Showing a List of PCIDs</b>
</p>
<p>
<pre>
DSPAPPNINF INFTYPE(*SSN) SSNTYPE(*ENDPNT)
JOB(APPNJOB/USERPROF/000001) OUTPUT(*)
</pre>
</p>
<p>This command shows a list of procedure correlation session identifiers (PCIDs) associated with the job name APPNJOB/USERPROF/000001. From this list, the user can specify an option to show additional information about a session.
</p>
<p><b>Example 3: Storing Contents of a Directory</b>
</p>
<p>
<pre>
DSPAPPNINF INFTYPE(*LCLNODE) OUTPUT(*OUTFILE)
OUTFILE(USERLIB/APPNFILE) OUTMBR(*FIRST, *REPLACE)
</pre>
</p>
<p>This command stores the contents of the local directory in the first member of an output file named USERLIB/APPNFILE. If information already exists in this member, the new information replaces the existing information.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPAPPNINF.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="DSPAPPNINF.ERROR.MESSAGES">Error messages</a> </h3>
<p>None
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPAPPNINF.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>