263 lines
9.1 KiB
HTML
263 lines
9.1 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>Add TCP/IP Server (ADDTCPSVR)</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="ADDTCPSVR.Top_Of_Page"></a>
|
|
<h2>Add TCP/IP Server (ADDTCPSVR)</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="#ADDTCPSVR.PARAMETERS.TABLE">Parameters</a><br>
|
|
<a href="#ADDTCPSVR.COMMAND.EXAMPLES">Examples</a><br>
|
|
<a href="#ADDTCPSVR.ERROR.MESSAGES">Error messages</a></td>
|
|
</tr>
|
|
</table>
|
|
|
|
<div> <a name="ADDTCPSVR"></a>
|
|
<p>The Add TCP/IP Server (ADDTCPSVR) command is used to add servers to the list of servers supported by the STRTCPSVR (Start TCP/IP server) and ENDTCPSVR (End TCP/IP server) CL commands.
|
|
</p>
|
|
<p>Servers added with the ADDTCPSVR command can be changed with the CHGTCPSVR (Change TCP/IP server) or removed with the RMVTCPSVR (Remove TCP/IP server) commands.
|
|
</p>
|
|
<p><b>Restrictions:</b>
|
|
</p>
|
|
<ul>
|
|
<li>You must have input/output system configuration (*IOSYSCFG) and all object (*ALLOBJ) special authorities to run this command.
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<table width="100%">
|
|
<tr><td align="right"><a href="#ADDTCPSVR.Top_Of_Page">Top</a></td></tr>
|
|
</table>
|
|
<hr size="2" width="100%">
|
|
|
|
<div>
|
|
<h3><a name="ADDTCPSVR.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="#ADDTCPSVR.SVRSPCVAL"><b>SVRSPCVAL</b></a></td>
|
|
<td valign="top">Server special value</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="#ADDTCPSVR.PGM"><b>PGM</b></a></td>
|
|
<td valign="top">Program to call</td>
|
|
<td valign="top"><i>Qualified object name</i></td>
|
|
<td valign="top" rowspan="3">Required, Positional 2</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top">Qualifier 1: Program to call</td>
|
|
<td valign="top"><i>Name</i></td>
|
|
</tr><tr>
|
|
<td valign="top">Qualifier 2: Library</td>
|
|
<td valign="top"><i>Name</i></td>
|
|
</tr><tr>
|
|
<td valign="top"><a href="#ADDTCPSVR.SVRNAME"><b>SVRNAME</b></a></td>
|
|
<td valign="top">Server name</td>
|
|
<td valign="top"><i>Character value</i></td>
|
|
<td valign="top">Required, Positional 3</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top"><a href="#ADDTCPSVR.SVRTYPE"><b>SVRTYPE</b></a></td>
|
|
<td valign="top">Server type</td>
|
|
<td valign="top"><i>Character value</i></td>
|
|
<td valign="top">Required, Positional 4</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top"><a href="#ADDTCPSVR.AUTOSTART"><b>AUTOSTART</b></a></td>
|
|
<td valign="top">Autostart</td>
|
|
<td valign="top">*YES, <b><u>*NO</u></b></td>
|
|
<td valign="top">Optional, Positional 5</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top"><a href="#ADDTCPSVR.TEXT"><b>TEXT</b></a></td>
|
|
<td valign="top">Text 'description'</td>
|
|
<td valign="top"><i>Character value</i>, <b><u>*BLANK</u></b></td>
|
|
<td valign="top">Optional, Positional 6</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<table width="100%">
|
|
<tr><td align="right"><a href="#ADDTCPSVR.Top_Of_Page">Top</a></td></tr>
|
|
</table>
|
|
</div>
|
|
<div> <a name="ADDTCPSVR.SVRSPCVAL"></a>
|
|
<h3>Server special value (SVRSPCVAL)</h3>
|
|
<p>Specifies the special value to be used to identify the server being added. This value will be used by the Start TCP/IP Server (STRTCPSVR) and End TCP/IP Server (ENDTCPSVR) commands.
|
|
</p>
|
|
<p>This is a required parameter.
|
|
</p>
|
|
<dl>
|
|
<dt><b><i>character-value</i></b></dt>
|
|
<dd>Specify a special value (up to 10 characters) that will identify the server to be added. The following rules and restrictions apply:
|
|
<ul>
|
|
<li>The first character must be an asterisk ('*')
|
|
</li>
|
|
<li>The second character must be an uppercase letter ('A-Z')
|
|
</li>
|
|
<li>The remaining characters must be part of the following alphanumeric character set ('A-Z','0-9').
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<table width="100%">
|
|
<tr><td align="right"><a href="#ADDTCPSVR.Top_Of_Page">Top</a></td></tr>
|
|
</table>
|
|
<div> <a name="ADDTCPSVR.PGM"></a>
|
|
<h3>Program to call (PGM)</h3>
|
|
<p>Specifies the program to be called when this server is started or ended by the following commands:
|
|
</p>
|
|
<ul>
|
|
<li>STRTCPSVR (Start TCP/IP Server)
|
|
</li>
|
|
<li>ENDTCPSVR (End TCP/IP Server)
|
|
</li>
|
|
<li>STRTCP (Start TCP/IP) - if the server is defined as AUTOSTART(*YES)
|
|
</li>
|
|
<li>ENDTCP (End TCP/IP)
|
|
</li>
|
|
</ul>
|
|
<p>The following ten-character argument will be passed to the defined program:
|
|
</p>
|
|
<ul>
|
|
<li>"*START " - if STRTCPSVR or STRTCP is issued.
|
|
</li>
|
|
<li>"*END " - if ENDTCPSVR or ENDTCP is issued.
|
|
</li>
|
|
</ul>
|
|
<p>This is a required parameter.
|
|
</p>
|
|
<p><b>Qualifier 1: Program to call</b>
|
|
</p>
|
|
<dl>
|
|
<dt><b><i>name</i></b></dt>
|
|
<dd>Specify the name of the program to be called when this server is started or ended.
|
|
</dd>
|
|
</dl>
|
|
<p><b>Qualifier 2: Library</b>
|
|
</p>
|
|
<dl>
|
|
<dt><b><i>name</i></b></dt>
|
|
<dd>Specify the name of library where the program is located.
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<table width="100%">
|
|
<tr><td align="right"><a href="#ADDTCPSVR.Top_Of_Page">Top</a></td></tr>
|
|
</table>
|
|
<div> <a name="ADDTCPSVR.SVRNAME"></a>
|
|
<h3>Server name (SVRNAME)</h3>
|
|
<p>Specifies the textual server name that will be used by iSeries Navigator to display an entry for this server.
|
|
</p>
|
|
<p>This is a required parameter.
|
|
</p>
|
|
<dl>
|
|
<dt><b><i>character-value</i></b></dt>
|
|
<dd>Specify the text name of this server.
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<table width="100%">
|
|
<tr><td align="right"><a href="#ADDTCPSVR.Top_Of_Page">Top</a></td></tr>
|
|
</table>
|
|
<div> <a name="ADDTCPSVR.SVRTYPE"></a>
|
|
<h3>Server type (SVRTYPE)</h3>
|
|
<p>Specifies the server type that will be used by Work Management functions from iSeries Navigator to find job information, such as joblogs and server status, for this server.
|
|
</p>
|
|
<p>This is a required parameter.
|
|
</p>
|
|
<dl>
|
|
<dt><b><i>character-value</i></b></dt>
|
|
<dd>Specify the server type name to be used by iSeries Navigator to find joblog information and server status. The following rules and restrictions apply:
|
|
<ul>
|
|
<li>Imbedded blanks or null characters are not allowed.
|
|
</li>
|
|
<li>The server job running on the system must <b>also</b> have the server type defined for that job. This is done by adding the server type definition using the Change Job (QWTCHGJB) API <b>after</b> the server job is started. See the Change Job (QWTCHGJB) API for more detail on how to define the server type within the server job. If the server type is not set within the server job or if the server type does not match what is defined on the SVRTYPE parameter, joblog information and server status will not be available using iSeries Navigator.
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<table width="100%">
|
|
<tr><td align="right"><a href="#ADDTCPSVR.Top_Of_Page">Top</a></td></tr>
|
|
</table>
|
|
<div> <a name="ADDTCPSVR.AUTOSTART"></a>
|
|
<h3>Autostart (AUTOSTART)</h3>
|
|
<p>Specifies whether the server being added should be started when the Start TCP/IP (STRTCP) command is run.
|
|
</p>
|
|
<dl>
|
|
<dt><b><u>*NO</u></b></dt>
|
|
<dd>The server being added should not start when the STRTCP command runs.
|
|
</dd>
|
|
<dt><b>*YES</b></dt>
|
|
<dd>The server being added should start when the STRTCP command runs.
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<table width="100%">
|
|
<tr><td align="right"><a href="#ADDTCPSVR.Top_Of_Page">Top</a></td></tr>
|
|
</table>
|
|
<div> <a name="ADDTCPSVR.TEXT"></a>
|
|
<h3>Text 'description' (TEXT)</h3>
|
|
<p>Specifies a text description for the server being added.
|
|
</p>
|
|
<dl>
|
|
<dt><b><u>*BLANK</u></b></dt>
|
|
<dd>No text is specified.
|
|
</dd>
|
|
<dt><b><i>character-value</i></b></dt>
|
|
<dd>Specify no more than 50 characters of text, enclosed in apostrophes.
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<table width="100%">
|
|
<tr><td align="right"><a href="#ADDTCPSVR.Top_Of_Page">Top</a></td></tr>
|
|
</table>
|
|
<hr size="2" width="100%">
|
|
<div><h3><a name="ADDTCPSVR.COMMAND.EXAMPLES">Examples</a> </h3>
|
|
<p>
|
|
<pre>
|
|
ADDTCPSVR SVRSPCVAL(*XYZ)
|
|
PGM(MYLIB/UUSTARTXYZ)
|
|
SVRNAME('XYZ protocol server')
|
|
SVRTYPE('XYZ') AUTOSTART(*YES)
|
|
</pre>
|
|
</p>
|
|
<p>This command adds a new server to the list of servers supported by the STRTCPSVR (Start TCP/IP Server) and ENDTCPSVR (End TCP/IP Server) CL commands. The new server type can be selected on the STRTCPSVR or ENDTCPSVR commands by specifying SERVER(*XYZ). User program UUSTARTXYZ in library MYLIB will be called when the XYZ server is started or ended. The new server will be started automatically when the STRTCPSVR command is run specifying SERVER(*AUTOSTART), or when the STRTCP (Start TCP/IP) command is run.
|
|
</p>
|
|
</div>
|
|
<table width="100%">
|
|
<tr><td align="right"><a href="#ADDTCPSVR.Top_Of_Page">Top</a></td></tr>
|
|
</table>
|
|
<hr size="2" width="100%">
|
|
<div><h3><a name="ADDTCPSVR.ERROR.MESSAGES">Error messages</a> </h3>
|
|
<p><b><u>*ESCAPE Messages</u></b>
|
|
</p>
|
|
<dl>
|
|
<dt><b>TCP1621</b></dt>
|
|
<dd>TCP/IP server &1 not added.
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<table width="100%">
|
|
<tr><td align="right"><a href="#ADDTCPSVR.Top_Of_Page">Top</a></td></tr>
|
|
</table>
|
|
</body>
|
|
</html>
|