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

2072 lines
59 KiB
HTML
Raw Permalink Blame History

<!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>List Network Routes (QtocLstNetRte) 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. -->
<!-- Created for V5R1-->
<!-- Change History: -->
<!-- YYMMDD USERID Change description -->
<!-- 050602 SGLEZ Add new V5R4 IPv6 fields -->
<!-- Edited by Sglez Jun 05 ========================================= -->
<!-- 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>List Network Routes (QtocLstNetRte) API</h2>
<div class="box" style="width: 60%;">
&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%">Qualified user space name</td>
<td align="left" valign="top" width="20%">Input</td>
<td align="left" valign="top" width="20%">Char(20)</td>
</tr>
<tr>
<td align="center" valign="top">2</td>
<td align="left" valign="top">Format name</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(8)</td>
</tr>
<tr>
<td align="center" valign="top">3</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;Service Program: QTOCNETSTS<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: Yes<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The List Network Routes
(QtocLstNetRte) API returns a detailed list of all routes. This API returns all
IPv4 routes using one output format name, and all IPv6 routes using a different
output format name.</p>
<p>TCP/IP must be active on this system; otherwise, a message will be
issued.</p>
<h3>Authorities and Locks</h3>
<dl>
<dt><em>User Space Library Authority</em></dt>
<dd>*EXECUTE</dd>
<dt><em>User Space Authority</em></dt>
<dd>*CHANGE</dd>
<dt><em>User Space Lock</em></dt>
<dd>*SHRNUP</dd>
</dl>
<br>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>Qualified user space name</strong></dt>
<dd>INPUT; CHAR(20)
<p>The user space that is to receive the created list.&nbsp; The first 10
characters contain the user space name, and the second 10 characters contain
the name of the library where the user space is located.&nbsp; You can use
these special values for the library name:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*CURLIB</em></td>
<td align="left" valign="top">The job's current library</td>
</tr>
<tr>
<td align="left" valign="top"><em>*LIBL</em></td>
<td align="left" valign="top">The library list</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Format name</strong></dt>
<dd>INPUT; CHAR(8)
<p>The format of the route information to be returned. The format names
supported are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>NRTE0100</em></td>
<td align="left" valign="top">Detailed information about each TCP/IPv4 route.
Refer to <a href="#NRTE0100">NRTE0100 Format</a> for details on the
format.</td>
</tr>
<tr>
<td align="left" valign="top"><em>NRTE0200</em></td>
<td align="left" valign="top">Detailed information about each TCP/IPv6 route.
Refer to <a href="#NRTE0200">NRTE0200 Format</a> for details on the format.</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Error code</strong></dt>
<dd>I/O; CHAR(*)
<p>The structure in which to return error information. For the format of the
structure, see <a href="../apiref/error.htm#hdrerrcod">Error Code Parameter</a>.</p>
</dd>
</dl>
<br>
<h3><a name="HDRSPCA0">Format of Route Lists</a></h3>
<p>To request a list of all routes, use format NRTE0100.</p>
<p>The route description list consists of:</p>
<ul>
<li>A user area</li>
<li>A generic header</li>
<li>An input parameter section</li>
<li>A header section</li>
<li>A list data section:
<ul>
<li>NRTE0100 format, or</li>
<li>NRTE0200 format</li>
</ul>
</li>
</ul>
<p>For details about the user area and generic header, see <a href=
"../apiref/usf.htm">User Space Format for List APIs</a>. For details about the remaining
items, see the following sections.</p>
<p>When you retrieve list entry information from a user space, you must use the
entry size returned in the generic header. The size of each entry may be padded
at the end. If you do not use the entry size, the result may not be valid. For
examples of how to process lists, see API <a href=
"../apiref/apiexmp.htm">Examples</a>.</p>
<br>
<h3><a name="HDRSPCA01">Input Parameter Section</a></h3>
<table border width="80%">
<tr>
<th align="center" valign="bottom" colspan="2">Offset</th>
<th align="left" valign="bottom" rowspan="2">Type</th>
<th align="left" valign="bottom" rowspan="2">Field</th>
</tr>
<tr>
<th align="center" valign="bottom">Dec</th>
<th align="center" valign="bottom">Hex</th>
</tr>
<tr>
<td align="center" valign="top" width="10%">0</td>
<td align="center" valign="top" width="10%">0</td>
<td align="left" valign="top" width="20%">CHAR(10)</td>
<td align="left" valign="top" width="60%">User space name specified</td>
</tr>
<tr>
<td align="center" valign="top">10</td>
<td align="center" valign="top">A</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">User space library name specified</td>
</tr>
<tr>
<td align="center" valign="top">20</td>
<td align="center" valign="top">14</td>
<td align="left" valign="top">CHAR(8)</td>
<td align="left" valign="top">Format name specified</td>
</tr>
<tr>
<td align="center" valign="top">28</td>
<td align="center" valign="top">1C</td>
<td align="left" valign="top">&nbsp;</td>
<td align="left" valign="top">&nbsp;</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRSPCA02">Header Section</a></h3>
<table border width="80%">
<tr>
<th align="center" valign="bottom" colspan="2">Offset</th>
<th align="left" valign="bottom" rowspan="2">Type</th>
<th align="left" valign="bottom" rowspan="2">Field</th>
</tr>
<tr>
<th align="center" valign="bottom">Dec</th>
<th align="center" valign="bottom">Hex</th>
</tr>
<tr>
<td align="center" valign="top" width="10%">0</td>
<td align="center" valign="top" width="10%">0</td>
<td align="left" valign="top" width="20%">CHAR(10)</td>
<td align="left" valign="top" width="60%">User space name used</td>
</tr>
<tr>
<td align="center" valign="top">10</td>
<td align="center" valign="top">A</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">User space library name used</td>
</tr>
<tr>
<td align="center" valign="top">20</td>
<td align="center" valign="top">14</td>
<td align="left" valign="top">&nbsp;</td>
<td align="left" valign="top">&nbsp;</td>
</tr>
</table>
<br>
<br>
<h3><a name="FRCD">Format of
Returned Connection Data</a></h3>
<p>To retrieve the list of TCP/IPv4 routes, request format <a href=
"#NRTE0100">NRTE0100</a>, and you will get a repeating list of NRTE0100 tables,
each one returning information about a single IPv4 route. To retrieve the list
of TCP/IPv6 routes, request format <a href="#NRTE0200">NRTE0200</a>, and you
will get a repeating list of NRTE0200 tables, each one returning information
about a single IPv6 route.</p>
<br>
<h3><a name="NRTE0100">NRTE0100 Format</a></h3>
<p>The following information about each TCP/IPv4 route is returned for the
NRTE0100 format. For detailed descriptions of the fields in the table, see <a
href="#NRTE0100_FIELD">Field Descriptions</a>.</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(15)</td>
<td align="left" valign="top" width="60%">Route destination</td>
</tr>
<tr>
<td align="center" valign="top">15</td>
<td align="center" valign="top">F</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">16</td>
<td align="center" valign="top">10</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Route destination binary</td>
</tr>
<tr>
<td align="center" valign="top">20</td>
<td align="center" valign="top">14</td>
<td align="left" valign="top">CHAR(15)</td>
<td align="left" valign="top">Subnet mask</td>
</tr>
<tr>
<td align="center" valign="top">35</td>
<td align="center" valign="top">23</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">36</td>
<td align="center" valign="top">24</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Subnet mask binary</td>
</tr>
<tr>
<td align="center" valign="top">40</td>
<td align="center" valign="top">28</td>
<td align="left" valign="top">CHAR(15)</td>
<td align="left" valign="top">Next hop</td>
</tr>
<tr>
<td align="center" valign="top">55</td>
<td align="center" valign="top">37</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">56</td>
<td align="center" valign="top">38</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Next hop binary</td>
</tr>
<tr>
<td align="center" valign="top">60</td>
<td align="center" valign="top">3C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Route status</td>
</tr>
<tr>
<td align="center" valign="top">64</td>
<td align="center" valign="top">40</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Type of service</td>
</tr>
<tr>
<td align="center" valign="top">68</td>
<td align="center" valign="top">44</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Route MTU</td>
</tr>
<tr>
<td align="center" valign="top">72</td>
<td align="center" valign="top">48</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Route type</td>
</tr>
<tr>
<td align="center" valign="top">76</td>
<td align="center" valign="top">4C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Route source</td>
</tr>
<tr>
<td align="center" valign="top">80</td>
<td align="center" valign="top">50</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Route precedence</td>
</tr>
<tr>
<td align="center" valign="top">84</td>
<td align="center" valign="top">54</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Local binding interface status</td>
</tr>
<tr>
<td align="center" valign="top">88</td>
<td align="center" valign="top">58</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Local binding type</td>
</tr>
<tr>
<td align="center" valign="top">92</td>
<td align="center" valign="top">5C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Local binding line type</td>
</tr>
<tr>
<td align="center" valign="top">96</td>
<td align="center" valign="top">60</td>
<td align="left" valign="top">CHAR(15)</td>
<td align="left" valign="top">Local binding interface</td>
</tr>
<tr>
<td align="center" valign="top">111</td>
<td align="center" valign="top">6F</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">112</td>
<td align="center" valign="top">70</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Local binding interface binary</td>
</tr>
<tr>
<td align="center" valign="top">116</td>
<td align="center" valign="top">74</td>
<td align="left" valign="top">CHAR(15)</td>
<td align="left" valign="top">Local binding subnet mask</td>
</tr>
<tr>
<td align="center" valign="top">131</td>
<td align="center" valign="top">83</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">132</td>
<td align="center" valign="top">84</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Local binding subnet mask binary</td>
</tr>
<tr>
<td align="center" valign="top">136</td>
<td align="center" valign="top">88</td>
<td align="left" valign="top">CHAR(15)</td>
<td align="left" valign="top">Local binding network address</td>
</tr>
<tr>
<td align="center" valign="top">151</td>
<td align="center" valign="top">97</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">152</td>
<td align="center" valign="top">98</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Local binding network address binary</td>
</tr>
<tr>
<td align="center" valign="top">156</td>
<td align="center" valign="top">9C</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Local binding line description</td>
</tr>
<tr>
<td align="center" valign="top">166</td>
<td align="center" valign="top">A6</td>
<td align="left" valign="top">CHAR(8)</td>
<td align="left" valign="top">Change date</td>
</tr>
<tr>
<td align="center" valign="top">174</td>
<td align="center" valign="top">AE</td>
<td align="left" valign="top">CHAR(6)</td>
<td align="left" valign="top">Change time</td>
</tr>
<tr>
<td align="center" valign="top">180</td>
<td align="center" valign="top">B4</td>
<td align="left" valign="top">&nbsp;</td>
<td align="left" valign="top">&nbsp;</td>
</tr>
</table>
<br>
<br>
<h3><a name="NRTE0100_FIELD">Field Descriptions</a></h3>
<p><strong>Change date.</strong>The date of the most recent change to this
route in the dynamic tables used by the TCP/IP protocol stack. It is returned
as 8 characters in the form YYYYMMDD, where:</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top">YYYY</td>
<td align="left" valign="top">Year</td>
</tr>
<tr>
<td align="left" valign="top">MM</td>
<td align="left" valign="top">Month</td>
</tr>
<tr>
<td align="left" valign="top">DD</td>
<td align="left" valign="top">Day</td>
</tr>
</table>
<p><strong>Change time.</strong>The time of the most recent change to this
route in the dynamic tables used by the TCP/IP protocol stack. It is returned
as 6 characters in the form HHMMSS, where:</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top">HH</td>
<td align="left" valign="top">Hour</td>
</tr>
<tr>
<td align="left" valign="top">MM</td>
<td align="left" valign="top">Minute</td>
</tr>
<tr>
<td align="left" valign="top">SS</td>
<td align="left" valign="top">Second</td>
</tr>
</table>
<p><strong>Local binding interface.</strong> The IP interface to bind to this
route.</p>
<p><strong>Local binding interface binary.</strong> Binary representation of
the local binding interface.</p>
<p><strong>Local binding interface status.</strong> The current status of this
logical interface.</p>
<p>The possible values are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">Inactive - The interface has not been started.
The interface is not active.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Active - The interface has been started and and
is running.</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">Starting - The system is processing the request
to start this interface.</td>
</tr>
<tr>
<td align="left" valign="top"><em>3</em></td>
<td align="left" valign="top">Ending - The system is processing the request to
end this interface.</td>
</tr>
<tr>
<td align="left" valign="top"><em>4</em></td>
<td align="left" valign="top">RCYPND - An error with the physical line
associated with this interface was detected by the system. The line description
associated with this interface is in the recovery pending (RCYPND) state.</td>
</tr>
<tr>
<td align="left" valign="top"><em>5</em></td>
<td align="left" valign="top">RCYCNL - A hardware failure has occurred and the
line description associated with this interface is in the recovery canceled
(RCYCNL) state.</td>
</tr>
<tr>
<td align="left" valign="top"><em>6</em></td>
<td align="left" valign="top">Failed - The line description associated with
this interface has entered the failed state.</td>
</tr>
<tr>
<td align="left" valign="top"><em>7</em></td>
<td align="left" valign="top">Failed (TCP) - An error was detected in the IBM
TCP/IP Vertical Licensed Internal Code.</td>
</tr>
<tr>
<td align="left" valign="top"><em>8</em></td>
<td align="left" valign="top">DOD - Point-to-Point (PPP) Dial-on-Demand.</td>
</tr>
<tr>
<td align="left" valign="top"><em>9</em></td>
<td align="left" valign="top">Active Duplicate IP Address Conflict - Another
host on the LAN responded to a packet destined for this logical interface.</td>
</tr>
</table>
<p><strong>Local binding line description.</strong> Each TCP/IP interface is
associated with a network. This field displays the name of the communications
line description or virtual line (L2TP) that identifies the network associated
with an interface. The following are special values:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*IPI</em></td>
<td align="left" valign="top">This interface is used by Internet Protocol (IP)
over Internetwork Packet Exchange (IPX)
<p><strong>Note:</strong> As of V5R2,
IP over IPX is no longer supported.</p>
</td>
</tr>
<tr>
<td align="left" valign="top"></td>
<td align="left" valign="top">This interface is used by Internet Protocol (IP)
over SNA.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*LOOPBACK</em></td>
<td align="left" valign="top">This is a loopback interface.&nbsp; Processing
associated with a loopback interface does not extend to a physical line.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*VIRTUALIP</em></td>
<td align="left" valign="top">The virtual interface is a circuitless interface.
It is used in conjunction with the associated local interface (LCLIFC) when
adding standard interfaces.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*OPC</em></td>
<td align="left" valign="top">This interface is attached to the optical bus
(OptiConnect).</td>
</tr>
</table>
<p><strong>Local binding line type.</strong> Indicates the type of line used by
an interface.&nbsp; The following link protocols are supported:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top" nowrap><em>-1</em></td>
<td align="left" valign="top">OTHER -
<ul>
<li>IPI - An Internet Protocol (IP) over Internetwork Pack Exchange (IPX).</li>
<li>IPS - An Internet Protocol (IP) over SNA interface.</li>
</ul>
<p><strong>Note:</strong> As of V5R2,
IP over IPX is no longer supported.</p>
</td>
</tr>
<tr>
<td align="left" valign="top"><em>-2</em></td>
<td align="left" valign="top">NONE - Line is not defined. This is used for the
following interfaces: *LOOPBACK, *VIRTUALIP, *OPC.&nbsp; There is no line type
value for these interfaces.</td>
</tr>
<tr>
<td align="left" valign="top"><em>-3</em></td>
<td align="left" valign="top">ERROR - This value is displayed if any system
errrors other than those for *NOTFND are received while trying to determine the
link type for an interface.</td>
</tr>
<tr>
<td align="left" valign="top"><em>-4</em></td>
<td align="left" valign="top">NOTFND - Not found.&nbsp; This value is displayed
if the line description object for this interface cannot be found.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">ELAN - Ethernet local area network protocol.</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">TRLAN - Token-ring local area network
protocol.</td>
</tr>
<tr>
<td align="left" valign="top"><em>3</em></td>
<td align="left" valign="top">FR - Frame relay network protocol.</td>
</tr>
<tr>
<td align="left" valign="top"><em>4</em></td>
<td align="left" valign="top">ASYNC - Asynchronous communications
protocol.</td>
</tr>
<tr>
<td align="left" valign="top"><em>5</em></td>
<td align="left" valign="top">PPP - Point-to-point Protocol.</td>
</tr>
<tr>
<td align="left" valign="top"><em>6</em></td>
<td align="left" valign="top">WLS - Wireless local area network protocol.</td>
</tr>
<tr>
<td align="left" valign="top"><em>7</em></td>
<td align="left" valign="top">X.25 - X.25 protocol.</td>
</tr>
<tr>
<td align="left" valign="top"><em>8</em></td>
<td align="left" valign="top">DDI - Distributed Data Interface protocol.</td>
</tr>
<tr>
<td align="left" valign="top"><em>9</em></td>
<td align="left" valign="top">TDLC - Twinaxial Datalink Control.&nbsp; Used for
TCP/IP over Twinax.</td>
</tr>
</table>
<p><strong>Local binding network address.</strong> The internet address, in
dotted decimal notation, of the IP network or subnetwork that the interface is
attached to.</p>
<p><strong>Local binding network address binary.</strong> Binary representation
of the local binding network address.</p>
<p><strong>Local binding subnet mask.</strong> The subnet mask for the network,
subnet, and host address fields of the internet address, in dotted decimal
notation, that defines the subnetwork for an interface.</p>
<p><strong>Local binding subnet mask binary.</strong> Binary representation of
the local binding subnet mask.</p>
<p><strong>Local binding type.</strong> The possible values are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">Dynamic</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Static</td>
</tr>
</table>
<p><strong>Next hop.</strong> The internet address of the first system on the
path from your system to the route destination in dotted decimal notation. The
following are special values:</p>
<p>*DIRECT</p>
<p>This is the next hop value of a route that is automatically created. When an
interface is added to this system, a route to the network the interface
attaches to is also created.</p>
<p><strong>Next hop binary.</strong> The binary represenation of the next hop.
For *DIRECT this will be the local binding network address.</p>
<p><strong>Reserved.</strong> An ignored field.</p>
<p><strong>Route destination.</strong> The Internet Protocol (IP) address, in
dotted decimal notation, of the ultimate destination reached by this route.
When used in combination with the subnet mask and the type of service values,
the route destination identifies a route to a network or system.</p>
<p><strong>Route destination binary.</strong> The binary representation of the
route destination.</p>
<p><strong>Route MTU.</strong> A number representing the maximum transmission
unit (MTU) value for this route in bytes. The following are special values:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top" nowrap><em>-1</em></td>
<td align="left" valign="top">OTHER -
<ul>
<li>IPI - An Internet Protocol (IP) over Internetwork Pack Exchange (IPX)
interface.</li>
<li>IPS - An Internet Protocol (IP) over SNA interface.</li>
</ul>
<p><strong>Note:</strong> As of V5R2,
IP over IPX is no longer supported.</p>
</td>
</tr>
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">IFC - The route is not currently active and the
MTU was specified as *IFC.</td>
</tr>
</table>
<p><strong>Route precedence.</strong> Identify priority of route, range 1-10.
Lowest priority being 1.</p>
<p><strong>Route source.</strong> Specifies how this route was added to the IP
routing tables.&nbsp; The possible values are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top" nowrap><em>-1</em></td>
<td align="left" valign="top">OTHER - The route was added by a sockets
input/output control (IOCtl) or other mechanism.</td>
</tr>
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">CFG - The route was added with system
configuration commands.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">ICMP - The route was added by the Internet
Control Message Protocol (ICMP) redirect mechanism.</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">SNMP - The route was added by the Simple Network
Management Protocol (SNMP).</td>
</tr>
<tr>
<td align="left" valign="top"><em>3</em></td>
<td align="left" valign="top">RIP - The route was added by the Routing
Information Protocol (RIP).</td>
</tr>
</table>
<p><strong>Route status.</strong> Indicated whether this route is
available.</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top">1</td>
<td align="left" valign="top">YES - The router specified by the next hop value
for this interface is available for use.&nbsp; This route is included amoung
the routes considered when datagram routing is performed by TCP/IP.</td>
</tr>
<tr>
<td align="left" valign="top">2</td>
<td align="left" valign="top">NO - The router specified by the next hop value
for this interface is not available for use, interface is not active.&nbsp;
This route is not included amoung the routes considered when datagram routing
is performed.</td>
</tr>
<tr>
<td align="left" valign="top">3</td>
<td align="left" valign="top">DOD - This route is used for Point-to-Point (PPP)
Dial-on-Demand.&nbsp; Currently, this Dial-on-Demand route is not
available.&nbsp; The route will become available when a Dial-on-Demand session
is initiated for the interface this route is associated with.</td>
</tr>
<tr>
<td align="left" valign="top">4</td>
<td align="left" valign="top">NO GATEWAY - The router specified by the next hop
value for this interface is not available for use, the router may be
experiencing a problem.</td>
</tr>
</table>
<p><strong>Route type.</strong> The route types are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top">0</td>
<td align="left" valign="top">DFTROUTE - A default route.</td>
</tr>
<tr>
<td align="left" valign="top">1</td>
<td align="left" valign="top">DIRECT - A route to a network or subnetwork to
which this system has a direct physical connection.</td>
</tr>
<tr>
<td align="left" valign="top">2</td>
<td align="left" valign="top">HOST - A route to a specific remote host.</td>
</tr>
<tr>
<td align="left" valign="top">3</td>
<td align="left" valign="top">SUBNET - An indirect route to a remote
subnetwork.</td>
</tr>
<tr>
<td align="left" valign="top">4</td>
<td align="left" valign="top">NET - An indirect route to a remote network.</td>
</tr>
</table>
<p><strong>Subnet mask.</strong> The actual value of the subnet mask in dotted
decimal notation.</p>
<p><strong>Subnet mask binary.</strong> The binary representation of the subnet
mask.</p>
<p><strong>Type of service.</strong> Defines how the internet hosts and routers
should make trade-offs between throughput, delay, reliability and cost. The
following are special values:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top" nowrap>-1</td>
<td align="left" valign="top">OTHER -
<ul>
<li>IPI - An Internet Protocol (IP) over Internetwork Pack Exchange (IPX)
interface.</li>
<li>IPS - An Internet Protocol (IP) over SNA interface.</li>
</ul>
<p><strong>Note:</strong> As of V5R2,
IP over IPX is no longer supported.</p>
</td>
</tr>
<tr>
<td align="left" valign="top">1</td>
<td align="left" valign="top">NORMAL - Used for delivery of datagrams.</td>
</tr>
<tr>
<td align="left" valign="top">2</td>
<td align="left" valign="top">MINDELAY - Prompt delivery of datagrams with the
minimize delay indication.</td>
</tr>
<tr>
<td align="left" valign="top">3</td>
<td align="left" valign="top">MAXTHRPUT - Datagrams with maximize throughput
indication.</td>
</tr>
<tr>
<td align="left" valign="top">4</td>
<td align="left" valign="top">MAXRLB - Datagrams with maximize reliability
indication.</td>
</tr>
<tr>
<td align="left" valign="top">5</td>
<td align="left" valign="top">MINCOST - Datagrams with minimize monetary cost
indication.</td>
</tr>
</table>
<br>
<h3><a name="NRTE0200">NRTE0200
Format</a></h3>
<p>The following information about each TCP/IPv6 route is returned for the
NRTE0200 format. For detailed descriptions of the fields in the table, see <a
href="#NRTE0200_FIELD">Field Descriptions</a>.</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(45)</td>
<td align="left" valign="top" width="60%">Route destination</td>
</tr>
<tr>
<td align="center" valign="top">45</td>
<td align="center" valign="top">2D</td>
<td align="left" valign="top">CHAR(3)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">48</td>
<td align="center" valign="top">30</td>
<td align="left" valign="top">CHAR(16)</td>
<td align="left" valign="top">Route destination binary</td>
</tr>
<tr>
<td align="center" valign="top">64</td>
<td align="center" valign="top">40</td>
<td align="left" valign="top">CHAR(3)</td>
<td align="left" valign="top">Prefix length</td>
</tr>
<tr>
<td align="center" valign="top">67</td>
<td align="center" valign="top">43</td>
<td align="left" valign="top">CHAR(5)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">72</td>
<td align="center" valign="top">48</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Prefix length binary</td>
</tr>
<tr>
<td align="center" valign="top">76</td>
<td align="center" valign="top">4C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Next hop address family</td>
</tr>
<tr>
<td align="center" valign="top">80</td>
<td align="center" valign="top">50</td>
<td align="left" valign="top">CHAR(45)</td>
<td align="left" valign="top">Next hop IPv6</td>
</tr>
<tr>
<td align="center" valign="top">125</td>
<td align="center" valign="top">7D</td>
<td align="left" valign="top">CHAR(3)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">128</td>
<td align="center" valign="top">80</td>
<td align="left" valign="top">CHAR(16)</td>
<td align="left" valign="top">Next hop IPv6 binary</td>
</tr>
<tr>
<td align="center" valign="top">144</td>
<td align="center" valign="top">90</td>
<td align="left" valign="top">CHAR(15)</td>
<td align="left" valign="top">Next hop IPv4</td>
</tr>
<tr>
<td align="center" valign="top">159</td>
<td align="center" valign="top">9F</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">160</td>
<td align="center" valign="top">A0</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Next hop IPv4 binary</td>
</tr>
<tr>
<td align="center" valign="top">164</td>
<td align="center" valign="top">A4</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Local binding line name</td>
</tr>
<tr>
<td align="center" valign="top">174</td>
<td align="center" valign="top">AE</td>
<td align="left" valign="top">CHAR(2)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">176</td>
<td align="center" valign="top">B0</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Local binding line type</td>
</tr>
<tr>
<td align="center" valign="top">180</td>
<td align="center" valign="top">B4</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Local binding line status</td>
</tr>
<tr>
<td align="center" valign="top">184</td>
<td align="center" valign="top">B8</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Route status</td>
</tr>
<tr>
<td align="center" valign="top">188</td>
<td align="center" valign="top">BC</td>
<td align="left" valign="top">BINARY(8)</td>
<td align="left" valign="top">Route lifetime remaining</td>
</tr>
<tr>
<td align="center" valign="top">196</td>
<td align="center" valign="top">C4</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Route lifetime at creation</td>
</tr>
<tr>
<td align="center" valign="top">200</td>
<td align="center" valign="top">C8</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Route source</td>
</tr>
<tr>
<td align="center" valign="top">204</td>
<td align="center" valign="top">CC</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Route type</td>
</tr>
<tr>
<td align="center" valign="top">208</td>
<td align="center" valign="top">D0</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Configured route MTU</td>
</tr>
<tr>
<td align="center" valign="top">212</td>
<td align="center" valign="top">D4</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Actual route MTU</td>
</tr>
<tr>
<td align="center" valign="top">216</td>
<td align="center" valign="top">D8</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Is on-link</td>
</tr>
<tr>
<td align="center" valign="top">220</td>
<td align="center" valign="top">DC</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Duplicate indicator</td>
</tr>
<tr>
<td align="center" valign="top">224</td>
<td align="center" valign="top">E0</td>
<td align="left" valign="top">CHAR(8)</td>
<td align="left" valign="top">Change date</td>
</tr>
<tr>
<td align="center" valign="top">232</td>
<td align="center" valign="top">E8</td>
<td align="left" valign="top">CHAR(6)</td>
<td align="left" valign="top">Change time</td>
</tr>
<tr>
<td align="center" valign="top">238</td>
<td align="center" valign="top">EE</td>
<td align="left" valign="top">CHAR(8)</td>
<td align="left" valign="top">Expiration date</td>
</tr>
<tr>
<td align="center" valign="top">246</td>
<td align="center" valign="top">F6</td>
<td align="left" valign="top">CHAR(6)</td>
<td align="left" valign="top">Expiration time</td>
</tr>
<tr>
<td align="center" valign="top"><img src="delta.gif" alt="Start of change">252</td>
<td align="center" valign="top">FC</td>
<td align="left" valign="top">CHAR(50)</td>
<td align="left" valign="top">Text description</td>
</tr>
<tr>
<td align="center" valign="top">302</td>
<td align="center" valign="top">12E</td>
<td align="left" valign="top">CHAR(2)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">304</td>
<td align="center" valign="top">130</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Text description CCSID<img src="deltaend.gif" alt="End of change"></td>
</tr>
<tr>
<td align="center" valign="top">308</td>
<td align="center" valign="top">134</td>
<td align="left" valign="top">&nbsp;</td>
<td align="left" valign="top">&nbsp;</td>
</tr>
</table>
<br>
<br>
<h3><a name="NRTE0200_FIELD">Field Descriptions</a></h3>
<p><strong>Actual route MTU.</strong> A number representing the maximum
transmission unit (MTU) value for this route in bytes.</p>
<p>The following is a special value:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">*IP6LINMTU - The route is not currently active
and the MTU was specified as *IP6LINMTU, the MTU value of the line to which
this route is bound.</td>
</tr>
</table>
<p><strong>Change date.</strong> The date of the most recent change to this
route in the dynamic tables used by the TCP/IPv6 protocol stack. It is returned
as 8 characters in the form YYYYMMDD, where:</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top">YYYY</td>
<td align="left" valign="top">Year</td>
</tr>
<tr>
<td align="left" valign="top">MM</td>
<td align="left" valign="top">Month</td>
</tr>
<tr>
<td align="left" valign="top">DD</td>
<td align="left" valign="top">Day</td>
</tr>
</table>
<p><strong>Change time.</strong> The time of the most recent change to this
route in the dynamic tables used by the TCP/IPv6 protocol stack. It is returned
as 6 characters in the form HHMMSS, where:</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top">HH</td>
<td align="left" valign="top">Hour</td>
</tr>
<tr>
<td align="left" valign="top">MM</td>
<td align="left" valign="top">Minute</td>
</tr>
<tr>
<td align="left" valign="top">SS</td>
<td align="left" valign="top">Second</td>
</tr>
</table>
<p><strong>Configured route MTU.</strong> A number representing the configured
maximum transmission unit (MTU) value for this route in bytes.</p>
<p>The following is a special value:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">*IP6LINMTU - The route MTU was specified as
*IP6LINMTU, the MTU value of the line to which this route is bound.</td>
</tr>
</table>
<p><strong>Duplicate indicator.</strong> Indicates whether this route is a
duplicate of another route in the routing table or not, and also whether there
are any routes which are duplicates of this route. Use the Route status field
to determine whether the route is in use or not.</p>
<p>Possible values are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">This route is not a duplicate of another route
and it does not have any duplicates.</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">This route is not a duplicate of another route
but it does have duplicates.</td>
</tr>
<tr>
<td align="left" valign="top"><em>3</em></td>
<td align="left" valign="top">This route is a duplicate of another route.</td>
</tr>
</table>
<p><strong>Expiration date.</strong> The date when this route will expire or
did expire. If the Expiration date and time are in the future, the route has
not expired yet. If the Expiration date and time are in the past, then this
route has expired and is still being returned for a short period of time to
indicate that the route ceased to function because its lifetime expired. The
Expiration date is returned as 8 characters in the form YYYYMMDD.</p>
<p>The meaning of the characters is as follows:</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top">YYYY</td>
<td align="left" valign="top">Year</td>
</tr>
<tr>
<td align="left" valign="top">MM</td>
<td align="left" valign="top">Month</td>
</tr>
<tr>
<td align="left" valign="top">DD</td>
<td align="left" valign="top">Day</td>
</tr>
</table>
<p>The following is a special value:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top" nowrap><em>00000000</em></td>
<td align="left" valign="top">Infinite - this route has an infinite lifetime
which never expires.</td>
</tr>
</table>
<p><strong>Expiration time.</strong> The time when this route will expire or
has expired. If the Expiration date and time are in the future, the route has
not expired yet. If the Expiration date and time are in the past, then this
route has expired and is still being returned for a short period of time to
indicate that the route ceased to function because its lifetime expired. The
Expiration time is returned as 6 characters in the form HHMMSS.</p>
<p>The meaning of the characters is as follows:</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top">HH</td>
<td align="left" valign="top">Hour</td>
</tr>
<tr>
<td align="left" valign="top">MM</td>
<td align="left" valign="top">Minute</td>
</tr>
<tr>
<td align="left" valign="top">SS</td>
<td align="left" valign="top">Second</td>
</tr>
</table>
<p>The following is a special value:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top" nowrap><em>000000</em></td>
<td align="left" valign="top">Infinite - this route has an infinite lifetime
which never expires.</td>
</tr>
</table>
<p><strong>Is on-link.</strong> Indicates whether this route is for a directly
attached prefix (network) or not.</p>
<p>Possible values are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">Unknown, the on-link status of this route is
undetermined.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Yes, this is a route to a directly attached
prefix.</td>
</tr>
</table>
<p><img src="delta.gif" alt="Start of change"><strong>Note:</strong>
As of V5R4, this field is no longer available and is always set to 0.
<img src="deltaend.gif" alt="End of change"></p>
<p><strong>Local binding line name.</strong> The name of the communications
line description to which this route is bound. This field is NULL padded.</p>
<p>The following are special values:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*LOOPBACK</em></td>
<td align="left" valign="top">This route is bound to the loopback interface.
Processing associated with the loopback interface does not extend to a physical
line.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*VIRTUALIP</em></td>
<td align="left" valign="top">The virtual interface is a circuitless interface.
It is used in conjunction with the associated local interface (LCLIFC) when
adding standard interfaces.
<p><img src="delta.gif" alt="Start of change"><strong>Note:</strong>
As of V5R4, this value is no longer supported.
<img src="deltaend.gif" alt="End of change"></p></td>
</tr>
<tr>
<td align="left" valign="top"><em>*OPC</em></td>
<td align="left" valign="top">This interface is attached to the optical bus
(OptiConnect).
<p><img src="delta.gif" alt="Start of change"><strong>Note:</strong>
As of V5R4, this value is no longer supported.
<img src="deltaend.gif" alt="End of change"></p></td>
</tr>
<tr>
<td align="left" valign="top"><em>*TNLCFG64</em></td>
<td align="left" valign="top">This interface is bound to a configured 6-4
tunneling line.
<p><img src="delta.gif" alt="Start of change"><strong>Note:</strong>
As of V5R4, this value is no longer supported.
<img src="deltaend.gif" alt="End of change"></p></td>
</tr>
</table>
<p><strong>Local binding line status.</strong> The current operational status
of the communications line to which this route is bound.</p>
<p>Possible values are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Active - The line is operational.</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">Inactive - The line is not operational.</td>
</tr>
<tr>
<td align="left" valign="top"><em>3</em></td>
<td align="left" valign="top">Failed - The desired state of the line is Active,
but it is currently in the Inactive state.</td>
</tr>
</table>
<p><strong>Local binding line type.</strong> Indicates the type of line to
which this route is bound.</p>
<p>Possible values are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top" nowrap><em>-1</em></td>
<td align="left" valign="top">OTHER</td>
</tr>
<tr>
<td align="left" valign="top"><em>-2</em></td>
<td align="left" valign="top">NONE - Line is not defined. This value is used
for the following interface: *LOOPBACK. There is no line
type value for this interface.</td>
</tr>
<tr>
<td align="left" valign="top"><em>-3</em></td>
<td align="left" valign="top">ERROR - This value is displayed if any system
errrors other than those for *NOTFND are received while trying to determine the
link type for an interface.</td>
</tr>
<tr>
<td align="left" valign="top"><em>-4</em></td>
<td align="left" valign="top">NOTFND - Not found. This value is displayed if
the line description object for this interface cannot be found.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">ELAN - Ethernet local area network protocol.</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">TRLAN - Token-ring local area network
protocol.</td>
</tr>
<tr>
<td align="left" valign="top"><em>3</em></td>
<td align="left" valign="top">FR - Frame relay network protocol.</td>
</tr>
<tr>
<td align="left" valign="top"><em>4</em></td>
<td align="left" valign="top">ASYNC - Asynchronous communications
protocol.</td>
</tr>
<tr>
<td align="left" valign="top"><em>5</em></td>
<td align="left" valign="top">PPP - Point-to-point Protocol.</td>
</tr>
<tr>
<td align="left" valign="top"><em>6</em></td>
<td align="left" valign="top">WLS - Wireless local area network protocol.</td>
</tr>
<tr>
<td align="left" valign="top"><em>7</em></td>
<td align="left" valign="top">X.25 - X.25 protocol.</td>
</tr>
<tr>
<td align="left" valign="top"><em>8</em></td>
<td align="left" valign="top">DDI - Distributed Data Interface protocol.</td>
</tr>
<tr>
<td align="left" valign="top"><em>9</em></td>
<td align="left" valign="top">TDLC - Twinaxial Datalink Control. Used for
TCP/IP over Twinax.</td>
</tr>
<tr>
<td align="left" valign="top"><em>10</em></td>
<td align="left" valign="top">L2TP (Virtual PPP) - Layer Two Tunneling
Protocol.</td>
</tr>
<tr>
<td align="left" valign="top"><em>11</em></td>
<td align="left" valign="top">IPv6 Tunneling Line - Any kind of IPv6 over IPv4
tunnel.
<p><img src="delta.gif" alt="Start of change"><strong>Note:</strong>
As of V5R4, TRLAN, FR, ASYNC, PPP, WLS, X.25, DDI, TDLC, L2TP and IPv6 Tunneling
Line values are no longer supported.
<img src="deltaend.gif" alt="End of change"></p></td>
</tr>
</table>
<p><strong>Next hop address family.</strong> The address family of the Next Hop
address for this route. Use this field to determine whether the IPv4 or IPv6
Next Hop field contains the value of the next hop.</p>
<p>Possible values are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">AF_INET - The next hop is an IPv4 address. Use
the Next hop IPv4 fields.</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">AF_INET6 - The next hop is an IPv6 address. Use
the Next hop IPv6 fields.</td>
</tr>
</table>
<p><img src="delta.gif" alt="Start of change"><strong>Note:</strong>
As of V5R4, AF_INET is no longer supported for next hop address family.
<img src="deltaend.gif" alt="End of change"></p>
<p><strong>Next hop IPv4.</strong> The IPv4 internet address of the first
system on the path from this system to the route destination in dotted-decimal
format. The next hop will only be an IPv4 address when the route uses an IPv6
over IPv4 tunnel. This field is only valid when the value of the Next hop
address family field is AF_INET. This field is NULL padded</p>
<p><img src="delta.gif" alt="Start of change"><strong>Note:</strong>
As of V5R4, this field is no longer available and is always set to 0.
<img src="deltaend.gif" alt="End of change"></p>
<p><strong>Next hop IPv4 binary.</strong> The binary representation of the Next
hop IPv4 field. This field is only valid when the value of the Next hop address
family field is AF_INET.</p>
<p><img src="delta.gif" alt="Start of change"><strong>Note:</strong>
As of V5R4, AF_INET is no longer supported for a next hop address family.
As a result, the value in this field is no longer valid.
<img src="deltaend.gif" alt="End of change"></p>
<p><strong>Next hop IPv6.</strong> The IPv6 internet address of the first
system on the path from your system to the route destination in IPv6 address
format. This field is only valid when the value of the Next hop address family
field is AF_INET6. This field is NULL padded.</p>
<p>The following special value may be returned:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*DIRECT</em></td>
<td align="left" valign="top">This is the next hop value of a route that is
automatically created. When an interface is added to this system, a route to
the network the interface attaches to is also created.</td>
</tr>
</table>
<p><strong>Next hop IPv6 binary.</strong> The binary representation of the Next
hop IPv6 field. Even though this field is defined as a character field, a
binary IPv6 address is returned in it except when the following special
character values are returned. This field is only valid when the value of the
Next hop address family field is AF_INET6.</p>
<p>The following special value may be returned:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*DIRECT</em></td>
<td align="left" valign="top">This is the next hop value of a route that is
automatically created. When an interface is added to this system, a route to
the network the interface attaches to is also created.</td>
</tr>
</table>
<p><strong>Prefix length.</strong> The prefix length defines how many bits of
the route destination IPv6 address are in the prefix. It is a zoned decimal
number which specifies how many of the left-most bits of the address make up
the prefix. The prefix length is used to generate network and host addresses.
This field is NULL padded.</p>
<p><strong>Prefix length binary.</strong> Binary representation of the prefix
length.</p>
<p><strong>Reserved.</strong> An ignored field.</p>
<p><strong>Route destination.</strong> The Internet Protocol version 6 (IPv6)
address, in IPv6 address format, of the ultimate destination reached by this
route. When used in combination with the prefix length the route destination
identifies a route to a network or system. This field is NULL padded.</p>
<p><strong>Route destination binary.</strong> The binary representation of the
route destination. Even though this field is defined as a character field, a
binary IPv6 address is returned in it.</p>
<p><strong>Route lifetime at creation.</strong> The route lifetime value which
this route had when it was first created, either automatically or by manual
configuration. The route lifetime value is the length of time, in seconds, that
a route remains in the route table. Only routes which are discovered on the
network will have route lifetimes shorter than infinite. Valid values range
from 1 through 4294967295 seconds.</p>
<p>The following is a special value:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">Infinite - this route had an infinite lifetime
when it was created.</td>
</tr>
</table>
<p><img src="delta.gif" alt="Start of change"><strong>Note:</strong>
As of V5R4, the route lifetime at creation field is always set to infinite.
<img src="deltaend.gif" alt="End of change"></p>
<p><strong>Route lifetime remaining.</strong> The length of time, in seconds,
that a route remains in the route table. Only routes which are discovered on
the network will have route lifetimes shorter than infinite. Valid values range
from -31536000 through 4294967295 seconds. Negative values indicate that the
route has expired, but it is being retained for a short period of time to show
why the route ceased to function.</p>
<p>The following is a special value:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top" nowrap><em>-1000000000</em></td>
<td align="left" valign="top">Infinite - this route has an infinite
lifetime.</td>
</tr>
</table>
<p><img src="delta.gif" alt="Start of change"><strong>Note:</strong>
As of V5R4, the route lifetime remaining field is always set to infinite.
<img src="deltaend.gif" alt="End of change"></p>
<p><strong>Route source.</strong> Specifies how this route was added to the
IPv6 routing table.</p>
<p>The possible values are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">Unknown</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">ICMPv6 Redirect - This route was added by the
ICMPv6 redirect mechanism.</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">ICMPv6 Router Advertisement Router Lifetime -
This route was added because of the presence of a non-zero value in the Router
Lifetime field in a Router Advertisement packet received by the system.</td>
</tr>
<tr>
<td align="left" valign="top"><em>3</em></td>
<td align="left" valign="top">ICMPv6 Router Advertisement Prefix Information
Option - This route was added because of the presence of a Prefix Information
Option on a Router Advertisement packet received by the system.</td>
</tr>
<tr>
<td align="left" valign="top"><em>4</em></td>
<td align="left" valign="top">CFG RTE - This route was manually
configured.</td>
</tr>
<tr>
<td align="left" valign="top"><em>5</em></td>
<td align="left" valign="top">CFG IFC - This route was added when because of a
manually configured interface.</td>
</tr>
<tr>
<td align="left" valign="top"><em>6</em></td>
<td align="left" valign="top">Autoconfigured Interface - This route was added
when because of an interface added by stateless autoconfiguration.</td>
</tr>
<tr>
<td align="left" valign="top"><em>7</em></td>
<td align="left" valign="top">RIP - This route was added by the Routing
Information Protocol (RIP).</td>
</tr>
<tr>
<td align="left" valign="top"><em>8</em></td>
<td align="left" valign="top">OSPF - This route was added by the Open Shortest
Path First (OSPF) routing protocol.</td>
</tr>
<tr>
<td align="left" valign="top"><em>9</em></td>
<td align="left" valign="top">ROUTING - This route was determined to be
necessary and added by the TCP/IP stack on this system.</td>
</tr>
</table>
<p><strong>Route status.</strong> The current state of the route.</p>
<p>Possible values are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">Unknown</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Active - This route is currently active and is in
the current route search path.</td>
</tr>
<tr>
<td align="left" valign="top"><em>3</em></td>
<td align="left" valign="top">Inactive - This route is not in the current route
search path, and is not being used.</td>
</tr>
</table>
<p><strong>Route type.</strong> The type of route that this route is.</p>
<p>Possible values are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">Unknown</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">DFTROUTE - A default route.</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">DIRECT - A route to a network to which this
system has a direct physical connection.</td>
</tr>
<tr>
<td align="left" valign="top"><em>3</em></td>
<td align="left" valign="top">HOST - A route to a specific remote host.</td>
</tr>
<tr>
<td align="left" valign="top"><em>4</em></td>
<td align="left" valign="top">NET - An indirect route to a remote network.</td>
</tr>
</table>
<p><img src="delta.gif" alt="Start of change"><strong>Text description.</strong> User
added text description associated with the route.</p>
<p><strong>Text description CCSID.</strong> Coded character set ID for the text description.
<img src="deltaend.gif" alt="End of change"> </p>
<br>
<br>
<h3>Error Messages</h3>
<table width="100%" cellpadding="5">
<!-- cols="15 85" -->
<tr>
<th align="left" valign="top">Message ID</th>
<th align="left" valign="top">Error Message Text</th>
</tr>
<tr>
<td width="15%" valign="top">TCP84C0 E</td>
<td width="85%" valign="top">TCP/IP stack not active.</td>
</tr>
<tr>
<td align="left" valign="top">TCP84C5 E</td>
<td align="left" valign="top">API error providing TCP/IP Network Status list
information.</td>
</tr>
<tr>
<td align="left" valign="top">TCP84C6 E</td>
<td align="left" valign="top">Internal operations error - RESULT &amp;1 CC
&amp;2 RC &amp;3 ERRNO &amp;4.</td>
</tr>
<tr>
<td align="left" valign="top">TCP84C9 I</td>
<td align="left" valign="top">Information returned incomplete.</td>
</tr>
<tr>
<td align="left" valign="top">CPF0F03 E</td>
<td align="left" valign="top">Error in retrieving the user space that was
created by the caller.</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">CPF3C1E E</td>
<td align="left" valign="top">Required parameter &amp;1 omitted.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C21 E</td>
<td align="left" valign="top">Format name &amp;1 is not valid.</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">CPF3CF2 E</td>
<td align="left" valign="top">API contains a problem. See prior messages to
determine why the failure occurred.</td>
</tr>
<tr>
<td align="left" valign="top">CPF8100 E</td>
<td align="left" valign="top">All CPF81xx messages could be returned. xx is
from 01 to FF.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9801 E</td>
<td align="left" valign="top">Object &amp;2 in library &amp;3 not found.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9802 E</td>
<td align="left" valign="top">Not authorized to object &amp;2 in &amp;3.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9803 E</td>
<td align="left" valign="top">Cannot allocate object &amp;2 in library
&amp;3.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9807 E</td>
<td align="left" valign="top">One or more libraries in library list
deleted.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9808 E</td>
<td align="left" valign="top">Cannot allocate one or more libraries on library
list.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9810 E</td>
<td align="left" valign="top">Library &amp;1 not found.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9820 E</td>
<td align="left" valign="top">Not authorized to use library &amp;1.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9830 E</td>
<td align="left" valign="top">Cannot assign library &amp;1.</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: V5R1
<hr>
<center>
<table cellpadding="2" cellspacing="2" align="center">
<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>
Reference in New Issue View Git Blame Copy Permalink