1829 lines
47 KiB
HTML
1829 lines
47 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>Query Line Description (QOLQLIND) 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 -->
|
|
<!-- This file has undergone html cleanup June 2002 by JET -->
|
|
<!-- Change History: -->
|
|
<!-- YYMMDD USERID Change description -->
|
|
<!--File Edited November 2001 -->
|
|
<!--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>Query Line Description (QOLQLIND) API</h2>
|
|
|
|
<div class="box" style="width: 60%;">
|
|
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%">Return code</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">Reason code</td>
|
|
<td align="left" valign="top">Output</td>
|
|
<td align="left" valign="top">Binary(4)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">3</td>
|
|
<td align="left" valign="top">Number of bytes</td>
|
|
<td align="left" valign="top">Output</td>
|
|
<td align="left" valign="top">Binary(4)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">4</td>
|
|
<td align="left" valign="top">User buffer</td>
|
|
<td align="left" valign="top">Output</td>
|
|
<td align="left" valign="top">Char(*)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">5</td>
|
|
<td align="left" valign="top">Line description</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(10)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">6</td>
|
|
<td align="left" valign="top">Format</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(1)</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
Optional Parameter Group:<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
<table width="100%">
|
|
<tr>
|
|
<td align="center" valign="top" width="10%">7</td>
|
|
<td align="left" valign="top" width="50%">Length of user buffer</td>
|
|
<td align="left" valign="top" width="20%">Input</td>
|
|
<td align="left" valign="top" width="20%">Binary(4)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">8</td>
|
|
<td align="left" valign="top">Bytes available</td>
|
|
<td align="left" valign="top">Output</td>
|
|
<td align="left" valign="top">Binary(4)</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
Default Public Authority: *USE<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
Threadsafe: No<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
</div>
|
|
|
|
<p>The Query Line Description (QOLQLIND) API queries an existing token-ring,
|
|
Ethernet, wireless, FDDI, frame relay, or X.25 line description. The data
|
|
received from the query is placed in the user buffer parameter.</p>
|
|
|
|
<p>The line description to be queried does not have to be associated with any
|
|
links the application program has enabled. However, data in the line
|
|
description may change after it is queried.</p>
|
|
|
|
<br>
|
|
<!-- Please NOTE: DO NOT DELETE THIS SECTION if this API has no authorities and locks. -->
|
|
<!-- Instead, use the commented out coding below to indicate NONE. -->
|
|
<h3>Authorities and Locks</h3>
|
|
|
|
<!-- Use this if there are no authorities and locks. -->
|
|
<p>None.</p>
|
|
|
|
<br>
|
|
<h3>Required Parameter Group</h3>
|
|
|
|
<dl>
|
|
<dt><strong>Return code</strong></dt>
|
|
|
|
<dd>OUTPUT; BINARY(4)
|
|
|
|
<p>The recovery action to take. See <a href="#HDRQLINDRR">Return and Reason
|
|
Codes</a>.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Reason code</strong></dt>
|
|
|
|
<dd>OUTPUT; BINARY(4)
|
|
|
|
<p>The error that occurred. See <a href="#HDRQLINDRR">Return and Reason
|
|
Codes</a>.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Number of bytes</strong></dt>
|
|
|
|
<dd>OUTPUT; BINARY(4)
|
|
|
|
<p>The number of bytes of data returned in the user buffer.</p>
|
|
</dd>
|
|
|
|
<dt><strong>User buffer</strong></dt>
|
|
|
|
<dd>OUTPUT; CHAR(*)
|
|
|
|
<p>The buffer where the data from the query will be received. Any unused space
|
|
in the buffer will be filled with X'00'. The length of this character structure
|
|
is determined using <a href="#FIGGRPP">User Buffer Format</a>.</p>
|
|
|
|
<p><strong><a name="FIGGRPP">User Buffer Format</a></strong></p>
|
|
|
|
<table border width="60%">
|
|
<tr>
|
|
<th valign="top">Format</th>
|
|
<th valign="top">Group Parameter Passed</th>
|
|
<th valign="top">Length of Char(*)</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top" width="10%">1</td>
|
|
<td align="center" valign="top" width="20%">No</td>
|
|
<td align="center" valign="top" width="70%">256</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top" width="10%">1 or 2</td>
|
|
<td align="center" valign="top" width="20%">Yes</td>
|
|
<td align="center" valign="top" width="70%">Specified by the length user buffer
|
|
parameter.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Note:</strong> You are recommended to set the length user buffer
|
|
value to a number large enough to hold the system maximum values of virtual
|
|
circuits, SAPs, and group addresses with additional space left for future
|
|
needs.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Line description</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(10)
|
|
|
|
<p>The name of the line description to query. An existing token-ring, Ethernet,
|
|
wireless, FDDI, frame relay, or X.25 line description must be used.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Format</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(1)
|
|
|
|
<p>The format of the data returned in the user buffer. The valid values are as
|
|
follows:</p>
|
|
|
|
<table cellpadding="3">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'01'</em></td>
|
|
<td valign="top">Use format 01.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'02'</em></td>
|
|
<td valign="top">Use format 02.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p>See <a href="#HDRQLINDFT">Format of Data in the User Buffer</a> for more
|
|
information.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
<br>
|
|
<h3>Optional Parameter Group</h3>
|
|
|
|
<dl>
|
|
<dt><strong>Length of user buffer</strong></dt>
|
|
|
|
<dd>INPUT; BINARY(4)
|
|
|
|
<p>The number of bytes available for the API to use in the user buffer
|
|
parameter. The valid values are from 0 to 32,767.</p>
|
|
|
|
<p><strong>Notes:</strong></p>
|
|
|
|
<ol>
|
|
<li>This parameter is required if format 2 is specified in the format
|
|
parameter. It is optional if format 1 is specified.<br>
|
|
<br>
|
|
</li>
|
|
|
|
<li>If length user buffer is specified, bytes available must also be
|
|
specified.<br>
|
|
<br>
|
|
</li>
|
|
|
|
<li>If additional information exists that could not be reported, the bytes
|
|
available parameter will contain a larger value than the bytes returned
|
|
parameter.</li>
|
|
</ol>
|
|
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><strong>Bytes available</strong></dt>
|
|
|
|
<dd>OUTPUT; BINARY(4)
|
|
|
|
<p>The total number of bytes of available information.</p>
|
|
|
|
<p><strong>Notes:</strong></p>
|
|
|
|
<ol>
|
|
<li>This parameter is required if format 2 is specified in the format
|
|
parameter. It is optional if format 1 is specified.<br>
|
|
<br>
|
|
</li>
|
|
|
|
<li>If bytes available is specified, length user buffer must also be
|
|
specified.<br>
|
|
<br>
|
|
</li>
|
|
|
|
<li>If the bytes available parameter contains a number larger than the bytes
|
|
returned parameter, there is additional information that the application cannot
|
|
access.<br>
|
|
<br>
|
|
</li>
|
|
|
|
<li>If the return code parameter is nonzero, this value is set to zero.</li>
|
|
</ol>
|
|
</dd>
|
|
</dl>
|
|
|
|
<br>
|
|
<h3><a name="HDRQLINDFT">Format of Data in the User Buffer</a></h3>
|
|
|
|
<p>The data received in the user buffer from the query is made up of two parts.
|
|
The first portion starts at offset 0 from the top of the user buffer and
|
|
contains general query data. The format of this data does not depend on value
|
|
of the format parameter supplied to the QOLQLIND API.</p>
|
|
|
|
<p><strong><a name="Table_1-4">General Query Data</a></strong></p>
|
|
|
|
<table border width="80%">
|
|
<tr>
|
|
<th valign="top">Field</th>
|
|
<th valign="top">Type</th>
|
|
<th valign="top">Description</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top" width="15%">Line description</td>
|
|
<td align="left" valign="top" width="15%">CHAR(10)</td>
|
|
<td align="left" valign="top" width="70%">The name of the token-ring, Ethernet,
|
|
wireless, FDDI, frame relay, or X.25 line description that was queried.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">Line type</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">The type of line description that was
|
|
queried. The valid values are as follows:<br>
|
|
<br>
|
|
|
|
|
|
<table cellpadding="3">
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'04'</em></td>
|
|
<td valign="top">X.25</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'05'</em></td>
|
|
<td valign="top">Token-ring</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'09'</em></td>
|
|
<td valign="top">Ethernet</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'0D'</em></td>
|
|
<td valign="top">FDDI</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'0E'</em></td>
|
|
<td valign="top">Frame relay</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'10'</em></td>
|
|
<td valign="top">Wireless</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">Status</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">The current status of the line
|
|
description. The valid values are as follows:<br>
|
|
<br>
|
|
|
|
|
|
<table cellpadding="3">
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'00'</em></td>
|
|
<td valign="top">Varied off</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'01'</em></td>
|
|
<td valign="top">Varied off pending</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'02'</em></td>
|
|
<td valign="top">Varied on pending</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'03'</em></td>
|
|
<td valign="top">Varied on</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'04'</em></td>
|
|
<td valign="top">Active</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'05'</em></td>
|
|
<td valign="top">Connect pending</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'06'</em></td>
|
|
<td valign="top">Recovery pending</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'07'</em></td>
|
|
<td valign="top">Recovery canceled</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'08'</em></td>
|
|
<td valign="top">Failed</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'09'</em></td>
|
|
<td valign="top">Diagnostic mode</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'FF'</em></td>
|
|
<td valign="top">Unknown</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p>The second portion of the user buffer starts immediately after the general
|
|
query data and contains data specific to the type of line description that was
|
|
queried. The format of this data depends on the value of the format parameter
|
|
supplied to the QOLQLIND API.</p>
|
|
|
|
<p><strong><a name="Table_1-5">LAN Specific Data-Format 01</a></strong></p>
|
|
|
|
<table border width="80%">
|
|
<tr>
|
|
<th valign="top">Field</th>
|
|
<th valign="top">Type</th>
|
|
<th valign="top">Description</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top" width="15%">Local adapter address</td>
|
|
<td align="left" valign="top" width="15%">CHAR(6)</td>
|
|
<td align="left" valign="top" width="70%">Specifies, in packed form, the local
|
|
adapter address of this line. The special value of X'000000000000' indicates
|
|
that the preset default address for the adapter card was configured. However,
|
|
the line description must be varied on before this address can be
|
|
retrieved.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">Line speed</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">The speed of this line. The valid
|
|
values are as follows:<br>
|
|
<br>
|
|
|
|
|
|
<table cellpadding="3">
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'01'</em></td>
|
|
<td valign="top">4 megabits/second</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'02'</em></td>
|
|
<td valign="top">10 megabits/second</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'03'</em></td>
|
|
<td valign="top">16 megabits/second</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'04'</em></td>
|
|
<td valign="top">100 megabits/second</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">Line capability</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">The capability of this line. The
|
|
valid values are as follows:<br>
|
|
<br>
|
|
|
|
|
|
<table cellpadding="3">
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'00'</em></td>
|
|
<td valign="top">Non-Ethernet</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'01'</em></td>
|
|
<td valign="top">Ethernet Version 2</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'02'</em></td>
|
|
<td valign="top">Ethernet 802.3</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'03'</em></td>
|
|
<td valign="top">Both Ethernet Version 2 and Ethernet 802.3</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">Line frame size</td>
|
|
<td align="left" valign="top">BINARY(2)</td>
|
|
<td align="left" valign="top">The maximum frame size possible on
|
|
this line.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">Ethernet Version 2 frame size</td>
|
|
<td align="left" valign="top">BINARY(2)</td>
|
|
<td align="left" valign="top">The maximum size for Ethernet Version
|
|
2 frames. This will be 1502 if the line is capable of Ethernet Version 2
|
|
traffic. Otherwise, it will be zero.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">Number of SSAPs</td>
|
|
<td align="left" valign="top">BINARY(2)</td>
|
|
<td align="left" valign="top">The number of source service access
|
|
points (SSAPs) configured for this line.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top" colspan="3"><strong>Note:</strong> The following
|
|
3 rows are repeated for each SSAP configured for this line.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">SSAP</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">The configured source service access
|
|
point.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">SSAP type</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">The SSAP type. The valid values are
|
|
as follows:<br>
|
|
<br>
|
|
|
|
|
|
<table cellpadding="3">
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'00'</em></td>
|
|
<td valign="top">Non-SNA SSAP</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'01'</em></td>
|
|
<td valign="top">SNA SSAP</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">SSAP frame size</td>
|
|
<td align="left" valign="top">BINARY(2)</td>
|
|
<td align="left" valign="top">The maximum frame size allowed on
|
|
this SSAP.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">Number of group addresses</td>
|
|
<td align="left" valign="top">BINARY(2)</td>
|
|
<td align="left" valign="top">The number of group addresses
|
|
configured for this line.
|
|
|
|
<p><strong>Note:</strong> This will always be zero for a token-ring line
|
|
description.</p>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top" colspan="3"><strong>Note:</strong> The following
|
|
row is repeated for each group address configured for this line.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">Group address</td>
|
|
<td align="left" valign="top">CHAR(6)</td>
|
|
<td align="left" valign="top">Specifies a group address, in packed
|
|
form.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong><a name="Table_1-6">LAN Specific Data-Format 02</a></strong></p>
|
|
|
|
<table border width="80%">
|
|
<tr>
|
|
<th valign="top">Field</th>
|
|
<th valign="top">Type</th>
|
|
<th valign="top">Description</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top" width="15%">Local adapter address</td>
|
|
<td align="left" valign="top" width="15%">CHAR(6)</td>
|
|
<td align="left" valign="top" width="70%">Specifies, in packed form, the local
|
|
adapter address of this line. The special value of X'000000000000' indicates
|
|
that the preset default address for the adapter card was configured. However,
|
|
the line description must be varied on before this address can be
|
|
retrieved.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">Line speed</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">The speed of this line. The valid
|
|
values are as follows:<br>
|
|
<br>
|
|
|
|
|
|
<table cellpadding="3">
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'01'</em></td>
|
|
<td valign="top">4 megabits/second</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'02'</em></td>
|
|
<td valign="top">10 megabits/second</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'03'</em></td>
|
|
<td valign="top">16 megabits/second</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'04'</em></td>
|
|
<td valign="top">100 megabits/second</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'05'</em></td>
|
|
<td valign="top">Frame relay (line speed is specified separately)</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">Line capability</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">The capability of this line. The
|
|
valid values are as follows:<br>
|
|
<br>
|
|
|
|
|
|
<table cellpadding="3">
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'00'</em></td>
|
|
<td valign="top">Non-Ethernet</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'01'</em></td>
|
|
<td valign="top">Ethernet Version 2</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'02'</em></td>
|
|
<td valign="top">Ethernet 802.3</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'03'</em></td>
|
|
<td valign="top">Both Ethernet Version 2 and Ethernet 802.3</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">Line frame size</td>
|
|
<td align="left" valign="top">BINARY(2)</td>
|
|
<td align="left" valign="top">The maximum frame size possible on
|
|
this line.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">Ethernet Version 2 frame size</td>
|
|
<td align="left" valign="top">BINARY(2)</td>
|
|
<td align="left" valign="top">The maximum size for Ethernet Version
|
|
2 frames. This will be 1502 if the line is capable of Ethernet Version 2
|
|
traffic. Otherwise, it will be zero.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">Functional address field</td>
|
|
<td align="left" valign="top">CHAR(6)</td>
|
|
<td align="left" valign="top">The hexadecimal functional address
|
|
configured for the line. An address of X'000000000000' indicates there are no
|
|
functional addresses configured on this line description.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top" colspan="3"><strong>Note:</strong> For additional
|
|
information on functional addresses, refer to the <cite>Token-Ring Architecture
|
|
Reference</cite> book, SC30-3374.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">Number of group addresses</td>
|
|
<td align="left" valign="top">BINARY(2)</td>
|
|
<td align="left" valign="top">The number of group addresses
|
|
configured for this line. This value is valid for Ethernet and wireless line
|
|
descriptions only.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">Offset to group addresses</td>
|
|
<td align="left" valign="top">BINARY(2)</td>
|
|
<td align="left" valign="top">Offset within this structure to the
|
|
array of group addresses</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">Number of SSAPs</td>
|
|
<td align="left" valign="top">BINARY(2)</td>
|
|
<td align="left" valign="top">The number of SSAPs configured for
|
|
this line.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">Offset to SSAPs</td>
|
|
<td align="left" valign="top">BINARY(2)</td>
|
|
<td align="left" valign="top">Offset within this structure to the
|
|
array of SSAPs</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">FR line speed</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Frame relay line speed. This value is
|
|
valid only when the line type field is set to X'0E'.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">Reserved</td>
|
|
<td align="left" valign="top">CHAR(*)</td>
|
|
<td align="left" valign="top">Reserved for extension</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top" colspan="3"><strong>Note:</strong> The following
|
|
row is duplicated by the number of group addresses.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">Group address</td>
|
|
<td align="left" valign="top">CHAR(6)</td>
|
|
<td align="left" valign="top">Specifies a group address, in packed
|
|
form.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top" colspan="3"><strong>Note:</strong> The following
|
|
three rows are duplicated by the number of SSAPs.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">SSAP</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">The configured source service access
|
|
point.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">SSAP type</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">The SSAP type. The valid values are
|
|
as follows:<br>
|
|
<br>
|
|
|
|
|
|
<table cellpadding="3">
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'00'</em></td>
|
|
<td valign="top">Non-SNA SSAP</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'01'</em></td>
|
|
<td valign="top">SNA SSAP</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">SSAP frame size</td>
|
|
<td align="left" valign="top">BINARY(2)</td>
|
|
<td align="left" valign="top">The maximum frame size allowed on
|
|
this SSAP.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong><a name="Table_1-7">X.25 Specific Data-Format 01</a></strong></p>
|
|
|
|
<table border width="80%">
|
|
<tr>
|
|
<th valign="top">Field</th>
|
|
<th valign="top">Type</th>
|
|
<th valign="top">Description</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top" width="15%">Local network address length</td>
|
|
<td align="left" valign="top" width="15%">CHAR(1)</td>
|
|
<td align="left" valign="top" width="70%">Specifies, in hexadecimal, the number
|
|
of binary coded decimal (BCD) digits in the local network address.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">Local network address</td>
|
|
<td align="left" valign="top">CHAR(9)</td>
|
|
<td align="left" valign="top">Specifies, in BCD, the local network
|
|
address of this line.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">Extended network addressing</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">Specifies whether network addressing
|
|
is extended to permit the use of 17 digits in an address. The valid values are
|
|
as follows:<br>
|
|
<br>
|
|
|
|
|
|
<table cellpadding="3">
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'01'</em></td>
|
|
<td valign="top">Network addresses may be up to 15 digits</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'02'</em></td>
|
|
<td valign="top">Network addresses may be up to 17 digits</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">Address insertion</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">Specifies whether the system inserts
|
|
the local network address in call request and call accept packets. The valid
|
|
values are as follows:<br>
|
|
<br>
|
|
|
|
|
|
<table cellpadding="3">
|
|
<tr>
|
|
<td align="left" valign="top"><em>'Y'</em></td>
|
|
<td valign="top">The local network address is inserted in call request and call
|
|
accept packets.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>'N'</em></td>
|
|
<td valign="top">The local network address is not inserted in call request and
|
|
call accept packets.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">Modulus</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">The X.25 modulus value. The valid
|
|
values are as follows:<br>
|
|
<br>
|
|
|
|
|
|
<table cellpadding="3">
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'01'</em></td>
|
|
<td valign="top">Modulus 8</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'02'</em></td>
|
|
<td valign="top">Modulus 128</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">X.25 DCE support</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">Specifies whether the system
|
|
communicates using the integrated X.25 DCE support. This allows the system,
|
|
acting as the DCE, to communicate with another system without going through an
|
|
X.25 network. The valid values are as follows:<br>
|
|
<br>
|
|
|
|
|
|
<table cellpadding="3">
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'01'</em></td>
|
|
<td valign="top">The system does not communicate using the X.25 DCE
|
|
support</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'02'</em></td>
|
|
<td valign="top">The system does communicate using the X.25 DCE support</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'03'</em></td>
|
|
<td valign="top">The system negotiates whether it communicates using the X.25
|
|
DCE support.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">Transmit maximum packet size</td>
|
|
<td align="left" valign="top">BINARY(2)</td>
|
|
<td align="left" valign="top">The transmit maximum packet size
|
|
configured for this line.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">Receive maximum packet size</td>
|
|
<td align="left" valign="top">BINARY(2)</td>
|
|
<td align="left" valign="top">The receive maximum packet size
|
|
configured for this line.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">Transmit default packet size</td>
|
|
<td align="left" valign="top">BINARY(2)</td>
|
|
<td align="left" valign="top">The transmit default packet size
|
|
configured for this line.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">Receive default packet size</td>
|
|
<td align="left" valign="top">BINARY(2)</td>
|
|
<td align="left" valign="top">The receive default packet size
|
|
configured for this line.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">Transmit default window size</td>
|
|
<td align="left" valign="top">BINARY(1)</td>
|
|
<td align="left" valign="top">The transmit default window size
|
|
configured for this line.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">Receive default window size</td>
|
|
<td align="left" valign="top">BINARY(1)</td>
|
|
<td align="left" valign="top">The receive default window size
|
|
configured for this line.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">Number of logical channels</td>
|
|
<td align="left" valign="top">BINARY(2)</td>
|
|
<td align="left" valign="top">The number of logical channels
|
|
configured for this line.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top" colspan="3"><strong>Note:</strong> The following
|
|
4 rows are repeated for each logical channel configured for this line</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">Logical channel group number</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">The logical channel group number.
|
|
This together with the logical channel number makes up the logical channel
|
|
identifier.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">Logical channel number</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">The logical channel number. This
|
|
together with the logical channel group number makes up the logical channel
|
|
identifier.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">Logical channel type</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">The logical channel type. The valid
|
|
values are as follows:<br>
|
|
<br>
|
|
|
|
|
|
<table cellpadding="3">
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'01'</em></td>
|
|
<td valign="top">Switched virtual circuit (SVC).</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'02'</em></td>
|
|
<td valign="top">Permanent virtual circuit (PVC) that is eligible for use by a
|
|
network controller.
|
|
|
|
<p><strong>Note:</strong> This does not necessarily mean that this PVC is
|
|
available for use. Another job running on the network controller attached to
|
|
this line may already have this PVC in use.</p>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'22'</em></td>
|
|
<td valign="top">PVC that is not eligible for use by a network controller. For
|
|
example, a PVC that is already attached to an asynchronous controller
|
|
description.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">Logical channel direction</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">The direction of calls allowed on the
|
|
logical channel. The valid values are as follows:<br>
|
|
<br>
|
|
|
|
|
|
<table cellpadding="3">
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'00'</em></td>
|
|
<td valign="top">Not applicable (PVC logical channel).</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'01'</em></td>
|
|
<td valign="top">Only incoming calls are allowed on this logical channel.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'02'</em></td>
|
|
<td valign="top">Only outgoing calls are allowed on this logical channel.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'03'</em></td>
|
|
<td valign="top">Both incoming and outgoing calls are allowed on this logical
|
|
channel.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong><a name="Table_1-8">X.25 Specific Data-Format 02</a></strong></p>
|
|
|
|
<table border width="80%">
|
|
<tr>
|
|
<th valign="top">Field</th>
|
|
<th valign="top">Type</th>
|
|
<th valign="top">Description</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top" width="15%">Local network address length</td>
|
|
<td align="left" valign="top" width="15%">CHAR(1)</td>
|
|
<td align="left" valign="top" width="70%">Specifies, in hexadecimal, the number
|
|
of binary coded decimal (BCD) digits in the local network address.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">Local network address</td>
|
|
<td align="left" valign="top">CHAR(9)</td>
|
|
<td align="left" valign="top">Specifies, in BCD, the local network
|
|
address of this line.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">Extended network addressing</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">Specifies whether network addressing
|
|
is extended to permit the use of 17 digits in an address. The valid values are
|
|
as follows:<br>
|
|
<br>
|
|
|
|
|
|
<table cellpadding="3">
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'01'</em></td>
|
|
<td valign="top">Network addresses may be up to 15 digits</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'02'</em></td>
|
|
<td valign="top">Network addresses may be up to 17 digits</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">Address insertion</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">Specifies whether the system inserts
|
|
the local network address in call request and call accept packets. The valid
|
|
values are as follows:<br>
|
|
<br>
|
|
|
|
|
|
<table cellpadding="3">
|
|
<tr>
|
|
<td align="left" valign="top"><em>'Y'</em></td>
|
|
<td valign="top">The local network address is inserted in call request and call
|
|
accept packets.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>'N'</em></td>
|
|
<td valign="top">The local network address is not inserted in call request and
|
|
call accept packets.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">Modulus</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">The X.25 modulus value. The valid
|
|
values are as follows:<br>
|
|
<br>
|
|
|
|
|
|
<table cellpadding="3">
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'01'</em></td>
|
|
<td valign="top">Modulus 8</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'02'</em></td>
|
|
<td valign="top">Modulus 128</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">X.25 DCE support</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">Specifies whether the system
|
|
communicates using the integrated X.25 DCE support. This allows the system,
|
|
acting as a DCE, to communicate with another system without going through an
|
|
X.25 network. The valid values are as follows:<br>
|
|
<br>
|
|
|
|
|
|
<table cellpadding="3">
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'01'</em></td>
|
|
<td valign="top">The system does not communicate using the X.25 DCE
|
|
support</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'02'</em></td>
|
|
<td valign="top">The system does communicate using the X.25 DCE support</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'03'</em></td>
|
|
<td valign="top">The system negotiates whether it communicates using the X.25
|
|
DCE support.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">Transmit maximum packet size</td>
|
|
<td align="left" valign="top">BINARY(2)</td>
|
|
<td align="left" valign="top">The transmit maximum packet size
|
|
configured for this line.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">Receive maximum packet size</td>
|
|
<td align="left" valign="top">BINARY(2)</td>
|
|
<td align="left" valign="top">The receive maximum packet size
|
|
configured for this line.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">Transmit default packet size</td>
|
|
<td align="left" valign="top">BINARY(2)</td>
|
|
<td align="left" valign="top">The transmit default packet size
|
|
configured for this line.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">Receive default packet size</td>
|
|
<td align="left" valign="top">BINARY(2)</td>
|
|
<td align="left" valign="top">The receive default packet size
|
|
configured for this line.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">Transmit default window size</td>
|
|
<td align="left" valign="top">BINARY(1)</td>
|
|
<td align="left" valign="top">The transmit default window size
|
|
configured for this line.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">Receive default window size</td>
|
|
<td align="left" valign="top">BINARY(1)</td>
|
|
<td align="left" valign="top">The receive default window size
|
|
configured for this line.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">Number of logical channels</td>
|
|
<td align="left" valign="top">BINARY(2)</td>
|
|
<td align="left" valign="top">The number of logical channels
|
|
configured for this line.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">Maximum frame size</td>
|
|
<td align="left" valign="top">BINARY(2)</td>
|
|
<td align="left" valign="top">The maximum frame size configured in
|
|
the line description. The valid values are as follows:
|
|
|
|
<ul>
|
|
<li>1024<br>
|
|
<br>
|
|
</li>
|
|
|
|
<li>2048<br>
|
|
<br>
|
|
</li>
|
|
|
|
<li>4096<br>
|
|
<br>
|
|
</li>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">ISDN interface</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">Indicates if the line uses an ISDN
|
|
interface. The valid values are as follows:<br>
|
|
<br>
|
|
|
|
|
|
<table cellpadding="3">
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'00'</em></td>
|
|
<td valign="top">X.25 line does not run over an ISDN interface.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'01'</em></td>
|
|
<td valign="top">X.25 line runs over an ISDN interface.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top" colspan="3"><strong>Note:</strong> The following
|
|
section applies only if the ISDN interface is specified as X'01'. The sections
|
|
of format 02 on the call direction field to the offset to logical channel array
|
|
field are not meaningful if an ISDN interface is not used and will return zeros
|
|
in these fields if an ISDN interface is not specified.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">Call direction</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">The direction of the ISDN call. The
|
|
valid values are as follows:<br>
|
|
<br>
|
|
|
|
|
|
<table cellpadding="3">
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'00'</em></td>
|
|
<td valign="top">Incoming switched call</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'01'</em></td>
|
|
<td valign="top">Outgoing switched call</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'02'</em></td>
|
|
<td valign="top">Either a nonswitched call or not ISDN-capable.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top" colspan="3"><strong>Note:</strong> The following
|
|
fields are only meaningful if the line description is switched.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">Length of call ID information</td>
|
|
<td align="left" valign="top">BINARY(2)</td>
|
|
<td align="left" valign="top">Length includes type and plan, as
|
|
described below, and the call identify information element.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">Type of number and numbering
|
|
plan</td>
|
|
<td align="left" valign="top">BINARY(1)</td>
|
|
<td align="left" valign="top">Type and plan as represented by the
|
|
following bit sequence: tttt pppp, where tttt equals the category of the
|
|
calling number and pppp equals the numbering plan identification used when the
|
|
calling party number was created.<br>
|
|
<br>
|
|
|
|
|
|
<table cellpadding="3">
|
|
<tr>
|
|
<td align="left" valign="top"><em>Type '0000 xxxx'</em></td>
|
|
<td valign="top">Unknown number</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>Type '0001 xxxx'</em></td>
|
|
<td valign="top">International number</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>Type '0010 xxxx'</em></td>
|
|
<td valign="top">National number</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>Type '0011 xxxx'</em></td>
|
|
<td valign="top">Network specific number</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>Type '0100 xxxx'</em></td>
|
|
<td valign="top">Subscriber number</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>Type '0110 xxxx'</em></td>
|
|
<td valign="top">Abbreviated number</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>Type '0111 xxxx'</em></td>
|
|
<td valign="top">Reserved for extension</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>Plan 'xxxx 0000'</em></td>
|
|
<td valign="top">Unknown</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>Plan 'xxxx 0001'</em></td>
|
|
<td valign="top">ISDN/telephony numbering plan</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>Plan 'xxxx 0011'</em></td>
|
|
<td valign="top">Data numbering plan</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>Plan 'xxxx 0100'</em></td>
|
|
<td valign="top">Telex numbering plan</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>Plan 'xxxx 1000'</em></td>
|
|
<td valign="top">National standard numbering plan</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>Plan 'xxxx 1001'</em></td>
|
|
<td valign="top">Private numbering plan</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>Plan 'xxxx 1111'</em></td>
|
|
<td valign="top">Reserved for extension</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Note:</strong> Refer to CCITT Recommendation Q.931 for more
|
|
information.</p>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">Reserved</td>
|
|
<td align="left" valign="top">BINARY(1)</td>
|
|
<td align="left" valign="top">Reserved for extension.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">Call ID digits</td>
|
|
<td align="left" valign="top">CHAR(128)</td>
|
|
<td align="left" valign="top">Calling party number of remote system
|
|
received off the D-channel, specified in IA5 code (ASCII).</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">Length of subaddress information</td>
|
|
<td align="left" valign="top">BINARY(2)</td>
|
|
<td align="left" valign="top">Length includes type, odd-even
|
|
indicator, and the subaddress information element. Values can range from
|
|
X'0001' to X'00FF'. The user specified subaddress is restricted to 20
|
|
bytes.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">Type of subaddress and odd-even
|
|
indicator</td>
|
|
<td align="left" valign="top">BINARY(1)</td>
|
|
<td align="left" valign="top">Type and odd-even indicator as
|
|
represented by the following bit sequence: tttt ixxx, where tttt equals the
|
|
type of subaddress and i equals whether the address has an even or odd number
|
|
of digits.<br>
|
|
<br>
|
|
|
|
|
|
<table cellpadding="3">
|
|
<tr>
|
|
<td align="left" valign="top"><em>Type '0000 xxxx'</em></td>
|
|
<td valign="top">NSAP</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>Type '0010 xxxx'</em></td>
|
|
<td valign="top">User specified</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>Type remaining</em></td>
|
|
<td valign="top">Reserved</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>Plan 'xxxx 0xxx'</em></td>
|
|
<td valign="top">Even number of address digits</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>Plan 'xxxx 1xxx'</em></td>
|
|
<td valign="top">Odd number of address digits</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Note:</strong> Refer to CCITT Recommendation Q.931 for more
|
|
information.</p>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">Reserved</td>
|
|
<td align="left" valign="top">BINARY(1)</td>
|
|
<td align="left" valign="top">Reserved for extension.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">Subaddress</td>
|
|
<td align="left" valign="top">CHAR(128)</td>
|
|
<td align="left" valign="top">Calling party subaddress information,
|
|
received from the D-channel, specified in the IA5 code set (a superset of
|
|
ASCII).</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">Offset to logical channel array</td>
|
|
<td align="left" valign="top">BINARY(2)</td>
|
|
<td align="left" valign="top">Offset within this structure to the
|
|
array of logical channels</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">Reserved</td>
|
|
<td align="left" valign="top">CHAR(*)</td>
|
|
<td align="left" valign="top">Reserved for extension</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top" colspan="3"><strong>Note:</strong> The following
|
|
5 rows are repeated for each logical channel configured for this line. This
|
|
section is not specific to ISDN interfaces.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">Logical channel group number</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">The logical channel group number.
|
|
This together with the logical channel number makes up the logical channel
|
|
identifier.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">Logical channel number</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">The logical channel number. This
|
|
together with the logical channel group number makes up the logical channel
|
|
identifier.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">Logical channel type</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">The logical channel type. The valid
|
|
values are as follows:<br>
|
|
<br>
|
|
|
|
|
|
<table cellpadding="3">
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'01'</em></td>
|
|
<td valign="top">Switched virtual circuit (SVC).</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'02'</em></td>
|
|
<td valign="top">Permanent virtual circuit (PVC) that is eligible for use by a
|
|
network controller.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<blockquote>
|
|
<p><strong>Note:</strong> This does not necessarily mean that this PVC is
|
|
available for use. Another job running on the network controller attached to
|
|
this line may already have this PVC in use.</p>
|
|
</blockquote>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">Type of calls allowed</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">Types of calls supported on the
|
|
logical channel. The valid values are as follows:<br>
|
|
<br>
|
|
|
|
|
|
<table cellpadding="3">
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'00'</em></td>
|
|
<td>Not applicable (PVC logical channel).</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'01'</em></td>
|
|
<td valign="top">Only incoming calls are allowed on this logical channel.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'02'</em></td>
|
|
<td valign="top">Only outgoing calls are allowed on this logical channel.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'03'</em></td>
|
|
<td valign="top">Both incoming and outgoing calls are allowed on this logical
|
|
channel.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">Availability</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">Specifies whether the virtual circuit
|
|
is available or currently is in use. The valid values are as follows:<br>
|
|
<br>
|
|
|
|
|
|
<table cellpadding="3">
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'00'</em></td>
|
|
<td valign="top">Available</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>X'01'</em></td>
|
|
<td valign="top">In use</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
<h3><a name="HDRQLINDRR">Return and Reason Codes</a></h3>
|
|
|
|
<p><strong><a name="Table_1-9">Return and Reason Codes for the QOLQLIND
|
|
API</a></strong></p>
|
|
|
|
<table border width="80%">
|
|
<tr>
|
|
<th valign="bottom">Return / Reason Code</th>
|
|
<th valign="bottom">Meaning</th>
|
|
<th valign="bottom">Recovery</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top" width="15%">00/0000</td>
|
|
<td align="left" valign="top" width="20%">Operation successful.</td>
|
|
<td align="left" valign="top" width="65%">Continue processing.
|
|
|
|
<p><strong>Notes:</strong></p>
|
|
|
|
<ol>
|
|
<li>When calling QOLQLIND (specifying an X.25 line description, format 1, and
|
|
not specifying group parameters), up to 54 logical channels can be contained in
|
|
the user buffer because it is limited to a size of 256 bytes. To increase the
|
|
size of the user buffer so that it is sufficient to contain all of the logical
|
|
channels, the group parameters should be used. To determine if there are more
|
|
than 54 logical channels configured, use the Display Line Description (DSPLIND)
|
|
command.<br>
|
|
<br>
|
|
</li>
|
|
|
|
<li>The application should check to ensure that the bytes available value
|
|
returned is less than or equal to the bytes returned value. If so, there is
|
|
additional information that the application may want to receive. To receive
|
|
this information, the application must re-issue the call, specifying the length
|
|
user buffer equal to or greater than the bytes available value.</li>
|
|
</ol>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">81/9999</td>
|
|
<td align="left" valign="top">Internal system error detected.
|
|
Escape message CPF91F0 will be sent to the application program when this return
|
|
and reason code is received.</td>
|
|
<td align="left" valign="top">See messages in the job log for
|
|
further information. Report the problem using the ANZPRB command.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">83/1005</td>
|
|
<td align="left" valign="top">Format not valid.</td>
|
|
<td align="left" valign="top">Correct the format parameter. Try the
|
|
request again.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">83/1014</td>
|
|
<td align="left" valign="top">Length user buffer value not valid.
|
|
This value cannot be negative.</td>
|
|
<td align="left" valign="top">Correct the length user buffer value
|
|
to a zero or a positive value less than 32K and try the operation again.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">83/1020</td>
|
|
<td align="left" valign="top">Group parameters not valid.</td>
|
|
<td align="left" valign="top">All parameters within the group must
|
|
be specified. Correct the parameter list and try the request again.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">83/1021</td>
|
|
<td align="left" valign="top">Required parameter not
|
|
specified.</td>
|
|
<td align="left" valign="top">Format 2 was requested and the
|
|
required group parameters (length user buffer and bytes available) were not
|
|
specified. Correct the parameter list and try the request again.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">83/1998</td>
|
|
<td align="left" valign="top">User buffer parameter too small.</td>
|
|
<td align="left" valign="top">Either the length user buffer value
|
|
is negative or it contains a positive value and the system was not able to put
|
|
the data into the user buffer provided by the application. Correct the
|
|
application and try the request again.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">83/2000</td>
|
|
<td align="left" valign="top">Line description not configured for
|
|
token-ring, Ethernet, wireless, or X.25.</td>
|
|
<td align="left" valign="top">Correct the line description
|
|
parameter. Try the request again.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">83/2002</td>
|
|
<td align="left" valign="top">Not authorized to line
|
|
description.</td>
|
|
<td align="left" valign="top">Get authorization to the line
|
|
description. Try the request again.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">83/2006</td>
|
|
<td align="left" valign="top">Line description not found.</td>
|
|
<td align="left" valign="top">Correct the line description
|
|
parameter. Try the request again.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">83/2007</td>
|
|
<td align="left" valign="top">Line description damaged.</td>
|
|
<td align="left" valign="top">Delete and re-create the line
|
|
description. Try the request again.</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">CPF3C90 E</td>
|
|
<td valign="top">Literal value cannot be changed.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF91F0 E</td>
|
|
<td valign="top">Internal system error.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" 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: V2R1
|
|
|
|
<hr>
|
|
<center>
|
|
<table cellpadding="2" cellspacing="2">
|
|
<tr align="center">
|
|
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
|
|
"comm.htm">Communications APIs</a> | <a href="aplist.htm">APIs by
|
|
category</a></td>
|
|
</tr>
|
|
</table>
|
|
</center>
|
|
</body>
|
|
</html>
|
|
|