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

413 lines
16 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>Verify TCP/IP Connection (VFYTCPCNN)</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="VFYTCPCNN.Top_Of_Page"></a>
<h2>Verify TCP/IP Connection (VFYTCPCNN)</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="#VFYTCPCNN.PARAMETERS.TABLE">Parameters</a><br>
<a href="#VFYTCPCNN.COMMAND.EXAMPLES">Examples</a><br>
<a href="#VFYTCPCNN.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="VFYTCPCNN"></a>
<p>The Verify TCP/IP Connection (VFYTCPCNN) command, also known as PING, tests the connectivity between a system and the remote system specified by the remote system parameter.
</p>
<p><b>Notes:</b>
</p>
<ul>
<li>The VFYTCPCNN (PING) command cannot be used to verify IP over SNA connections.
</li>
<li>The local domain name is used by many applications including PING. PING appends the local domain to a host name <u> if</u> a domain is not specified or if a period (.) does not appear at the end of the specified host name.
</li>
</ul>
</div>
<table width="100%">
<tr><td align="right"><a href="#VFYTCPCNN.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="VFYTCPCNN.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="#VFYTCPCNN.RMTSYS"><b>RMTSYS</b></a></td>
<td valign="top">Remote system</td>
<td valign="top"><i>Character value</i>, *INTNETADR</td>
<td valign="top">Required, Positional 1</td>
</tr>
<tr>
<td valign="top"><a href="#VFYTCPCNN.INTNETADR"><b>INTNETADR</b></a></td>
<td valign="top">Remote internet address</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#VFYTCPCNN.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" rowspan="3"><a href="#VFYTCPCNN.MSGMODE"><b>MSGMODE</b></a></td>
<td valign="top">Message mode</td>
<td valign="top"><i>Element list</i></td>
<td valign="top" rowspan="3">Optional</td>
</tr>
<tr>
<td valign="top">Element 1: Response message detail</td>
<td valign="top">
<b><u>*VERBOSE</u></b>, *QUIET</td>
</tr>
<tr>
<td valign="top">Element 2: Summary, if response errors</td>
<td valign="top">
<b><u>*COMP</u></b>, *ESCAPE</td>
</tr>
<tr>
<td valign="top"><a href="#VFYTCPCNN.PKTLEN"><b>PKTLEN</b></a></td>
<td valign="top">Packet length (in bytes)</td>
<td valign="top">8-512, <b><u>256</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#VFYTCPCNN.NBRPKT"><b>NBRPKT</b></a></td>
<td valign="top">Number of packets</td>
<td valign="top">1-999, <b><u>5</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#VFYTCPCNN.WAITTIME"><b>WAITTIME</b></a></td>
<td valign="top">Wait time (in seconds)</td>
<td valign="top">1-120, <b><u>1</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#VFYTCPCNN.LCLINTNETA"><b>LCLINTNETA</b></a></td>
<td valign="top">Local internet 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="#VFYTCPCNN.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</td>
</tr>
<tr>
<td valign="top"><a href="#VFYTCPCNN.IPTTL"><b>IPTTL</b></a></td>
<td valign="top">IP time to live (hop limit)</td>
<td valign="top">1-255, <b><u>*DFT</u></b></td>
<td valign="top">Optional</td>
</tr>
</table>
<table width="100%">
<tr><td align="right"><a href="#VFYTCPCNN.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="VFYTCPCNN.RMTSYS"></a>
<h3>Remote system (RMTSYS)</h3>
<p>Specifies the remote system name of the host with which the Verify TCP/IP operation takes place. To be successful, the name must be valid, and the remote system must be able to communicate with the local system. You can assign names to an internet address by using either of the following:
</p>
<ul>
<li>Work with Host Table menu, which is an option on the Configure TCP/IP menu.
</li>
<li>Remote name server to map a remote system name to an internet address.
</li>
</ul>
<p>Host name resolution will depend on the value specified for the <b>Address version format (ADRVERFMT)</b> parameter.
</p>
<dl>
<dt><b>*INTNETADR</b></dt>
<dd>The remote system is identified by the value specified for the <b>Remote internet address (INTNETADR)</b> parameter.
</dd>
<dt><b><i>character-value</i></b></dt>
<dd>Specify the remote system name to be verified.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#VFYTCPCNN.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="VFYTCPCNN.INTNETADR"></a>
<h3>Remote internet address (INTNETADR)</h3>
<p>Specifies the remote internet address. Either a valid IP Version 4 or IP Version 6 address will be accepted. An IP Version 4 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.
</p>
<dl>
<dt><b><i>character-value</i></b></dt>
<dd>Specify the internet address of the remote system. 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="#VFYTCPCNN.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="VFYTCPCNN.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. IP Version 6 host name resolution will be performed if the system has at least one IP Version 6 address configured. If an IP Version 6 address is not found, IP Version 4 host name resolution will be performed if the system has at least one IP Version 4 address configured. The loopback address is not considered in this case as a configured 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="#VFYTCPCNN.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="VFYTCPCNN.MSGMODE"></a>
<h3>Message mode (MSGMODE)</h3>
<p>Specifies the amount of information to be displayed.
</p>
<p><b>Element 1: Response message detail</b>
</p>
<dl>
<dt><b><u>*VERBOSE</u></b></dt>
<dd>Display messages as each PING response arrives.
</dd>
<dt><b>*QUIET</b></dt>
<dd>Display only the initial PING (VFYTCPCNN) message and the summary messages.
</dd>
</dl>
<p><b>Element 2: Summary, if response errors</b>
</p>
<dl>
<dt><b><u>*COMP</u></b></dt>
<dd>If the PING (CFYTCPCNN) request is successful, the summary message returned is a completion message.
</dd>
<dt><b>*ESCAPE</b></dt>
<dd>A monitorable escape message is returned. This is useful if you have written a program to issue the PING request and wish to monitor the PING request for errors. See the error messages section of the PING (VFYTCPCNN) command help for a list of possible escape messages.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#VFYTCPCNN.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="VFYTCPCNN.PKTLEN"></a>
<h3>Packet length (in bytes) (PKTLEN)</h3>
<p>Specifies the length (in bytes) of the packets that are sent to the remote system.
</p>
<dl>
<dt><b><u>256</u></b></dt>
<dd>The packet length is 256 bytes.
</dd>
<dt><b><i>8-512</i></b></dt>
<dd>Specify the number of bytes in each packet.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#VFYTCPCNN.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="VFYTCPCNN.NBRPKT"></a>
<h3>Number of packets (NBRPKT)</h3>
<p>Specifies the number of packets that are sent to the remote system.
</p>
<dl>
<dt><b><u>5</u></b></dt>
<dd>Five packets are sent.
</dd>
<dt><b><i>1-999</i></b></dt>
<dd>Specify the number of packets that are sent to the remote system.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#VFYTCPCNN.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="VFYTCPCNN.WAITTIME"></a>
<h3>Wait time (in seconds) (WAITTIME)</h3>
<p>Specifies the number of seconds to wait for the return (echo) packet before declaring this packet transfer a failure.
</p>
<dl>
<dt><b><u>1</u></b></dt>
<dd>The system waits 1 second.
</dd>
<dt><b><i>1-120</i></b></dt>
<dd>Specify the number of second to wait.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#VFYTCPCNN.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="VFYTCPCNN.LCLINTNETA"></a>
<h3>Local internet address (LCLINTNETA)</h3>
<p>Specifies the local internet address of the interface that the outbound packets are to use. Any valid IP Version 4 or IP Version 6 address will be accepted. An IP Version 4 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.
</p>
<dl>
<dt><b><u>*ANY</u></b></dt>
<dd>Use any interface's local internet address.
</dd>
<dt><b><i>character-value</i></b></dt>
<dd>Specify the local internet address.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#VFYTCPCNN.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="VFYTCPCNN.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>
<b>Note: </b>This parameter is not used if IP Version 6 address resolution is used for verifying connectivity to a remote system.
</p>
<dl>
<dt><b><u>*NORMAL</u></b></dt>
<dd>Normal service is used for delivery of data.
</dd>
<dt><b>*MINDELAY</b></dt>
<dd>Minimize delay means that prompt delivery is important for data on this connection.
</dd>
<dt><b>*MAXTHRPUT</b></dt>
<dd>Maximize throughput means that a high data rate is important for data on this connection.
</dd>
<dt><b>*MAXRLB</b></dt>
<dd>Maximize reliability means that a higher level of effort to ensure delivery is important for data on this connection.
</dd>
<dt><b>*MINCOST</b></dt>
<dd>Minimize monetary cost means that lower cost is important for data on this connection.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#VFYTCPCNN.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="VFYTCPCNN.IPTTL"></a>
<h3>IP time to live (hop limit) (IPTTL)</h3>
<p>Specifies the IP datagram (packet) time-to-live value. The datagram is valid only for the number of router hops specified by this parameter. The time-to-live value acts as a "hop counter". The counter is decremented each time the datagram passes through a router or gateway. Limiting the validity of the datagram by the number of hops helps to prevent internet routing loops.
</p>
<p><b>Note:</b> IP Version 6 refers to this parameter as the <b>hop limit</b>.
</p>
<dl>
<dt><b><u>*DFT</u></b></dt>
<dd>Use the default time-to-live value.
<p>The default time-to-live value for multicast addresses is 1. The default time-to-live value for all other addresses is specified by the IPTTL parameter of the Change TCP/IP Attributes (CHGTCPA) command.
</p>
</dd>
<dt><b><i>1-255</i></b></dt>
<dd>Specify an IP datagram (packet) time-to-live value.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#VFYTCPCNN.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="VFYTCPCNN.COMMAND.EXAMPLES">Examples</a> </h3>
<p><b>Example 1: Verify TCP/IP Connection with a Specified Host Name</b>
</p>
<p>
<pre>
VFYTCPCNN RMTSYS(IPHOST) PKTLEN(100) NBRPKT(10)
WAITTIME(15)
</pre>
</p>
<p>This command attempts to send 10 packets of 100 bytes each to a remote system (known to the TCP/IP configuration as IPHOST) over a TCP/IP link. Each packet transfer must take place within 15 seconds or it fails.
</p>
<p><b>Example 2: Verify TCP/IP Connection with an IP Address</b>
</p>
<p>
<pre>
VFYTCPCNN RMTSYS(*INTNETADR) INTNETADR('128.1.1.10')
PKTLEN(100) NBRPKT(10) WAITTIME(15)
</pre>
</p>
<p>This command attempts to send 10 packets of 100 bytes each to a remote system over a TCP/IP interface. The user represents the RMTSYS with its internet address 128.1.1.10, rather than with an assigned system name. Each packet transfer that takes more that 15 seconds fails.
</p>
<p><b>Example 3: Verify TCP/IP Connection with Host Name and Using a Specific Local Interface Address</b>
</p>
<p>
<pre>
VFYTCPCNN RMTSYS(IPHOST) MSGMODE(*QUIET)
LCLINTNETA('9.2.2.3')
</pre>
</p>
<p>This command attempts to send 5 packets (default) of 256 bytes each (default) to a remote system over a specific TCP/IP interface that has the local address 9.2.2.3.
</p>
<p>Because MSGMODE(*QUIET) is specified, only the primary output messages are displayed. The interface parameter is useful on multi-homed hosts to verify network connectivity through a specific physical interface.
</p>
<p><b>Example 4: Verify TCP/IP Connection with an IP Version 6 Address</b>
</p>
<p>
<pre>
VFYTCPCNN RMTSYS(*INTNETADR)
INTNETADR('1:2:3:4:5:6:7:8')
</pre>
</p>
<p>This command attempts to verify the TCP/IP connection of a remote system that has the local address of <b>1:2:3:4:5:6:7:8</b>.
</p>
<p><b>Example 5: Verify TCP/IP Connection with a Specified IP Version 6 Defined Host Name</b>
</p>
<p>
<pre>
VFYTCPCNN RMTSYS(IPV6HOST)
</pre>
</p>
<p>This command attempts to send 5 packets (default) of 256 bytes each (default) to a remote system (known to the IP Version 6 TCP/IP configuration as IPV6HOST) over a TCP/IP link.
</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 verify its connection over a TCP/IP link.
</p>
<p><b>Example 6: Verify TCP/IP Connection and Explicitly Use IP Version 6 Host Name Resolution</b>
</p>
<p>
<pre>
VFYTCPCNN RMTSYS(IPV6HOST) ADRVERFMT(*IP6)
</pre>
</p>
<p>This command attempts to send 5 packets (default) of 256 bytes each (default) to a remote system (known to the IP Version 6 TCP/IP configuration as IPV6HOST) over a TCP/IP link.
</p>
<p>This example differs from example 5 in that only a valid IP version 6 resolved address, for IPV6HOST, will be used when attempting to verify its connection over a TCP/IP link.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#VFYTCPCNN.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="VFYTCPCNN.ERROR.MESSAGES">Error messages</a> </h3>
<p>None
</p>
<p><b><u>*ESCAPE Messages</u></b>
</p>
<dl>
<dt><b>TCP3210</b></dt>
<dd>Connection verification statistics: &amp;1 of &amp;2 successful (&amp;3 %).
</dd>
<dt><b>TCP3219</b></dt>
<dd>Address &amp;1 does not match address version format &amp;2.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#VFYTCPCNN.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>