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

245 lines
9.1 KiB
HTML
Raw 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>End TCP/IP (ENDTCP)</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="ENDTCP.Top_Of_Page"></a>
<h2>End TCP/IP (ENDTCP)</h2>
<table width="100%">
<tr>
<td valign="top" align="left"><b>Where allowed to run: </b>All environments (*ALL)<br>
<b>Threadsafe: </b>Conditional
</td>
<td valign="top" align="right">
<a href="#ENDTCP.PARAMETERS.TABLE">Parameters</a><br>
<a href="#ENDTCP.COMMAND.EXAMPLES">Examples</a><br>
<a href="#ENDTCP.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="ENDTCP"></a>
<p>The End TCP/IP (ENDTCP) command ends TCP/IP processing.
</p>
<p><b>Attention:</b>
</p>
<p>There is no confirmation display shown when ENDTCP is entered. The ENDTCP command must be used carefully. When it is used, it ends all TCP/IP processing on the system that you are working on.
</p>
<p>If OPTION(*IMMED) is specified for the ENDTCP command, the following is true:
</p>
<ul>
<li>All TCP/IP connections are ended. This affects all currently active applications using sockets or the Pascal API.
</li>
<li>Unless ENDSVR(*NO) is specified, TCP/IP server jobs are ended for TELNET, FTP, TFTP, SMTP, LPD, HTTP, POP, RouteD, DHCP, DNS, DDM, BOOTP, REXEC, SNMP, DIRSRV, NSLD, INETD, MGTC, ONDMD, NETSVR, DLFM, VPN, EDRSQL, HOD, ODPA, NTP, QoS, TCM, DOMINO, WEBFACING, and CIMOM.
</li>
<li>Agents that are currently active in the QSYSWRK subsystem are ended. See the description of the <b>End application servers (ENDSVR)</b> parameter for more information.
</li>
<li>All active TCP/IP interfaces are ended.
</li>
</ul>
<p>If OPTION(*CNTRLD) is specified for the ENDTCP command, the following is true:
</p>
<ul>
<li>No new open operations are allowed to TCP, UDP, or raw sockets.
</li>
<li>A job is submitted to the QSYSWRK subsystem that will, after the time indicated in the DELAY parameter value has expired, do an ENDTCP *IMMED operation.
</li>
<li>An ENDTCP OPTION(*IMMED) can be submitted at any time after issuing ENDTCP OPTION(*CNTRLD). This cancels the controlled end. TCP/IP processing is ended immediately when the ENDTCP OPTION(*IMMED) is issued.
</li>
</ul>
<p><b>Restrictions:</b>
</p>
<ul>
<li>This command is conditionally threadsafe. This command calls different programs to process each type of TCP/IP server. If the programs being called are threadsafe, this command is threadsafe.
</li>
</ul>
</div>
<table width="100%">
<tr><td align="right"><a href="#ENDTCP.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="ENDTCP.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="#ENDTCP.OPTION"><b>OPTION</b></a></td>
<td valign="top">How to end</td>
<td valign="top"><b><u>*IMMED</u></b>, *CNTRLD</td>
<td valign="top">Optional, Positional 1</td>
</tr>
<tr>
<td valign="top"><a href="#ENDTCP.DELAY"><b>DELAY</b></a></td>
<td valign="top">Controlled end delay time</td>
<td valign="top">1-86400, <b><u>30</u></b></td>
<td valign="top">Optional, Positional 2</td>
</tr>
<tr>
<td valign="top"><a href="#ENDTCP.ENDSVR"><b>ENDSVR</b></a></td>
<td valign="top">End application servers</td>
<td valign="top"><b><u>*YES</u></b>, *NO</td>
<td valign="top">Optional</td>
</tr>
</table>
<table width="100%">
<tr><td align="right"><a href="#ENDTCP.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="ENDTCP.OPTION"></a>
<h3>How to end (OPTION)</h3>
<p>Specifies whether TCP/IP processing is ended in an immediate or controlled manner.
</p>
<dl>
<dt><b><u>*IMMED</u></b></dt>
<dd>TCP/IP processing is ended immediately.
<p><b>Attention:</b>
</p>
<p>The ENDTCP OPTION(*IMMED) command should be used carefully. Partially updated data may result if an application is processing data and has not completed an operation when the ENDTCP *IMMED command is issued. It is suggested that you do the following:
</p>
<ul>
<li>Notify all users before issuing the ENDTCP command so that they can end their applications.
</li>
<li>Issue the ENDTCP command at a time when you know no TCP/IP traffic is occurring on the system. To display the current TCP/IP traffic on the system, use option 3 on the Work with TCP/IP Status (WRKTCPSTS or NETSTAT) command.
</li>
</ul>
</dd>
<dt><b>*CNTRLD</b></dt>
<dd>TCP/IP processing is ended in a controlled manner. Applications using TCP/IP are given time to complete their processing. New application processing is not allowed. After the specified period of time elapses, the processing for ENDTCP OPTION(*IMMED) is performed.
<p>The controlled end processing does <u> not</u> do any of the following:
</p>
<ul>
<li>It does not monitor to see if all TCP/IP processing has completed before the specified period of time has elapsed.
</li>
<li>It does not notify an application that is actively using a TCP/IP connection that TCP/IP processing will be ended.
</li>
</ul>
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#ENDTCP.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ENDTCP.DELAY"></a>
<h3>Controlled end delay time (DELAY)</h3>
<p>Specifies the amount of time (in seconds) allowed in which to complete a controlled end of TCP/IP processing. After this period of time all TCP/IP processing is ended immediately.
</p>
<dl>
<dt><b><i>1-86400</i></b></dt>
<dd>Specify the number of seconds in which the end operation is completed.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#ENDTCP.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ENDTCP.ENDSVR"></a>
<h3>End application servers (ENDSVR)</h3>
<p>Specifies whether or not all TCP/IP application server jobs are ended when the End TCP/IP (ENDTCP) command ends TCP/IP processing.
</p>
<p><b>Attention:</b>
</p>
<p>Before specifying *NO for this parameter, please consider the following:
</p>
<ul>
<li>It is not possible to end all the TCP/IP processing on your system without affecting the applications which use TCP/IP.
</li>
<li>If TCP/IP processing is ended and no form of TCP/IP emulation (such as AnyNet) is active, then TCP/IP applications which are not restarted will not function correctly.
</li>
<li>Applications that use the Pascal API must always be ended and restarted whenever TCP/IP processing is ended and restarted.
</li>
</ul>
<dl>
<dt><b><u>*YES</u></b></dt>
<dd>The ENDTCP command ends all TCP/IP application servers prior to ending TCP/IP processing.
</dd>
<dt><b>*NO</b></dt>
<dd>The ENDTCP command does not end any TCP/IP application server jobs when it ends TCP/IP processing.
</dd>
</dl>
<p>
<b>Note: </b>ENDTCP ENDSVR(*NO) can be used to end TCP/IP processing without disturbing the operation of jobs using AnyNet. TCP/IP processing will be ended, however TCP/IP application servers that are using AnyNet will continue to function.
</p>
<p>If both TCP/IP and AnyNet are inactive, use the End TCP/IP Server (ENDTCPSVR) command to end TCP/IP application server jobs.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#ENDTCP.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="ENDTCP.COMMAND.EXAMPLES">Examples</a> </h3>
<p><b>Example 1: Ending TCP/IP Immediately</b>
</p>
<p>
<pre>
ENDTCP OPTION(*IMMED)
</pre>
</p>
<p>This command ends all TCP/IP processing on the system immediately.
</p>
<p><b>Example 2: Ending TCP/IP in a Controlled Time</b>
</p>
<p>
<pre>
ENDTCP OPTION(*CNTRLD) DELAY(120)
</pre>
</p>
<p>This command ends all TCP/IP processing after 120 seconds have expired. During this time, new TCP/IP processing is not allowed.
</p>
<p><b>Example 3: Ending TCP/IP Immediately Without Ending Application Servers</b>
</p>
<p>
<pre>
ENDTCP OPTION(*IMMED) ENDSVR(*NO)
</pre>
</p>
<p>This command ends all TCP/IP processing on the system immediately. However, any TCP/IP application servers (FTP, SMTP, and so on) that are active are not ended when TCP/IP processing is ended.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#ENDTCP.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="ENDTCP.ERROR.MESSAGES">Error messages</a> </h3>
<p><b><u>*ESCAPE Messages</u></b>
</p>
<dl>
<dt><b>TCP1A13</b></dt>
<dd>Another job is starting or ending TCP/IP or IP over SNA.
</dd>
<dt><b>TCP1A70</b></dt>
<dd>&amp;1 not active.
</dd>
<dt><b>TCP1A72</b></dt>
<dd>TCP/IP already ending with *CNTRLD option.
</dd>
<dt><b>TCP1A73</b></dt>
<dd>Internal object damaged.
</dd>
<dt><b>TCP1A74</b></dt>
<dd>Error occurred submitting job.
</dd>
<dt><b>TCP1A77</b></dt>
<dd>&amp;1 completed successfully; however errors occurred.
</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="#ENDTCP.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>