friedkiwi/ibm-information-center
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
14ed2849c6
ibm-information-center/dist/eclipse/plugins/i5OS.ic.cl_5.4.0.1/trctcprte.htm

479 lines
18 KiB
HTML
Raw 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">
<title>Trace TCP/IP Route (TRCTCPRTE)</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="TRCTCPRTE.Top_Of_Page"></a>
<h2>Trace TCP/IP Route (TRCTCPRTE)</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="#TRCTCPRTE.PARAMETERS.TABLE">Parameters</a><br>
<a href="#TRCTCPRTE.COMMAND.EXAMPLES">Examples</a><br>
<a href="#TRCTCPRTE.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="TRCTCPRTE"></a>
<p>The Trace TCP/IP Route (TRCTCPRTE) command, also known as TRACEROUTE, traces the route of IP packets to a user-specified destination system. The route can involve many different systems along the way. Each system along the route is referred to as a <b>hop</b>. You can trace all hops along the route or specify the starting and ending hops to be traced.
</p>
<p>The route is traced by sending packets (called <b>probes</b>) to the destination system. Each probe contains an upper limit (called <b>Time To Live</b> or <b>TTL</b>) on the number of hop systems the probe can pass through.
</p>
<p><b>Note:</b> In IP Version 6, <b>Time To Live</b> (TTL) is called the <b>hop limit</b>.
</p>
<p>A route is traced by successively incrementing the TTL of the probe packets by one hop. The trace ends when either a probe response is received from the destination system or when the probe Time To Live value equals the maximum allowed.
</p>
<p>Responses from the probe packets are sent as messages to the job log or as queue entries to a user-specified data queue.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#TRCTCPRTE.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="TRCTCPRTE.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="#TRCTCPRTE.RMTSYS"><b>RMTSYS</b></a></td>
<td valign="top">Remote system</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Required, Positional 1</td>
</tr>
<tr>
<td valign="top" rowspan="3"><a href="#TRCTCPRTE.RANGE"><b>RANGE</b></a></td>
<td valign="top">Range of hops to probe</td>
<td valign="top"><i>Element list</i></td>
<td valign="top" rowspan="3">Optional</td>
</tr>
<tr>
<td valign="top">Element 1: Starting probe TTL (hop limit)</td>
<td valign="top">
1-255, <b><u>1</u></b></td>
</tr>
<tr>
<td valign="top">Element 2: Maximum probe TTL (hop limit)</td>
<td valign="top">
1-255, <b><u>30</u></b></td>
</tr>
<tr>
<td valign="top"><a href="#TRCTCPRTE.PROBES"><b>PROBES</b></a></td>
<td valign="top">Probes sent per hop</td>
<td valign="top">1-64, <b><u>3</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#TRCTCPRTE.WAITTIME"><b>WAITTIME</b></a></td>
<td valign="top">Response wait time</td>
<td valign="top">1-120, <b><u>3</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#TRCTCPRTE.PKTLEN"><b>PKTLEN</b></a></td>
<td valign="top">Packet length (in bytes)</td>
<td valign="top">40-65535, <b><u>40</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#TRCTCPRTE.OUTPUT"><b>OUTPUT</b></a></td>
<td valign="top">Output</td>
<td valign="top"><b><u>*MSG</u></b>, *VERBOSE, *DTAQ</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top" rowspan="3"><a href="#TRCTCPRTE.DTAQ"><b>DTAQ</b></a></td>
<td valign="top">Data queue</td>
<td valign="top"><i>Qualified object name</i></td>
<td valign="top" rowspan="3">Optional</td>
</tr>
<tr>
<td valign="top">Qualifier 1: Data queue</td>
<td valign="top"><i>Name</i></td>
</tr><tr>
<td valign="top">Qualifier 2: Library</td>
<td valign="top"><i>Name</i>, *CURLIB, <b><u>*LIBL</u></b></td>
</tr><tr>
<td valign="top"><a href="#TRCTCPRTE.ADRVERFMT"><b>ADRVERFMT</b></a></td>
<td valign="top">Address version format</td>
<td valign="top"><b><u>*CALC</u></b>, *IP4, *IP6</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#TRCTCPRTE.LCLINTNETA"><b>LCLINTNETA</b></a></td>
<td valign="top">Source IP address</td>
<td valign="top"><i>Character value</i>, <b><u>*ANY</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#TRCTCPRTE.RMTPORT"><b>RMTPORT</b></a></td>
<td valign="top">Base remote port</td>
<td valign="top">1-65535, <b><u>33434</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#TRCTCPRTE.NAMELOOKUP"><b>NAMELOOKUP</b></a></td>
<td valign="top">Lookup host names</td>
<td valign="top"><b><u>*YES</u></b>, *NO</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#TRCTCPRTE.PROBEPCL"><b>PROBEPCL</b></a></td>
<td valign="top">Probing protocol</td>
<td valign="top"><b><u>*ICMP</u></b>, *UDP</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#TRCTCPRTE.FRAGMENT"><b>FRAGMENT</b></a></td>
<td valign="top">Allow fragmentation</td>
<td valign="top"><b><u>*TCPA</u></b>, *NO, *YES</td>
<td valign="top">Optional</td>
</tr>
</table>
<table width="100%">
<tr><td align="right"><a href="#TRCTCPRTE.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="TRCTCPRTE.RMTSYS"></a>
<h3>Remote system (RMTSYS)</h3>
<p>Specifies the remote system name (255 characters) or IP address of the destination system.
</p>
<dl>
<dt><b><i>character-value</i></b></dt>
<dd>Specify the remote system name or IP address. Either a valid IP Version 4 or IP Version 6 address will be accepted.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#TRCTCPRTE.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="TRCTCPRTE.RANGE"></a>
<h3>Range of hops to probe (RANGE)</h3>
<p>Specifies the range of hop systems from which probe responses are expected. Each probe specifies a TTL (Time To Live) integer value. This TTL value is the maximum number of hops the probe can traverse. For example, a probe packet with a TTL of 3 can pass through at most 3 hop systems before the hop system discards the probe and sends information back to the system from which the probe originated.
</p>
<p>Element 1 specifies the first TTL value sent in probe packets. Element 2 specifies the last TTL value sent in probe packets. Trace information is generated from each hop system which discards a probe packet because the TTL value in the probe is reached or when the destination system is reached.
</p>
<p><b>Element 1: Starting probe TTL (hop limit)</b>
</p>
<dl>
<dt><b><u>1</u></b></dt>
<dd>The default starting hop is 1.
</dd>
<dt><b><i>1-255</i></b></dt>
<dd>Specify the first hop limit TTL number used for probe packets.
</dd>
</dl>
<p><b>Element 2: Maximum probe TTL (hop limit)</b>
</p>
<dl>
<dt><b><u>30</u></b></dt>
<dd>The default ending hop is 30.
</dd>
<dt><b><i>1-255</i></b></dt>
<dd>Specify the maximum number of hops a probe can traverse to reach the destination system.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#TRCTCPRTE.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="TRCTCPRTE.PROBES"></a>
<h3>Probes sent per hop (PROBES)</h3>
<p>Specifies the number of probe packets sent to each hop system for each probe TTL (hop limit) value in the range specified by the RANGE parameter.
</p>
<dl>
<dt><b><u>3</u></b></dt>
<dd>The default number of probes is three.
</dd>
<dt><b><i>1-64</i></b></dt>
<dd>Specify the number of probes to send.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#TRCTCPRTE.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="TRCTCPRTE.WAITTIME"></a>
<h3>Response wait time (WAITTIME)</h3>
<p>Specifies the maximum time, in seconds, to wait for a response from a hop system to each probe.
</p>
<dl>
<dt><b><u>3</u></b></dt>
<dd>Wait up to 3 seconds for a response.
</dd>
<dt><b><i>1-120</i></b></dt>
<dd>Specify the maximum number of seconds to wait for a response.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#TRCTCPRTE.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="TRCTCPRTE.PKTLEN"></a>
<h3>Packet length (in bytes) (PKTLEN)</h3>
<p>Specifies the total length, in bytes, of the IP packet sent for each probe.
</p>
<dl>
<dt><b><u>40</u></b></dt>
<dd>The probe packet length is 40 bytes.
</dd>
<dt><b><i>40-65535</i></b></dt>
<dd>Specify the number of bytes in the probe IP packet.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#TRCTCPRTE.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="TRCTCPRTE.OUTPUT"></a>
<h3>Output (OUTPUT)</h3>
<p>Specifies where the results obtained from sending the probe packets is sent. Information is sent for each hop until the destination system is reached, including hop count, average round-trip time, IP address of the hop and host name of the hop.
</p>
<dl>
<dt><b><u>*MSG</u></b></dt>
<dd>Results are output as messages sent to the job log of the job in which the command is issued.
</dd>
<dt><b>*VERBOSE</b></dt>
<dd>Results are output as messages sent to the job log of the job in which the command is issued. All responses received are displayed. Results are not limited to ICMP TIME_EXCEEDED and PORT_UNREACHABLE responses.
</dd>
<dt><b>*DTAQ</b></dt>
<dd>Results from probes are placed on the data queue specified by the Data Queue (DTAQ) parameter.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#TRCTCPRTE.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="TRCTCPRTE.DTAQ"></a>
<h3>Data queue (DTAQ)</h3>
<p>Specifies the data queue on which entries are placed. When a data queue is specified, messages are not sent to the job log unless an error occurs.
</p>
<p>Each queue entry contains the response to a probe if one was received or indicates that no probe response was received. The specified data queue must have a queue entry length of at least 32 characters and must exist when this command is issued.
</p>
<p><b>Qualifier 1: Data queue</b>
</p>
<dl>
<dt><b><i>name</i></b></dt>
<dd>Specify the name of the data queue.
</dd>
</dl>
<p><b>Qualifier 2: Library</b>
</p>
<dl>
<dt><b><u>*LIBL</u></b></dt>
<dd>All libraries in the job's library list are searched.
</dd>
<dt><b>*CURLIB</b></dt>
<dd>The current library for the job is searched. If no library is specified as the current library for the job, the QGPL library is used.
</dd>
<dt><b><i>name</i></b></dt>
<dd>Specify the name of the library to search.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#TRCTCPRTE.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="TRCTCPRTE.ADRVERFMT"></a>
<h3>Address version format (ADRVERFMT)</h3>
<p>Specifies how the host name specified for the <b>Remote system (RMTSYS)</b> parameter is to be resolved.
</p>
<dl>
<dt><b><u>*CALC</u></b></dt>
<dd>The host name resolution method will be 'calculated' (determined) based on the host name entered in the RMTSYS parameter. TRCTCPRTE (TRACEROUTE) will first use IP Version 4 host name resolution in determining the IP address. If that fails, IP Version 6 host name resolution is used in determining the IP address.
</dd>
<dt><b>*IP4</b></dt>
<dd>Use the IP Version 4 host name resolution method.
</dd>
<dt><b>*IP6</b></dt>
<dd>Use the IP Version 6 host name resolution method.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#TRCTCPRTE.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="TRCTCPRTE.LCLINTNETA"></a>
<h3>Source IP address (LCLINTNETA)</h3>
<p>Specifies how the source IP address in the probe packet is chosen.
</p>
<dl>
<dt><b><u>*ANY</u></b></dt>
<dd>The source IP address in the probe packets is chosen by the system. The system may use any active local interface which can reach the remote system.
</dd>
<dt><b><i>character-value</i></b></dt>
<dd>Specify the local interface to use as the source IP address.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#TRCTCPRTE.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="TRCTCPRTE.RMTPORT"></a>
<h3>Base remote port (RMTPORT)</h3>
<p>Specifies the base UDP port number used in probes.
</p>
<dl>
<dt><b><u>33434</u></b></dt>
<dd>Use the default base UDP port number of 33434.
</dd>
<dt><b><i>1-65535</i></b></dt>
<dd>Specify the base UDP port number to be used in probes.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#TRCTCPRTE.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="TRCTCPRTE.NAMELOOKUP"></a>
<h3>Lookup host names (NAMELOOKUP)</h3>
<p>Specifies whether IP addresses will be resolved to the host name.
</p>
<dl>
<dt><b><u>*YES</u></b></dt>
<dd>The address will be resolved to the host name.
</dd>
<dt><b>*NO</b></dt>
<dd>The address will not be resolved to the host name.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#TRCTCPRTE.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="TRCTCPRTE.PROBEPCL"></a>
<h3>Probing protocol (PROBEPCL)</h3>
<p>Specifies the protocol used when sending probe packets.
</p>
<dl>
<dt><b><u>*ICMP</u></b></dt>
<dd>The probes sent to the destination system are ICMP (Internet Control Message Protocol) Echo Request packets.
</dd>
<dt><b>*UDP</b></dt>
<dd>The probes sent to the destination system are UDP (User Datagram Protocol) packets.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#TRCTCPRTE.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="TRCTCPRTE.FRAGMENT"></a>
<h3>Allow fragmentation (FRAGMENT)</h3>
<p>Specifies how the setting of the "Do Not Fragment" option in the IP header of the probe packet is determined.
</p>
<dl>
<dt><b><u>*TCPA</u></b></dt>
<dd>The system sets the option based on the setting of the IP Path MTU Discovery TCP/IP attribute.
<p>
<b>Note: </b>Use the Change TCP/IP Attributes (CHGTCPA) command to change the value of this attribute.
</p>
</dd>
<dt><b>*NO</b></dt>
<dd>The "Do Not Fragment" option is always specified.
</dd>
<dt><b>*YES</b></dt>
<dd>The "Do Not Fragment" option is never specified.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#TRCTCPRTE.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="TRCTCPRTE.COMMAND.EXAMPLES">Examples</a> </h3>
<p><b>Example 1: Trace Entire Route</b>
</p>
<p>
<pre>
TRCTCPRTE RMTSYS('130.14.3.5')
</pre>
</p>
<p>This command traces the entire route between the local system and the destination system whose IP address is '130.14.3.5'. Three probe packets will be sent to each hop system. Each IP probe packet will be 40 bytes long and will contain an ICMP Echo Request packet. Results received are sent as messages to the job log.
</p>
<p><b>Example 2: Trace Partial Route</b>
</p>
<p>
<pre>
TRCTCPRTE RMTSYS('AAA.BBBB.COM') RANGE(3 7)
PROBES(5) PROBEPCL(*UDP)
OUTPUT(*DTAQ) DTAQ(MYLIB/MYDATAQ)
</pre>
</p>
<p>This command traces the route between the local system and the destination system whose host name is 'AAA.BBBB.COM'. Five probe packets will be sent for the starting range value of 3. Each probe will be a UDP packet inside an IP packet that is 40 bytes long. Each of these 5 probes will specify a TTL of 3. If system AAA.BBB.COM can be reached by passing through at most 2 hop systems then the trace will terminate at this point.
</p>
<p>If system AAA.BBB.COM is futher than 2 hops, another set of 5 probe packets will be sent to the destination AAA.BBB.COM. Each of these 5 probes will specify a TTL of 4. This is repeated until either system AAA.BBB.COM responds to a probe or 5 probes with a TTL of 7, the ending range value, are sent. Any results received are placed as queue entries on data queue MYDATAQ in library MYLIB.
</p>
<p><b>Example 3: Trace Route with an IP Version 6 Address</b>
</p>
<p>
<pre>
TRCTCPRTE RMTSYS('1:2:3:4:5:6:7:8')
</pre>
</p>
<p>This command traces the entire route between the local system and the destination system whose IP address is <b>1:2:3:4:5:6:7:8</b>. Three probe packets will be sent to each hop system. Each IP probe packet will be 40 bytes long and will contain an ICMP6 Echo Request packet. Results received are sent as messages to the job log.
</p>
<p>
<b>Note: </b>A colon character ( <b>:</b> ) found in the parameter value signifies an IP Version 6 address and will cause an ICMP6 echo request packet to be generated.
</p>
<p><b>Example 4: Trace Route with an IP Version 6 Host Name</b>
</p>
<p>
<pre>
TRCTCPRTE RMTSYS('IP6HOST')
</pre>
</p>
<p>This command traces the entire route between the local system and the destination system whose host name is 'IP6HOST'. Three probe packets will be sent to each hop system. Each IP probe packet will be 40 bytes long and will contain an ICMP6 Echo Request packet. Results received are sent as messages to the job log.
</p>
<p>The default "Address version format" is *CALC. Host name resolution may return multiple IP addresses for a given host name. But, in the case (*CALC), the first IP address (IP Version 4 or IP Version 6) resolved will be the address used when attempting to trace the route.
</p>
<p><b>Example 5: Trace Route with an IP Version 6 Host Name and Explicitly Use IP Version 6 Host Name Resolution</b>
</p>
<p>
<pre>
TRCTCPRTE RMTSYS('IP6HOST') ADRVERFMT(*IP6)
</pre>
</p>
<p>This command traces the entire route between the local system and the destination system whose host name is 'IP6HOST'. Three probe packets will be sent to each hop system. Each IP probe packet will be 40 bytes long and will contain an ICMP6 Echo Request packet. Results received are sent as messages to the job log.
</p>
<p>This example differs from example 4 in that only a valid IP version 6 resolved address, for IP6HOST, will be used when attempting to trace the route.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#TRCTCPRTE.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="TRCTCPRTE.ERROR.MESSAGES">Error messages</a> </h3>
<p><b><u>*ESCAPE Messages</u></b>
</p>
<dl>
<dt><b>TCP3250</b></dt>
<dd>DTAQ parameter value required with OUTPUT(*DTAQ).
</dd>
<dt><b>TCP3251</b></dt>
<dd>DTAQ parameter not valid when OUTPUT(*MSG) specified.
</dd>
<dt><b>TCP3252</b></dt>
<dd>Starting range value greater than range limit.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#TRCTCPRTE.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink