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

342 lines
12 KiB
HTML
Raw Permalink 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>Verify APPC Connection (APING)</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="APING.Top_Of_Page"></a>
<h2>Verify APPC Connection (APING)</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="#APING.PARAMETERS.TABLE">Parameters</a><br>
<a href="#APING.COMMAND.EXAMPLES">Examples</a><br>
<a href="#APING.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="APING"></a>
<p>The Verify APPC Connection (VFYAPPCCNN) command, also known as APING, exchanges data packets between the local location and the specified remote location using Advanced Program-to-Program Communications, and measures the round-trip time of each data packet exchange iteration.
</p>
<p>For this function to work, the remote location specified must be running the target portion of this function, <u> APINGD</u> (APING daemon).
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#APING.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="APING.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="#APING.RMTLOCNAME"><b>RMTLOCNAME</b></a></td>
<td valign="top">Remote location</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Required, Positional 1</td>
</tr>
<tr>
<td valign="top"><a href="#APING.MODE"><b>MODE</b></a></td>
<td valign="top">Mode</td>
<td valign="top"><i>Communications name</i>, <b><u>*NETATR</u></b></td>
<td valign="top">Optional, Positional 2</td>
</tr>
<tr>
<td valign="top"><a href="#APING.RMTUSER"><b>RMTUSER</b></a></td>
<td valign="top">Remote user ID</td>
<td valign="top"><i>Character value</i>, <b><u>*NONE</u></b>, *CURRENT</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#APING.RMTPWD"><b>RMTPWD</b></a></td>
<td valign="top">Remote password</td>
<td valign="top"><i>Character value</i>, <b><u>*NONE</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#APING.MSGMODE"><b>MSGMODE</b></a></td>
<td valign="top">Message mode</td>
<td valign="top"><b><u>*VERBOSE</u></b>, *QUIET</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#APING.PKTLEN"><b>PKTLEN</b></a></td>
<td valign="top">Packet length (in bytes)</td>
<td valign="top">0-32763, <b><u>100</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#APING.NBRITER"><b>NBRITER</b></a></td>
<td valign="top">Number of iterations</td>
<td valign="top">1-32767, <b><u>2</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#APING.NBRPKT"><b>NBRPKT</b></a></td>
<td valign="top">Number of packets</td>
<td valign="top">1-32767, <b><u>1</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#APING.ECHO"><b>ECHO</b></a></td>
<td valign="top">Echo</td>
<td valign="top"><b><u>*YES</u></b>, *NO</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#APING.WAITTIME"><b>WAITTIME</b></a></td>
<td valign="top">Wait time (in seconds)</td>
<td valign="top">2-3600, <b><u>10</u></b>, *NOMAX, *NOWAIT</td>
<td valign="top">Optional</td>
</tr>
</table>
<table width="100%">
<tr><td align="right"><a href="#APING.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="APING.RMTLOCNAME"></a>
<h3>Remote location (RMTLOCNAME)</h3>
<p>Specifies the remote location to connect with. Specify the remote location name using the format nnnnnnnn.cccccccc, where nnnnnnnn is the network identifier (ID) and cccccccc is the remote location name. If only the remote location name is specified, the local network ID (LCLNETID) network attribute is used as the value of the network identifier (ID).
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#APING.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="APING.MODE"></a>
<h3>Mode (MODE)</h3>
<p>Specifies the name of the mode to be used for the APPC conversation.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><u>*NETATR</u></b></dt>
<dd>The mode in the network attributes is used.
</dd>
<dt><b><i>mode-name</i></b></dt>
<dd>Specify a mode name. Specify BLANK for a mode name consisting of eight blank characters.
</dd>
</dl>
<p>
<b>Note: </b>SNASVCMG and CPSVCMG are reserved names and cannot be specified.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#APING.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="APING.RMTUSER"></a>
<h3>Remote user ID (RMTUSER)</h3>
<p>Specifies the user identifier (ID) for the target system. If a user ID is specified for this parameter and password security is active on the target system, RMTPWD(*NONE) is not valid.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><u>*NONE</u></b></dt>
<dd>No user ID is sent. If security on the target system is configured to require a user ID, the command will fail.
</dd>
<dt><b>*CURRENT</b></dt>
<dd>The user ID of the job (signed-on user) using this command is sent.
</dd>
<dt><b><i>remote-user-identifier</i></b></dt>
<dd>Specify a user ID to use that exists on the target system. If a user ID is specified and password security is active on the target system, a password must be specified.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#APING.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="APING.RMTPWD"></a>
<h3>Remote password (RMTPWD)</h3>
<p>Specifies the password sent to the target system.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><u>*NONE</u></b></dt>
<dd>The system does not send a password. If a user identifier (ID) is specified on the RMTUSER parameter and password security is active on the target system, the command will fail.
</dd>
<dt><b><i>password</i></b></dt>
<dd>Specify a password sent to the target system to verify the sign-on of the user ID specified in the RMTUSER parameter. The password may or may not be substituted across the communication line depending on whether the remote system supports password substitution.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#APING.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="APING.MSGMODE"></a>
<h3>Message mode (MSGMODE)</h3>
<p>Specifies the amount of information displayed by the command.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><u>*VERBOSE</u></b></dt>
<dd>Display verification message after each iteration.
</dd>
<dt><b>*QUIET</b></dt>
<dd>Display only initial and summary messages.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#APING.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="APING.PKTLEN"></a>
<h3>Packet length (in bytes) (PKTLEN)</h3>
<p>Specifies the length (in bytes) of the packets that are exchanged between the local and remote systems.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><u>100</u></b></dt>
<dd>The packet length is 100 bytes.
</dd>
<dt><b><i>packet-length</i></b></dt>
<dd>Specify the length of the packet. Valid values range from 0 through 32763 bytes.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#APING.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="APING.NBRITER"></a>
<h3>Number of iterations (NBRITER)</h3>
<p>Specifies the number of iterations. For each iteration, the specified number of data packets are exchanged between the local and remote systems.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><u>2</u></b></dt>
<dd>Two iterations are performed.
</dd>
<dt><b><i>number-of-iterations</i></b></dt>
<dd>Specify the number of iterations. Valid values range from 1 through 32767.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#APING.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="APING.NBRPKT"></a>
<h3>Number of packets (NBRPKT)</h3>
<p>Specifies the number of packets that are sent by the local system for each iteration before giving the target system permission to send.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><u>1</u></b></dt>
<dd>One packet is sent for each iteration.
</dd>
<dt><b><i>number-of-packets</i></b></dt>
<dd>Specify the number of packets that are sent for each iteration. Valid values range from 1 through 32767.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#APING.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="APING.ECHO"></a>
<h3>Echo (ECHO)</h3>
<p>Whether the remote location should echo packets back to the local location.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><u>*YES</u></b></dt>
<dd>Packets are echoed back from the remote location to the local location.
</dd>
<dt><b>*NO</b></dt>
<dd>Packets are sent from the local location to the remote location only; packets are not echoed back to the local location.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#APING.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="APING.WAITTIME"></a>
<h3>Wait time (in seconds) (WAITTIME)</h3>
<p>Specifies the time in seconds to wait for the return (echo) before declaring the remote location to be unreachable.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><u>10</u></b></dt>
<dd>The system waits 10 seconds.
</dd>
<dt><b>*NOMAX</b></dt>
<dd>The system waits forever.
</dd>
<dt><b>*NOWAIT</b></dt>
<dd>The system returns immediately if there is a connection ready and available.
</dd>
<dt><b><i>time-to-wait-for-reply</i></b></dt>
<dd>Specify the length of time in seconds. Valid values range from 2 through 3600 seconds.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#APING.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="APING.COMMAND.EXAMPLES">Examples</a> </h3>
<p><b>Example 1: Verify an APPC Connection</b>
</p>
<p>
<pre>
VFYAPPCCNN RMTLOCNAME(RPCNET.CHICAGO) NBRITER(3) NBRPKT(4)
PKTLEN(500)
</pre>
</p>
<p>This command exchanges four 500-byte packets in each of three iterations with remote location CHICAGO, network identifier RPCNET. The default mode used is taken from network attribute DFTMODE. Since the default MSGMODE(*VERBOSE) was taken, each iteration will result in an informational message in the job log indicating the elapsed time for the iteration.
</p>
<p><b>Example 2: Using APING Alias Command</b>
</p>
<p>
<pre>
APING RMTLOCNAME(RPCNET.CHICAGO) NBRITER(3) NBRPKT(4) PKTLEN(500)
</pre>
</p>
<p>This command is equivalent to the command in Example 1 above.
</p>
<p><b>Example 3: Using APING with a Wait Time</b>
</p>
<p>
<pre>
APING RMTLOCNAME(RPCNET.CHICAGO) WAITTIME(20)
</pre>
</p>
<p>This command will verify the connection with remote location CHICAGO, network identifier RPCNET. The maximum time to wait for a response from the remote location is 20 seconds.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#APING.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="APING.ERROR.MESSAGES">Error messages</a> </h3>
<p><b><u>*ESCAPE Messages</u></b>
</p>
<dl>
<dt><b>CPF91CC</b></dt>
<dd>Command did not complete successfully.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#APING.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink