friedkiwi/ibm-information-center
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
8826eae394
ibm-information-center/dist/eclipse/plugins/i5OS.ic.apis_5.4.0.1/qwcrssts.htm

2130 lines
67 KiB
HTML
Raw Normal View History

Add readme and dist folders
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">
<meta name="Copyright" content="Copyright (c) 2006 by IBM Corporation">
<title>Retrieve System Status (QWCRSSTS) API</title>
<!-- Begin Header Records ========================================= -->
<!-- All rights reserved. Licensed Materials Property of IBM -->
<!-- US Government Users Restricted Rights -->
<!-- Use, duplication or disclosure restricted by -->
<!-- GSA ADP Schedule Contract with IBM Corp. -->
<!-- WM SCRIPT A converted by B2H R4.1 (346) (CMS) by V2KEA304 -->
<!-- at RCHVMW2 on 17 Feb 1999 at 11:05:09 -->
<!-- File cleanup completed on 02 August 2001 -->
<!-- Change History: -->
<!-- YYMMDD USERID Change description -->
<!-- File cleanup completed Feb 2002 by v2cdijab -->
<!-- End Header Records -->
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
</head>
<body>
<a name="Top_Of_Page"></a>
<!-- Java sync-link -->
<script type="text/javascript" language="Javascript" src="../rzahg/synch.js">
</script>
<h2>Retrieve System Status (QWCRSSTS) API</h2>
<div class="box" style="width: 80%;">
<br>
&nbsp;&nbsp;Required Parameter Group:<br>
<!-- iddvc RMBR -->
<br>
<table width="100%">
<tr>
<td align="center" valign="top" width="10%">1</td>
<td align="left" valign="top" width="50%">Receiver variable</td>
<td align="left" valign="top" width="20%">Output</td>
<td align="left" valign="top" width="20%">Char(*)</td>
</tr>
<tr>
<td align="center" valign="top">2</td>
<td align="left" valign="top">Length of receiver variable</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Binary(4)</td>
</tr>
<tr>
<td align="center" valign="top">3</td>
<td align="left" valign="top">Format name</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(8)</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="left" valign="top">Reset status statistics</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(10)</td>
</tr>
<tr>
<td align="center" valign="top">5</td>
<td align="left" valign="top">Error Code</td>
<td align="left" valign="top">I/O</td>
<td align="left" valign="top">Char(*)</td>
</tr>
</table>
<br>
&nbsp;&nbsp;Optional Parameter Group:<br>
<!-- iddvc RMBR -->
<br>
<table width="100%">
<tr>
<td align="center" valign="top" width="10%">6</td>
<td align="left" valign="top" width="50%">Pool selection information</td>
<td align="left" valign="top" width="20%">Input</td>
<td align="left" valign="top" width="20%">Char(*)</td>
</tr>
<tr>
<td align="center" valign="top">7</td>
<td align="left" valign="top">Size of pool selection information</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Binary(4)</td>
</tr>
</table>
<br>
&nbsp;&nbsp;Default Public Authority: *USE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: No<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The Retrieve System Status (QWCRSSTS) API allows you to retrieve a group of
statistics that represents the current status of the system.</p>
<br>
<h3>Authorities and Locks</h3>
<p>None.</p>
<br>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>Receiver variable</strong></dt>
<dd>OUTPUT; CHAR(*)
<p>The variable that will receive the system status information being
retrieved. For the format, see <a href="#HDRRECVARN">Format of Data
Returned</a>.</p>
</dd>
<dt><strong>Length of receiver variable</strong></dt>
<dd>INPUT; BINARY(4)
<p>The length of the receiver variable described in <a href="#HDRRECVARN">
Format of Data Returned</a>. If the length is larger than the size of the
receiver variable, the results may not be predictable. The minimum length is 8
bytes.</p>
</dd>
<dt><strong>Format name</strong></dt>
<dd>INPUT; CHAR(8)
<p>The format of the information to be returned. You must use one of the
following format names:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>SSTS0100</em></td>
<td align="left" valign="top">Basic system status information about the
signed-on users and batch jobs in the system. The information returned in this
format is similar to the basic display of the Display System Status (DSPSYSSTS)
command.</td>
</tr>
<tr>
<td align="left" valign="top"><em>SSTS0200</em></td>
<td align="left" valign="top">System status information. The information
returned in this format is similar to the disk information of the intermediate
or advanced display of the DSPSYSSTS command.</td>
</tr>
<tr>
<td align="left" valign="top"><em>SSTS0300</em></td>
<td align="left" valign="top">System status information. The information
returned in this format is similar to the pool information of the intermediate
or advanced display of the DSPSYSSTS command.</td>
</tr>
<tr>
<td align="left" valign="top"><em>SSTS0400</em></td>
<td align="left" valign="top">Pool status information. The information returned
in this format is the SSTS0300 format information and additional pool
information. The pool selection information parameter must be used when this
format is used.</td>
</tr>
<tr>
<td align="left" valign="top"><em>SSTS0500</em></td>
<td align="left" valign="top">Pool subsystem information. The information
returned in this format is a list of active subsystems using a pool. The pool
selection information parameter must be used to select one system pool when
this format is used.</td>
</tr>
</table>
<p>For more information about these formats, see <a href="#HDRRECVARN">Format
of Data Returned</a>.</p>
</dd>
<dt><strong>Reset status statistics</strong></dt>
<dd>INPUT; CHAR(10)
<p>Whether the status statistics and elapsed time are reset to zero, as if this
were the first call to the API. The statistics will be reset before new
information is gathered. This parameter will also reset the status statistics
on the DSPSYSSTS and Work with System Status (WRKSYSSTS) commands. This
parameter is ignored for format SSTS0100 and format SSTS0500.</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>*YES</em></td>
<td align="left" valign="top">Statistics will be reset to zero.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*NO</em></td>
<td align="left" valign="top">Statistics will not be reset to zero.</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Error code</strong></dt>
<dd>I/O; CHAR(*)
<p> The structure in which to return error information. For the format of the
structure, see <a href="../apiref/error.htm#hdrerrcod">Error Code Parameter</a>. If this
parameter is omitted, diagnostic and escape messages are issued to the
application.</p>
</dd>
</dl>
<br>
<h3>Optional Parameter Group</h3>
<dl>
<dt><strong>Pool selection information</strong></dt>
<dd>INPUT; CHAR(*)
<p>Information that is used for selecting which pools to include in the list.
This parameter only applies to the SSTS0400 and SSTS0500 formats. See <a href=
"#HDRLPOOSLI">Format of Pool Selection Information</a> for a description on the
layout of this parameter. If this optional parameter is specified, the Size of
pool selection information parameter must also be specified.</p>
</dd>
<dt><strong>Size of pool selection information</strong></dt>
<dd>INPUT; BINARY(4)
<p>The size, in bytes, of the pool selection information parameter. If the
value of this parameter is 0, the pool selection information is not used. The
valid values for this parameter are 0, 20, or 24. If this parameter is not
specified, the Size of pool selection information is defaulted to 0.</p>
</dd>
</dl>
<br>
<h3><a name="HDRRECVARN">Format of Data Returned</a></h3>
<p>The receiver variable holds the system status information returned.</p>
<br>
<h3><a name="HDRSSTS1">SSTS0100 Format</a></h3>
<p>The following table shows the information returned for the SSTS0100 format.
For a detailed description of each field see <a href="#HDRSSTSFD">Field
Descriptions</a>.</p>
<table border width="80%">
<tr>
<th align="center" valign="bottom" colspan="2">Offset</th>
<th align="left" valign="bottom" rowspan="2">Type</th>
<th align="left" valign="bottom" rowspan="2">Field</th>
</tr>
<tr>
<th align="center" valign="bottom">Dec</th>
<th align="center" valign="bottom">Hex</th>
</tr>
<tr>
<td align="center" valign="top" width="10%">0</td>
<td align="center" valign="top" width="10%">0</td>
<td align="left" valign="top" width="20%">BINARY(4)</td>
<td align="left" valign="top" width="60%">Bytes available</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="center" valign="top">4</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Bytes returned</td>
</tr>
<tr>
<td align="center" valign="top">8</td>
<td align="center" valign="top">8</td>
<td align="left" valign="top">CHAR(8)</td>
<td align="left" valign="top">Current date and time</td>
</tr>
<tr>
<td align="center" valign="top">16</td>
<td align="center" valign="top">10</td>
<td align="left" valign="top">CHAR(8)</td>
<td align="left" valign="top">System name</td>
</tr>
<tr>
<td align="center" valign="top">24</td>
<td align="center" valign="top">18</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Users currently signed on</td>
</tr>
<tr>
<td align="center" valign="top">28</td>
<td align="center" valign="top">1C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Users temporarily signed off (disconnected)</td>
</tr>
<tr>
<td align="center" valign="top">32</td>
<td align="center" valign="top">20</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Users suspended by system request</td>
</tr>
<tr>
<td align="center" valign="top">36</td>
<td align="center" valign="top">24</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Users suspended by group jobs</td>
</tr>
<tr>
<td align="center" valign="top">40</td>
<td align="center" valign="top">28</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Users signed off with printer output waiting to
print</td>
</tr>
<tr>
<td align="center" valign="top">44</td>
<td align="center" valign="top">2C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Batch jobs waiting for messages</td>
</tr>
<tr>
<td align="center" valign="top">48</td>
<td align="center" valign="top">30</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Batch jobs running</td>
</tr>
<tr>
<td align="center" valign="top">52</td>
<td align="center" valign="top">34</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Batch jobs held while running</td>
</tr>
<tr>
<td align="center" valign="top">56</td>
<td align="center" valign="top">38</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Batch jobs ending</td>
</tr>
<tr>
<td align="center" valign="top">60</td>
<td align="center" valign="top">3C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Batch jobs waiting to run or already
scheduled</td>
</tr>
<tr>
<td align="center" valign="top">64</td>
<td align="center" valign="top">40</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Batch jobs held on a job queue</td>
</tr>
<tr>
<td align="center" valign="top">68</td>
<td align="center" valign="top">44</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Batch jobs on a held job queue</td>
</tr>
<tr>
<td align="center" valign="top">72</td>
<td align="center" valign="top">48</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Batch jobs on an unassigned job queue</td>
</tr>
<tr>
<td align="center" valign="top">76</td>
<td align="center" valign="top">4C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Batch jobs ended with printer output waiting to
print</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRSSTS2">SSTS0200 Format</a></h3>
<p>The following table shows the information returned for the SSTS0200 format.
For a detailed description of each field, see the <a href="#HDRSSTSFD">Field
Descriptions</a>.</p>
<table border width="80%">
<tr>
<th align="center" valign="bottom" colspan="2">Offset</th>
<th align="left" valign="bottom" rowspan="2">Type</th>
<th align="left" valign="bottom" rowspan="2">Field</th>
</tr>
<tr>
<th align="center" valign="bottom">Dec</th>
<th align="center" valign="bottom">Hex</th>
</tr>
<tr>
<td align="center" valign="top" width="10%">0</td>
<td align="center" valign="top" width="10%">0</td>
<td align="left" valign="top" width="20%">BINARY(4)</td>
<td align="left" valign="top" width="60%">Bytes available</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="center" valign="top">4</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Bytes returned</td>
</tr>
<tr>
<td align="center" valign="top">8</td>
<td align="center" valign="top">8</td>
<td align="left" valign="top">CHAR(8)</td>
<td align="left" valign="top">Current date and time</td>
</tr>
<tr>
<td align="center" valign="top">16</td>
<td align="center" valign="top">10</td>
<td align="left" valign="top">CHAR(8)</td>
<td align="left" valign="top">System name</td>
</tr>
<tr>
<td align="center" valign="top">24</td>
<td align="center" valign="top">18</td>
<td align="left" valign="top">CHAR(6)</td>
<td align="left" valign="top">Elapsed time</td>
</tr>
<tr>
<td align="center" valign="top">30</td>
<td align="center" valign="top">1E</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Restricted state flag</td>
</tr>
<tr>
<td align="center" valign="top">31</td>
<td align="center" valign="top">1F</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">32</td>
<td align="center" valign="top">20</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">% processing unit used</td>
</tr>
<tr>
<td align="center" valign="top">36</td>
<td align="center" valign="top">24</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Jobs in system</td>
</tr>
<tr>
<td align="center" valign="top">40</td>
<td align="center" valign="top">28</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">% permanent addresses</td>
</tr>
<tr>
<td align="center" valign="top">44</td>
<td align="center" valign="top">2C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">% temporary addresses</td>
</tr>
<tr>
<td align="center" valign="top">48</td>
<td align="center" valign="top">30</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">System ASP</td>
</tr>
<tr>
<td align="center" valign="top">52</td>
<td align="center" valign="top">34</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">% system ASP used</td>
</tr>
<tr>
<td align="center" valign="top">56</td>
<td align="center" valign="top">38</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Total auxiliary storage</td>
</tr>
<tr>
<td align="center" valign="top">60</td>
<td align="center" valign="top">3C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Current unprotected storage used</td>
</tr>
<tr>
<td align="center" valign="top">64</td>
<td align="center" valign="top">40</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Maximum unprotected storage used</td>
</tr>
<tr>
<td align="center" valign="top">68</td>
<td align="center" valign="top">44</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">% DB capability</td>
</tr>
<tr>
<td align="center" valign="top">72</td>
<td align="center" valign="top">48</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Main storage size</td>
</tr>
<tr>
<td align="center" valign="top">76</td>
<td align="center" valign="top">4C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Number of partitions</td>
</tr>
<tr>
<td align="center" valign="top">80</td>
<td align="center" valign="top">50</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Partition identifier</td>
</tr>
<tr>
<td align="center" valign="top">84</td>
<td align="center" valign="top">54</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">88</td>
<td align="center" valign="top">58</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Current processing capacity</td>
</tr>
<tr>
<td align="center" valign="top">92</td>
<td align="center" valign="top">5C</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Processor sharing attribute</td>
</tr>
<!--<tr>
<td align="center" valign="top"><IMG src="delta.gif" alt="Start of change">93</td>
<td align="center" valign="top">5D</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Authorization type<IMG src="deltaend.gif" alt="End of change"></td>
</tr>-->
<tr>
<td align="center" valign="top">93</td>
<td align="center" valign="top">5D</td>
<td align="left" valign="top">CHAR(3)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">96</td>
<td align="center" valign="top">60</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Number of processors</td>
</tr>
<tr>
<td align="center" valign="top">100</td>
<td align="center" valign="top">64</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Active jobs in system</td>
</tr>
<tr>
<td align="center" valign="top">104</td>
<td align="center" valign="top">68</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Active threads in system</td>
</tr>
<tr>
<td align="center" valign="top">108</td>
<td align="center" valign="top">6C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Maximum jobs in system</td>
</tr>
<tr>
<td align="center" valign="top">112</td>
<td align="center" valign="top">70</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">% temporary 256MB segments used</td>
</tr>
<tr>
<td align="center" valign="top">116</td>
<td align="center" valign="top">74</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">% temporary 4GB segments used</td>
</tr>
<tr>
<td align="center" valign="top">120</td>
<td align="center" valign="top">78</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">% permanent 256MB segments used</td>
</tr>
<tr>
<td align="center" valign="top">124</td>
<td align="center" valign="top">7C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">% permanent 4GB segments used</td>
</tr>
<tr>
<td align="center" valign="top">128</td>
<td align="center" valign="top">80</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">% current interactive performance</td>
</tr>
<tr>
<td align="center" valign="top">132</td>
<td align="center" valign="top">84</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">% uncapped CPU capacity used</td>
</tr>
<tr>
<td align="center" valign="top">136</td>
<td align="center" valign="top">88</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">% shared processor pool used
<tr>
<td align="center" valign="top"><IMG src="delta.gif" alt="Start of change">140</td>
<td align="center" valign="top">8C</td>
<td align="left" valign="top">BINARY(8), UNSIGNED</td>
<td align="left" valign="top">Main storage size (long)<IMG src="deltaend.gif" alt="End of change"></td>
</tr>
<!--<tr>
<td align="center" valign="top"><IMG src="delta.gif" alt="Start of change">148</td>
<td align="center" valign="top">94</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">User authorizations available<IMG src="deltaend.gif" alt="End of change"></td>
</tr>-->
<!--<tr>
<td align="center" valign="top"><IMG src="delta.gif" alt="Start of change">152</td>
<td align="center" valign="top">98</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">User authorizations needed<IMG src="deltaend.gif" alt="End of change"></td>
</tr>-->
</td>
</tr>
</table>
<br>
<br>
<h3> <a name="HDRSSTS3">SSTS0300 Format</a></h3>
<p>The following table shows the information returned for the SSTS0300 format.
For a detailed description of each field, see the <a href="#HDRSSTSFD">Field
Descriptions</a>.</p>
<table border width="80%">
<tr>
<th align="center" valign="bottom" colspan="2">Offset</th>
<th align="left" valign="bottom" rowspan="2">Type</th>
<th align="left" valign="bottom" rowspan="2">Field</th>
</tr>
<tr>
<th align="center" valign="bottom">Dec</th>
<th align="center" valign="bottom">Hex</th>
</tr>
<tr>
<td align="center" valign="top" width="10%">0</td>
<td align="center" valign="top" width="10%">0</td>
<td align="left" valign="top" width="20%">BINARY(4)</td>
<td align="left" valign="top" width="60%">Bytes available</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="center" valign="top">4</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Bytes returned</td>
</tr>
<tr>
<td align="center" valign="top">8</td>
<td align="center" valign="top">8</td>
<td align="left" valign="top">CHAR(8)</td>
<td align="left" valign="top">Current date and time</td>
</tr>
<tr>
<td align="center" valign="top">16</td>
<td align="center" valign="top">10</td>
<td align="left" valign="top">CHAR(8)</td>
<td align="left" valign="top">System name</td>
</tr>
<tr>
<td align="center" valign="top">24</td>
<td align="center" valign="top">18</td>
<td align="left" valign="top">CHAR(6)</td>
<td align="left" valign="top">Elapsed time</td>
</tr>
<tr>
<td align="center" valign="top">30</td>
<td align="center" valign="top">1E</td>
<td align="left" valign="top">CHAR(2)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">32</td>
<td align="center" valign="top">20</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Number of pools</td>
</tr>
<tr>
<td align="center" valign="top">36</td>
<td align="center" valign="top">24</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Offset to pool information</td>
</tr>
<tr>
<td align="center" valign="top">40</td>
<td align="center" valign="top">28</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of pool information entry</td>
</tr>
<tr>
<td align="center" valign="top">44</td>
<td align="center" valign="top">2C</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="left" valign="top" rowspan="15" colspan="2">Offsets vary. These
fields repeat, in the order listed, for each pool allocated by the system.</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">System pool</td>
</tr>
<tr>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Pool size</td>
</tr>
<tr>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Reserved size</td>
</tr>
<tr>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Maximum active threads</td>
</tr>
<tr>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Database faults</td>
</tr>
<tr>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Database pages</td>
</tr>
<tr>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Nondatabase faults</td>
</tr>
<tr>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Nondatabase pages</td>
</tr>
<tr>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Active to wait</td>
</tr>
<tr>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Wait to ineligible</td>
</tr>
<tr>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Active to ineligible</td>
</tr>
<tr>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Pool name</td>
</tr>
<tr>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Subsystem name</td>
</tr>
<tr>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Subsystem library name</td>
</tr>
<tr>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Paging option</td>
</tr>
</table>
<br>
<br>
<h3> <a name="HDRSSTS4">SSTS0400 Format</a></h3>
<p>The following table shows the information returned for the SSTS0400 format.
For a detailed description of each field, see the <a href="#HDRSSTSFD">Field
Descriptions</a>.</p>
<table border width="80%">
<tr>
<th align="center" valign="bottom" colspan="2">Offset</th>
<th align="left" valign="bottom" rowspan="2">Type</th>
<th align="left" valign="bottom" rowspan="2">Field</th>
</tr>
<tr>
<th align="center" valign="bottom">Dec</th>
<th align="center" valign="bottom">Hex</th>
</tr>
<tr>
<td align="center" valign="top" width="10%">0</td>
<td align="center" valign="top" width="10%">0</td>
<td align="left" valign="top" width="20%">BINARY(4)</td>
<td align="left" valign="top" width="60%">Bytes available</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="center" valign="top">4</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Bytes returned</td>
</tr>
<tr>
<td align="center" valign="top">8</td>
<td align="center" valign="top">8</td>
<td align="left" valign="top">CHAR(8)</td>
<td align="left" valign="top">Current date and time</td>
</tr>
<tr>
<td align="center" valign="top">16</td>
<td align="center" valign="top">10</td>
<td align="left" valign="top">CHAR(8)</td>
<td align="left" valign="top">System name</td>
</tr>
<tr>
<td align="center" valign="top">24</td>
<td align="center" valign="top">18</td>
<td align="left" valign="top">CHAR(6)</td>
<td align="left" valign="top">Elapsed time</td>
</tr>
<tr>
<td align="center" valign="top">30</td>
<td align="center" valign="top">1E</td>
<td align="left" valign="top">CHAR(2)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">32</td>
<td align="center" valign="top">20</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Main storage size</td>
</tr>
<tr>
<td align="center" valign="top">36</td>
<td align="center" valign="top">24</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Minimum machine pool size</td>
</tr>
<tr>
<td align="center" valign="top">40</td>
<td align="center" valign="top">28</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Minimum base pool size</td>
</tr>
<tr>
<td align="center" valign="top">44</td>
<td align="center" valign="top">2C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Number of pools</td>
</tr>
<tr>
<td align="center" valign="top">48</td>
<td align="center" valign="top">30</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Offset to pool information</td>
</tr>
<tr>
<td align="center" valign="top">52</td>
<td align="center" valign="top">34</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of pool information entry</td>
</tr>
<tr>
<td align="center" valign="top"><IMG src="delta.gif" alt="Start of change">56</td>
<td align="center" valign="top">38</td>
<td align="left" valign="top">BINARY(8), UNSIGNED</td>
<td align="left" valign="top">Main storage size (long)<IMG src="deltaend.gif" alt="End of change"></td>
</tr>
<tr>
<td align="center" valign="top">64</td>
<td align="center" valign="top">40</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="left" valign="top" colspan="4"><strong>Note:</strong> The following
fields repeat, in the order listed, for the number of pools returned.</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">System pool</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Pool size</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Reserved size</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Maximum active threads</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Database faults</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Database pages</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Nondatabase faults</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Nondatabase pages</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Active to wait</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Wait to ineligible</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Active to ineligible</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Pool name</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Subsystem name</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Subsystem library name</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Paging option</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Defined size</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Current threads</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Current ineligible threads</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Tuning priority</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Tuning minimum pool size %</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Tuning maximum pool size %</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Tuning minimum faults</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Tuning per-thread faults</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Tuning maximum faults</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">CHAR(50)</td>
<td align="left" valign="top">Description</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Status</td>
</tr>
<tr>
<td align="center" valign="top"><IMG src="delta.gif" alt="Start of change">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Tuning minimum activity level</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Tuning maximum activity level<IMG src="deltaend.gif" alt="End of change"></td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Reserved</td>
</tr>
</table>
<br>
<br>
<h3> <a name="HDRSSTS5">SSTS0500 Format</a></h3>
<p>The following table shows the information returned for the SSTS0500 format.
For a detailed description of each field, see the <a href="#HDRSSTSFD">Field
Descriptions</a>.</p>
<table border width="80%">
<tr>
<th align="center" valign="bottom" colspan="2">Offset</th>
<th align="left" valign="bottom" rowspan="2">Type</th>
<th align="left" valign="bottom" rowspan="2">Field</th>
</tr>
<tr>
<th align="center" valign="bottom">Dec</th>
<th align="center" valign="bottom">Hex</th>
</tr>
<tr>
<td align="center" valign="top" width="10%">0</td>
<td align="center" valign="top" width="10%">0</td>
<td align="left" valign="top" width="20%">BINARY(4)</td>
<td align="left" valign="top" width="60%">Bytes available</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="center" valign="top">4</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Bytes returned</td>
</tr>
<tr>
<td align="center" valign="top">8</td>
<td align="center" valign="top">8</td>
<td align="left" valign="top">CHAR(8)</td>
<td align="left" valign="top">Current date and time</td>
</tr>
<tr>
<td align="center" valign="top">16</td>
<td align="center" valign="top">10</td>
<td align="left" valign="top">CHAR(8)</td>
<td align="left" valign="top">System name</td>
</tr>
<tr>
<td align="center" valign="top">24</td>
<td align="center" valign="top">18</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">System pool</td>
</tr>
<tr>
<td align="center" valign="top">28</td>
<td align="center" valign="top">1C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Number of subsystems available</td>
</tr>
<tr>
<td align="center" valign="top">32</td>
<td align="center" valign="top">20</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Number of subsystems returned</td>
</tr>
<tr>
<td align="center" valign="top">36</td>
<td align="center" valign="top">24</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Offset to subsystem information</td>
</tr>
<tr>
<td align="center" valign="top">40</td>
<td align="center" valign="top">28</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of subsystem information entry</td>
</tr>
<tr>
<td align="center" valign="top">44</td>
<td align="center" valign="top">32</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Pool name</td>
</tr>
<tr>
<td align="center" valign="top">54</td>
<td align="center" valign="top">36</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="left" valign="top" colspan="4"><strong>Note:</strong> The following
fields repeat, in the order listed, for the number of subsystems returned.</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Subsystem name</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Subsystem library name</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Reserved</td>
</tr>
</table>
<br>
<br>
<h3> <a name="HDRSSTSFD">Field Descriptions</a></h3>
<p><strong>% current interactive
performance.</strong> The percentage of interactive performance assigned to
this logical partition. This value is a percentage of the total interactive
performance available to the entire physical system. For example, a value of 41
in binary would be 41 percent.
<!--<IMG src="delta.gif" alt="Start of change">
If the authorization type for this system is not 5250 CPW, a
value of 0 will be returned. See the Authorization type field for information on
how to determine if the system is 5250 CPW authorized.
<IMG src="deltaend.gif" alt="End of change"></p>-->
<p><strong>% DB capability.</strong> The percentage of processor database
capability (in tenths) that was used during the elapsed time. Database
capability is the maximum CPU utilization available for database processing on
this server. -1 is returned if this server does not report the amount of CPU
used for database processing. For example, a value of 411 in binary would be
41.1 percent.</p>
<p><strong>% permanent addresses.</strong> The percentage (in thousandths) of
the maximum possible addresses for permanent objects that have been used. For
example, a value of 41123 in binary would be 41.123 percent.</p>
<p><strong>% permanent 256MB
segments used.</strong> The percentage (in thousandths) of the maximum possible
permanent 256MB segments that have been used. For example, a value of 41123 in
binary would be 41.123 percent.</p>
<p><strong>% permanent 4GB segments used.</strong> The percentage (in
thousandths) of the maximum possible permanent 4GB segements that have been
used. For example, a value of 41123 in binary would be 41.123 percent.</p>
<p><strong>% processing unit used.</strong> The average (in tenths) of the
elapsed time during which the processing units were in use. For example, a
value of 411 in binary would be 41.1 percent.
For an uncapped partition,
this is the percentage (in tenths) of the configured uncapped shared
processing capacity for the partition that was used during the elapsed
time. This percentage could be greater than 100% for an uncapped
partition.
</p>
<p><strong>% shared processor pool used.</strong>
The percentage (in tenths) of the total shared processor pool
capacity used by all partitions using the pool during the elapsed
time. -1 is returned if this partition does not share processors.
For example, a value of 411 in binary would be 41.1 percent.
</p>
<p><strong>% system ASP used.</strong> The percentage (in ten thousandths) of
the system storage pool currently in use. For example, a value of 41123 in
binary would be 4.1123 percent.</p>
<p><strong>% temporary addresses.</strong> The percentage (in thousandths) of
the maximum possible addresses for temporary objects that have been used. For
example, a value of 41123 in binary would be 41.123 percent.</p>
<p><strong>% temporary 256MB
segments used.</strong> The percentage (in thousandths) of the maximum possible
temporary 256MB segments that have been used. For example, a value of 41123 in
binary would be 41.123 percent.</p>
<p><strong>% temporary 4GB segments used.</strong> The percentage (in
thousandths) of the maximum possible temporary 4GB segments that have been
used. For example, a value of 41123 in binary would be 41.123 percent.</p>
<p><strong>% uncapped CPU capacity used.</strong> The percentage
(in tenths) of the uncapped shared processing capacity for
the partition that was used
during the elapsed time. -1 is returned if this partition can not
use more than its configured processing capacity. For example, a value
of 411 in binary would be 41.1 percent.
</p>
<p><strong>Active jobs in system.</strong> The number of jobs active in the
system (jobs that have been started, but have not yet ended), including both
user and system jobs.</p>
<p><strong>Active threads in system.</strong> The number of initial and
secondary threads in the system (threads that have been started, but have not
yet ended), including both user and system threads.</p>
<p><strong>Active to ineligible.</strong> The rate (in tenths), in transitions
per minute, of transitions of threads from an active condition to an ineligible
condition. For example, a value of 123 in binary would be 12.3 transitions per
minute.</p>
<p><strong>Active to wait.</strong> The rate (in tenths), in transitions per
minute, of transitions of threads from an active condition to a waiting
condition. For example, a value of 123 in binary would be 12.3 transitions per
minute.</p>
<!--<p><IMG src="delta.gif" alt="Start of change"><strong>Authorization type.</strong>
Indicates whether the physical machine is 5250 CPW or user authorized. A value of '0'
indicates 5250 CPW authorization. A value of '1' indicates
user authorization.<IMG src="deltaend.gif" alt="End of change"></p>-->
<p><strong>Batch jobs ended with printer output waiting to print.</strong> The
number of completed batch jobs that produced printer output that is waiting to
print.</p>
<p><strong>Batch jobs ending.</strong> The number of batch jobs that are in the
process of ending due to one of the following conditions:</p>
<ul>
<li>The job finishes processing normally.</li>
<li>The job ends before its normal completion point and is being removed from
the system.</li>
</ul>
<p><strong>Batch jobs held on a job queue.</strong> The number of batch jobs
that were submitted, but were held before they could begin running.</p>
<p><strong>Batch jobs held while running.</strong> The number of batch jobs
that had started running, but are now held.</p>
<p><strong>Batch jobs on a held job queue.</strong> The number of batch jobs on
job queues that have been assigned to a subsystem, but are being held.</p>
<p><strong>Batch jobs on an unassigned job queue.</strong> The number of batch
jobs on job queues that have not been assigned to a subsystem.</p>
<p><strong>Batch jobs running.</strong> The number of batch jobs currently
running on the system.</p>
<p><strong>Batch jobs waiting for messages.</strong> The number of batch jobs
waiting for a reply to a message before they can continue to run.</p>
<p><strong>Batch jobs waiting to run or already scheduled.</strong> The number
of batch jobs on the system that are currently waiting to run, including those
that were submitted to run at a future date and time. Jobs on the job schedule
that have not been submitted are not included.</p>
<p><strong>Bytes available.</strong> The length of all data available to
return. All available data is returned if enough space is provided.</p>
<p><strong>Bytes returned.</strong> The length of the data actually returned.
The number of bytes returned is always less than or equal to both the number of
bytes available and the receiving variable length.</p>
<p><strong>Current date and time.</strong> The date and time when the status
was gathered. This is in system timestamp format.</p>
<p><strong>Current ineligible threads.</strong> The number of ineligible
threads in the pool's activity level.</p>
<p><strong>Current processing
capacity.</strong> The amount (in hundredths) of current processing capacity of
the partition. For a partition sharing physical processors, this attribute
represents the share of the physical processors in the pool it is executing.
For example, a value of 233 means that the partition's current processing
capacity is equivalent to 2.33 physical processors. If the current number of
processors in the partition is four, each virtual processor has 0.58 the
computing capacity of a physical processor in the physical machine. For a
partition using dedicated processors, the value represents the number of
virtual processors that are currently active in the partition. For example, a
partition using four dedicated processors will return a value of 400 for the
current processing capacity.</p>
<p><strong>Current threads.</strong> The number of threads currently using the
pool's activity level.</p>
<p><strong>Current unprotected storage used.</strong> The current amount of
storage in use for temporary objects. This value is in millions (M) of
bytes.</p>
<p><strong>Database faults.</strong> The rate (in tenths), shown in page faults
per second, of database page faults against pages containing either database
data or access paths. A page fault is a program notification that occurs when a
page that is marked as not in main storage is referred to by an active program.
An access path is the means by which the system provides a logical organization
to the data in a database file. For example, a value of 123 in binary would be
12.3 page faults per second.</p>
<p><strong>Database pages.</strong> The rate (in tenths), in pages per second,
at which database pages are brought into the storage pool. A page is a
4096-byte block of information that is transferable between auxiliary storage
and main storage. For example, a value of 123 in binary would be 12.3 pages per
second.</p>
<p><strong>Defined size.</strong> The size of the pool, in kilobytes, as
defined in the shared pool, subsystem description, or system value QMCHPOOL. -1
will be returned for pools without a defined size.</p>
<p><strong>Description.</strong> The description of the shared pool. This field
is blank for private pools defined in subsystem descriptions.</p>
<p><strong>Elapsed time.</strong> The time that has elapsed between the
measurement start time and the current system time. This value is in the format
HHMMSS where HH is the hour, MM is the minute, and SS is the second.</p>
<p><strong>Jobs in system.</strong> The total number of user jobs and system
jobs that are currently in the system. The total includes:</p>
<ul>
<li>All jobs on job queues waiting to be processed.</li>
<li>All jobs currently active (being processed).</li>
<li>All jobs that have completed running but still have
<IMG src="delta.gif" alt="Start of change">pending job logs or
<IMG src="deltaend.gif" alt="End of change">
output on output queues to be produced.</li>
</ul>
<p><strong>Length of pool information entry.</strong> The length of the
information returned for each pool. If the receiver variable was not
sufficiently large to hold all of the pool information, the amount of pool
information returned may be less than this value.</p>
<p><strong>Length of subsystem information entry.</strong> The length of the
information returned for each subsystem. If the receiver variable was not
sufficiently large to hold all of the information, the amount of information
returned may be less than this value.</p>
<p><strong>Main storage size.</strong> The amount of main storage, in
kilobytes, in the system. On a partitioned system, the main storage size can
change while the system is active.<IMG src="delta.gif" alt="Start of change">
If the main storage size is larger than 2,147,483,647 kilobytes, this field
will return a value of 2,147,483,647 (the maximum amount a 4-byte field can hold).
The field "Main storage size (long)" should be used instead of this field, to
return the actual size.<IMG src="deltaend.gif" alt="End of change"></p>
<p><IMG src="delta.gif" alt="Start of change"><strong>Main storage size (long).</strong>
The amount of main storage, in kilobytes, in the system. On a partitioned system,
the main storage size can change while the system is active.<IMG src="deltaend.gif" alt="End of change"></p>
<p><strong>Maximum active threads.</strong> The maximum number of threads that
can be active in the pool at any one time.</p>
<p><strong>Maximum jobs in
system.</strong> The maximum number of jobs that are allowed on the system.
When the number of jobs reaches this maximum, you can no longer submit or start
more jobs on the system. The total includes:</p>
<ul>
<li>All jobs on job queues waiting to be processed.</li>
<li>All jobs currently active (being processed).</li>
<li>All jobs that have completed running but still have output on output queues
to be produced.</li>
</ul>
<p><strong>Maximum unprotected storage used.</strong> The largest amount of
storage for temporary objects used at any one time since the last IPL. This
value is in millions (M) of bytes.</p>
<p><strong>Minimum base pool size.</strong> The minimum size, in kilobytes, for
the base pool. This value is the QBASPOOL system value.</p>
<p><strong>Minimum machine pool size.</strong> The minimum size, in kilobytes,
for the machine pool. This value is the minimum size required by the machine
for the machine pool.</p>
<p><strong>Nondatabase faults.</strong> The rate (in tenths), in page faults
per second, of nondatabase page faults against pages other than those
designated as database pages. For example, a value of 123 in binary would be
12.3 page faults per second.</p>
<p><strong>Nondatabase pages.</strong> The rate (in tenths), in pages per
second, at which nondatabase pages are brought into the storage pool. For
example, a value of 123 in binary would be 12.3 pages per second.</p>
<p><strong>Number of
partitions.</strong> The number of partitions on the system. This includes
partitions that are currently powered on (running) and partitions that are
powered off.</p>
<p><strong>Number of pools.</strong> The number of pools allocated when the
information was gathered. This number may be larger than the number of pools
information is returned for if the receiver variable is not large enough.</p>
<p><strong>Number of
processors.</strong> The number of processors that are currently active in this
partition.</p>
<p><strong>Number of subsystems available.</strong> The number of subsystems
using the pool.</p>
<p><strong>Number of subsystems returned.</strong> The number of subsystems
returned in the receiver variable.</p>
<p><strong>Offset to pool information.</strong> The offset from the beginning
of the structure to the start of the pool information.</p>
<p><strong>Offset to subsystem information.</strong> The offset from the
beginning of the structure to the start of the subsystem information.</p>
<p><strong>Paging option.</strong> Whether the system will dynamically adjust
the paging characteristics of the storage pool for optimum performance. The
following special values may be returned.</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>*FIXED</em></td>
<td align="left" valign="top">The system does not dynamically adjust the paging
characteristics.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*CALC</em></td>
<td align="left" valign="top">The system dynamically adjusts the paging
characteristics.</td>
</tr>
<tr>
<td align="left" valign="top"><em>USRDFN</em></td>
<td align="left" valign="top">The system does not dynamically adjust the paging
characteristics for the storage pool but uses values that have been defined
through an API.</td>
</tr>
</table>
<p><strong>Partition
identifier.</strong> The identifier for the current partition in which the API
is running.</p>
<p><strong>Pool name.</strong> The name of this storage pool. The name may be a
number, in which case it is a private pool associated with a subsystem. The
following special values may be returned.</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*MACHINE</em></td>
<td align="left" valign="top">The specified pool definition is defined to be
the machine pool.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*BASE</em></td>
<td align="left" valign="top">The specified pool definition is defined to be
the base system pool, which can be shared with other subsystems.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*INTERACT</em></td>
<td align="left" valign="top">The specified pool definition is defined to be
the shared pool used for interactive work.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*SPOOL</em></td>
<td align="left" valign="top">The specified pool definition is defined to be
the shared pool used for spooled writers.</td>
</tr>
<tr>
<td align="left" valign="top" nowrap><em>*SHRPOOL1- *SHRPOOL60</em></td>
<td align="left" valign="top">The specified pool definition is defined to be a
shared pool.</td>
</tr>
</table>
<p><strong>Pool size.</strong> The amount of main storage, in kilobytes, in the
pool.</p>
<p><strong>Processor sharing
attribute.</strong> This attribute indicates whether this partition is sharing
processors. If the value indicates the
partition does not share physical processors, then this partition uses only
dedicated processors. If the value indicates the partition shares physical
processors, then this partition uses physical processors from a shared pool of
physical processors. The following values are returned:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">Partition does not share processors</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Partition shares processors (capped).
The partition is limited to using its configured capacity.</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">Partition shares processors (uncapped).
The partition can use more than its configured capacity.</td>
</tr>
</table>
<p><strong>Reserved.</strong> An ignored field.</p>
<p><strong>Reserved size.</strong> The amount of storage, in kilobytes, in the
pool reserved for system use (for example, for save/restore operations). The
system calculates this amount by using storage pool sizes and activity
levels.</p>
<p><strong>Restricted state flag.</strong> Whether the system is in restricted
state. The following values are returned:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">System is not in restricted state.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">System is in restricted state.</td>
</tr>
</table>
<p><strong>Status.</strong>The status of the pool:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">Active</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Inactive</td>
</tr>
</table>
<p><strong>Subsystem library name.</strong> The library containing the
subsystem description. This field will be blank for shared pools (formats
SSTS0300 and SSTS0400).</p>
<p><strong>Subsystem name.</strong> The subsystem with which this storage pool
is associated. This field will be blank for shared pools (formats SSTS0300 and
SSTS0400).</p>
<p><strong>System ASP.</strong> The storage capacity of the system auxiliary
storage pool (ASP1). This value is in millions (M) of bytes.</p>
<p><strong>System name.</strong> The name of the system where the statistics
were collected.</p>
<p><strong>System pool.</strong> The system-related pool identifier for each of
the system storage pools that currently has main storage allocated to it.</p>
<p><strong>Total auxiliary storage.</strong> The total auxiliary storage (in
millions of bytes) on the system.</p>
<p><IMG src="delta.gif" alt="Start of change"><strong>Tuning maximum activity level.</strong> The maximum value that the shared
pool's activity level can be set to by the performance adjuster when the QPFRADJ system
value is set to 2 or 3. This field is 0 for private pools defined in subsystem
descriptions.<IMG src="deltaend.gif" alt="End of change">
</p>
<p><strong>Tuning maximum faults.</strong> The maximum page faults per second
(in hundredths) to use as a guideline for the shared storage pool. For example,
a value of 1234 would be 12.34 page faults per second. This field is 0 for
private pools defined in subsystem descriptions.</p>
<p><strong>Tuning maximum pool size %.</strong> The maximum amount of storage
to allocate to the shared storage pool (as a percentage of total main storage).
The value returned is in hundredths. For example, a value of 1234 would be
12.34 percent. This field is 0 for private pools defined in subsystem
descriptions.</p>
<p><IMG src="delta.gif" alt="Start of change"><strong>Tuning minimum activity level.</strong> The minimum value that the shared
pool's activity level can be set to by the performance adjuster when the QPFRADJ system
value is set to 2 or 3. This field is 0 for private pools defined in subsystem
descriptions.<IMG src="deltaend.gif" alt="End of change"></p>
<p><strong>Tuning minimum faults.</strong> The minimum page faults per second
(in hundredths) to use as a guideline for the shared storage pool. For example,
a value of 1234 would be 12.34 page faults per second. This field is 0 for
private pools defined in subsystem descriptions.</p>
<p><strong>Tuning minimum pool size %.</strong> The minimum amount of storage
to allocate to the shared storage pool (as a percentage of total main storage).
The value returned is in hundredths. For example, a value of 1234 would be
12.34 percent. This field is 0 for private pools defined in subsystem
descriptions.</p>
<p><strong>Tuning per-thread faults.</strong> The page faults per second (in
hundredths) for each active thread to use as a guideline for the shared storage
pool. For example, a value of 1234 would be 12.34 page faults per second. This
field is 0 for private pools defined in subsystem descriptions.</p>
<p><strong>Tuning priority.</strong> The priority of the shared storage pool
used by the system when making automatic performance adjustments. This field is
0 for private pools defined in subsystem descriptions.</p>
<!--<p><IMG src="delta.gif" alt="Start of change"><strong>User authorizations available.</strong>
The number of user authorizations configured for this partition. If the number of user
authorizations available is *NOMAX, a value of -1 will be returned. If
the authorization type is not user, a value of 0 will be returned.
See the Authorization type field for information on how to determine if the system is
user authorized.<IMG src="deltaend.gif" alt="End of change"></p>-->
<!--<p><IMG src="delta.gif" alt="Start of change"><strong>User authorizations needed.</strong>
The number of jobs or threads currently recognized by the operating system as needing a
user authorization. If the authorization type is not user, a value of 0 will be returned.
See the Authorization type field for information on how to determine if the system is
user authorized.<IMG src="deltaend.gif" alt="End of change"></p>-->
<p><strong>Users currently signed on.</strong> The number of users currently
signed on the system. System request jobs and group jobs are not included in
this number.</p>
<p><strong>Users signed off with printer output waiting to print.</strong> The
number of sessions that have ended with printer output files waiting to
print.</p>
<p><strong>Users suspended by group jobs.</strong> The number of user jobs that
have been temporarily suspended by group jobs so that another job may be
run.</p>
<p><strong>Users suspended by system request.</strong> The number of user jobs
that have been temporarily suspended by system request jobs so that another job
may be run.</p>
<p><strong>Users temporarily signed off (disconnected).</strong> The number of
jobs that have been disconnected due to either the selection of option 80
(Temporary sign-off) or the entry of the Disconnect Job (DSCJOB) command.</p>
<p><strong>Wait to ineligible.</strong> The rate (in tenths), in transitions
per minute, of transitions of threads from a waiting condition to an ineligible
condition. For example, a value of 123 in binary would be 12.3 transitions per
minute.</p>
<br>
<h3><a name="HDRLPOOSLI">Format of Pool Selection Information</a></h3>
<table border width="80%">
<tr>
<th align="center" valign="bottom" colspan="2">Offset</th>
<th align="left" valign="bottom" rowspan="2">Type</th>
<th align="left" valign="bottom" rowspan="2">Field</th>
</tr>
<tr>
<th align="center" valign="bottom">Dec</th>
<th align="center" valign="bottom">Hex</th>
</tr>
<tr>
<td align="center" valign="top" width="10%">0</td>
<td align="center" valign="top" width="10%">0</td>
<td align="left" valign="top" width="20%">CHAR(10)</td>
<td align="left" valign="top" width="60%">Type of pool</td>
</tr>
<tr>
<td align="center" valign="top">10</td>
<td align="center" valign="top">A</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Shared pool name</td>
</tr>
<tr>
<td align="center" valign="top">20</td>
<td align="center" valign="top">14</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">System pool identifier</td>
</tr>
</table>
<br>
<br>
<h3> <a name="HDRPLSFD1">Selection Field Descriptions</a></h3>
<p><strong>Shared pool name.</strong>This is used to select a shared pool when
type of pool is *SHARED. The possible values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*ALL</em></td>
<td align="left" valign="top">All shared pools are returned.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*MACHINE</em></td>
<td align="left" valign="top">The machine pool is returned.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*BASE</em></td>
<td align="left" valign="top">The base pool is returned.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*INTERACT</em></td>
<td align="left" valign="top">The shared pool used for interactive work is
returned.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*SPOOL</em></td>
<td align="left" valign="top">The shared pool used for spool writers is
returned.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*SHRPOOL1-60</em></td>
<td align="left" valign="top">The specified shared pool is returned.</td>
</tr>
</table>
<p>When *ALL is specified the pools are returned in the order *MACHINE, *BASE,
*INTERACT, *SPOOL, and *SHRPOOL1-60. This field must be blank when *SYSTEM is
specified for type of pool.</p>
<p><strong>System pool identifier.</strong>This is used to select an active
system pool when type of pool is *SYSTEM. The possible values are:</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>-1</em></td>
<td align="left" valign="top">All active pools are returned.</td>
</tr>
<tr>
<td align="left" valign="top" nowrap><em>1 - 64</em></td>
<td align="left" valign="top">The specified active pool is returned. If the
pool is not active, CPF186B is sent.</td>
</tr>
</table>
<p>When -1 is specified only the active pools are returned in system pool
identifier order. This field must be 0 when *SHARED is specified for type of
pool.</p>
<p><strong>Type of pool.</strong>The type of pools to include in the list. The
possible special values follow:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*SHARED</em></td>
<td align="left" valign="top">The shared pools identified by the shared pool
name field in the selection information. The other selection fields are not
used. The selection information size must be a minimum of 20.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*SYSTEM</em></td>
<td align="left" valign="top">The system pools identified by the system pool
identifier field in the selection information. The other selection fields are
not used. The selection information size must be a minimum of 24.
<p> The pool selection information parameter only applies to the SSTS0400 and
SSTS0500 formats. When other formats are used, the size of pool selection
information parameter must be 0 or not specified.</p>
</td>
</tr>
</table>
<br>
<br>
<h3>Error Messages</h3>
<table width="100%" cellpadding="5">
<!-- cols="15 85" -->
<tr>
<th align="left" valign="top" nowrap>Message ID</th>
<th align="left" valign="top">Error Message Text</th>
</tr>
<tr>
<td align="left" valign="top">CPF1E99 E</td>
<td align="left" valign="top">Unexpected error occurred.</td>
</tr>
<tr>
<td align="left" valign="top">CPF186A E</td>
<td align="left" valign="top">Selection information not allowed with format
&amp;1.</td>
</tr>
<tr>
<td align="left" valign="top">CPF186B E</td>
<td align="left" valign="top">Pool &amp;1 not active.</td>
</tr>
<tr>
<td align="left" valign="top">CPF186C E</td>
<td align="left" valign="top">Selection information required with format
&amp;1.</td>
</tr>
<tr>
<td align="left" valign="top">CPF1869 E</td>
<td align="left" valign="top">Value &amp;1 for reset status statistics not
valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF187A E</td>
<td align="left" valign="top">List of active subsystems not available.</td>
</tr>
<tr>
<td align="left" valign="top">CPF24B4 E</td>
<td align="left" valign="top">Severe error while addressing parameter
list.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3CF1 E</td>
<td align="left" valign="top">Error code parameter not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C1D E</td>
<td align="left" valign="top">Length specified in parameter &amp;1 not
valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C19 E</td>
<td align="left" valign="top">Error occurred with receiver variable
specified.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C21 E</td>
<td align="left" valign="top">Format name &amp;1 is not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C24 E</td>
<td align="left" valign="top">Length of the receiver variable is not
valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C3A E</td>
<td align="left" valign="top">Value for parameter &amp;2 for API &amp;1 not
valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C36 E</td>
<td align="left" valign="top">Number of parameters, &amp;1, entered for this
API was not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C90 E</td>
<td align="left" valign="top">Literal value cannot be changed.</td>
</tr>
<tr>
<td align="left" valign="top">CPF980A E</td>
<td align="left" valign="top">&amp;1 routine in &amp;2 module detected an exception. The exception return code was &amp;3.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9872 E</td>
<td align="left" valign="top">Program or service program &amp;1 in library
&amp;2 ended. Reason code &amp;3.</td>
</tr>
</table>
<br>
<hr>
API introduced: V2R3
<hr>
<table align="center" cellpadding="2" cellspacing="2">
<tr align="center">
<td valign="middle" align="center"><a href="#Top">Top</a> | <a href="wm1.htm">
Work Management APIs</a> | <a href="aplist.htm">APIs by category</a></td>
</tr>
</table>
</body>
</html>
Reference in New Issue Copy Permalink