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

430 lines
16 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>Run SMG Command (RUNSMGCMD)</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="RUNSMGCMD.Top_Of_Page"></a>
<h2>Run SMG Command (RUNSMGCMD)</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="#RUNSMGCMD.PARAMETERS.TABLE">Parameters</a><br>
<a href="#RUNSMGCMD.COMMAND.EXAMPLES">Examples</a><br>
<a href="#RUNSMGCMD.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="RUNSMGCMD"></a>
<p>The Run System Manager Command (RUNSMGCMD) command provides the capability of sending a command from the central site system to one or more managed systems.
</p>
<p><b>Restriction:</b>
</p>
<p>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.
</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>
</div>
<table width="100%">
<tr><td align="right"><a href="#RUNSMGCMD.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="RUNSMGCMD.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="#RUNSMGCMD.CMD"><b>CMD</b></a></td>
<td valign="top">Command to run</td>
<td valign="top"><i>Command string</i></td>
<td valign="top">Required, Positional 1</td>
</tr>
<tr>
<td valign="top" rowspan="4"><a href="#RUNSMGCMD.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="#RUNSMGCMD.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" rowspan="8"><a href="#RUNSMGCMD.RMTSTRTIME"><b>RMTSTRTIME</b></a></td>
<td valign="top">Start time on managed system</td>
<td valign="top"><i>Element list</i></td>
<td valign="top" rowspan="8">Optional</td>
</tr>
<tr>
<td valign="top">Element 1: Time zone</td>
<td valign="top">
<b><u>*LCLSYS</u></b>, *MGDSYS</td>
</tr>
<tr>
<td valign="top">Element 2: Start after</td>
<td valign="top">
<i>Element list</i></td>
</tr>
<tr>
<td valign="top" style="padding-left:10pt">Element 1: Time</td>
<td valign="top">
<i>Time</i>, <b><u>*CURRENT</u></b></td>
</tr>
<tr>
<td valign="top" style="padding-left:10pt">Element 2: Date</td>
<td valign="top">
<i>Date</i>, <b><u>*CURRENT</u></b>, *NEXT</td>
</tr>
<tr>
<td valign="top">Element 3: Start before</td>
<td valign="top">
<i>Element list</i></td>
</tr>
<tr>
<td valign="top" style="padding-left:10pt">Element 1: Time</td>
<td valign="top">
<i>Time</i>, <b><u>*ANY</u></b>, *CURRENT</td>
</tr>
<tr>
<td valign="top" style="padding-left:10pt">Element 2: Date</td>
<td valign="top">
<i>Date</i>, <b><u>*ANY</u></b>, *CURRENT, *NEXT</td>
</tr>
<tr>
<td valign="top"><a href="#RUNSMGCMD.RTNSPLF"><b>RTNSPLF</b></a></td>
<td valign="top">Return spooled file</td>
<td valign="top"><b><u>*YES</u></b>, *NO, *FAIL</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RUNSMGCMD.USRPRF"><b>USRPRF</b></a></td>
<td valign="top">User profile</td>
<td valign="top"><i>Simple name</i>, <b><u>*NONE</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RUNSMGCMD.PASSWORD"><b>PASSWORD</b></a></td>
<td valign="top">Password</td>
<td valign="top"><i>Character value</i>, *USRPRF, <b><u>*NONE</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RUNSMGCMD.ENCODE"><b>ENCODE</b></a></td>
<td valign="top">Encode command</td>
<td valign="top">*YES, <b><u>*NO</u></b></td>
<td valign="top">Optional</td>
</tr>
</table>
<table width="100%">
<tr><td align="right"><a href="#RUNSMGCMD.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="RUNSMGCMD.CMD"></a>
<h3>Command to run (CMD)</h3>
<p>Specifies the command to run. The command can be any command that is run in batch mode. The command must follow the i5/OS CL command format of 1 to 10 characters with the first character alphabetic and the other nine characters alphanumeric. You can use F4 to enable prompting for a CL command.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RUNSMGCMD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RUNSMGCMD.NODL"></a>
<h3>Managed systems node list (NODL)</h3>
<p>Specifies the node list object name that contains a list of systems which are the destinations for the request. It cannot be specified if control point name (CPNAME) parameter is also specified.
</p>
<p>The possible value is:
</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 values are:
</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 this 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 which contains the list of systems on which the command is to be performed.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RUNSMGCMD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RUNSMGCMD.CPNAME"></a>
<h3>Managed system node names (CPNAME)</h3>
<p>Specifies the APPN control point names of the managed systems on which this activity is to be performed. Control point names cannot be specified if the node list (NODL) parameter is specified.
</p>
<p>The possible value is:
</p>
<dl>
<dt><b><u>*NONE</u></b></dt>
<dd>The systems on which this activity is to be performed are not identified individually. A node list must be specified.
</dd>
</dl>
<p>The possible values are:
</p>
<dl>
<dt><b>*NETATR</b></dt>
<dd>The network ID of the local system is used. This is useful when the node being specified is in the same network as the local system.
</dd>
<dt><b><i>network-identifier</i></b></dt>
<dd>The APPN network identifier of the managed system on which the activity is to be performed.
</dd>
</dl>
<p>The possible control point name value is:
</p>
<dl>
<dt><b><i>control-point-name</i></b></dt>
<dd>The APPN control point name of the managed system on which the activity is to be performed.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RUNSMGCMD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RUNSMGCMD.RMTSTRTIME"></a>
<h3>Start time on managed system (RMTSTRTIME)</h3>
<p>Specifies the date and time when the activity can begin running on the managed system. The current date and time values and next date values are determined when the activity begins running at the central site system based on the central site date and time.
</p>
<p>The possible time zone values are:
</p>
<p>The time zone of the remote start time.
</p>
<dl>
<dt><b><u>*LCLSYS</u></b></dt>
<dd>The remote start time is specified in the time zone of the central site system.
</dd>
<dt><b>*MGDSYS</b></dt>
<dd>The remote start time is specified in the time zone of the managed system.
</dd>
</dl>
<p>The possible start after time values are:
</p>
<p>This is the definition of the time after which the activity is to start.
</p>
<dl>
<dt><b><u>*CURRENT</u></b></dt>
<dd>This function can start on the managed system at any time on or after the time this activity is started on the central site system on the date specified in element 3.
</dd>
<dt><b><i>start-after-time</i></b></dt>
<dd>Specify the time when this function can start on the managed system. The time can be entered as 4 or 6 digits (hhmm or hhmmss) where hh = hours, mm = minutes, and ss = seconds. Seconds are optional. The time can be specified with or without a time separator. With a time separator, specify a string of 5 or 8 digits (hh:mm or hh:mm:ss).
</dd>
</dl>
<p>The possible start after date values are:
</p>
<dl>
<dt><b><u>*CURRENT</u></b></dt>
<dd>This function starts on the managed system on any date on or after the activity starts on the central site system.
</dd>
<dt><b>*NEXT</b></dt>
<dd>This function starts on the managed system on any date after the activity starts on the central site system.
</dd>
<dt><b><i>start-after-date</i></b></dt>
<dd>Specify the date after the functions start on the managed system. The date must be specified in the job date format.
</dd>
</dl>
<p>The possible start before time values are:
</p>
<p>This element is ignored if start before date is *ANY.
</p>
<dl>
<dt><b><u>*ANY</u></b></dt>
<dd>The activity can start at any time on or after the start time.
</dd>
<dt><b>*CURRENT</b></dt>
<dd>The activity must start before the time when the change request is submitted on the date specified on the start before date element.
</dd>
<dt><b><i>start-before-time</i></b></dt>
<dd>Specify the time before which the activity must be started. If the activity cannot start before this time, it never starts. The time can be entered as 4 or 6 digits (hhmm or hhmmss) where hh = hours, mm = minutes, and ss = seconds. Seconds are optional. The time can be specified with or without a time separator (:). With a time separator, specify a string of 5 or 8 digits (hh:mm or hh:mm:ss).
</dd>
</dl>
<p>The possible start before date values are:
</p>
<dl>
<dt><b><u>*ANY</u></b></dt>
<dd>The activity can start at any date on or after the start date.
</dd>
<dt><b>*CURRENT</b></dt>
<dd>The activity must start on the date the change request was submitted.
</dd>
<dt><b>*NEXT</b></dt>
<dd>The activity must start by the day after the date the change request was submitted.
</dd>
<dt><b><i>start-before-date</i></b></dt>
<dd>Specify the date before which the activity must be started. If the activity cannot be started by this date, it never starts. The date must be specified in the job date format.
<p><b>Note:</b>
</p>
<p>The special values *CURRENT and *NEXT cannot be specified for the date and time if the time zone value *MGDSYS is specified.
</p>
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RUNSMGCMD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RUNSMGCMD.RTNSPLF"></a>
<h3>Return spooled file (RTNSPLF)</h3>
<p>Specifies that the output spooled files from the remote command that was submitted returns.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><u>*YES</u></b></dt>
<dd>All spooled files created from the remote command is returned from the managed system. The spooled files from all the nodes are combined into one spooled file that can be viewed by displaying the command activity details of the change request.
</dd>
<dt><b>*NO</b></dt>
<dd>The output data is not returned from the managed system.
</dd>
<dt><b>*FAIL</b></dt>
<dd>The spooled file job log is returned from the managed system if the command fails when running.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RUNSMGCMD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RUNSMGCMD.USRPRF"></a>
<h3>User profile (USRPRF)</h3>
<p>Specifies the user profile under which the command runs at the remote system. If the remote system is running, the NetView Remote Operations Agent/400 product this parameter is ignored at the remote system.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><u>*NONE</u></b></dt>
<dd>No user profile is specified. The default user profile is used on each remote system.
</dd>
<dt><b><i>user-profile</i></b></dt>
<dd>Specify the name of the user profile.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RUNSMGCMD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RUNSMGCMD.PASSWORD"></a>
<h3>Password (PASSWORD)</h3>
<p>The password for the remote user profile.
</p>
<ul>
<li>Managed Systems at releases prior to V5R1M0 only accept uppercased passwords up to 10 characters long. If a longer password is entered, SMU18A2 message with 100B0007 SNA sense code is returned, indicating that the request was rejected.
</li>
<li>Managed Systems at release V5R1M0 and above, running with QPWDLVL system value:
<ul>
<li>0 or 1 -- truncate the received passwords to 10 characters.
</li>
<li>2 or 3 -- accept passwords up to 128 characters.
</li>
</ul>
</li>
</ul>
<p>The possible values are:
</p>
<dl>
<dt><b><u>*NONE</u></b></dt>
<dd>No password is specified.
</dd>
<dt><b>*USRPRF</b></dt>
<dd>The password is the same as the user profile.
</dd>
<dt><b><i>password</i></b></dt>
<dd>Specify the password for the user profile.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RUNSMGCMD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RUNSMGCMD.ENCODE"></a>
<h3>Encode command (ENCODE)</h3>
<p>The password for the remote user profile.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><u>*NO</u></b></dt>
<dd>The command, user profile, and password are not encoded when the request is sent to the remote system.
</dd>
<dt><b>*YES</b></dt>
<dd>The command, user profile, and password are encoded when the request is sent to the managed systems. The remote command key managed system attribute must be specified on both the central site system and the managed system. This attribute can be changed using the Change Managed System Attributes (CHGMGDSYSA) command. The remote command key must be the same on the central site system and the managed system.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RUNSMGCMD.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="RUNSMGCMD.COMMAND.EXAMPLES">Examples</a> </h3>
<p>
<pre>
RUNSMGCMD CMD(STRSBS QSNADS) NODL(MYLIB/SALESOFC)
RTNSPLF(*FAIL)
</pre>
</p>
<p>This command sends a command to start subsystem QSNADS to the systems identified in node list SALESOFC in library MYLIB. Job log spooled files will be returned if the STRSBS command fails.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RUNSMGCMD.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="RUNSMGCMD.ERROR.MESSAGES">Error messages</a> </h3>
<p>None
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RUNSMGCMD.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>