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

299 lines
14 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 Subsystem (ENDSBS)</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="ENDSBS.Top_Of_Page"></a>
<h2>End Subsystem (ENDSBS)</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="#ENDSBS.PARAMETERS.TABLE">Parameters</a><br>
<a href="#ENDSBS.COMMAND.EXAMPLES">Examples</a><br>
<a href="#ENDSBS.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="ENDSBS"></a>
<p>The End Subsystem (ENDSBS) command ends the specified subsystem (or all active subsystems) and specifies what happens to active work being processed. No new jobs or routing steps are started in the subsystem or subsystems after this command is run.
</p>
<p>Interactive jobs that have been transferred to a job queue by the Transfer Job (TFRJOB) command are ended as part of ending the subsystem. If an initial program load (IPL) occurs while either a batch or interactive job is on a job queue (because of the TFRJOB command), that job is removed from the job queue during IPL and its job log is produced.
</p>
<p>You can specify that the application programs running in the subsystem are given time to control end-of-job processing. If no time is given or if cleanup cannot be performed within the given time, the system performs minimal end-of-job processing, which can include:
</p>
<ul>
<li>Closing the database files.
</li>
<li>Spooling the job log to an output queue.
</li>
<li>Cleaning up internal objects in the operating system.
</li>
<li>Showing the end-of-job display (for interactive jobs).
</li>
<li>Completing commitment control processing.
</li>
</ul>
<p><b>Restrictions:</b>
</p>
<ol>
<li>To use this command, you must have:
<ul>
<li>job control (*JOBCTL) special authority.
</li>
<li>object operational (*OBJOPR) and read (*READ) authority to the subsystem description associated with the specified subsystem.
</li>
</ul>
</li>
<li>If the controlling subsystem is being ended, because either its name or *ALL is specified for the <b>Subsystem</b> (SBS) parameter, then this command can be run only in
<ul>
<li>an interactive job that is in the controlling subsystem and only from a work station (associated with the interactive job) whose work station entry in the controlling subsystem description specifies *SIGNON for the <b>Allocation</b> (AT) parameter. For more information, see the Add Work Station Entry (ADDWSE) command.
</li>
<li>or a batch job running in the controlling subsystem, initiated from a job queue, with the BCHTIMLMT parameter and SBS(*ALL) specified.
</li>
</ul>
<p>ENDSBS SBS(*ALL) is not allowed in a TELNET job, pass-through job, or in a workstation function job.
</p>
</li>
<li>ENDSBS SBS(*ALL) is not allowed in a batch job that allows multiple threads.
</li>
</ol>
</div>
<table width="100%">
<tr><td align="right"><a href="#ENDSBS.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="ENDSBS.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="#ENDSBS.SBS"><b>SBS</b></a></td>
<td valign="top">Subsystem</td>
<td valign="top"><i>Name</i>, *ALL</td>
<td valign="top">Required, Positional 1</td>
</tr>
<tr>
<td valign="top"><a href="#ENDSBS.OPTION"><b>OPTION</b></a></td>
<td valign="top">How to end</td>
<td valign="top"><b><u>*CNTRLD</u></b>, *IMMED</td>
<td valign="top">Optional, Positional 2</td>
</tr>
<tr>
<td valign="top"><a href="#ENDSBS.DELAY"><b>DELAY</b></a></td>
<td valign="top">Controlled end delay time</td>
<td valign="top">0-99999, <b><u>*NOLIMIT</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#ENDSBS.ENDSBSOPT"><b>ENDSBSOPT</b></a></td>
<td valign="top">End subsystem option</td>
<td valign="top">Single values: <b><u>*DFT</u></b><br>Other values (up to 3 repetitions): *NOJOBLOG, *CHGPTY, *CHGTSL</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#ENDSBS.BCHTIMLMT"><b>BCHTIMLMT</b></a></td>
<td valign="top">Batch time limit</td>
<td valign="top">5-9999, *NOMAX</td>
<td valign="top">Optional</td>
</tr>
</table>
<table width="100%">
<tr><td align="right"><a href="#ENDSBS.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="ENDSBS.SBS"></a>
<h3>Subsystem (SBS)</h3>
<p>Specifies the name of the subsystem to be ended, or it specifies that all active subsystems are to be ended.
</p>
<p>This is a required parameter.
</p>
<dl>
<dt><b>*ALL</b></dt>
<dd>All the subsystems that are currently active are being ended. All jobs are ended except the job in which this command is entered. When this value is specified, the QSYSOPR message queue should be in break delivery mode in the job issuing the end subsystem command.
</dd>
<dt><b><i>name</i></b></dt>
<dd>Specify the simple name of the subsystem to be ended. If the subsystem specified is the controlling subsystem, the interactive job from which the command was issued remains active. Also, if the subsystem specified is the controlling subsystem and the job that issues this command is one of two secondary jobs that are active at the work station, neither of the jobs is forced to end. The controlling subsystem does not end until you end one of the jobs (either by signing off in one job or by ending one job from the other).
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#ENDSBS.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ENDSBS.OPTION"></a>
<h3>How to end (OPTION)</h3>
<p>Specifies whether jobs in the subsystem are ended in a controlled manner (ending jobs in a controlled manner lets the application programs perform end-of-job processing) or immediately.
</p>
<dl>
<dt><b><u>*CNTRLD</u></b></dt>
<dd>The jobs are ended in a controlled manner. This allows the programs that are running to perform cleanup (end of job processing). When a job being ended has a signal handling procedure for the asynchronous signal SIGTERM, the SIGTERM signal is generated for that job. The application has the amount of time specified for the DELAY parameter to complete cleanup before the job is ended.
</dd>
<dt><b>*IMMED</b></dt>
<dd>The jobs are ended immediately. When a job being ended has a signal handling procedure for the asynchronous signal SIGTERM, the SIGTERM signal is generated for that job and the QENDJOBLMT system value specifies a time limit. Other than by handling the SIGTERM signal, the programs that are running are not allowed to perform any cleanup.
<p>
<b>Note: </b>The *IMMED value might cause undesirable results if data has been partially updated. This value should be used only after a controlled end has been attempted unsuccessfully.
</p>
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#ENDSBS.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ENDSBS.DELAY"></a>
<h3>Controlled end delay time (DELAY)</h3>
<p>Specifies the amount of time (in seconds) that is allowed to complete the controlled subsystem end operation. If this amount of time is exceeded and the end operation is not complete, any jobs still being processed in the subsystem are ended immediately.
</p>
<dl>
<dt><b><u>*NOLIMIT</u></b></dt>
<dd>The amount of time in which to complete a controlled end is not limited.
</dd>
<dt><b><i>0-99999</i></b></dt>
<dd>Specify the number of seconds in which the end operation is allowed to complete.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#ENDSBS.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ENDSBS.ENDSBSOPT"></a>
<h3>End subsystem option (ENDSBSOPT)</h3>
<p>Specifies the options to take when ending the active subsystems. In general, specifying these options will improve the performance of the ENDSBS command. Each option has certain side effects that you need to analyze before using that option.
</p>
<p>This parameter has no effect on jobs that are already in the ending status.
</p>
<dl>
<dt><b><u>*DFT</u></b></dt>
<dd>The subsystems will end with no special ending options.
<ul>
<li>Joblogs will be produced.
</li>
<li>The run priority will not change.
</li>
<li>The timeslice value will not change.
</li>
</ul>
</dd>
<dt><b>*NOJOBLOG</b></dt>
<dd>No joblogs will be created for jobs that are ended due to this command being invoked. This includes subsystem monitor jobs and all user jobs in the subsystem. This option can significantly reduce the amount of time necessary to complete the ENDSBS command. However, if a problem occurs in a job, there will be no joblog to record the problem, which may make problem diagnosis difficult or impossible.
</dd>
<dt><b>*CHGPTY</b></dt>
<dd>The CPU priority of jobs that are ending is changed to a higher value (worse priority). The remaining active jobs on the system may have better performance when *CHGPTY is specified. However, jobs that are ending may take longer to finish. This option is ignored if the subsystem is ending controlled. But if the DELAY time limit expires, this option will take effect immediately.
</dd>
<dt><b>*CHGTSL</b></dt>
<dd>The timeslice of jobs that are ending is changed to a lower value. The remaining active jobs on the system may have better performance when *CHGTSL is specified. However, jobs that are ending may take longer to finish. This option is ignored if the subsystem is ending controlled. But if the DELAY time limit expires, this option will take effect immediately.
<p>
<b>Note: </b>Specifying *CHGPTY and *CHGTSL will reduce the impact on other active jobs on the system, but this may cause undesirable delays if there are active workstations that were allocated to the ending subsystem. It may take longer for those workstations to have their signon screens re-displayed since the job using the display must end before the workstation is ready to be allocated to another subsystem.
</p>
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#ENDSBS.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ENDSBS.BCHTIMLMT"></a>
<h3>Batch time limit (BCHTIMLMT)</h3>
<p>Specifies the amount of time (in minutes) that the system will run in batch restricted state. This parameter is only valid when ending all subsystems from a batch job running in the controlling subsystem. Under this condition, a parameter value must be specified. When this parameter is specified, the system will be ended to the restricted state, with only the batch job running the ENDSBS command remaining active. While the system is in this restricted state, system reference code A900 3C70 is displayed. If the specified time limit is reached, the batch job will be ended and the controlling subsystem restarted.
</p>
<p>
<b>Note: </b>This parameter is recommended only for an application that requires no operator interaction.
</p>
<dl>
<dt><b>*NOMAX</b></dt>
<dd>There is no time limit for the batch restricted function. The system will remain in the restricted state until the job ends, the Start Subsystem (STRSBS) command is used, or the Dedicated Service Tools (DST) option to end batch restricted state is used.
</dd>
<dt><b><i>5-9999</i></b></dt>
<dd>Specify the time limit (in minutes) that the batch restricted function is allowed to run.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#ENDSBS.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="ENDSBS.COMMAND.EXAMPLES">Examples</a> </h3>
<p>
<pre>
ENDSBS SBS(QBATCH) OPTION(*CNTRLD) DELAY(60)
</pre>
</p>
<p>This command ends all active jobs in the QBATCH subsystem and ends the subsystem. The active jobs are allowed 60 seconds to perform application-provided end-of-job processing.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#ENDSBS.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="ENDSBS.ERROR.MESSAGES">Error messages</a> </h3>
<p><b><u>*ESCAPE Messages</u></b>
</p>
<dl>
<dt><b>CPF1001</b></dt>
<dd>Wait time expired for system response.
</dd>
<dt><b>CPF1032</b></dt>
<dd>System ending with *CNTRLD option.
</dd>
<dt><b>CPF1033</b></dt>
<dd>System ending with *IMMED option.
</dd>
<dt><b>CPF1034</b></dt>
<dd>All subsystems ending with *CNTRLD option.
</dd>
<dt><b>CPF1035</b></dt>
<dd>Subsystems ending with *IMMED option.
</dd>
<dt><b>CPF1036</b></dt>
<dd>System powering down with *CNTRLD option.
</dd>
<dt><b>CPF1037</b></dt>
<dd>System powering down with *IMMED option.
</dd>
<dt><b>CPF1038</b></dt>
<dd>No authority to use command.
</dd>
<dt><b>CPF1052</b></dt>
<dd>ENDSBS *ALL not allowed in current environment.
</dd>
<dt><b>CPF1053</b></dt>
<dd>Ending controlling subsystem &amp;1 not allowed.
</dd>
<dt><b>CPF1054</b></dt>
<dd>No subsystem &amp;1 active.
</dd>
<dt><b>CPF1055</b></dt>
<dd>Subsystem &amp;1 ending with *CNTRLD option.
</dd>
<dt><b>CPF1056</b></dt>
<dd>Subsystem &amp;1 already ending with *IMMED option.
</dd>
<dt><b>CPF1081</b></dt>
<dd>Controlling subsystem already ending to a single job.
</dd>
<dt><b>CPF1091</b></dt>
<dd>Function check occurred in system arbiter.
</dd>
<dt><b>CPF18C3</b></dt>
<dd>Exit Point Program &amp;1 cannot enter restricted state.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#ENDSBS.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>