ibm-information-center/dist/eclipse/plugins/i5OS.ic.cl_5.4.0.1/rmvtcprte.htm

258 lines
13 KiB
HTML
Raw Permalink 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">
<title>Remove TCP/IP Route (RMVTCPRTE)</title>
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
</head>
<body bgcolor="white">
<script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<a name="RMVTCPRTE.Top_Of_Page"></a>
<h2>Remove TCP/IP Route (RMVTCPRTE)</h2>
<table width="100%">
<tr>
<td valign="top" align="left"><b>Where allowed to run: </b>All environments (*ALL)<br>
<b>Threadsafe: </b>No
</td>
<td valign="top" align="right">
<a href="#RMVTCPRTE.PARAMETERS.TABLE">Parameters</a><br>
<a href="#RMVTCPRTE.COMMAND.EXAMPLES">Examples</a><br>
<a href="#RMVTCPRTE.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="RMVTCPRTE"></a>
<p>The Remove TCP/IP Route (RMVTCPRTE) command removes a previously identified route from the Transmission Control Protocol/Internet Protocol (TCP/IP) configuration.
</p>
<p>Five parameter values uniquely define a route. These values are the route destination (RTEDEST), the subnet mask (SUBNETMASK), the type of service (TOS), the internet address of the next system on the route (NEXTHOP), and the preferred binding interface (BINDIFC). For default routes and default multicast routes (*DFTROUTE and *DFTMCAST), the NEXTHOP, TOS and BINDIFC values uniquely define the route because the SUBNETMASK is always *NONE.
</p>
<p>
<b>Note: </b>When a RMVTCPRTE command is entered using option 4 of the Work with TCP/IP Routes display, a confirmation display is shown. This display warns that the removal of a route might affect active TCP connections and that unpredictable results might occur. A confirmation display is not shown when the RMVTCPRTE CL command is issued directly.
</p>
<p><b>Restrictions:</b>
</p>
<ul>
<li>You must have input/output system configuration (*IOSYSCFG) special authority to run this command.
</li>
<li>Attempts to remove a route that is required to reach an existing RSI entry will fail.
</li>
</ul>
</div>
<table width="100%">
<tr><td align="right"><a href="#RMVTCPRTE.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="RMVTCPRTE.PARAMETERS.TABLE">Parameters</a></h3>
<table border="1" cellpadding="4" cellspacing="0">
<!-- col1="10" col2="15" col3="30" col4="10" -->
<tr>
<th bgcolor="aqua" valign="bottom" align="left">Keyword</th>
<th bgcolor="aqua" valign="bottom" align="left">Description</th>
<th bgcolor="aqua" valign="bottom" align="left">Choices</th>
<th bgcolor="aqua" valign="bottom" align="left">Notes</th>
</tr>
<tr>
<td valign="top"><a href="#RMVTCPRTE.RTEDEST"><b>RTEDEST</b></a></td>
<td valign="top">Route destination</td>
<td valign="top"><i>Character value</i>, *DFTROUTE, *DFTMCAST</td>
<td valign="top">Required, Positional 1</td>
</tr>
<tr>
<td valign="top"><a href="#RMVTCPRTE.SUBNETMASK"><b>SUBNETMASK</b></a></td>
<td valign="top">Subnet mask</td>
<td valign="top"><i>Character value</i>, *NONE, *HOST</td>
<td valign="top">Required, Positional 2</td>
</tr>
<tr>
<td valign="top"><a href="#RMVTCPRTE.TOS"><b>TOS</b></a></td>
<td valign="top">Type of service</td>
<td valign="top">*MINDELAY, *MAXTHRPUT, *MAXRLB, *MINCOST, <b><u>*NORMAL</u></b></td>
<td valign="top">Optional, Positional 3</td>
</tr>
<tr>
<td valign="top"><a href="#RMVTCPRTE.NEXTHOP"><b>NEXTHOP</b></a></td>
<td valign="top">Next hop</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RMVTCPRTE.BINDIFC"><b>BINDIFC</b></a></td>
<td valign="top">Preferred binding interface</td>
<td valign="top"><i>Character value</i>, <b><u>*NONE</u></b></td>
<td valign="top">Optional</td>
</tr>
</table>
<table width="100%">
<tr><td align="right"><a href="#RMVTCPRTE.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="RMVTCPRTE.RTEDEST"></a>
<h3>Route destination (RTEDEST)</h3>
<p>Specifies the route destination being removed. You must specify all 4 bytes that make up an internet address though some of the bytes may be equal to 0. For example, a route to all the hosts on the 9.5.11 subnetwork is identified by entering 9.5.11.0 for the route destination. Used in combination with a subnetmask, type of service value, and next hop, the route destination uniquely identifies a route to a network or system.
</p>
<dl>
<dt><b>*DFTROUTE</b></dt>
<dd>Specifies that a default route entry is being removed. A default route entry is used by the system to route data that is being sent to a remote destination that does not have a specific route defined. The default route entries are used based on the availability of the next hop gateway and the type of service (TOS). If the application requests a specific TOS, the TOS of the default route used must match the TOS requested. If no default route is found that matches the requested TOS, the first available default route with a TOS of *NORMAL is used.
</dd>
<dt><b>*DFTMCAST</b></dt>
<dd>Use the *DFTMCAST special value to indicate that the static route you are removing is a default Multicast route. The default Multicast route is used by an application when no specific route is specified.
<p>
<b>Note: </b>When RTEDEST(*DFTMCAST) is specified, then SUBNETMASK(*NONE) must also be specified and the NEXTHOP parameter must be a local TCP/IP interface (on this system).
</p>
</dd>
<dt><b><i>character-value</i></b></dt>
<dd>Specify the route destination being changed. The route destination can be specified in the form <i>nnn.0.0.0</i>, for Class A, <i>nnn.nnn.0.0</i> for Class B, and <i>nnn.nnn.nnn.0</i> for Class C, or <i>nnn.nnn.nnn.nnn</i> for any combination thereof, where <i>nnn</i> is a decimal number ranging from 0 through 255.
<p>Any combination thereof means that you may specify a route, such as 9.5.0.0 to the hosts on the 9.5 subnet, even though all 9.5.x.x addresses are class A network addresses.
</p>
<p>Exceptions:
</p>
<ul>
<li>The first byte (octet) must be greater than 0 and less than 255.
</li>
<li>The last byte (octet) may not equal 255.
</li>
<li>The last byte (octet) may not equal 0 if *HOST is specified for the SUBNETMASK value.
</li>
<li>Routes to a broadcast address are not allowed.
</li>
</ul>
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RMVTCPRTE.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RMVTCPRTE.SUBNETMASK"></a>
<h3>Subnet mask (SUBNETMASK)</h3>
<p>Specifies a bit mask that identifies to TCP/IP which bits of the value specified for the route destination (RTEDEST) compose the network and subnet portions of the internet address. By defining the network portion and subnetwork portion of the RTEDEST address, the subnet mask also defines which bits of the RTEDEST address make up the host portion. The mask is a 32-bit combination that is logically ANDed with the internet address to determine a particular subnetwork. The bits of the mask set to the value one (1) determine the network and subnetwork portions of the address. The bits set to the value zero (0) determine the host portion of the address.
</p>
<dl>
<dt><b>*NONE</b></dt>
<dd>No subnet mask is used. A subnet mask is not used when specifying default routes. For example, when RTEDEST(*DFTMCAST) or RTEDEST(*DFTROUTE) is specified, SUBNETMASK(*NONE) must also be specified.
</dd>
<dt><b>*HOST</b></dt>
<dd>The internet address value specified in the route destination field is a host address. The subnetmask value is calculated to be 255.255.255.255.
</dd>
<dt><b><i>character-value</i></b></dt>
<dd>Specify the mask of the subnet field. The internet address is in the form <i>nnn.nnn.nnn.nnn</i>, where <i>nnn</i> is a decimal number ranging from 0 through 255. The subnetmask network class's network ID part of the destination route's internet address must equal 255. For example, a destination route's internet address value of 129.35.11.0 is a Class B subnet. The network ID part of its address is 129.35. The upper 2 bytes must designate 255 in the subnetmask. The subnetmask must appear in the format 255.255.x.x, where x is determined by the user. The portion of the subnetmask that is associated with the network portion of a particular class of address must equal 255.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RMVTCPRTE.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RMVTCPRTE.TOS"></a>
<h3>Type of service (TOS)</h3>
<p>Specifies the type of service to be used. The type of service defines how the internet hosts and routers should make trade-offs between throughput, delay, reliability, and cost.
</p>
<p>*NORMAL: Normal service is used for delivery of data.
</p>
<p>*MINDELAY: Minimize delay means that prompt delivery is important for data on this connection.
</p>
<p>*MAXTHRPUT: Maximize throughput means that a high data rate is important for data on this connection.
</p>
<p>*MAXRLB: Maximize reliability means that a higher level of effort to ensure delivery is important for data on this connection.
</p>
<p>*MINCOST: Minimize monetary cost means that lower cost is important for data on this connection.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RMVTCPRTE.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RMVTCPRTE.NEXTHOP"></a>
<h3>Next hop (NEXTHOP)</h3>
<p>Specifies the internet address of the next system (gateway) on the route.
</p>
<dl>
<dt><b><i>character-value</i></b></dt>
<dd>Specify the internet address. The internet address is specified in the form <i>nnn.nnn.nnn.nnn</i>, where <i>nnn</i> is a decimal number ranging from 0 through 255. An internet address is not valid if it has a value of all binary ones or all binary zeros for the network identifier (ID) portion or the host ID portion of the address. If the internet address is entered from a command line, the address must be enclosed in apostrophes.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RMVTCPRTE.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RMVTCPRTE.BINDIFC"></a>
<h3>Preferred binding interface (BINDIFC)</h3>
<p>Preferred Binding Interface (BINDIFC). Specify the IP interface this route will be bound to. The bind is absolute.
</p>
<p>
<b>Note: </b>This parameter is useful only when there are multiple interfaces defined on your system for the same network. BINDIFC allows you to define which interface should be used to reach the network for a particular route destination. In this way you can distribute traffic (load balancing) across multiple interfaces so all routes do not use the same interface to reach the network.
</p>
<p>If the IP interface you specify is active, this route will bind to it, otherwise it will follow the normal route binding rules (which are also used when BINDIFC is defined as *NONE).
</p>
<dl>
<dt><b><u>*NONE</u></b></dt>
<dd>No particular IP interface will be bound to this route. The first active IP interface on the network defined by the NEXTHOP and SUBNETMASK parameters will be used. This is the default value.
</dd>
<dt><b><i>character-value</i></b></dt>
<dd>Specify the internet address (IP address) of the interface you want this route to bind to.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RMVTCPRTE.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="RMVTCPRTE.COMMAND.EXAMPLES">Examples</a> </h3>
<p><b>Example 1: Removing a Route</b>
</p>
<p>
<pre>
RMVTCPRTE RTEDEST('132.65.0.0') SUBNETMASK('255.65.0.0')
TOS(*MINDELAY) NEXTHOP('9.5.15.1')
</pre>
</p>
<p>This command removes the route identified as 132.65.0.0 with a subnetmask of 255.65.0.0, a type of service of *MINDELAY, and a next hop of 9.5.15.1.
</p>
<p><b>Example 2: Removing a Default Route</b>
</p>
<p>
<pre>
RMVTCPRTE RTEDEST(*DFTROUTE) SUBNETMASK(*NONE)
NEXTHOP('186.34.76.92')
</pre>
</p>
<p>This command removes a host route identified as a default route (*DFTROUTE). The subnetmask is specified as *NONE and the type of service defaults to *NORMAL. The subnetmask, type of service, and next-hop value differentiate this *DFTROUTE from the other possible eight *DFTROUTE entries.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RMVTCPRTE.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="RMVTCPRTE.ERROR.MESSAGES">Error messages</a> </h3>
<p><b><u>*ESCAPE Messages</u></b>
</p>
<dl>
<dt><b>TCP1D03</b></dt>
<dd>&amp;1 member record length not correct.
</dd>
<dt><b>TCP1D04</b></dt>
<dd>Error occurred processing member &amp;1 of &amp;2/&amp;3.
</dd>
<dt><b>TCP1901</b></dt>
<dd>Internet address &amp;1 not valid.
</dd>
<dt><b>TCP261C</b></dt>
<dd>Process completed successfully.
</dd>
<dt><b>TCP264A</b></dt>
<dd>&amp;2 &amp;1 not removed.
</dd>
<dt><b>TCP8050</b></dt>
<dd>*IOSYSCFG authority required to use &amp;1.
</dd>
<dt><b>TCP9999</b></dt>
<dd>Internal system error in program &amp;1.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RMVTCPRTE.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>