361 lines
11 KiB
HTML
361 lines
11 KiB
HTML
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
||
|
|
<html>
|
||
|
|
<head>
|
||
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||
|
|
<meta name="Copyright" content="Copyright (c) 2006 by IBM Corporation">
|
||
|
|
<title>Change IPv4 Interface (QTOCCHGIF) 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 V5R4 on 041115 by cmwood -->
|
||
|
|
<!-- Change history: -->
|
||
|
|
<!-- 041115 cmwood created, DCR 93267 -->
|
||
|
|
<!-- End Header Records -->
|
||
|
|
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
<!-- Java sync-link =================================================== -->
|
||
|
|
<script type="text/javascript" language="Javascript" src="../rzahg/synch.js">
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<a name="Top_Of_Page"></a>
|
||
|
|
|
||
|
|
<h2><img src="delta.gif" alt="Start of change">Change IPv4 Interface (QTOCC4IF) API</h2>
|
||
|
|
|
||
|
|
<div class="box" style="width: 90%;">
|
||
|
|
<br>
|
||
|
|
Required Parameter Group:<br>
|
||
|
|
<br>
|
||
|
|
<br>
|
||
|
|
<table width="100%">
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">1</td>
|
||
|
|
<td align="left" valign="top">Interface information</td>
|
||
|
|
<td align="left" valign="top">Input</td>
|
||
|
|
<td align="left" valign="top">Char(*)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top" width="10%">2</td>
|
||
|
|
<td align="left" valign="top" width="50%">Format name</td>
|
||
|
|
<td align="left" valign="top" width="20%">Input</td>
|
||
|
|
<td align="left" valign="top" width="20%">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>
|
||
|
|
Default Public Authority: *USE<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
Threadsafe: Yes<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<p>The Change IPv4 Interface (QTOCC4IF) API is used to change selected parameters
|
||
|
|
for an IPv4 interface that is defined in the system's TCP/IP configuration.</p>
|
||
|
|
<br>
|
||
|
|
<h3>Authorities and Locks</h3>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><em>Special Authority</em></dt>
|
||
|
|
|
||
|
|
<dd>The caller of this API must be running under a user profile that has input/output system configuration (*IOSYSCFG) special authority.
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
<h3>Required Parameter Group</h3>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><strong>Interface Information</strong></dt>
|
||
|
|
<dd>INPUT; CHAR(*)
|
||
|
|
<p>Contains the characteristics of the IPv4 interface being changed.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
|
||
|
|
<dt><strong>Format name</strong></dt>
|
||
|
|
<dd>INPUT; CHAR(8)
|
||
|
|
<p>The format of the interface information parameter. The format name supported is:</p>
|
||
|
|
<dl>
|
||
|
|
<dt><em>IFCH0100</em></dt>
|
||
|
|
<dd>Format for adding or changing an IPv4 interface parameter. For the format of the structure,
|
||
|
|
see <a href="#InterfaceDefinition">IFCH0100 Format</a>.</dd>
|
||
|
|
</dl>
|
||
|
|
</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 refer to <a href="../apiref/error.htm#hdrerrcod">Error Code Parameter</a>.</p>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
<h3><a name="InterfaceDefinition">IFCH0100 Format</a></h3>
|
||
|
|
|
||
|
|
For detailed descriptions of the fields in this table, see <a href="#Header_8"> Field Descriptions</a>.
|
||
|
|
|
||
|
|
<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="left" valign="bottom">Dec</th>
|
||
|
|
<th align="left" 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%">Length of fixed interface information</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">4</td>
|
||
|
|
<td align="center" valign="top">4</td>
|
||
|
|
<td align="left" valign="top">CHAR(15)</td>
|
||
|
|
<td align="left" valign="top">Internet address</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">19</td>
|
||
|
|
<td align="center" valign="top">13</td>
|
||
|
|
<td align="left" valign="top">CHAR(1)</td>
|
||
|
|
<td align="left" valign="top">Reserved</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">20</td>
|
||
|
|
<td align="center" valign="top">14</td>
|
||
|
|
<td align="left" valign="top">BINARY(4)</td>
|
||
|
|
<td align="left" valign="top">Proxy ARP allowed</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">24</td>
|
||
|
|
<td align="center" valign="top">18</td>
|
||
|
|
<td align="left" valign="top">BINARY(4)</td>
|
||
|
|
<td align="left" valign="top">Offset to preferred interface list</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">28</td>
|
||
|
|
<td align="center" valign="top">1C</td>
|
||
|
|
<td align="left" valign="top">BINARY(4)</td>
|
||
|
|
<td align="left" valign="top">Number of entries in preferred interface list</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">32</td>
|
||
|
|
<td align="center" valign="top">20</td>
|
||
|
|
<td align="left" valign="top">BINARY(4)</td>
|
||
|
|
<td align="left" valign="top">Length of one preferred interface list entry</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">36</td>
|
||
|
|
<td align="center" valign="top">24</td>
|
||
|
|
<td align="left" valign="top">CHAR(24)</td>
|
||
|
|
<td align="left" valign="top">Interface name</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top" colspan=2>This field repeats for each preferred interface list entry</td>
|
||
|
|
<td align="left" valign="top">CHAR(*)</td>
|
||
|
|
<td align="left" valign="top">Preferred interface list entry (See Format of Preferred
|
||
|
|
Interface List Entry for more information.) </td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
</table>
|
||
|
|
<br>
|
||
|
|
<br>
|
||
|
|
<h3><a name="Header_7">Format of Preferred Interface List Entry</a></h3>
|
||
|
|
<P>The preferred interface list entry describes the data specified for each
|
||
|
|
entry in the preferred interface list of the IFCH0100 format.
|
||
|
|
For detailed descriptions of the fields in the table, see Field Descriptions.</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="left" valign="bottom">Dec</th>
|
||
|
|
<th align="left" valign="bottom">Hex</th>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">0</td>
|
||
|
|
<td align="center" valign="top">0</td>
|
||
|
|
<td align="left" valign="top">CHAR(15)</td>
|
||
|
|
<td align="left" valign="top">Preferred interface internet address</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">15</td>
|
||
|
|
<td align="center" valign="top">0F</td>
|
||
|
|
<td align="left" valign="top">CHAR(1)</td>
|
||
|
|
<td align="left" valign="top">Reserved</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
</table>
|
||
|
|
<br><br>
|
||
|
|
<h3><a name="Header_8">Field Descriptions</a></h3>
|
||
|
|
|
||
|
|
<p><strong>Interface name.</strong> Specifies a textual description of this interface.
|
||
|
|
Up to 24 characters, padded with blanks, may be specified. A value of *SAME means
|
||
|
|
that the interface name does not change.</p>
|
||
|
|
|
||
|
|
<p><strong>Internet address.</strong> The IPv4 internet address, in dotted decimal
|
||
|
|
notation, of an interface.</p>
|
||
|
|
|
||
|
|
<p><strong>Length of fixed interface information.</strong> This field contains
|
||
|
|
the number of bytes specified in the fixed portion of the interface information
|
||
|
|
structure. The minimum value for this field is 24.</p>
|
||
|
|
|
||
|
|
<P><strong>Length of one preferred interface list entry.</strong> The length
|
||
|
|
of a preferred interface list entry. A value of zero means that the list will be removed.
|
||
|
|
A value greater than zero means that the list will be replaced. A value of -1 means that
|
||
|
|
the list does not change.</p>
|
||
|
|
|
||
|
|
<P><strong>Number of entries in preferred interface list</strong> The number of
|
||
|
|
entries in the preferred interface list. A value of zero means that the list will be
|
||
|
|
removed. A value greater than zero means that the list will be replaced. A value of -1
|
||
|
|
means that the list does not change. The maximum value for this field is 10.</p>
|
||
|
|
|
||
|
|
<p><strong>Offset to preferred interface list</strong> The offset from the start
|
||
|
|
of the fixed interface information to the beginning of the preferred interface list.
|
||
|
|
A value of zero or greater means that the list will be replaced. A value of -1 means
|
||
|
|
that the list does not change.</p>
|
||
|
|
|
||
|
|
<p><strong>Preferred interface internet address</strong> The internet address, in
|
||
|
|
dotted decimal notation, of an interface in the preferred interface list.</p>
|
||
|
|
|
||
|
|
<p><strong>Preferred interface list entry.</strong> Specifies information about
|
||
|
|
an interface in the preferred interface list. The order
|
||
|
|
in which the list entries are specified is also the order in which the
|
||
|
|
system uses the interfaces as Proxy Agents.</p>
|
||
|
|
|
||
|
|
<p><strong>Proxy ARP allowed.</strong> This field applies to Opticonnect (*OPC)
|
||
|
|
and Virtual Ethernet interfaces only. For those types of interfaces, this field
|
||
|
|
indicates whether Proxy (Address Resolution Protocol) ARP has been configured
|
||
|
|
to be allowed or not allowed.</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="15 85" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>0</em></td>
|
||
|
|
<td align="left" valign="top">NO - Proxy ARP not allowed.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>1</em></td>
|
||
|
|
<td align="left" valign="top">YES - Proxy ARP allowed.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>-1</em></td>
|
||
|
|
<td align="left" valign="top">The value does not change.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p><strong>Reserved.</strong> A reserved field. This field must be set to zero.</p>
|
||
|
|
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<h3>Usage Notes</h3>
|
||
|
|
<p>Typically, if an error is detected during the change operation, a diagnostic message
|
||
|
|
will be sent to the job log. This diagnostic message will contain details about the
|
||
|
|
error. The API will then either signal the error message TCP2658 or return
|
||
|
|
TCP2658 in the error code structure.</p>
|
||
|
|
<br>
|
||
|
|
|
||
|
|
<h3>Error Messages</h3>
|
||
|
|
|
||
|
|
<table width="100%">
|
||
|
|
<tr>
|
||
|
|
<th align="left" valign="top">Message ID</th>
|
||
|
|
<th align="left" valign="top">Error Message Text</th>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF3CF1 E</td>
|
||
|
|
<td valign="top">Error code parameter not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF3CF2 E</td>
|
||
|
|
<td valign="top">Error(s) occurred during running of &1 API.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9872 E</td>
|
||
|
|
<td valign="top">Program or service program &1 in library &2 ended.
|
||
|
|
Reason code &3.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">TCP2658 E</td>
|
||
|
|
<td valign="top">&2 &1 not changed.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">TCP923C E</td>
|
||
|
|
<td valign="top">&1 special authority is required.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">TCP923F E</td>
|
||
|
|
<td valign="top">Value for parameter &2 for API &1 not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
<img src="deltaend.gif" alt="End of change">
|
||
|
|
|
||
|
|
<hr>
|
||
|
|
API introduced: V5R4
|
||
|
|
|
||
|
|
<hr>
|
||
|
|
<center>
|
||
|
|
<table cellpadding="2" cellspacing="2">
|
||
|
|
<tr align="center">
|
||
|
|
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
|
||
|
|
"comm.htm">Communications APIs</a> | <a href="aplist.htm">APIs by
|
||
|
|
category</a></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</center>
|
||
|
|
</body>
|
||
|
|
</html>
|
||
|
|
|