friedkiwi/ibm-information-center
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
0332907f0f
ibm-information-center/dist/eclipse/plugins/i5OS.ic.apis_5.4.0.1/QNMRGTI.htm

2111 lines
65 KiB
HTML
Raw Normal View History

Add readme and dist folders
2024-04-02 14:02:31 +00:00
<!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>Register APPN Topology Information (QNMRGTI) 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. -->
<!-- NETMG2 SCRIPT A converted by B2H R4.1 (346) (CMS) by HOLTJM at -->
<!-- RCHVMW2 on 29 Jan 1999 at 10:01:37 -->
<!-- Change History: -->
<!-- YYMMDD USERID Change description -->
<!--File Edited December 2001 -->
<!-- This file has undergone html cleanup July 2002 by JET -->
<!--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>Register APPN Topology Information (QNMRGTI) API</h2>
<div class="box" style="width: 75%;">
<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%">Queue handle</td>
<td align="left" valign="top" width="20%">Output</td>
<td align="left" valign="top" width="20%">Binary(4)</td>
</tr>
<tr>
<td align="center" valign="top">2</td>
<td align="left" valign="top">Options</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Array of Char(10)</td>
</tr>
<tr>
<td align="center" valign="top">3</td>
<td align="left" valign="top">Number of options</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Binary(4)</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="left" valign="top">Format</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(8)</td>
</tr>
<tr>
<td align="center" valign="top">5</td>
<td align="left" valign="top">Qualified user space name</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(20)</td>
</tr>
<tr>
<td align="center" valign="top">6</td>
<td align="left" valign="top">Qualified queue name</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(20)</td>
</tr>
<tr>
<td align="center" valign="top">7</td>
<td align="left" valign="top">Queue type</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(10)</td>
</tr>
<tr>
<td align="center" valign="top">8</td>
<td align="left" valign="top">Replace registration</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(10)</td>
</tr>
<tr>
<td align="center" valign="top">9</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;Default Public Authority: *USE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: No<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The Register APPN Topology Information (QNMRGTI) API causes the requested
APPN topology information to be reported. The application calling this API may
request the current copy of the entire database (to be reported to the
specified user space), or may register for information about particular types
of ongoing updates to the topology (to be reported to the registered queue), or
both.</p>
<p>A queue handle is returned by this program when a queue is successfully
registered for topology updates. The queue handle identifies a registered
queue, and must be used when the Deregister APPN Topology Information
(QNMDRGTI) API is called. The queue handle is unique to a specific job.</p>
<p>When a queue is registered for ongoing topology updates, the specified types
of updates for which the queue is registered will be asynchronously enqueued on
an ongoing basis. If current topology is also requested on the application
calling this API, the current topology is reported to the user space before
topology updates are reported to the registered queue.</p>
<p>The QNMRGTI API may be called to request the current topology only (without
updates), updates only (without current topology), or both current topology and
updates. This is determined by the options specified in the options
parameter.</p>
<p>If an application program calling the API requests current topology, and the
complete topology data cannot be returned in the user space, an error is
returned. In this situation, the user space header contains a P in the
information status field indicating partial but accurate data. Even if a user
space error such as this occurs, any queue registered on the API call will
remain registered.</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>Queue Authority</em></dt>
<dd>*CHANGE<br>
<br>
</dd>
<dt><em>Queue Library Authority</em></dt>
<dd>*USE<br>
<br>
</dd>
<dt><em>User Space Lock</em></dt>
<dd>*EXCLRD</dd>
</dl>
<br>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>Queue handle</strong></dt>
<dd>OUTPUT; BINARY(4)
<p>A variable that uniquely identifies the registered queue within the job.
This value is returned when a queue is registered. When the *CURRENT value is
the only option specified in the options parameter, 0 is returned.</p>
</dd>
<dt><strong>Options</strong></dt>
<dd>INPUT; Array OF CHAR(10)
<p>An array structure containing options specifying the topology information to
be reported. These options only apply to topology updates. All deletions are
reported regardless of the type of updating information you want.</p>
<p>One or more of the following values must be specified:</p>
<table cellpadding="3">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*CURRENT</em></td>
<td valign="top">Report the current copy of the entire topology database.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*LOCALEN</em></td>
<td valign="top">Register for local topology updates pertaining to adjacent end
nodes. Local topology consists of the local node, adjacent nodes, and links to
adjacent nodes. See <a href="#HDRLCLUPD">Local and Network Topology Updates</a>
for more details.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*LOCALNN</em></td>
<td valign="top">Register for local topology updates pertaining to adjacent
network nodes. This option must be used if updates pertaining to adjacent
network nodes in a disconnected subnetwork, such as network nodes having a
different network ID, are required.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*LOCALVN</em></td>
<td valign="top">Register for local topology updates pertaining to adjacent
virtual nodes. An APPN virtual node represents a connection network (for
example, an attached token-ring network). For more information, see the book <a
href="../ddm/rbae5kickoff.htm">Distributed Data Management</a>.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*NETNN</em></td>
<td valign="top">Register for network topology updates pertaining to network
nodes.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*NETVN</em></td>
<td valign="top">Register for network topology updates pertaining to virtual
nodes.</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Number of options</strong></dt>
<dd>INPUT; BINARY(4)
<p>The number of options specified in the options parameter. Valid values are 1
through 6.</p>
</dd>
<dt><strong>Format</strong></dt>
<dd>INPUT; CHAR(8)
<p>The content and format of the topology information reported. The valid
values are:</p>
<table cellpadding="3">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>APPN0100</em></td>
<td valign="top">The basic APPN topology information format. See <a href=
"#HDRMRGFMT">APPN0100 Format</a> for a description of this format.</td>
</tr>
<tr>
<td valign="top"><em>APPN0200</em></td>
<td valign="top">The basic APPN topology information format. See <a href=
"#HDRMRG2FMT">APPN0200 Format</a> for a description of this format.</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Qualified user space name</strong></dt>
<dd>INPUT; CHAR(20)
<p>The user space that is to receive current topology information. This
parameter is ignored when the *CURRENT value is not specified on the options
parameter. The first 10 characters specify the user space name, and the last 10
characters specify the library name.</p>
<p>The following special values are supported for the library name:</p>
<table cellpadding="3">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*LIBL</em></td>
<td valign="top">The library list.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*CURLIB</em></td>
<td valign="top">The job's current library.</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Qualified queue name</strong></dt>
<dd>INPUT; CHAR(20)
<p>The queue that is to receive requested topology information. This parameter
is ignored when the *CURRENT value is the only option specified on the options
parameter. The first 10 characters specify the queue object name, and the last
10 characters specify the library name.</p>
<p>The following special values are supported for the library name:</p>
<table cellpadding="3">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*LIBL</em></td>
<td valign="top">The library list.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*CURLIB</em></td>
<td valign="top">he job's current library.</td>
</tr>
</table>
<p>When special values are used for the library name, the actual name will be
substituted when the API is called. The actual name will be used in future
references to the object when topology updates are enqueued.</p>
<p>The following considerations apply to the queue specified on the API
call:</p>
<ul>
<li>The queue object must exist when this API is called.<br>
<br>
</li>
<li>There is no restriction that prevents applications in separate jobs from
registering the same queue object. Therefore, each application should ensure it
registers a unique queue to prevent duplicate topology updates from being
reported to the same queue. For example, specifying a queue in library QTEMP
ensures the queue is not being used by other jobs on the system.<br>
<br>
</li>
<li>The maximum entry length of the queue must be at least 128 bytes.<br>
<br>
</li>
<li>The sequence of the queue must be *FIFO.<br>
<br>
</li>
<li>A data queue defined with FORCE(*YES) is allowed, but is discouraged due to
degraded performance.<br>
<br>
</li>
<li>A data queue defined with SENDERID is allowed, but the application is
responsible for ensuring sufficient record length to handle the additional data
on queue elements.</li>
</ul>
<br>
</dd>
<dt><strong>Queue type</strong></dt>
<dd>INPUT; CHAR(10)
<p>The type of queue object. This parameter is ignored when *CURRENT is the
only value specified on the options parameter.</p>
<p>Otherwise, one of the following values must be specified:</p>
<table cellpadding="3">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*DTAQ</em></td>
<td valign="top">Data queue</td>
</tr>
<tr>
<td align="left" valign="top"><em>*USRQ</em></td>
<td valign="top">User queue</td>
</tr>
<tr>
<td align="left" valign="top"><em>Replace registration</em></td>
<td valign="top">&nbsp;</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Replacement Registration</strong></dt>
<dd>INPUT; CHAR(10)
<p>Whether this registration should replace a previous registration that has
the same qualified queue name and type. This parameter is ignored when *CURRENT
is the only value specified on the options parameter.</p>
<table cellpadding="3">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>*YES</em></td>
<td valign="top">This registration replaces any previous registration with the
same qualified queue name and type. The options specified on this registration
replace options from any previous registration.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*NO</em></td>
<td valign="top">This registration does not replace any existing registration
with the same qualified queue name and type. The existing registration is not
changed.</td>
</tr>
</table>
<br>
</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>.</p>
</dd>
</dl>
<br>
<h3><a name="HDRTUSFMT">Format of the Generated List</a></h3>
<p>The user space is used to report current topology information and consists
of:</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</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 other items, see the
following sections. For a detailed description of each field in the information
returned, see <a href="#HDRMRGTDF">Field Descriptions</a>.</p>
<p><strong>Input Parameter Section</strong></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(10)</td>
<td align="left" valign="top" width="60%">User space name specified</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">10</td>
<td align="center" valign="top" width="10%">A</td>
<td align="left" valign="top" width="20%">CHAR(10)</td>
<td align="left" valign="top" width="60%">User space library name
specified</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">20</td>
<td align="center" valign="top" width="10%">14</td>
<td align="left" valign="top" width="20%">CHAR(8)</td>
<td align="left" valign="top" width="60%">Format name specified</td>
</tr>
</table>
<p><strong>Header Section</strong></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(10)</td>
<td align="left" valign="top" width="60%">User space name used</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">10</td>
<td align="center" valign="top" width="10%">A</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" width="10%">20</td>
<td align="center" valign="top" width="10%">14</td>
<td align="left" valign="top" width="20%">BINARY(4)</td>
<td align="left" valign="top" width="60%">Number of nodes reported</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">24</td>
<td align="center" valign="top" width="10%">18</td>
<td align="left" valign="top" width="20%">CHAR(8)</td>
<td align="left" valign="top" width="60%">Timestamp of list data</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">32</td>
<td align="center" valign="top" width="10%">20</td>
<td align="left" valign="top" width="20%">CHAR(8)</td>
<td align="left" valign="top" width="60%">Timestamp when local node
initialized</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">40</td>
<td align="center" valign="top" width="10%">28</td>
<td align="left" valign="top" width="20%">BINARY(4)</td>
<td align="left" valign="top" width="60%">Number of end nodes reported</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">44</td>
<td align="center" valign="top" width="10%">2C</td>
<td align="left" valign="top" width="20%">BINARY(4)</td>
<td align="left" valign="top" width="60%">Number of transmission groups
reported for all end nodes</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">48</td>
<td align="center" valign="top" width="10%">30</td>
<td align="left" valign="top" width="20%">BINARY(4)</td>
<td align="left" valign="top" width="60%">Number of transmission groups
reported for all network and virtual nodes</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">52</td>
<td align="center" valign="top" width="10%">34</td>
<td align="left" valign="top" width="20%">CHAR(8)</td>
<td align="left" valign="top" width="60%">Local node network ID</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">60</td>
<td align="center" valign="top" width="10%">3C</td>
<td align="left" valign="top" width="20%">CHAR(8)</td>
<td align="left" valign="top" width="60%">Local node control point name</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">68</td>
<td align="center" valign="top" width="10%">44</td>
<td align="left" valign="top" width="20%">BINARY(4)</td>
<td align="left" valign="top" width="60%">Local topology database flow
reduction sequence number</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">72</td>
<td align="center" valign="top" width="10%">48</td>
<td align="left" valign="top" width="20%">CHAR(3)</td>
<td align="left" valign="top" width="60%">Local node type</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">75</td>
<td align="center" valign="top" width="10%">4B</td>
<td align="left" valign="top" width="20%">CHAR(1)</td>
<td align="left" valign="top" width="60%">Reserved</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">76</td>
<td align="center" valign="top" width="10%">4C</td>
<td align="left" valign="top" width="20%">BINARY(4)</td>
<td align="left" valign="top" width="60%">Local node type enumeration</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">80</td>
<td align="center" valign="top" width="10%">50</td>
<td align="left" valign="top" width="20%">BINARY(2)</td>
<td align="left" valign="top" width="60%">Length of local node
network-qualified control point name</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">82</td>
<td align="center" valign="top" width="10%">52</td>
<td align="left" valign="top" width="20%">CHAR(17)</td>
<td align="left" valign="top" width="60%">Local node network-qualified control
point name</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">99</td>
<td align="center" valign="top" width="10%">63</td>
<td align="left" valign="top" width="20%">CHAR(1)</td>
<td align="left" valign="top" width="60%">Reserved</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">100</td>
<td align="center" valign="top" width="10%">64</td>
<td align="left" valign="top" width="20%">BINARY(4)</td>
<td align="left" valign="top" width="60%">Number of nodes deleted since local
node initialized</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">104</td>
<td align="center" valign="top" width="10%">68</td>
<td align="left" valign="top" width="20%">BINARY(4)</td>
<td align="left" valign="top" width="60%">Number of transmission groups deleted
since local node initialized</td>
</tr>
</table>
<p><strong><a name="HDRMRGFMT">APPN0100 Format</a></strong></p>
<p>The format of topology entry data is the same for queue entries reported on
the registered queue for topology updates and deletions as for list entries
reported to the user space for the current topology.</p>
<p>For topology entries reported to the user space, the entry ID field contains
the value that indicates a current topology entry.</p>
<p>For topology entries reported to the registered queue, the entry ID field
contains a value that identifies the type of notification reported:</p>
<ul>
<li>Topology entry updated</li>
<li>Topology entry deleted</li>
<li>Topology database deleted</li>
</ul>
<p>The format of the topology entry is described below. See <a href=
"#HDRMRGTDF">Field Descriptions</a> for descriptions of the fields in this
format.</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(10)</td>
<td align="left" valign="top" width="60%">Entry type</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">10</td>
<td align="center" valign="top" width="10%">A</td>
<td align="left" valign="top" width="20%">CHAR(2)</td>
<td align="left" valign="top" width="60%">Entry ID</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">12</td>
<td align="center" valign="top" width="10%">C</td>
<td align="left" valign="top" width="20%">CHAR(8)</td>
<td align="left" valign="top" width="60%">Timestamp</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">20</td>
<td align="center" valign="top" width="10%">14</td>
<td align="left" valign="top" width="20%">CHAR(8)</td>
<td align="left" valign="top" width="60%">Node network ID</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">28</td>
<td align="center" valign="top" width="10%">1C</td>
<td align="left" valign="top" width="20%">CHAR(8)</td>
<td align="left" valign="top" width="60%">Node control point name</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">36</td>
<td align="center" valign="top" width="10%">24</td>
<td align="left" valign="top" width="20%">BINARY(4)</td>
<td align="left" valign="top" width="60%">Number of associated transmission
group entries</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">40</td>
<td align="center" valign="top" width="10%">28</td>
<td align="left" valign="top" width="20%">CHAR(1)</td>
<td align="left" valign="top" width="60%">Node data valid indicator</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">41</td>
<td align="center" valign="top" width="10%">29</td>
<td align="left" valign="top" width="20%">CHAR(3)</td>
<td align="left" valign="top" width="60%">Node type</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">44</td>
<td align="center" valign="top" width="10%">2C</td>
<td align="left" valign="top" width="20%">CHAR(8)</td>
<td align="left" valign="top" width="60%">Node attributes</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">52</td>
<td align="center" valign="top" width="10%">34</td>
<td align="left" valign="top" width="20%">CHAR(8)</td>
<td align="left" valign="top" width="60%">Transmission group destination
network ID</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">60</td>
<td align="center" valign="top" width="10%">3C</td>
<td align="left" valign="top" width="20%">CHAR(8)</td>
<td align="left" valign="top" width="60%">Transmission group destination
control point name</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">68</td>
<td align="center" valign="top" width="10%">44</td>
<td align="left" valign="top" width="20%">BINARY(4)</td>
<td align="left" valign="top" width="60%">Transmission group number</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">72</td>
<td align="center" valign="top" width="10%">48</td>
<td align="left" valign="top" width="20%">CHAR(20)</td>
<td align="left" valign="top" width="60%">Transmission group
characteristics</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">92</td>
<td align="center" valign="top" width="10%">5C</td>
<td align="left" valign="top" width="20%">BINARY(4)</td>
<td align="left" valign="top" width="60%">Length of DLC signaling
information</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">96</td>
<td align="center" valign="top" width="10%">60</td>
<td align="left" valign="top" width="20%">CHAR(16)</td>
<td align="left" valign="top" width="60%">DLC signaling information</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">112</td>
<td align="center" valign="top" width="10%">70</td>
<td align="left" valign="top" width="20%">CHAR(10)</td>
<td align="left" valign="top" width="60%">Controller description object
name</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">122</td>
<td align="center" valign="top" width="10%">7A</td>
<td align="left" valign="top" width="20%">CHAR(1)</td>
<td align="left" valign="top" width="60%">Transmission group flags</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">123</td>
<td align="center" valign="top" width="10%">7B</td>
<td align="left" valign="top" width="20%">CHAR(5)</td>
<td align="left" valign="top" width="60%">Reserved</td>
</tr>
</table>
<p><strong><a name="HDRMRG2FMT">APPN0200 Format</a></strong></p>
<p>See <a href="#HDRMRGTDF">Field Descriptions</a> for descriptions of the
fields in this format.</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(10)</td>
<td align="left" valign="top" width="60%">Entry type</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">10</td>
<td align="center" valign="top" width="10%">A</td>
<td align="left" valign="top" width="20%">CHAR(2)</td>
<td align="left" valign="top" width="60%">Entry ID</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">12</td>
<td align="center" valign="top" width="10%">C</td>
<td align="left" valign="top" width="20%">BINARY(4)</td>
<td align="left" valign="top" width="60%">Node entry time left</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">16</td>
<td align="center" valign="top" width="10%">10</td>
<td align="left" valign="top" width="20%">BINARY(4)</td>
<td align="left" valign="top" width="60%">Node flow reduction sequence
number</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">20</td>
<td align="center" valign="top" width="10%">14</td>
<td align="left" valign="top" width="20%">BINARY(2)</td>
<td align="left" valign="top" width="60%">Length of node network-qualified
name</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">22</td>
<td align="center" valign="top" width="10%">16</td>
<td align="left" valign="top" width="20%">CHAR(17)</td>
<td align="left" valign="top" width="60%">Node network-qualified control point
name</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">39</td>
<td align="center" valign="top" width="10%">27</td>
<td align="left" valign="top" width="20%">CHAR(1)</td>
<td align="left" valign="top" width="60%">Reserved</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">40</td>
<td align="center" valign="top" width="10%">28</td>
<td align="left" valign="top" width="20%">BINARY(4)</td>
<td align="left" valign="top" width="60%">Node type enumeration</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">44</td>
<td align="center" valign="top" width="10%">2C</td>
<td align="left" valign="top" width="20%">CHAR(8)</td>
<td align="left" valign="top" width="60%">Node attributes</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">52</td>
<td align="center" valign="top" width="10%">34</td>
<td align="left" valign="top" width="20%">BINARY(4)</td>
<td align="left" valign="top" width="60%">Number of associated transmission
group entries</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">56</td>
<td align="center" valign="top" width="10%">38</td>
<td align="left" valign="top" width="20%">CHAR(4)</td>
<td align="left" valign="top" width="60%">Transmission group number</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">60</td>
<td align="center" valign="top" width="10%">3C</td>
<td align="left" valign="top" width="20%">BINARY(2)</td>
<td align="left" valign="top" width="60%">Length of transmission group
destination network-qualified name</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">62</td>
<td align="center" valign="top" width="10%">3E</td>
<td align="left" valign="top" width="20%">CHAR(17)</td>
<td align="left" valign="top" width="60%">Transmission group destination
network-qualified control point name</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">79</td>
<td align="center" valign="top" width="10%">4F</td>
<td align="left" valign="top" width="20%">CHAR(1)</td>
<td align="left" valign="top" width="60%">Transmission group flags</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">80</td>
<td align="center" valign="top" width="10%">50</td>
<td align="left" valign="top" width="20%">CHAR(20)</td>
<td align="left" valign="top" width="60%">Transmission group
characteristics</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">100</td>
<td align="center" valign="top" width="10%">64</td>
<td align="left" valign="top" width="20%">BINARY(4)</td>
<td align="left" valign="top" width="60%">Transmission group entry time
left</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">104</td>
<td align="center" valign="top" width="10%">68</td>
<td align="left" valign="top" width="20%">BINARY(4)</td>
<td align="left" valign="top" width="60%">Transmission group flow reduction
sequence number</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">108</td>
<td align="center" valign="top" width="10%">6C</td>
<td align="left" valign="top" width="20%">BINARY(2)</td>
<td align="left" valign="top" width="60%">Length of DLC signaling
information</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">110</td>
<td align="center" valign="top" width="10%">6E</td>
<td align="left" valign="top" width="20%">CHAR(8)</td>
<td align="left" valign="top" width="60%">DLC signaling information</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">118</td>
<td align="center" valign="top" width="10%">76</td>
<td align="left" valign="top" width="20%">CHAR(10)</td>
<td align="left" valign="top" width="60%">Controller description object
name</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRMRGTDF">Field Descriptions</a></h3>
<p><strong>Controller description object name.</strong> The name of the
controller description object for the transmission group. This field is valid
only when the number of associated transmission group entries field is not
zero. The object name is only available for transmission group entries
associated with the local node, and only when the object currently exists on
the local system. When the object name is not available, this field contains
blanks.</p>
<p><strong>DLC signaling information.</strong> The data link control (DLC)
signaling information related to the link connection network. For token ring,
the first 6 bytes is the MAC address, and the seventh byte is the link layer
service access point address. This field is valid only when the number of
associated transmission group entries field is not zero.</p>
<p><strong>Entry ID.</strong> The type of topology information. The possible
values are listed below. Value 00 is always used in topology entries reported
to only the user space.</p>
<p>The other three values are used for topology entries reported to the
registered queue.</p>
<table cellpadding="3">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>00</em></td>
<td valign="top">The entry reported is present in the current APPN topology
database.</td>
</tr>
<tr>
<td align="left" valign="top"><em>01</em></td>
<td valign="top">The entry reported was updated in the APPN topology
database.</td>
</tr>
<tr>
<td align="left" valign="top"><em>02</em></td>
<td valign="top">The entry reported was deleted from the APPN topology
database. APPN performs cleanup of the APPN topology database once every 24
hours. This cleanup may cause multiple entries to be removed from the APPN
topology database.</td>
</tr>
<tr>
<td align="left" valign="top"><em>03</em></td>
<td valign="top">The current APPN topology database was deleted and
reinitialized with the node entry for the local system. The node entry for the
local system is reported on the entry. Any additions to the newly initialized
topology database will follow in subsequent queue entries. This indication may
be reported, for example, when the node type parameter changes as a result of
the Change Network Attributes (CHGNETA) command, causing the APPN topology
database to be deleted.</td>
</tr>
</table>
<p><strong>Entry type.</strong> The type of queue entry.</p>
<p>This field can contain the following special value:</p>
<table cellpadding="3">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*APPNTOP</em></td>
<td valign="top">The entry contains APPN topology information.</td>
</tr>
</table>
<p><strong>Format name specified.</strong> The format name specified to the
API.</p>
<p><strong>Length of DLC signaling information.</strong> The length of the data
link control (DLC) signaling information. This field is valid only when the
number of associated transmission group entries field is not zero. The value is
7 for token ring (only DLC currently allowed), or 0 when there is no DLC
signaling information available.</p>
<p><strong>Length of local node network-qualified control point name.</strong>
The length of the node network-qualified control point name. Valid range is
3-17.</p>
<p><strong>Length of node network-qualified name.</strong> The length of the
node network-qualified name.</p>
<p><strong>Length of transmission group destination network-qualified
name.</strong> The length of the transmission group destination
network-qualified control point name. When the number of associated
transmission group entries is zero, this value is zero. When the number of
associated transmission group entries is not zero, valid values range from 3
through 17.</p>
<p><strong>Local node control point name.</strong> The control point name for
the local node.</p>
<p><strong>Local node network ID.</strong> The network ID for the local
node.</p>
<p><strong>Local node network-qualified control point name.</strong> The
network-qualified control point name for the local node, in the format <samp>
NETID.CPNAME</samp>.</p>
<p><strong>Local node type.</strong> The APPN node type of the local node. The
valid values are:</p>
<table cellpadding="3">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>*EN</em></td>
<td valign="top">APPN end node</td>
</tr>
<tr>
<td align="left" valign="top"><em>*NN</em></td>
<td valign="top">APPN network node</td>
</tr>
<tr>
<td align="left" valign="top"><em>*VN</em></td>
<td valign="top">APPN virtual node</td>
</tr>
</table>
<p><strong>Local node type enumeration.</strong> A number representing the APPN
node type of the node. The valid values are:</p>
<table cellpadding="3">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td valign="top">Node data not valid (this may occur when an entry only
contains transmission groups owned by this node).</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td valign="top">APPN network node</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td valign="top">APPN end node</td>
</tr>
<tr>
<td align="left" valign="top"><em>3</em></td>
<td valign="top">APPN virtual node</td>
</tr>
</table>
<p><strong>Local topology database flow reduction sequence number.</strong> The
flow reduction sequence number (FRSN) incremented each time the local network
node sends a topology database update. This field is valid only when the local
node type is a network node.</p>
<p><strong>Node attributes.</strong> The attributes of the node. See <a href=
"#HDRNATD">Format of Node Attributes Field</a> for the structure. For format
APPN0100, the data in this field is valid only when the node data valid
indicator field is Y. For format APPN0200, the data in this field is valid only
when the node type enumeration is not 0.</p>
<p><strong>Node control point name.</strong> The control point name for the
node.</p>
<p><strong>Node data valid indicator.</strong> Whether values contained in the
format APPN0100 node type and attributes fields are valid. The valid values
are:</p>
<table cellpadding="3">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>Y</em></td>
<td valign="top">The values contained in the node type and the node attributes
fields are valid.</td>
</tr>
<tr>
<td align="left" valign="top"><em>N</em></td>
<td valign="top">The values contained in the node type and the node attributes
fields are not valid. This may occur when an entry only contains associated
transmission groups owned by this node.</td>
</tr>
</table>
<p><strong>Node entry time left.</strong> The number of days left before the
node entry is deleted from the topology database. This field in the APPN0200
format is valid only when the node type enumeration is not 0.</p>
<p><strong>Node flow reduction sequence number.</strong> The flow reduction
sequence number (FRSN) for the node. This field in the APPN0200 format is valid
only when the local node is a network node and the node type enumeration is 1
or 3 (the node is a network node or virtual node).</p>
<blockquote>
<p>Node and transmission group FRSN numbers are not broadcast on topology data
updates (TDUs) and not duplicated on every network node in the network. Each
network node keeps its own node and transmission group FRSN for each node and
transmission group in the topology database. FRSNs are used to minimize TDU
exchanges with adjacent network nodes.</p>
</blockquote>
<p><strong>Node network ID.</strong> The network ID for the node.</p>
<p><strong>Node network-qualified control point name.</strong> The
network-qualified control point name for the node, in the format <samp>
NETID.CPNAME</samp>.</p>
<p><strong>Node type.</strong> The APPN node type of the node. This field in
the APPN0100 format contains blanks when the node data valid indicator field is
N. The valid values are:</p>
<table cellpadding="3">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>*EN</em></td>
<td valign="top">APPN end node</td>
</tr>
<tr>
<td align="left" valign="top"><em>*NN</em></td>
<td valign="top">APPN network node</td>
</tr>
<tr>
<td align="left" valign="top"><em>*VN</em></td>
<td valign="top">APPN virtual node</td>
</tr>
</table>
<p>There is no distinction made between APPN end nodes and low-entry networking
(LEN) nodes. Any node defined as a LEN node is reported as *EN.</p>
<p><strong>Node type enumeration.</strong> A number representing the APPN node
type of the node. This field is used only for format APPN0200. The valid values
are:</p>
<table cellpadding="3">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td valign="top">Node Data not valid (this may occur when an entry only
contains transmission groups owned by this node).</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td valign="top">APPN network node</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td valign="top">APPN end node</td>
</tr>
<tr>
<td align="left" valign="top"><em>3</em></td>
<td valign="top">APPN virtual node</td>
</tr>
</table>
<p><strong>Number of associated transmission group entries.</strong> The number
of transmission group (TG) entries reported for a node. When this value is not
zero, the specified number of associated transmission groups are reported for
the node. The first associated transmission group entry is reported on the same
entry as the initial node entry, and any additional transmission groups are
reported on subsequent entries.</p>
<p><strong>Number of end nodes reported.</strong> The total number of end nodes
returned in the list (end node entries containing valid node data).</p>
<p><strong>Number of nodes deleted since local node initialized.</strong> The
number of node entries deleted from the topology database since the local node
was initialized.</p>
<p><strong>Number of nodes reported.</strong> The total number of node entries
returned in the list (entries containing valid node data).</p>
<p><strong>Number of transmission groups deleted since local node
initialized.</strong> The number of transmission group entries deleted from the
topology database since the local node was initialized.</p>
<p><strong>Number of transmission groups reported for all end nodes.</strong>
The total number of associated transmission groups returned in the list owned
by end nodes.</p>
<p><strong>Number of transmission groups reported for all network and virtual
nodes.</strong> The total number of associated transmission groups returned in
the list owned by network nodes and virtual nodes.</p>
<p><strong>Reserved.</strong> An ignored field.</p>
<p><strong>Transmission group characteristics.</strong> The transmission group
(TG) characteristics. See <a href="#HDRSTGC">Format of Transmission Group
Characteristics</a> for the structure. This field is valid only when the number
of associated transmission group entries field is not zero.</p>
<p><strong>Transmission group destination control point name.</strong> The
control point name for the transmission group (TG) destination node. This field
is blank when the number of associated transmission group entries field is
zero.</p>
<p><strong>Transmission group destination network ID.</strong> The network ID
for transmission group (TG) destination node. This field is blank when the
number of associated transmission group entries field is zero.</p>
<p><strong>Transmission group destination network-qualified control point
name.</strong> The network-qualified control point name for the transmission
group destination node, in the format <samp>NETID.CPNAME</samp>. This field is
blank when the number of associated transmission group entries field is
zero.</p>
<p><strong>Transmission group entry time left.</strong> The number of days left
before the transmission group entry is deleted from the topology database. This
field in the APPN0200 format is valid only when the number of associated
transmission group entries field is not zero.</p>
<p><strong>Transmission group flags.</strong> The format of the transmission
group flags data is described in <a href="#HDRSTGF">Format of Transmission
Group Flags Field</a>. This field is valid only when the number of associated
transmission group entries field is not zero.</p>
<p><strong>Transmission group flow reduction sequence number.</strong> The flow
reduction sequence number (FRSN) for the transmission group. This field in the
APPN0200 format is valid only when the number of associated transmission group
entries field is not zero, the local node is a network node, and the
transmission group reported is owned by a network node or virtual node.</p>
<blockquote>
<p>Node and transmission group FRSN numbers are not broadcast on topology data
updates (TDUs) and not duplicated on every network node in the network. Each
network node keeps its own node and transmission group FRSN for each node and
transmission group in the topology database. FRSNs are used to minimize TDU
exchanges with adjacent network nodes.</p>
</blockquote>
<p><strong>Transmission group number.</strong> The transmission group (TG)
number. This field is valid only when the number of associated transmission
group entries field is not zero.</p>
<p><strong>Timestamp.</strong> The machine timestamp (time of day) when
reported.</p>
<p><strong>Timestamp of list data.</strong> The machine timestamp of the list
data.</p>
<p><strong>Timestamp when local node initialized.</strong> The machine
timestamp when the local node was initialized. The local node is initialized at
initial program load (IPL) time and when the APPN node type changes.</p>
<p><strong>User space library name specified.</strong> The user space library
name specified to the API.</p>
<p><strong>User space library name used.</strong> The actual user space library
name used to report data.</p>
<p><strong>User space name specified.</strong> The user space name specified to
the API.</p>
<p><strong>User space name used.</strong> The actual user space name used to
report data.</p>
<br>
<h3><a name="HDRNATD">Format of Node Attributes Field</a></h3>
<p>The format of the node attributes field is described below.</p>
<table border width="80%">
<tr>
<th align="center" valign="bottom" colspan="2">Offset</th>
<th align="center" valign="bottom" rowspan="2">Bit</th>
<th align="left" valign="bottom" rowspan="2">Type</th>
<th align="left" valign="bottom" rowspan="2">Description</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="center" valign="top" width="10%">&nbsp;</td>
<td align="left" valign="top" width="20%">CHAR(4)</td>
<td align="left" valign="top" width="50%">Resource sequence number</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">4</td>
<td align="center" valign="top" width="10%">4</td>
<td align="center" valign="top" width="10%">&nbsp;</td>
<td align="left" valign="top" width="20%">CHAR(1)</td>
<td align="left" valign="top" width="50%">Route addition resistance</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">5</td>
<td align="center" valign="top" width="10%">5</td>
<td align="center" valign="top" width="10%">&nbsp;</td>
<td align="left" valign="top" width="20%">CHAR(1)</td>
<td align="left" valign="top" width="50%">Node status</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">5</td>
<td align="center" valign="top" width="10%">5</td>
<td align="center" valign="top" width="10%">0</td>
<td align="left" valign="top" width="20%">BIT(1)</td>
<td align="left" valign="top" width="50%">Node congested</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">5</td>
<td align="center" valign="top" width="10%">5</td>
<td align="center" valign="top" width="10%">1</td>
<td align="left" valign="top" width="20%">BIT(1)</td>
<td align="left" valign="top" width="50%">Intermediate routing resources
depleted</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">5</td>
<td align="center" valign="top" width="10%">5</td>
<td align="center" valign="top" width="10%">2</td>
<td align="left" valign="top" width="20%">BIT(1)</td>
<td align="left" valign="top" width="50%">End point routing resources
depleted</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">5</td>
<td align="center" valign="top" width="10%">5</td>
<td align="center" valign="top" width="10%">3</td>
<td align="left" valign="top" width="20%">BIT(2)</td>
<td align="left" valign="top" width="50%">Reserved</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">5</td>
<td align="center" valign="top" width="10%">5</td>
<td align="center" valign="top" width="10%">5</td>
<td align="left" valign="top" width="20%">BIT(1)</td>
<td align="left" valign="top" width="50%">Quiescing</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">5</td>
<td align="center" valign="top" width="10%">5</td>
<td align="center" valign="top" width="10%">6</td>
<td align="left" valign="top" width="20%">BIT(2)</td>
<td align="left" valign="top" width="50%">Reserved</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">6</td>
<td align="center" valign="top" width="10%">6</td>
<td align="center" valign="top" width="10%">&nbsp;</td>
<td align="left" valign="top" width="20%">CHAR(1)</td>
<td align="left" valign="top" width="50%">Node type and support</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">6</td>
<td align="center" valign="top" width="10%">6</td>
<td align="center" valign="top" width="10%">0</td>
<td align="left" valign="top" width="20%">CHAR(1)</td>
<td align="left" valign="top" width="50%">Gateway services support</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">6</td>
<td align="center" valign="top" width="10%">6</td>
<td align="center" valign="top" width="10%">1</td>
<td align="left" valign="top" width="20%">BIT(1)</td>
<td align="left" valign="top" width="50%">Central directory services
support</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">6</td>
<td align="center" valign="top" width="10%">6</td>
<td align="center" valign="top" width="10%">2</td>
<td align="left" valign="top" width="20%">BIT(1)</td>
<td align="left" valign="top" width="50%">Intermediate routing services
support</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">6</td>
<td align="center" valign="top" width="10%">6</td>
<td align="center" valign="top" width="10%">3</td>
<td align="left" valign="top" width="20%">BIT(1)</td>
<td align="left" valign="top" width="50%">Retired (always set to 1)</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">6</td>
<td align="center" valign="top" width="10%">6</td>
<td align="center" valign="top" width="10%">4</td>
<td align="left" valign="top" width="20%">BIT(2)</td>
<td align="left" valign="top" width="50%">Reserved</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">6</td>
<td align="center" valign="top" width="10%">6</td>
<td align="center" valign="top" width="10%">6</td>
<td align="left" valign="top" width="20%">BIT(2)</td>
<td align="left" valign="top" width="50%">Retired (always set to 1)</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">7</td>
<td align="center" valign="top" width="10%">7</td>
<td align="center" valign="top" width="10%">&nbsp;</td>
<td align="left" valign="top" width="20%">CHAR(1)</td>
<td align="left" valign="top" width="50%">Additional node support</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">7</td>
<td align="center" valign="top" width="10%">7</td>
<td align="center" valign="top" width="10%">0</td>
<td align="left" valign="top" width="20%">BIT(1)</td>
<td align="left" valign="top" width="50%">Peripheral border node support:<br>
<table cellpadding="3">
<tr>
<td align="left" valign="top"><em>0</em></td>
<td valign="top">The node lacks such support</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td valign="top">The node has such support</td>
</tr>
</table>
<br>
</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">7</td>
<td align="center" valign="top" width="10%">7</td>
<td align="center" valign="top" width="10%">1</td>
<td align="left" valign="top" width="20%">BIT(1)</td>
<td align="left" valign="top" width="50%">Interchange node support:<br>
<table cellpadding="3">
<tr>
<td align="left" valign="top"><em>0</em></td>
<td valign="top">The node lacks such support</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td valign="top">The node has such support</td>
</tr>
</table>
<br>
</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">7</td>
<td align="center" valign="top" width="10%">7</td>
<td align="center" valign="top" width="10%">2</td>
<td align="left" valign="top" width="20%">BIT(1)</td>
<td align="left" valign="top" width="50%">Extended border node support:<br>
<table cellpadding="3">
<tr>
<td align="left" valign="top"><em>0</em></td>
<td valign="top">The node lacks such support</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td valign="top">The node has such support</td>
</tr>
</table>
<br>
</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">7</td>
<td align="center" valign="top" width="10%">7</td>
<td align="center" valign="top" width="10%">3</td>
<td align="left" valign="top" width="20%">BIT(2)</td>
<td align="left" valign="top" width="50%">High performance routing support
level:<br>
<table cellpadding="3">
<tr>
<td align="left" valign="top"><em>00</em></td>
<td valign="top">Lacks high performance routing support</td>
</tr>
<tr>
<td align="left" valign="top"><em>01</em></td>
<td valign="top">Supports high performance routing but not the high performance
routing transport tower</td>
</tr>
<tr>
<td align="left" valign="top"><em>10</em></td>
<td valign="top">Supports high performance routing and the high performance
routing transport tower</td>
</tr>
<tr>
<td align="left" valign="top"><em>11</em></td>
<td valign="top">Reserved</td>
</tr>
</table>
<br>
</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">7</td>
<td align="center" valign="top" width="10%">7</td>
<td align="center" valign="top" width="10%">5</td>
<td align="left" valign="top" width="20%">BIT(2)</td>
<td align="left" valign="top" width="50%">Reserved</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRSTGF">Format of Transmission Group Flags Field</a></h3>
<p>The format of the transmission group flags data is described below.</p>
<table border width="80%">
<tr>
<th align="center" valign="bottom" colspan="2">Offset</th>
<th align="center" valign="bottom" rowspan="2">Bit</th>
<th align="left" valign="bottom" rowspan="2">Type</th>
<th align="left" valign="bottom" rowspan="2">Description</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="center" valign="top" width="10%">&nbsp;</td>
<td align="left" valign="top" width="20%">CHAR(1)</td>
<td align="left" valign="top" width="50%">Transmission group flags</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">0</td>
<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%">BIT(1)</td>
<td align="left" valign="top" width="50%">Link connection network
indicator:<br>
<table cellpadding="3">
<tr>
<td align="left" valign="top"><em>0</em></td>
<td valign="top">The transmission group-Partner Node's Network-Qualified CP/PU
Name field does not identify a link connection network (such as a local area
network)</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td valign="top">The transmission group-Partner Node's Network-Qualified CP/PU
Name field identifies a link connection network</td>
</tr>
</table>
<br>
</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">0</td>
<td align="center" valign="top" width="10%">0</td>
<td align="center" valign="top" width="10%">1</td>
<td align="left" valign="top" width="20%">BIT(1)</td>
<td align="left" valign="top" width="50%">Reserved</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">0</td>
<td align="center" valign="top" width="10%">0</td>
<td align="center" valign="top" width="10%">2</td>
<td align="left" valign="top" width="20%">BIT(1)</td>
<td align="left" valign="top" width="50%">This transmission group supports high
performance routing:<br>
<table cellpadding="3">
<tr>
<td align="left" valign="top"><em>0</em></td>
<td valign="top">No</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td valign="top">Yes</td>
</tr>
</table>
<br>
</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">0</td>
<td align="center" valign="top" width="10%">0</td>
<td align="center" valign="top" width="10%">3</td>
<td align="left" valign="top" width="20%">BIT(2)</td>
<td align="left" valign="top" width="50%">Transmission group type:<br>
<table cellpadding="3">
<tr>
<td align="left" valign="top"><em>00</em></td>
<td valign="top">Boundary function based transmission group or APPN
transmission group</td>
</tr>
<tr>
<td align="left" valign="top"><em>01</em></td>
<td valign="top">Interchange transmission group</td>
</tr>
<tr>
<td align="left" valign="top"><em>10</em></td>
<td valign="top">Virtual route based transmission group</td>
</tr>
<tr>
<td align="left" valign="top"><em>11</em></td>
<td valign="top">Reserved</td>
</tr>
</table>
<br>
</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">0</td>
<td align="center" valign="top" width="10%">0</td>
<td align="center" valign="top" width="10%">5</td>
<td align="left" valign="top" width="20%">BIT(1)</td>
<td align="left" valign="top" width="50%">Intersubnetwork link indicator:<br>
<table cellpadding="3">
<tr>
<td align="left" valign="top"><em>0</em></td>
<td valign="top">This link is not an intersubnetwork link.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td valign="top">This link is an intersubnetwork link. It defines a border
between subnetworks.</td>
</tr>
</table>
<br>
</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">0</td>
<td align="center" valign="top" width="10%">0</td>
<td align="center" valign="top" width="10%">6</td>
<td align="left" valign="top" width="20%">BIT(1)</td>
<td align="left" valign="top" width="50%">Reserved</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">0</td>
<td align="center" valign="top" width="10%">0</td>
<td align="center" valign="top" width="10%">7</td>
<td align="left" valign="top" width="20%">BIT(1)</td>
<td align="left" valign="top" width="50%">This transmission group goes to a
node that supports the high performance routing transport tower:<br>
<table cellpadding="3">
<tr>
<td align="left" valign="top"><em>0</em></td>
<td valign="top">No</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td valign="top">Yes</td>
</tr>
</table>
<br>
</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRSTGC">Format of Transmission Group Characteristics</a></h3>
<p>The format of the transmission group (TG) characteristics data is described
below.</p>
<table border width="80%">
<tr>
<th align="center" valign="bottom" colspan="2">Offset</th>
<th align="center" valign="bottom" rowspan="2">Bit</th>
<th align="left" valign="bottom" rowspan="2">Type</th>
<th align="left" valign="bottom" rowspan="2">Description</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="center" valign="top" width="10%">&nbsp;</td>
<td align="left" valign="top" width="20%">CHAR(4)</td>
<td align="left" valign="top" width="50%">Resource sequence number (reserved
except in topology database updates (TDUs)): a 32-bit binary value that
uniquely identifies a topology update.</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">4</td>
<td align="center" valign="top" width="10%">4</td>
<td align="center" valign="top" width="10%">&nbsp;</td>
<td align="left" valign="top" width="20%">CHAR(1)</td>
<td align="left" valign="top" width="50%">Status</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">4</td>
<td align="center" valign="top" width="10%">4</td>
<td align="center" valign="top" width="10%">0</td>
<td align="left" valign="top" width="20%">BIT(1)</td>
<td align="left" valign="top" width="50%">Operational status:<br>
<table cellpadding="3">
<tr>
<td align="left" valign="top"><em>0</em></td>
<td valign="top">The transmission group is not operational</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td valign="top">The transmission group is operational</td>
</tr>
</table>
<br>
</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">4</td>
<td align="center" valign="top" width="10%">4</td>
<td align="center" valign="top" width="10%">1</td>
<td align="left" valign="top" width="20%">BIT(1)</td>
<td align="left" valign="top" width="50%">Reserved</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">4</td>
<td align="center" valign="top" width="10%">4</td>
<td align="center" valign="top" width="10%">2</td>
<td align="left" valign="top" width="20%">BIT(1)</td>
<td align="left" valign="top" width="50%">Quiescing:<br>
<table cellpadding="3">
<tr>
<td align="left" valign="top"><em>0</em></td>
<td valign="top">The transmission group is not quiescing</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td valign="top">The transmission group is quiescing</td>
</tr>
</table>
<br>
</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">4</td>
<td align="center" valign="top" width="10%">4</td>
<td align="center" valign="top" width="10%">3</td>
<td align="left" valign="top" width="20%">BIT(1)</td>
<td align="left" valign="top" width="50%">CP-CP session support status:<br>
<table cellpadding="3">
<tr>
<td align="left" valign="top"><em>0</em></td>
<td valign="top">CP-CP sessions are supported on this transmission group.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td valign="top">CP-CP sessions are not supported on this transmission
group.</td>
</tr>
</table>
<br>
</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">4</td>
<td align="center" valign="top" width="10%">4</td>
<td align="center" valign="top" width="10%">4</td>
<td align="left" valign="top" width="20%">BIT(4)</td>
<td align="left" valign="top" width="50%">Reserved</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">5</td>
<td align="center" valign="top" width="10%">5</td>
<td align="center" valign="top" width="10%">&nbsp;</td>
<td align="left" valign="top" width="20%">CHAR(1)</td>
<td align="left" valign="top" width="50%">Effective capacity</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">6</td>
<td align="center" valign="top" width="10%">6</td>
<td align="center" valign="top" width="10%">&nbsp;</td>
<td align="left" valign="top" width="20%">CHAR(5)</td>
<td align="left" valign="top" width="50%">Reserved</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">11</td>
<td align="center" valign="top" width="10%">B</td>
<td align="center" valign="top" width="10%">&nbsp;</td>
<td align="left" valign="top" width="20%">CHAR(1)</td>
<td align="left" valign="top" width="50%">Cost per connect time</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">12</td>
<td align="center" valign="top" width="10%">C</td>
<td align="center" valign="top" width="10%">&nbsp;</td>
<td align="left" valign="top" width="20%">CHAR(1)</td>
<td align="left" valign="top" width="50%">Cost per byte transmitted</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">13</td>
<td align="center" valign="top" width="10%">D</td>
<td align="center" valign="top" width="10%">&nbsp;</td>
<td align="left" valign="top" width="20%">CHAR(1)</td>
<td align="left" valign="top" width="50%">Reserved</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">14</td>
<td align="center" valign="top" width="10%">E</td>
<td align="center" valign="top" width="10%">&nbsp;</td>
<td align="left" valign="top" width="20%">CHAR(1)</td>
<td align="left" valign="top" width="50%">Security</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">15</td>
<td align="center" valign="top" width="10%">F</td>
<td align="center" valign="top" width="10%">&nbsp;</td>
<td align="left" valign="top" width="20%">CHAR(1)</td>
<td align="left" valign="top" width="50%">Propagation delay of the transmission
group</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">16</td>
<td align="center" valign="top" width="10%">10</td>
<td align="center" valign="top" width="10%">&nbsp;</td>
<td align="left" valign="top" width="20%">CHAR(1)</td>
<td align="left" valign="top" width="50%">Modem class</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">17</td>
<td align="center" valign="top" width="10%">11</td>
<td align="center" valign="top" width="10%">&nbsp;</td>
<td align="left" valign="top" width="20%">CHAR(1)</td>
<td align="left" valign="top" width="50%">User-defined parameter 1</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">18</td>
<td align="center" valign="top" width="10%">12</td>
<td align="center" valign="top" width="10%">&nbsp;</td>
<td align="left" valign="top" width="20%">CHAR(1)</td>
<td align="left" valign="top" width="50%">User-defined parameter 2</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">19</td>
<td align="center" valign="top" width="10%">13</td>
<td align="center" valign="top" width="10%">&nbsp;</td>
<td align="left" valign="top" width="20%">CHAR(1)</td>
<td align="left" valign="top" width="50%">User-defined parameter 3</td>
</tr>
</table>
<br>
<br>
<h3>Error Messages</h3>
<table width="100%" cellpadding="3">
<!-- 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">CPF24B4 E</td>
<td valign="top">Severe error while addressing parameter list.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C21 E</td>
<td valign="top">Format name &amp;1 is not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3CAA E</td>
<td valign="top">List is too large for user space &amp;1.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C90 E</td>
<td valign="top">Literal value cannot be changed.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3CF1 E</td>
<td valign="top">Error code parameter not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF8100 E</td>
<td valign="top">All CPF81xx messages could be returned. xx is from 01 to
FF.</td>
</tr>
<tr>
<td align="left" valign="top">CPF91C2 E</td>
<td valign="top">Queue type must be *DTAQ or *USRQ.</td>
</tr>
<tr>
<td align="left" valign="top">CPF91C3 E</td>
<td valign="top">Internal processing error.</td>
</tr>
<tr>
<td align="left" valign="top">CPF91C4 E</td>
<td valign="top">Queue &amp;5/&amp;4 with type &amp;6 already registered.</td>
</tr>
<tr>
<td align="left" valign="top">CPF91C5 E</td>
<td valign="top">Queue &amp;2/&amp;1 not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF91C7 E</td>
<td valign="top">Options list not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF91C8 E</td>
<td valign="top">Replace registration must be *YES or *NO.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9800 E</td>
<td valign="top">All CPF98xx messages could be signaled. xx is from 01 to
FF.</td>
</tr>
</table>
<br>
<hr>
API introduced: V2R3
<hr>
<center>
<table cellpadding="2" cellspacing="2">
<tr align="center">
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
"netmg.htm">Network Management APIs</a> | <a href="aplist.htm">APIs by
category</a></td>
</tr>
</table>
</center>
</body>
</html>
Reference in New Issue Copy Permalink