ibm-information-center/dist/eclipse/plugins/i5OS.ic.apis_5.4.0.1/qwcrneta.htm

1181 lines
37 KiB
HTML
Raw Normal View History

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>Retrieve Network Attributes (QWCRNETA) 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. -->
<!-- WM SCRIPT A converted by B2H R4.1 (346) (CMS) by V2KEA304 -->
<!-- at RCHVMW2 on 17 Feb 1999 at 11:05:09 -->
<!-- File cleanup completed on 17 July 2001 -->
<!-- Change History: -->
<!-- YYMMDD USERID Change description -->
<!-- File cleanup completed Feb 2002 by v2cdijab -->
<!-- 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 type="text/javascript" language="Javascript" src="../rzahg/synch.js">
</script>
<h2>Retrieve Network Attributes (QWCRNETA) API</h2>
<div class="box" style="width: 90%;">
<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%">Receiver variable</td>
<td align="left" valign="top" width="15%">Output</td>
<td align="left" valign="top" width="25%">Char(*)</td>
</tr>
<tr>
<td align="center" valign="top">2</td>
<td align="left" valign="top">Length of receiver variable</td>
<td align="left" valign="top">Input</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 network attributes to retrieve</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">Network attribute names</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">5</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: Yes<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The Retrieve Network Attributes (QWCRNETA) API lets you retrieve network
attributes.</p>
<br>
<h3>Authorities and Locks</h3>
<p>None.</p>
<br>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>Receiver variable</strong></dt>
<dd>OUTPUT; CHAR(*)
<p>The variable that is to receive the information requested. For the format,
see <a href="#HDRRECVARP">Format of Data Returned</a>.</p>
</dd>
<dt><strong>Length of receiver variable</strong></dt>
<dd>INPUT; BINARY(4)
<p>The length of the receiver variable described in <a href="#HDRRECVARP">
Format of Data Returned</a>. If the length is larger than the size of the
receiver variable, the results may not be predictable. The minimum length is 28
bytes.</p>
</dd>
<dt><strong>Number of network attributes to retrieve</strong></dt>
<dd>INPUT; BINARY(4)
<p>The total number of network attributes to be retrieved.</p>
</dd>
<dt><strong>Network attribute names</strong></dt>
<dd>INPUT: ARRAY(*) of CHAR(10)
<p>The names of the network attributes to be retrieved. This can be a list of
network attribute names where each name is 10 characters.</p>
</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="HDRRECVARP">Format of Data Returned</a></h3>
<p>The receiver variable holds the information returned about each network
attribute.</p>
<p>The receiver variable has three logical parts:</p>
<ol>
<li>The first field specifies the number of network attributes returned.</li>
<li>The next fields give the offsets to the network attributes returned. There
is one offset field for each network attribute returned.</li>
<li>Next are the network attribute information tables for the network
attributes returned. There is one network attribute information table for each
network attribute.</li>
</ol>
The following table shows the format of the receiver variable. The offset
fields are repeated until the offsets for all the network attributes returned
are listed; the network attribute information table for each network attribute
is repeated in the same way. For a detailed description of each field, see the
<a href="#HDRNETFLDW">Field Descriptions</a>.
<p>The format of the receiver variable is:</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%">BINARY(4)</td>
<td align="left" valign="top" width="60%">Number of network attributes
returned</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="center" valign="top">4</td>
<td align="left" valign="top">ARRAY(*) of BINARY(4)</td>
<td align="left" valign="top">Offset to network attribute information
table</td>
</tr>
<tr>
<td align="center" valign="top">*</td>
<td align="center" valign="top">*</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Network attribute information table</td>
</tr>
<tr>
<td align="LEFT" valign="TOP" colspan="4"><strong>Note:</strong> Each network
attribute in the table is represented by the standard network attribute
information table described in <a href="#HDRNATTTAB">Network Attribute
Information Table</a>.</td>
</tr>
</table>
<p>To determine the length of the receiver variable, the following calculation
should be done. For each network attribute to be returned, get the length of
the data returned for the network attribute and add 24. After adding the values
for each network attribute, add 4. This calculation takes into account the data
alignment that needs to be done; therefore, this value is a worst-case
estimate.</p>
<br>
<h3><a name="HDRNATTTAB">Network Attribute Information Table</a></h3>
<p>The following table shows the format of the network attribute information
table.</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%">Network attribute</td>
</tr>
<tr>
<td align="center" valign="top">10</td>
<td align="center" valign="top">A</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Type of data</td>
</tr>
<tr>
<td align="center" valign="top">11</td>
<td align="center" valign="top">B</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Information status</td>
</tr>
<tr>
<td align="center" valign="top">12</td>
<td align="center" valign="top">C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of data</td>
</tr>
<tr>
<td align="center" valign="top">16</td>
<td align="center" valign="top">10</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Data</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRNETFLDW">Field Descriptions</a></h3>
<p><strong>Data.</strong> The data returned for the network attribute.</p>
<p><strong>Information status.</strong> Whether the information was available
for the network attribute.</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>blank</em></td>
<td align="left" valign="top">The information was available.</td>
</tr>
<tr>
<td align="left" valign="top"><em>L</em></td>
<td align="left" valign="top">The information was not available because the
network attribute was locked.</td>
</tr>
</table>
<p><strong>Length of data.</strong> The length of the data returned for the
network attribute. If this value is 0, the network attribute was not
available.</p>
<p><strong>Network attribute.</strong> The network attribute to be retrieved.
See <a href="#HDRLNETA">Valid Network Attributes</a> for the list of valid
network attributes.</p>
<p><strong>Number of network attributes returned.</strong> The number of
network attributes returned to the application.</p>
<p><strong>Offset to network attribute information table.</strong> The offset
from the beginning of the structure to the start of the network attribute
information.</p>
<p><strong>Type of data.</strong> The type of data returned.</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>blank</em></td>
<td align="left" valign="top">The data was not available.</td>
</tr>
<tr>
<td align="left" valign="top"><em>C</em></td>
<td align="left" valign="top">The data is returned in character format.</td>
</tr>
<tr>
<td align="left" valign="top"><em>B</em></td>
<td align="left" valign="top">The data is returned in binary format.</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRLNETA">Valid Network Attributes</a></h3>
<p>For a detailed description of each field, see the <a href="#HDRNEATWM">
Network Attribute Field Descriptions</a>.</p>
<table border width="80%">
<tr>
<th align="left" valign="bottom">Network attribute</th>
<th align="left" valign="bottom">Type</th>
<th align="left" valign="bottom">Description</th>
</tr>
<tr>
<td align="left" valign="top" width="30%">ALRBCKFP</td>
<td align="left" valign="top" width="20%">CHAR(16)</td>
<td align="left" valign="top" width="50%">Alert backup focal point</td>
</tr>
<tr>
<td align="left" valign="top">ALRCTLD</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Alert controller</td>
</tr>
<tr>
<td align="left" valign="top">ALRDFTFP</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Alert focal point</td>
</tr>
<tr>
<td align="left" valign="top">ALRFTR</td>
<td align="left" valign="top">CHAR(20)</td>
<td align="left" valign="top">Alert filter</td>
</tr>
<tr>
<td align="left" valign="top">ALRHLDCNT</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Alert hold count</td>
</tr>
<tr>
<td align="left" valign="top">ALRLOGSTS</td>
<td align="left" valign="top">CHAR(7)</td>
<td align="left" valign="top">Alert logging status</td>
</tr>
<tr>
<td align="left" valign="top">ALRPRIFP</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Alert primary focal point</td>
</tr>
<tr>
<td align="left" valign="top">ALRRQSFP</td>
<td align="left" valign="top">CHAR(16)</td>
<td align="left" valign="top">Alert focal point to request</td>
</tr>
<tr>
<td align="left" valign="top">ALRSTS</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Alert status</td>
</tr>
<tr>
<td align="left" valign="top">ALWADDCLU</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Allow add to cluster</td>
</tr>
<tr>
<td align="left" valign="top">ALWANYNET</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Allow AnyNet support</td>
</tr>
<tr>
<td align="left" valign="top">ALWHPRTWR</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Allow HPR tower support</td>
</tr>
<tr>
<td align="left" valign="top">ALWVRTAPPN</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Allow virtual APPN support</td>
</tr>
<tr>
<td align="left" valign="top">VRTAUTODEV</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Autocreate APPC device limit</td>
</tr>
<tr>
<td align="left" valign="top">DDMACC</td>
<td align="left" valign="top">CHAR(20)</td>
<td align="left" valign="top">DDM request access</td>
</tr>
<tr>
<td align="left" valign="top">DFTCNNLST</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Default ISDN connection list</td>
</tr>
<tr>
<td align="left" valign="top">DFTMODE</td>
<td align="left" valign="top">CHAR(8)</td>
<td align="left" valign="top">Default mode</td>
</tr>
<tr>
<td align="left" valign="top">DFTNETTYPE</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">ISDN network type</td>
</tr>
<tr>
<td align="left" valign="top">DTACPR</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Data compression</td>
</tr>
<tr>
<td align="left" valign="top">DTACPRINM</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Intermediate data compression</td>
</tr>
<tr>
<td align="left" valign="top">HPRPTHTMR</td>
<td align="left" valign="top">CHAR(40)</td>
<td align="left" valign="top">HPR path switch timers</td>
</tr>
<tr>
<td align="left" valign="top">JOBACN</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Job action</td>
</tr>
<tr>
<td align="left" valign="top">LCLCPNAME</td>
<td align="left" valign="top">CHAR(8)</td>
<td align="left" valign="top">Local control point</td>
</tr>
<tr>
<td align="left" valign="top">LCLLOCNAME</td>
<td align="left" valign="top">CHAR(8)</td>
<td align="left" valign="top">Local location</td>
</tr>
<tr>
<td align="left" valign="top">LCLNETID</td>
<td align="left" valign="top">CHAR(8)</td>
<td align="left" valign="top">Local network ID</td>
</tr>
<tr>
<td align="left" valign="top">MAXINTSSN</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Maximum sessions</td>
</tr>
<tr>
<td align="left" valign="top">MAXHOP</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Maximum hop count</td>
</tr>
<tr>
<td align="left" valign="top">MDMCNTRYID</td>
<td align="left" valign="top">CHAR(2)</td>
<td align="left" valign="top">Modem country or region ID</td>
</tr>
<tr>
<td align="left" valign="top">MSGQ</td>
<td align="left" valign="top">CHAR(20)</td>
<td align="left" valign="top">Message queue</td>
</tr>
<tr>
<td align="left" valign="top">NETSERVER</td>
<td align="left" valign="top">CHAR(85)</td>
<td align="left" valign="top">Server network ID</td>
</tr>
<tr>
<td align="left" valign="top">NODETYPE</td>
<td align="left" valign="top">CHAR(8)</td>
<td align="left" valign="top">APPN node type</td>
</tr>
<tr>
<td align="left" valign="top">NWSDOMAIN</td>
<td align="left" valign="top">CHAR(8)</td>
<td align="left" valign="top">Network server domain</td>
</tr>
<tr>
<td align="left" valign="top">OUTQ</td>
<td align="left" valign="top">CHAR(20)</td>
<td align="left" valign="top">Output queue</td>
</tr>
<tr>
<td align="left" valign="top">PNDSYSNAME</td>
<td align="left" valign="top">CHAR(8)</td>
<td align="left" valign="top">Pending system name</td>
</tr>
<tr>
<td align="left" valign="top">PCSACC</td>
<td align="left" valign="top">CHAR(20)</td>
<td align="left" valign="top">Client Access</td>
</tr>
<tr>
<td align="left" valign="top">RAR</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Addition resistance</td>
</tr>
<tr>
<td align="left" valign="top">SYSNAME</td>
<td align="left" valign="top">CHAR(8)</td>
<td align="left" valign="top">Current system name</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRNEATWM">Network Attribute Field Descriptions</a></h3>
<p><strong>Addition resistance.</strong> The Advanced Peer-to-Peer Networking
(APPN) function routes addition resistance for an APPN node type of *NETNODE or
*BEXNODE.</p>
<p><strong>Alert backup focal point.</strong> Identifies the system that
provides alert focal point services if the local system is unavailable and
ALRPRIFP is *YES. The backup focal point is only used by systems in the primary
sphere of control. The first eight characters are the control point name and
the last eight characters are the network ID. *NONE means no backup focal point
is defined.</p>
<p><strong>Alert controller.</strong> The name of the controller to be used for
alerts in a system service control point - physical unit (SSCP-PU) session.
This controller is ignored if the system has a focal point (in which case the
node is in another system's sphere of control). *NONE means no alert controller
is defined.</p>
<p><strong>Alert filter.</strong> The name of the filter object that is used by
the alert manager when processing alerts. *NONE means no alert filter is being
used. The first ten characters are the filter name and the last ten characters
are the library name.</p>
<p><strong>Alert focal point.</strong> Whether or not the system is an alert
default focal point.</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>*NO</em></td>
<td align="left" valign="top">The system is not an alert default focal
point.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*YES</em></td>
<td align="left" valign="top">The system is defined to be an alert default
focal point and provides focal point services to all nodes in the network that
are not being serviced by another focal point.</td>
</tr>
</table>
<p><strong>Alert focal point to request.</strong> Specifies the name of the
system that is requested to provide focal point services. If a focal point is
already defined for the entry point, it is taken away when the new focal point
is requested. *NONE means no focal point is requested.</p>
<p><strong>Alert hold count.</strong> The maximum number of alerts to be
created before the alerts are sent over the System Service Control Point -
Physical Unit (SSCP-PU) session. Alerts are held by the system until this
number of alerts have been created. If the Alert Controller (ALRCTLD) network
attribute is being used to send alerts (SSCP-PU session), alerts will be sent
automatically regardless of the ALRHLDCNT network attribute when a switched
connection is made for other reasons.</p>
<p><strong>Alert logging status.</strong> Specifies which alerts are to be
logged:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*LOCAL</em></td>
<td align="left" valign="top">Only locally created alerts are logged.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*RCV</em></td>
<td align="left" valign="top">Only Alerts received from other nodes are
logged.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*ALL</em></td>
<td align="left" valign="top">Both locally created alerts and incoming alerts
are logged.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*NONE</em></td>
<td align="left" valign="top">No alerts are logged.</td>
</tr>
</table>
<p><strong>Alert primary focal point.</strong> Whether or not the system is an
alert primary focal point.</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>*NO</em></td>
<td align="left" valign="top">The system is not an alert primary focal
point.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*YES</em></td>
<td align="left" valign="top">The system is defined to be an alert primary
focal point and provides focal point services to all nodes in the network that
are explicitly defined in the sphere of control.</td>
</tr>
</table>
<p><strong>Alert status.</strong> Alert status controls the creation of local
alerts. The following is a list of values and their meanings:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*ON</em></td>
<td align="left" valign="top">Alerts are created by a system for all changeable
conditions except <em>unattended</em> conditions.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*UNATTEND</em></td>
<td align="left" valign="top">Alerts are created by the system for all alert
conditions including those which have the alert indicator in the message
description set to *UNATTEND.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*OFF</em></td>
<td align="left" valign="top">Alerts are not created by the system.</td>
</tr>
</table>
<p><strong>Allow add to cluster.</strong> Whether this system will allow
another system to add it as a node in a cluster. The following is a list of
values and their meanings:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*NONE</em></td>
<td align="left" valign="top">No other system can add this system as a node in
a cluster.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*ANY</em></td>
<td align="left" valign="top">Any other system can add this system as a node in
a cluster.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*RQSAUT</em></td>
<td align="left" valign="top">Any other system can add this system as a node in
a cluster only after the cluster add request has been authenticated.</td>
</tr>
</table>
<p><strong>Allow AnyNet<sup>(R)</sup> support.</strong> The AnyNet support value is used for
the UNIX-type APIs that use the AF_INET address family. The following is a list
of values and their meanings:</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>*NO</em></td>
<td align="left" valign="top">The system does not allow AF_INET support to be
used over an SNA connection.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*YES</em></td>
<td align="left" valign="top">The system allows AF_INET (AnyNet) support to be
used over an SNA connection.</td>
</tr>
</table>
<p><strong>Allow HPR tower support.</strong> The HPR transport tower support
value is used for APPN session traffic. The following is a list of values and
their meanings:</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>*NO</em></td>
<td align="left" valign="top">The system does not allow HPR transport tower
support to be used with APPN session traffic.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*YES</em></td>
<td align="left" valign="top">The system allows HPR transport tower support to
be used with APPN session traffic.</td>
</tr>
</table>
<p><strong>Allow virtual APPN support.</strong> The virtual APPN support value
is used to specify whether or not APPC sessions and devices are allowed to use
virtual APPN controllers.</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>*NO</em></td>
<td align="left" valign="top">The system does not allow APPC sessions or
devices to use virtual APPN controllers. If sessions are using HPR transport
tower support, they will use virtual APPN controllers regardless of this
setting.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*YES</em></td>
<td align="left" valign="top">The system does allow APPC sessions or devices to
use virtual APPN controllers.</td>
</tr>
</table>
<p><strong>Autocreate APPC device limit.</strong> The specification for the
APPC device limit used for autocreation of devices on virtual APPN
controllers.</p>
<p><strong>APPN node type.</strong> The Advanced Peer-to-Peer Networking (APPN)
node type can have the following values:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*ENDNODE</em></td>
<td align="left" valign="top">The node does not provide network services to
other nodes, but may participate in the APPN network by using the services of
an attached network server, or may operate in a peer environment similar to
migration end nodes.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*NETNODE</em></td>
<td align="left" valign="top">The node provides intermediate routing, route
selection services, and distributed directory services for local users and to
end nodes and migration end nodes that it is serving.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*BEXNODE</em></td>
<td align="left" valign="top">The node performs as a branch extender node. The
node performs as an end node in the backbone APPN network, and performs as a
network node server to end nodes within its local domain.</td>
</tr>
</table>
<p><strong>Client Access.</strong> The way in which the system processes Client
Access requests from other systems.</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*REJECT</em></td>
<td align="left" valign="top">The system rejects every request from Client
Access.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*OBJAUT</em></td>
<td align="left" valign="top">Normal object authorizations are checked for the
Client Access request. For example, authorization to retrieve data from a
database file for a transfer function request is checked.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*REGFAC</em></td>
<td align="left" valign="top">The system uses the system's registration
facility to determine which exit program (if any) to run. If no exit program is
defined for an exit point and this value is specified, *OBJAUT is used.</td>
</tr>
<tr>
<td align="left" valign="top"><em>program library</em></td>
<td align="left" valign="top">The name of a user-written validation program
that is called each time a Client Access application request comes from a
personal computer. The program is passed two parameters: the first describes
the PC request (the name of the application and type request); the second is
used by the program to indicate to the Client Access application whether or not
this PC request should be handled. The first 10 characters are the program
name, and the last 10 characters are the library name.</td>
</tr>
</table>
<p><strong>Current system name.</strong> The current system name that appears
on displays.</p>
<p><strong>Data compression.</strong> Whether data compression is used when the
system is an SNA end node (the node containing either a primary or secondary
LU). This field is used by mode descriptions that specify *NETATR for data
compression. The following values are valid:</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">Data compression is not allowed on the
session.</td>
</tr>
<tr>
<td align="left" valign="top"><em>-1</em></td>
<td align="left" valign="top">Data compression is requested on the session by
the local system. However, the request can be refused or changed to a lower
compression level by the remote system. Data compression is allowed on the
session if requested by the remote system.</td>
</tr>
<tr>
<td align="left" valign="top"><em>-2</em></td>
<td align="left" valign="top">Data compression is allowed on the session by the
local system if requested by a remote system. The local system does not request
that compression be used.</td>
</tr>
<tr>
<td align="left" valign="top"><em>-3</em></td>
<td align="left" valign="top">Data compression is required on the session. If
the remote system does not change the levels of compression to the local
system's exact requested levels, the session is not established. The data
compression levels that the local system requires are the specified
levels.</td>
</tr>
<tr>
<td align="left" valign="top" nowrap><em>line speed</em></td>
<td align="left" valign="top">If either the receiving or sending link has a
line speed equal to or less than this specified line speed, this value
indicates the need for compression by requesting that the remote systems
compress the session data. Otherwise, this value does not indicate to the
remote systems that there is a need to compress the data. Possible values range
from 1 through 2&nbsp;147&nbsp;483&nbsp;647 bits per second.</td>
</tr>
</table>
<p>If data compression is requested by the remote system, the data compression
levels used by the session are the lower of the requested levels and the
configured levels (INDTACPR and OUTDTACPR).</p>
<p><strong>DDM request access.</strong> The system processes distributed data
management (DDM) and Distributed Relational Database Architecture (DRDA)
requests from other systems as follows:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*REJECT</em></td>
<td align="left" valign="top">The system does not allow DDM or DRDA requests
from remote systems. This system can still use DDM or DRDA, however, to access
files or SQL tables on remote systems.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*OBJAUT</em></td>
<td align="left" valign="top">All requests are allowed and controlled by the
object authorization on the system.</td>
</tr>
<tr>
<td align="left" valign="top"><em>program library</em></td>
<td align="left" valign="top">The name of a user-written validation program
that is called each time a DDM request is made from a remote system. This
program indicates to DDM whether the request should proceed or be ended. System
security still applies. The first ten characters are the program name and the
last ten characters are the library name.</td>
</tr>
</table>
<p><strong>Default ISDN connection list.</strong> The name of the default
integrated services digital network (ISDN) connection list object.
The operating system no longer uses this network attribute.
Changes made to this network attribute have no effect.
</p>
<p><strong>Default mode.</strong> The default mode name for the system.</p>
<p><strong>HPR path switch timers.</strong> The settings for the amount of
time, in minutes, to allow for a path switch attempt of a Rapid Transport
Protocol (RTP) connection. Four positional values exist to specify the time
allowed based on the type of session traffic. Each positional timer will
consist of 10 characters within the 40-character field. A description of each
element within the field is given below:</p>
<dl>
<dt><em>Network priority timer (characters 1-10)</em></dt>
<dd>The first element is the network priority timer, which specifies the amount
of time in minutes to allow for a path switch attempt of an RTP connection that
has network transmission priority or *NONE.<br>
<br>
</dd>
<dt><em>High priority timer (characters 11-20)</em></dt>
<dd>The second element is the high priority timer, which specifies the amount
of time in minutes to allow for a path switch attempt of an RTP connection that
has high transmission priority or *NONE.<br>
<br>
</dd>
<dt><em>Medium priority timer (characters 21-30)</em></dt>
<dd>The third element is the medium priority timer, which specifies the amount
of time in minutes to allow for a path switch attempt of an RTP connection that
has medium transmission priority or *NONE.<br>
<br>
</dd>
<dt><em>Low priority timer (characters 31-40)</em></dt>
<dd>The fourth element is the low priority timer, which specifies the amount of
time in minutes to allow for a path switch attempt of an RTP connection that
has low transmission priority or *NONE.</dd>
</dl>
<p><strong>Intermediate data compression.</strong> The level of data
compression to request when the iSeries server is an SNA intermediate node. The
following are valid values:</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">Does not indicate to the remote systems that
there is a need to compress the data.</td>
</tr>
<tr>
<td align="left" valign="top"><em>-1</em></td>
<td align="left" valign="top">Indicates the need for compression by requesting
that the remote systems compress the session data.</td>
</tr>
<tr>
<td align="left" valign="top" nowrap><em>line speed</em></td>
<td align="left" valign="top">If either the receiving or sending link has a
line speed equal to or less than this specified line speed, this value
indicates the need for compression by requesting that the remote systems
compress the session data. Otherwise, this value does not indicate to the
remote systems that there is a need to compress the data. Possible values range
from 1 through 2&nbsp;147&nbsp;483&nbsp;647 bits per second.</td>
</tr>
</table>
<p><strong>ISDN network type.</strong> The type of integrated services digital
network (ISDN) to which the system is attached.
The operating system no longer uses this network attribute.
Changes made to this network attribute have no effect.
<p><strong>Job action.</strong> The action that is taken for any input stream
received through the SNA distribution services (SNADS) network by the
system.</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*REJECT</em></td>
<td align="left" valign="top">The input stream is rejected by the system. This
action allows users to secure their system from input streams received through
the network.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*FILE</em></td>
<td align="left" valign="top">The input stream is filed in the queue of network
files received for the user to whom it was sent. That user may then look at the
input stream, end it, receive it, or submit it to a job queue.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*SEARCH</em></td>
<td align="left" valign="top">The table of network job entries is searched to
determine the action to be taken for the input stream.</td>
</tr>
</table>
<p><strong>Local control point.</strong> The local control point name for the
system.</p>
<p><strong>Local location.</strong> The default local location name for the
system.</p>
<p><strong>Local network ID.</strong> The local network ID assigned to the
system.</p>
<p><strong>Maximum hop count.</strong> The maximum number of times in an SNA
distribution services (SNADS) network that a distribution queue entry
originating at this node may be received and routed on the path to its final
destination. If this number is exceeded, the distribution queue entry is ended.
When the distribution queue entry is ended, a feedback status is sent back to
the sender if it was requested.</p>
<p><strong>Maximum sessions.</strong> The maximum number of advanced
program-to-program communications (APPC) intermediate sessions for an Advanced
Peer-to-Peer Networking (APPN) node type of *NETNODE or *BEXNODE.</p>
<p><strong>Message queue.</strong> The name of the message queue to which
messages received through the SNA distribution services (SNADS) network are
sent for:</p>
<ul>
<li>Users who have no message queue specified in their user profile</li>
<li>Users whose message queue is not available</li>
</ul>
<p>The first 10 characters are the message queue name, and the last 10
characters are the library name.</p>
<p><strong>Modem country or region ID.</strong> The country or region identifier
associated with a modem.</p>
<p>This defines the country or region-specific default characteristics for modems that
are internal to i5/OS I/O adapters. This value must be configured correctly to
ensure proper operation and, in some countries or regions, meet legal requirements. The
adapter will fail the vary on of the line if the modem country or region ID is not
set.</p>
<p><strong>Network server domain.</strong> The LAN server domain to which all
Integrated Netfinity<sup>(R)</sup> Servers (also known as file server I/O processor and
FSIOP) on the system belong.</p>
<p><strong>Output queue.</strong> The name of the output queue to which spooled
files received through the SNA distribution services (SNADS) network are sent
for users whose output queue is not available. The first 10 characters are the
output queue name, and the last 10 characters are the library name.</p>
<p><strong>Pending system name.</strong> The pending system name (if a change
is pending). This will contain blanks if no change is pending.</p>
<p><strong>Server network ID.</strong> The network node server of an Advanced
Peer-to-Peer Networking (APPN) network (up to a maximum of five) for an APPN
node type of *ENDNODE. The list is not used for an APPN node type of *NETNODE
or *BEXNODE.</p>
<br>
<h3>Error Messages</h3>
<table width="100%" cellpadding="5">
<!-- cols="15 85" -->
<tr>
<th align="left" valign="top" nowrap>Message ID</th>
<th align="left" valign="top">Error Message Text</th>
</tr>
<tr>
<td align="left" valign="top">CPF1860 E</td>
<td align="left" valign="top">Value &amp;1 in list not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF1861 E</td>
<td align="left" valign="top">Length of the receiver variable not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF1862 E</td>
<td align="left" valign="top">Number of values to retrieve not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF24B4 E</td>
<td align="left" valign="top">Severe error while addressing parameter
list.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C19 E</td>
<td align="left" valign="top">Error occurred with receiver variable
specified.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C90 E</td>
<td align="left" valign="top">Literal value cannot be changed.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3CF1 E</td>
<td align="left" valign="top">Error code parameter not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9872 E</td>
<td align="left" valign="top">Program or service program &amp;1 in library
&amp;2 ended. Reason code &amp;3.</td>
</tr>
</table>
<br>
<hr>
API introduced: V2R3
<hr>
<table align="center" cellpadding="2" cellspacing="2">
<tr align="center">
<td valign="middle" align="center"><a href="#Top">Top</a> | <a href="wm1.htm">
Work Management APIs</a> | <a href="aplist.htm">APIs by category</a></td>
</tr>
</table>
</body>
</html>