409 lines
18 KiB
HTML
409 lines
18 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">
|
|
<title>Change TCP/IP Route (CHGTCPRTE)</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="CHGTCPRTE.Top_Of_Page"></a>
|
|
<h2>Change TCP/IP Route (CHGTCPRTE)</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="#CHGTCPRTE.PARAMETERS.TABLE">Parameters</a><br>
|
|
<a href="#CHGTCPRTE.COMMAND.EXAMPLES">Examples</a><br>
|
|
<a href="#CHGTCPRTE.ERROR.MESSAGES">Error messages</a></td>
|
|
</tr>
|
|
</table>
|
|
|
|
<div> <a name="CHGTCPRTE"></a>
|
|
<p>The Change TCP/IP Route (CHGTCPRTE) command is used to change an existing route in 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 (*DFROUTE and *DFTMCAST), the NEXTHOP, TOS and BINDIFC values uniquely define the route because the SUBNETMASK is always *NONE.
|
|
</p>
|
|
<p><b>Restrictions:</b>
|
|
</p>
|
|
<ul>
|
|
<li>You must have input/output system configuration (*IOSYSCFG) special authority to run this command.
|
|
</li>
|
|
<li>Only one parameter, the MTU value, can be changed on an existing route entry. The route cannot be in use when attempting to change its MTU value.
|
|
</li>
|
|
<li>Attempts to change 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="#CHGTCPRTE.Top_Of_Page">Top</a></td></tr>
|
|
</table>
|
|
<hr size="2" width="100%">
|
|
|
|
<div>
|
|
<h3><a name="CHGTCPRTE.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="#CHGTCPRTE.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, Key, Positional 1</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top"><a href="#CHGTCPRTE.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, Key, Positional 2</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top"><a href="#CHGTCPRTE.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, Key, Positional 3</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top"><a href="#CHGTCPRTE.NEXTHOP"><b>NEXTHOP</b></a></td>
|
|
<td valign="top">Next hop</td>
|
|
<td valign="top"><i>Character value</i></td>
|
|
<td valign="top">Optional, Key</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top"><a href="#CHGTCPRTE.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, Key</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top"><a href="#CHGTCPRTE.MTU"><b>MTU</b></a></td>
|
|
<td valign="top">Maximum transmission unit</td>
|
|
<td valign="top">576-16388, <b><u>*SAME</u></b>, *IFC</td>
|
|
<td valign="top">Optional</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top"><a href="#CHGTCPRTE.METRIC"><b>METRIC</b></a></td>
|
|
<td valign="top">Route metric</td>
|
|
<td valign="top">1-16, <b><u>*SAME</u></b></td>
|
|
<td valign="top">Optional</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top"><a href="#CHGTCPRTE.REDST"><b>REDST</b></a></td>
|
|
<td valign="top">Route redistribution</td>
|
|
<td valign="top"><b><u>*SAME</u></b>, *YES, *NO</td>
|
|
<td valign="top">Optional</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top"><a href="#CHGTCPRTE.DUPRTEPTY"><b>DUPRTEPTY</b></a></td>
|
|
<td valign="top">Duplicate route priority</td>
|
|
<td valign="top">1-10, <b><u>*SAME</u></b></td>
|
|
<td valign="top">Optional</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<table width="100%">
|
|
<tr><td align="right"><a href="#CHGTCPRTE.Top_Of_Page">Top</a></td></tr>
|
|
</table>
|
|
</div>
|
|
<div> <a name="CHGTCPRTE.RTEDEST"></a>
|
|
<h3>Route destination (RTEDEST)</h3>
|
|
<p>Specifies the route destination being changed. 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 changed. 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 changing 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="#CHGTCPRTE.Top_Of_Page">Top</a></td></tr>
|
|
</table>
|
|
<div> <a name="CHGTCPRTE.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.
|
|
</p>
|
|
<p>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. 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 like 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="#CHGTCPRTE.Top_Of_Page">Top</a></td></tr>
|
|
</table>
|
|
<div> <a name="CHGTCPRTE.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="#CHGTCPRTE.Top_Of_Page">Top</a></td></tr>
|
|
</table>
|
|
<div> <a name="CHGTCPRTE.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 of the next system on the route. 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="#CHGTCPRTE.Top_Of_Page">Top</a></td></tr>
|
|
</table>
|
|
<div> <a name="CHGTCPRTE.BINDIFC"></a>
|
|
<h3>Preferred binding interface (BINDIFC)</h3>
|
|
<p>Specifies 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>Enter 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="#CHGTCPRTE.Top_Of_Page">Top</a></td></tr>
|
|
</table>
|
|
<div> <a name="CHGTCPRTE.MTU"></a>
|
|
<h3>Maximum transmission unit (MTU)</h3>
|
|
<p>Specifies the maximum size (in bytes) of IP datagrams that can be transmitted through this route. A datagram is a basic unit of information passed over an internet network. The minimum size of any maximum transmission unit value is 576 bytes.
|
|
</p>
|
|
<dl>
|
|
<dt><b><u>*SAME</u></b></dt>
|
|
<dd>The existing maximum transmission unit value for this route is used.
|
|
</dd>
|
|
<dt><b>*IFC</b></dt>
|
|
<dd>The maximum transmission unit (MTU) is the MTU of the interface that is associated with this route.
|
|
</dd>
|
|
<dt><b><i>576-16388</i></b></dt>
|
|
<dd>Specify a value for the maximum transmission unit in bytes. The maximum MTU that can be specified for this route depends on the type of physical connection to the network. The following table lists the maximum MTU values that can be specified based on the line type:
|
|
<dl>
|
|
<dt><b>X.25</b></dt>
|
|
<dd>4096
|
|
</dd>
|
|
<dt><b>Token ring (4 meg)</b></dt>
|
|
<dd>4060
|
|
</dd>
|
|
<dt><b>Token ring (16 meg)</b></dt>
|
|
<dd>16388
|
|
</dd>
|
|
<dt><b>Ethernet 802.3</b></dt>
|
|
<dd>1492
|
|
</dd>
|
|
<dt><b>Ethernet Version 2</b></dt>
|
|
<dd>1500
|
|
</dd>
|
|
<dt><b>DDI</b></dt>
|
|
<dd>4352
|
|
</dd>
|
|
<dt><b>Frame relay</b></dt>
|
|
<dd>8177
|
|
</dd>
|
|
<dt><b>Wireless 802.3</b></dt>
|
|
<dd>1492
|
|
</dd>
|
|
<dt><b>Wireless Version 2</b></dt>
|
|
<dd>1500
|
|
</dd>
|
|
<dt><b>Twinax (TDLC)</b></dt>
|
|
<dd>4105
|
|
</dd>
|
|
</dl>
|
|
<p><b>Notes:</b>
|
|
</p>
|
|
<ol>
|
|
<li>TCP/IP uses the route MTU value to calculate the size of the datagrams it sends. For best performance, specify a value that is no smaller than the smallest MTU used by host systems along the entire path of this route. If this information is not available, use the default value of 576.
|
|
</li>
|
|
<li>The MTU of a route cannot exceed the MTU of the interface on which the NEXTHOP value is accessed. If the interface's MTU value was specified as *LIND, the interface's MTU value is derived from the line description. If the route's MTU value is specified as *IFC and the interface's MTU value is specified as *LIND, both values are derived from the line description.
|
|
</li>
|
|
<li>The actual MTU value used for a route is resolved during <u> interface</u> activation. This value is the minimum of either the specified MTU value for the route or the MTU value determined from the associated interface used by the route.
|
|
</li>
|
|
</ol>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<table width="100%">
|
|
<tr><td align="right"><a href="#CHGTCPRTE.Top_Of_Page">Top</a></td></tr>
|
|
</table>
|
|
<div> <a name="CHGTCPRTE.METRIC"></a>
|
|
<h3>Route metric (METRIC)</h3>
|
|
<p>Allows you to assign a routing metric "cost" value to this route. The metric cost of a route is a factor in determining the desirability of the route. The metric value range is from 1 to 16. A metric value of 1 is close (one router hop) and therefore desirable. Desirability decreases as the metric value (distance) increases. A metric value of 16 is considered unreachable (an infinite distance away).
|
|
</p>
|
|
<p>You can discourage the routing table from choosing this route by specifying a metric value that is higher than the actual number of hops to the destination and therefore reduce traffic on this route.
|
|
</p>
|
|
<dl>
|
|
<dt><b><u>*SAME</u></b></dt>
|
|
<dd>The value of the route metric will not change from its current value.
|
|
</dd>
|
|
<dt><b><i>1-16</i></b></dt>
|
|
<dd>Specify a metric value.
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<table width="100%">
|
|
<tr><td align="right"><a href="#CHGTCPRTE.Top_Of_Page">Top</a></td></tr>
|
|
</table>
|
|
<div> <a name="CHGTCPRTE.REDST"></a>
|
|
<h3>Route redistribution (REDST)</h3>
|
|
<p>Specifies whether this static route information will be shared with other routers. You can reduce traffic on this route by specifying *NO.
|
|
</p>
|
|
<dl>
|
|
<dt><b><u>*SAME</u></b></dt>
|
|
<dd>The route distribution value will not change from its current setting.
|
|
</dd>
|
|
<dt><b>*YES</b></dt>
|
|
<dd>*YES means that this route will be shown to any requesting router.
|
|
</dd>
|
|
<dt><b>NO</b></dt>
|
|
<dd>*NO means this route will not be shown or shared with other routers.
|
|
</dd>
|
|
</dl>
|
|
<p>
|
|
<b>Note: </b>REDST(*YES) is analogous to the RIPv1 specification of STATIC. REDST(*NO) is analogours to the RIPv1 SPECIFICATION OF passive.
|
|
</p>
|
|
</div>
|
|
<table width="100%">
|
|
<tr><td align="right"><a href="#CHGTCPRTE.Top_Of_Page">Top</a></td></tr>
|
|
</table>
|
|
<div> <a name="CHGTCPRTE.DUPRTEPTY"></a>
|
|
<h3>Duplicate route priority (DUPRTEPTY)</h3>
|
|
<p>Specify the duplicate route priority of this static route. Routes with a high duplicate route priority (DUPRTEPTY) will be tried before routes with a low one.
|
|
</p>
|
|
<dl>
|
|
<dt><b><u>*SAME</u></b></dt>
|
|
<dd>The priority value metric will not change from its current value.
|
|
</dd>
|
|
<dt><b><i>1-10</i></b></dt>
|
|
<dd>Specify a priority value.
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<table width="100%">
|
|
<tr><td align="right"><a href="#CHGTCPRTE.Top_Of_Page">Top</a></td></tr>
|
|
</table>
|
|
<hr size="2" width="100%">
|
|
<div><h3><a name="CHGTCPRTE.COMMAND.EXAMPLES">Examples</a> </h3>
|
|
<p><b>Example 1: Changing a Route</b>
|
|
</p>
|
|
<p>
|
|
<pre>
|
|
CHGTCPRTE RTEDEST('132.65.0.0') SUBNETMASK('255.255.0.0')
|
|
TOS(*MINDELAY) NEXTHOP('132.65.34.98') MTU(1024)
|
|
</pre>
|
|
</p>
|
|
<p>This command changes the route identified by route destination 132.65.0.0 with a subnetmask of 255.255.0.0 and type of service of *MINDELAY. The change is to use a maximum transmission unit (MTU) of 1024.
|
|
</p>
|
|
<p><b>Example 2: Changing a Default Route</b>
|
|
</p>
|
|
<p>
|
|
<pre>
|
|
CHGTCPRTE RTEDEST(*DFTROUTE) SUBNETMASK(*NONE) TOS(*NORMAL)
|
|
NEXTHOP('186.49.126.108') MTU(1024)
|
|
</pre>
|
|
</p>
|
|
<p>This command changes the default route identified by next-hop value 186.49.126.108 to use an MTU value of 1024.
|
|
</p>
|
|
</div>
|
|
<table width="100%">
|
|
<tr><td align="right"><a href="#CHGTCPRTE.Top_Of_Page">Top</a></td></tr>
|
|
</table>
|
|
<hr size="2" width="100%">
|
|
<div><h3><a name="CHGTCPRTE.ERROR.MESSAGES">Error messages</a> </h3>
|
|
<p><b><u>*ESCAPE Messages</u></b>
|
|
</p>
|
|
<dl>
|
|
<dt><b>TCP1D03</b></dt>
|
|
<dd>&1 member record length not correct.
|
|
</dd>
|
|
<dt><b>TCP1D04</b></dt>
|
|
<dd>Error occurred processing member &1 of &2/&3.
|
|
</dd>
|
|
<dt><b>TCP1901</b></dt>
|
|
<dd>Internet address &1 not valid.
|
|
</dd>
|
|
<dt><b>TCP1902</b></dt>
|
|
<dd>Internet address &1 not valid.
|
|
</dd>
|
|
<dt><b>TCP1908</b></dt>
|
|
<dd>Internet address &1 not valid.
|
|
</dd>
|
|
<dt><b>TCP261C</b></dt>
|
|
<dd>Process completed successfully.
|
|
</dd>
|
|
<dt><b>TCP2658</b></dt>
|
|
<dd>&2 &1 not changed.
|
|
</dd>
|
|
<dt><b>TCP8050</b></dt>
|
|
<dd>*IOSYSCFG authority required to use &1.
|
|
</dd>
|
|
<dt><b>TCP9509</b></dt>
|
|
<dd>Line &1 not found.
|
|
</dd>
|
|
<dt><b>TCP9999</b></dt>
|
|
<dd>Internal system error in program &1.
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<table width="100%">
|
|
<tr><td align="right"><a href="#CHGTCPRTE.Top_Of_Page">Top</a></td></tr>
|
|
</table>
|
|
</body>
|
|
</html>
|