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

321 lines
11 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>Run SMG Object (RUNSMGOBJ)</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="RUNSMGOBJ.Top_Of_Page"></a>
<h2>Run SMG Object (RUNSMGOBJ)</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="#RUNSMGOBJ.PARAMETERS.TABLE">Parameters</a><br>
<a href="#RUNSMGOBJ.COMMAND.EXAMPLES">Examples</a><br>
<a href="#RUNSMGOBJ.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="RUNSMGOBJ"></a>
<p>The Run System Manager Object (RUNSMGOBJ) command provides the capability of running an object or sending a command from the central site system to one or more managed systems.
</p>
<p><b>Note:</b>
</p>
<p>A change request is automatically submitted that can be viewed to determine the status of this command. A message is returned identifying the name of the change request.
</p>
<p><b>Restrictions:</b>
</p>
<ol>
<li>Only i5/OS program objects, or file members such as *CL, *REXX, and *UNSPEC can be run.
</li>
<li>The object cannot reside in the QTEMP library.
</li>
<li>If a node list (NODL) value is specified, the node list can only contain entries that have a value of *SNA for the address type.
</li>
</ol>
</div>
<table width="100%">
<tr><td align="right"><a href="#RUNSMGOBJ.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="RUNSMGOBJ.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" rowspan="3"><a href="#RUNSMGOBJ.OBJ"><b>OBJ</b></a></td>
<td valign="top">Object</td>
<td valign="top"><i>Qualified object name</i></td>
<td valign="top" rowspan="3">Required, Positional 1</td>
</tr>
<tr>
<td valign="top">Qualifier 1: Object</td>
<td valign="top"><i>Name</i></td>
</tr><tr>
<td valign="top">Qualifier 2: Library</td>
<td valign="top"><i>Name</i>, <b><u>*CURLIB</u></b></td>
</tr><tr>
<td valign="top"><a href="#RUNSMGOBJ.OBJTYPE"><b>OBJTYPE</b></a></td>
<td valign="top">Object type</td>
<td valign="top">*FILE, *FILEDATA, *PGM</td>
<td valign="top">Required, Positional 2</td>
</tr>
<tr>
<td valign="top"><a href="#RUNSMGOBJ.MBR"><b>MBR</b></a></td>
<td valign="top">Member</td>
<td valign="top"><i>Name</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RUNSMGOBJ.DATATYPE"><b>DATATYPE</b></a></td>
<td valign="top">Data type</td>
<td valign="top"><b><u>*UNSPEC</u></b>, *CL, *REXX</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top" rowspan="4"><a href="#RUNSMGOBJ.NODL"><b>NODL</b></a></td>
<td valign="top">Managed systems node list</td>
<td valign="top"><i>Element list</i></td>
<td valign="top" rowspan="4">Optional</td>
</tr>
<tr>
<td valign="top">Element 1: Node list</td>
<td valign="top">
Single values: <b><u>*NONE</u></b><br>Other values: <i>Qualified object name</i></td>
</tr>
<tr>
<td valign="top" style="padding-left:10pt">Qualifier 1: Node list</td>
<td valign="top"><i>Name</i></td>
</tr><tr>
<td valign="top" style="padding-left:10pt">Qualifier 2: Library</td>
<td valign="top"><i>Name</i>, <b><u>*LIBL</u></b>, *CURLIB</td>
</tr><tr>
<td valign="top" rowspan="3"><a href="#RUNSMGOBJ.CPNAME"><b>CPNAME</b></a></td>
<td valign="top">Managed system node names</td>
<td valign="top">Single values: <b><u>*NONE</u></b><br>Other values (up to 50 repetitions): <i>Element list</i></td>
<td valign="top" rowspan="3">Optional</td>
</tr>
<tr>
<td valign="top">Element 1: Network identifier</td>
<td valign="top">
<i>Communications name</i>, <b><u>*NETATR</u></b></td>
</tr>
<tr>
<td valign="top">Element 2: Control point</td>
<td valign="top">
<i>Communications name</i></td>
</tr>
<tr>
<td valign="top"><a href="#RUNSMGOBJ.PARM"><b>PARM</b></a></td>
<td valign="top">Parameters</td>
<td valign="top">Values (up to 20 repetitions): <i>Not restricted</i></td>
<td valign="top">Optional</td>
</tr>
</table>
<table width="100%">
<tr><td align="right"><a href="#RUNSMGOBJ.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="RUNSMGOBJ.OBJ"></a>
<h3>Object (OBJ)</h3>
<p>Specifies the qualified program to be run.
</p>
<p>The possible library values are one of the following:
</p>
<dl>
<dt><b>*CURLIB</b></dt>
<dd>The current library for the job is used to locate the object.
</dd>
<dt><b><i>library-name</i></b></dt>
<dd>Specify that only the library named in this parameter is searched.
</dd>
</dl>
<p>The possible object name value is:
</p>
<dl>
<dt><b><i>object-name</i></b></dt>
<dd>Specify that only characters A through Z, 0 through 9, dollar sign, at sign, and number sign are used in the object name.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RUNSMGOBJ.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RUNSMGOBJ.OBJTYPE"></a>
<h3>Object type (OBJTYPE)</h3>
<p>Specifies the object to be used.
</p>
<dl>
<dt><b>*PGM</b></dt>
<dd>When this is selected, a program object is to be run.
</dd>
<dt><b>*FILEDATA</b></dt>
<dd>A CL input stream or a REXX procedure contained in a file is to be run.
</dd>
<dt><b>*FILE</b></dt>
<dd>The name of the containing the member with the CL input stream to be run.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RUNSMGOBJ.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RUNSMGOBJ.MBR"></a>
<h3>Member (MBR)</h3>
<p>Specifies the i5/OS physical file member. It is ignored unless the object type is *FILE. (Example: i5/OS CL input stream.)
</p>
<dl>
<dt><b><i>member-name</i></b></dt>
<dd>Specify the name of the member to be run.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RUNSMGOBJ.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RUNSMGOBJ.DATATYPE"></a>
<h3>Data type (DATATYPE)</h3>
<p>Specifies the data type of the member. This parameter specifies the type of source file that runs on the managed system.
</p>
<dl>
<dt><b><u>*UNSPEC</u></b></dt>
<dd>Unspecified file member type. If the data type cannot be determined at the managed system, or if the name of the file where this member resides is QCLSRC, then the file member is treated as a CL batch input stream. If the source file is named QREXSRC, the file member is treated as a REXX procedure.
</dd>
<dt><b>*CL</b></dt>
<dd>The file member contains control language in other words, a CL batch input stream.
</dd>
<dt><b>*REXX</b></dt>
<dd>The file member contains a REXX procedure.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RUNSMGOBJ.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RUNSMGOBJ.NODL"></a>
<h3>Managed systems node list (NODL)</h3>
<p>Specifies the node list name that contains a list of systems which are the destinations for the activity. This parameter cannot be specified if the control point name (CPNAME) parameter is also specified.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><u>*NONE</u></b></dt>
<dd>The systems on which this activity is to be performed are not identified by a node list. Individual control point names must be specified.
</dd>
</dl>
<p>The possible library values are one of the following:
</p>
<dl>
<dt><b>*LIBL</b></dt>
<dd>All of the libraries in the user and system portions of the job's library list are searched for the node list object.
</dd>
<dt><b>*CURLIB</b></dt>
<dd>The current library for the job is used to locate the node list object.
</dd>
<dt><b><i>library-name</i></b></dt>
<dd>Specify that only the library named in the parameter is searched.
</dd>
</dl>
<p>The possible node list name value is:
</p>
<dl>
<dt><b><i>node-list-name</i></b></dt>
<dd>Specify the node list object name that contains the list of systems on which the activity is to be performed.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RUNSMGOBJ.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RUNSMGOBJ.CPNAME"></a>
<h3>Managed system node names (CPNAME)</h3>
<p>Specifies the managed systems APPN control point names on which this activity is performed. Control point names cannot be specified if a node list is specified.
</p>
<dl>
<dt><b><u>*NONE</u></b></dt>
<dd>The systems on which this activity is performed are not identified individually. A node list must be specified.
</dd>
<dt><b>*NETATR</b></dt>
<dd>The local system network ID is used. This is useful when the node specified is in the same network as the local system.
</dd>
<dt><b><i>network-identifier</i></b></dt>
<dd>Specify the managed system APPN network identifier on which the activity is performed.
</dd>
</dl>
<p>The possible control point name value is:
</p>
<dl>
<dt><b><i>control-point-name</i></b></dt>
<dd>Specify the managed system APPN control point name on which the activity is performed.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RUNSMGOBJ.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RUNSMGOBJ.PARM"></a>
<h3>Parameters (PARM)</h3>
<p>Specifies that the parameters to be passed when starting the program. Up to 20 parameters can be specified.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><i>parameter</i></b></dt>
<dd>Specify a 1 to 253 character parameter. The prompt panel initially allows 50 characters to be entered. By entering an ampersand (&amp;) in position 1, the field expands for larger parameters.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RUNSMGOBJ.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="RUNSMGOBJ.COMMAND.EXAMPLES">Examples</a> </h3>
<p><b>Example 1: Running a REXX Procedure</b>
</p>
<p>
<pre>
RUNSMGOBJ OBJ(DEVLIB/QREXSRC) OBJTYPE(*FILEDATA)
MBR(REPORT1) CPNAME((*NETATR DEVSYS))
</pre>
</p>
<p>This command runs the REXX procedure in member REPORT1 of file QREXSRC in library DEVLIB on the development system.
</p>
<p><b>Example 2: Running a Program</b>
</p>
<p>
<pre>
RUNSMGOBJ OBJ(SALESLIB/GENRPTS) OBJTYPE(*PGM)
NODL(SYSLIB/ALLSTORES)
PARM('SALES ONLY' 'TODAY')
</pre>
</p>
<p>This command runs a program called GENRPTS in library SALELIB on all systems listed in the node list ALLSTORES in library SYSLIB. Two parameters are passed as input to the program. The first parameter has the value 'SALES ONLY' and the second parameter has the value 'TODAY'.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RUNSMGOBJ.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="RUNSMGOBJ.ERROR.MESSAGES">Error messages</a> </h3>
<p>None
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RUNSMGOBJ.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>