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

230 lines
9.2 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>Start Agent Services (STRAGTSRV)</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="STRAGTSRV.Top_Of_Page"></a>
<h2>Start Agent Services (STRAGTSRV)</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="#STRAGTSRV.PARAMETERS.TABLE">Parameters</a><br>
<a href="#STRAGTSRV.COMMAND.EXAMPLES">Examples</a><br>
<a href="#STRAGTSRV.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="STRAGTSRV"></a>
<p>The Start Agent Services (STRAGTSRV) command starts all of the agent services on this system that are defined in a preferences file. Another preferences file is also used to help define how the services are started. The preferences files are stream files named <i>ableplatform.preferences</i> and <i>able.preferences</i> that are located in the directory specified for the <b>Preferences file directory (PREFDIR)</b> parameter.
</p>
<p>You can use the End Agent Services (ENDAGTSRV) command to end the agent services started by this command.
</p>
<p><b>Restrictions:</b>
</p>
<ul>
<li>You must have all object (*ALLOBJ) and job control (*JOBCTL) special authorities to run this command.
</li>
</ul>
</div>
<table width="100%">
<tr><td align="right"><a href="#STRAGTSRV.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="STRAGTSRV.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="#STRAGTSRV.PREFDIR"><b>PREFDIR</b></a></td>
<td valign="top">Preferences file directory</td>
<td valign="top"><i>Path name</i>, <b><u>*DFT</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#STRAGTSRV.HOMEDIR"><b>HOMEDIR</b></a></td>
<td valign="top">Home directory</td>
<td valign="top"><i>Path name</i>, <b><u>*CURRENT</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#STRAGTSRV.CLASSPATH"><b>CLASSPATH</b></a></td>
<td valign="top">Additional classpath</td>
<td valign="top"><i>Path name</i>, <b><u>*NONE</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top" rowspan="3"><a href="#STRAGTSRV.SBMJOBUSER"><b>SBMJOBUSER</b></a></td>
<td valign="top">User profile for SBMJOB</td>
<td valign="top">Single values: <b><u>*CURRENT</u></b><br>Other values (up to 10 repetitions): <i>Element list</i></td>
<td valign="top" rowspan="3">Optional</td>
</tr>
<tr>
<td valign="top">Element 1: Pool identifier</td>
<td valign="top">
<i>Character value</i></td>
</tr>
<tr>
<td valign="top">Element 2: User profile</td>
<td valign="top">
<i>Name</i></td>
</tr>
</table>
<table width="100%">
<tr><td align="right"><a href="#STRAGTSRV.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="STRAGTSRV.PREFDIR"></a>
<h3>Preferences file directory (PREFDIR)</h3>
<p>Specifies the directory that contains the preferences files that define the agent services to be started and how they are started. The preferences files must be named <i>ableplatform.preferences</i> and <i>able.preferences</i>.
</p>
<dl>
<dt><b><u>*DFT</u></b></dt>
<dd>Use the preferences files located in /QIBM/ProdData/OS400/able/.
</dd>
<dt><b><i>path-name</i></b></dt>
<dd>Specify the directory that contains the preferences files to be used to start the agent services.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#STRAGTSRV.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="STRAGTSRV.HOMEDIR"></a>
<h3>Home directory (HOMEDIR)</h3>
<p>Specifies the directory to be used as the home directory of the agent services.
</p>
<dl>
<dt><b><u>*CURRENT</u></b></dt>
<dd>Use the home directory currently in effect for the job running this command. This is the home directory defined for the current user profile of the job running the STRAGTSRV command.
</dd>
<dt><b><i>path-name</i></b></dt>
<dd>Specify the path name of the directory to be used as the home directory for the Java Virtual Machines (JVMs) which are used by the agents running in these services. The services use this directory to find needed resources.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#STRAGTSRV.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="STRAGTSRV.CLASSPATH"></a>
<h3>Additional classpath (CLASSPATH)</h3>
<p>Specifies the additional classpath to be appended to the classpath setting of each Java Virtual Machine (JVM) to be started to run the agent services.
</p>
<dl>
<dt><b><u>*NONE</u></b></dt>
<dd>No additional classpath will be appended.
</dd>
<dt><b><i>path-name</i></b></dt>
<dd>Specify the path name of the additional classpath to be appended to the classpath setting of each JVM.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#STRAGTSRV.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="STRAGTSRV.SBMJOBUSER"></a>
<h3>User profile for SBMJOB (SBMJOBUSER)</h3>
<p>Specifies the user profile to be used for the Java Virtual Machine (JVM) jobs that will run the agent services. You can specify that a particular JVM run under a different profile than the current user profile of the job running the STRAGTSRV command.
</p>
<p>You can specify an alternate user profile for up to 10 JVM jobs.
</p>
<p><b>Single values</b>
</p>
<dl>
<dt><b><u>*CURRENT</u></b></dt>
<dd>All JVM jobs will run under the same user profile as the current user profile of the job running this command.
</dd>
</dl>
<p><b>Element 1: Pool identifier</b>
</p>
<dl>
<dt><b><i>character-value</i></b></dt>
<dd>Specify an identifier that matches a JVM that is defined in the preferences file specified for the <b>Preferences file directory (PREFDIR)</b> parameter.
</dd>
</dl>
<p><b>Element 2: User profile</b>
</p>
<dl>
<dt><b><i>name</i></b></dt>
<dd>Specify the name of the user profile to be used on the Submit Job (SBMJOB) commands for the JVMs. The JVM jobs will run under the specified user profile instead of the current user profile of the job running this command.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#STRAGTSRV.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="STRAGTSRV.COMMAND.EXAMPLES">Examples</a> </h3>
<p><b>Example 1: Starting with Shipped Default Values</b>
</p>
<p>
<pre>
STRAGTSRV
</pre>
</p>
<p>This command starts all of the agent services defined in the default ableplatform.preferences file in '/qibm/prodData/OS400/able/' in a way defined in the default able.preferences file in '/qibm/prodData/OS400/able/'. The home directory of each agent service will be set to the Home Directory of the current user. All jobs submitted to run the Java Virtual Machines will run under the current profile.
</p>
<p><b>Example 2: Starting with User-Specified Values</b>
</p>
<p>
<pre>
STRAGTSRV PREFDIR('/qibm/userData/OS400/able/test/')
HOMEDIR('/qibm/userData/OS400/able/test/')
CLASSPATH('/qibm/userData/OS400/able/test/test.jar')
SBMJOBUSER((POOL1 TESTPROF1) (POOL3 TESTPROF3))
</pre>
</p>
<p>This command starts all of the agent services defined in the ableplatform.preferences file in '/qibm/userData/OS400/able/test/' in a way defined in the default able.preferences file in '/qibm/userData/OS400/able/test/'. The home directory of each agent service will be set to '/qibm/userData/OS400/able/test/'. The Java Virtual Machines will have thier classpaths set to include the test.jar Java Archive file in '/qibm/userData/OS400/able/test/'. The jobs submitted to run the Java Virtual Machines for POOL1 and POOL3 will run under the users TESTPROF1 and TESTPROF3 respectivley, all other JVMs will run under the current user profile.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#STRAGTSRV.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="STRAGTSRV.ERROR.MESSAGES">Error messages</a> </h3>
<p><b><u>*ESCAPE Messages</u></b>
</p>
<dl>
<dt><b>CPF1890</b></dt>
<dd>*ALLOBJ authority required for requested operation.
</dd>
<dt><b>CPF90FF</b></dt>
<dd>*JOBCTL special authority required to do requested operation.
</dd>
</dl>
<p><b>Error messages from submitted job:</b>
</p>
<p>This command submits a batch job which, in turn, submits additional batch jobs where the agent services will run. The following error messages could be signaled from this batch job:
</p>
<dl>
<dt><b>CPF4B01</b></dt>
<dd>Agent Service not submitted. Reason code &amp;1.
</dd>
<dt><b>CPF4B02</b></dt>
<dd>The Java Virtual Machine(JVM) for the agent service was not started. Reason code &amp;1
</dd>
<dt><b>CPF4B03</b></dt>
<dd>Java Virtual Machine(JVM) exception has occurred.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#STRAGTSRV.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>