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

794 lines
30 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">
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
<title>Retrieve Partition Information (dlpar_get_info) API</title>
<!-- Begin Header Records ========================================== -->
<!-- Created: -->
<!-- 040404 jlv New API -->
<!-- Change History: -->
<!-- YYMMDD USERID Change description -->
<!-- 041109 AP API update -->
<!-- End Header Records -->
</head>
<body>
<!-- Java sync-link -->
<script language="Javascript" src="../rzahg/synch.js" type="text/javascript">
</script>
<a name="Top_Of_Page"></a>
<h2>Retrieve Partition Information (dlpar_get_info) API</h2>
<div class="box" style="width: 60%;">
<br>
&nbsp;&nbsp;Syntax:
<pre>#include &lt;qpmlpmgt.h&gt;
int dlpar_get_info(void *receiver_variable, int data_format, int receiver_length);
</pre>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Service Program Name: QPMLPMGT<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Default Public Authority: *EXCLUDE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: Yes<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>Retrieve Partition Information (dlpar_get_info) API returns information
about configuration and CPU utilization of the logical partition where this API was called.
The API can return information in one of two formats.
Format is specified by <em>Format of data to return</em> parameter.
</p>
<p>Format 1 returns information about those partition attributes that are unlikely to change without partition IPL.</p>
<p>Format 2 returns information about partition attributes that can change at any time during partition operation.
Data returned by format 2 should be sampled more frequently.</p>
<p>If some fields returned by this API are not supported by the installed version of the hypervisor, these fields will be set to zero.</p>
<br>
<h3>Authorities and Locks</h3>
<p><em>None.</em></p>
<br>
<h3>Parameters</h3>
<dl><dt><strong>Receiver variable </strong>&nbsp;(<em>receiver_variable</em>)</dt><dd>OUTPUT; CHAR(*)
<p>The variable that is to receive the requested information.</p>
</dd><dt><strong>Format of the data to return </strong>&nbsp;(<em>data_format</em>)</dt><dd>INPUT; BINARY(4)
<p>This parameter determines what information is returned in the receiver variable.
The supported formats are:</p>
<table cellpadding="5">
<tr>
<td align="left" valign="top">
Value</td>
<td align="left" valign="top">Description</td>
</tr>
<tr>
<td align="left" valign="top">
1</td>
<td align="left" valign="top">Partition information that is unlikely to change without partition IPL</td>
</tr>
<tr>
<td align="left" valign="top">
2</td>
<td align="left" valign="top">Partition information that may change at any time during partition operation</td>
</tr>
</table><br>
</dd><dt><strong>Length of the receiver variable </strong>&nbsp;(<em>receiver_length</em>)</dt><dd>INPUT; BINARY(4)
<p>Number of bytes provided by the caller in the receiver variable.
The API will return as much information as fits in the receiver variable.
The size of the receiver variable can be smaller than the length of the requested format
as long as <em>Length of the receiver variable</em> parameter is specified correctly.
</p>
</dd></dl>
<br>
<h3>Format 1</h3>
<p>The following information is returned for the Format 1. For detailed
descriptions of the fields in the table, see <a href="#HDRDESC">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%">Version</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">4</td>
<td align="center" valign="top" width="10%">4</td>
<td align="left" valign="top" width="20%">BINARY(4)</td>
<td align="left" valign="top" width="60%">Reserved</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">8</td>
<td align="center" valign="top" width="10%">8</td>
<td align="left" valign="top" width="20%">BINARY(8)</td>
<td align="left" valign="top" width="60%">Maximum memory</td>
</tr>
<tr>
<td align="center" valign="top">16</td>
<td align="center" valign="top">10</td>
<td align="left" valign="top">BINARY(8)</td>
<td align="left" valign="top">Minimum memory</td>
</tr>
<tr>
<td align="center" valign="top">24</td>
<td align="center" valign="top">18</td>
<td align="left" valign="top">BINARY(8)</td>
<td align="left" valign="top">Memory increment</td>
</tr>
<tr>
<td align="center" valign="top">32</td>
<td align="center" valign="top">20</td>
<td align="left" valign="top">BINARY(8)</td>
<td align="left" valign="top">Dispatch wheel rotation time</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">LPAR number</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">LPAR flags</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">Maximum physical processors in system</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">Minimum virtual processors</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">Maximum virtual processors</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">Minimum processing capacity</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 processing capacity</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">Processing capacity increment</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">Minimum interactive capacity</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">Maximum interactive capacity</td>
</tr>
<tr>
<td align="center" valign="top">80</td>
<td align="center" valign="top">50</td>
<td align="left" valign="top">BINARY(2)</td>
<td align="left" valign="top">SMT threads per processor</td>
</tr>
<tr>
<td align="center" valign="top">82</td>
<td align="center" valign="top">52</td>
<td align="left" valign="top">CHAR(6)</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">CHAR(256)</td>
<td align="left" valign="top">Partition name</td>
</tr>
<tr>
<td align="center" valign="top">344</td>
<td align="center" valign="top">158</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Defined processing capacity</td>
</tr>
<td align="center" valign="top">348</td>
<td align="center" valign="top">15C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Defined virtual processors</td>
</tr>
<tr>
<td align="center" valign="top">352</td>
<td align="center" valign="top">160</td>
<td align="left" valign="top">BINARY(8)</td>
<td align="left" valign="top">Defined memory</td>
</tr>
<tr>
<td align="center" valign="top">360</td>
<td align="center" valign="top">168</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Defined variable capacity weight</td>
</tr>
<tr>
<td align="center" valign="top">364</td>
<td align="center" valign="top">16C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Defined interactive capacity</td>
</tr>
</table>
<br><br>
<h3><a name="HDRDESC">Field Descriptions</a></h3>
<p><strong>Defined interactive capacity</strong> is the desired amount of interactive capacity that was configured for this partition through the HMC.
Partition's interactive capacity is defined as this partition's portion of total interactive capacity of the physical machine (in units of 1/100 of a percent).</p>
<p><strong>Defined memory</strong> is the desired amount of memory (in megabytes) that was configured for this partition through the HMC.</p>
<p><strong>Defined processing capacity</strong> is the desired amount of processing capacity (in units of 1/100 of a physical processor) that was configured for this partition through the HMC.</p>
<p><strong>Defined variable capacity weight</strong> is the desired weighting factor that was configured for this partition through the HMC.
Variable capacity weight is used for uncapped partitions when they compete for unused CPU cycles in the shared pool.
Variable capacity weight can be in the range of 0 - 255. The larger the weight, the more the chance this partition will get additional CPU cycles from the shared pool.</p>
<p><strong>Defined virtual processors</strong> is the desired number of virtual processors that was configured for this partition through the HMC.</p>
<p><strong>Dispatch wheel rotation time</strong> is the number of nanoseconds in the hypervisor's scheduling window. Each virtual processor will be given the opportunity to execute on a physical processor some time during this period. The amount of time each virtual processor is able to use a physical processor is determined by partition processing capacity.</p>
<p><strong>LPAR number</strong> is the identifier of this partition. It is unique within a physical machine.</p>
<p><strong>LPAR flags</strong> indicate whether or not hardware threads are bound in the partition and whether or not the partition uses only dedicated physical processors.</p>
<p>This is a bit field and it contains the combination of the following values:</p>
<table width="100%">
<tr>
<td align="left" valign="top" width="15%">x'00000001'</td>
<td align="left" valign="top" width="60%">Partition uses dedicated processors</td>
</tr>
<tr>
<td align="left" valign="top">x'00000002'</td>
<td align="left" valign="top">Hardware threads are bound</td>
</tr>
</table>
<br>
<p>Use the following table:</p>
<table border width="100%">
<tr>
<th align="center" valign="bottom" colspan="2">Offset</th>
<th align="left" valign="bottom" rowspan="2">Bit</th>
<th align="left" valign="bottom" rowspan="2">Type</th>
<th align="left" valign="bottom" rowspan="2">Field</th>
<th align="left" valign="bottom" rowspan="2">Description</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="6%">44</td>
<td align="center" valign="top" width="6%">2C</td>
<td align="center" valign="top" width="5%"><br></td>
<td align="left" valign="top" width="11%">Binary(4)</td>
<td align="left" valign="top" width="15%">lpar_flags</td>
<td align="left" valign="top" width="58%"><br></td>
</tr>
<tr>
<td align="center" valign="top" width="6%">44</td>
<td align="center" valign="top" width="6%">2C</td>
<td align="center" valign="top" width="5%">0</td>
<td align="left" valign="top" width="11%">Bit(30)</td>
<td align="left" valign="top" width="15%">Reserved.</td>
<td align="left" valign="top" width="58%">Reserved.</td>
</tr>
<tr>
<td align="center" valign="top" width="6%">47</td>
<td align="center" valign="top" width="6%">2F</td>
<td align="center" valign="top" width="5%">6</td>
<td align="left" valign="top" width="11%">Bit(1)</td>
<td align="left" valign="top" width="15%">lpar_smtbound</td>
<td align="left" valign="top" width="58%">Bound hardware threads indicator. If on, hardware threads are bound. </td>
</tr>
<tr>
<td align="center" valign="top" width="6%">47</td>
<td align="center" valign="top" width="6%">2F</td>
<td align="center" valign="top" width="5%">7</td>
<td align="left" valign="top" width="11%">Bit(1)</td>
<td align="left" valign="top" width="15%">lpar_dedicated</td>
<td align="left" valign="top" width="58%">Dedicated processors indicator. If on, partition uses dedicated processors.
</td>
</tr>
</table>
<br>
<p><strong>Maximum interactive capacity</strong> is the maximum portion of the physical machine's interactive capacity (in units of 1/100 of a percent), that can be assigned to this partition.</p>
<p><strong>Maximum memory</strong> is the maximum amount of main storage (in units of megabytes) that can be assigned to this partition.</p>
<p><strong>Maximum processing capacity</strong> is the maximum amount of processing capacity (in units of 1/100 of a physical processor) that can be assigned to this partition.<p>
<p><strong>Maximum physical processors in system</strong> is the maximum number of physical processors that can be active in this physical machine without installing additional processors. This field includes currently active processors and any standby (on demand) processors that are present in this physical machine.</p>
<p><strong>Maximum virtual processors</strong> is the maximum number of virtual processors that can be configured for this partition.</p>
<p><strong>Memory increment</strong> is the smallest amount of main storage (in units of megabytes) that can be added to or removed from this partition's memory.<p>
<p><strong>Minimum interactive capacity</strong> is the minimum portion of the physical machine's interactive capacity (in units of 1/100 of a percent), that can be assigned to this partition. </p>
<p><strong>Minimum memory</strong> is the minimum amount of main storage (in units of megabytes) that can be assigned to this partition.</p>
<p><strong>Minimum processing capacity</strong> is the minimum amount of processing capacity (in units of 1/100 of a physical processor) that can be assigned to this partition.</p>
<p><strong>Minimum virtual processors</strong> is the minimum number of virtual processors that can be configured for this partition.</p>
<p><strong>Partition name</strong> is the name that has been assigned to this partition. This field is a null-terminated UTF-8 character string.</p>
<p><strong>Processing capacity increment</strong> is the smallest capacity (in units of 1/100 of a physical processor) that can be added to or removed from this partition's processing capacity.</p>
<p><strong>Reserved</strong> is a reserved field for alignment purposes.</p>
<p><strong>SMT threads per processor</strong> is the number of hardware threads per processor when hardware multi-threading is enabled.</p>
<p><strong>Version</strong> is the version of format 1 returned by the API.</p>
<br>
<h3>Format 2</h3>
<p>The following information is returned for Format2. For detailed
descriptions of the fields in the table, see <a href="#FMTLPMG0200DESC">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%">Version</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">4</td>
<td align="center" valign="top" width="10%">4</td>
<td align="left" valign="top" width="20%">BINARY(4)</td>
<td align="left" valign="top" width="60%">Reserved</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">8</td>
<td align="center" valign="top" width="10%">8</td>
<td align="left" valign="top" width="20%">BINARY(8)</td>
<td align="left" valign="top" width="60%">Online memory</td>
</tr>
<tr>
<td align="center" valign="top">16</td>
<td align="center" valign="top">10</td>
<td align="left" valign="top">BINARY(8)</td>
<td align="left" valign="top">Total CPU time</td>
</tr>
<tr>
<td align="center" valign="top">24</td>
<td align="center" valign="top">18</td>
<td align="left" valign="top">BINARY(8)</td>
<td align="left" valign="top">Interactive CPU time</td>
</tr>
<tr>
<td align="center" valign="top">32</td>
<td align="center" valign="top">20</td>
<td align="left" valign="top">BINARY(8)</td>
<td align="left" valign="top">Interactive CPU time above threshold</td>
</tr>
<tr>
<td align="center" valign="top">40</td>
<td align="center" valign="top">28</td>
<td align="left" valign="top">BINARY(8)</td>
<td align="left" valign="top">Unused CPU time in a shared pool</td>
</tr>
<tr>
<td align="center" valign="top">48</td>
<td align="center" valign="top">30</td>
<td align="left" valign="top">BINARY(8)</td>
<td align="left" valign="top">Dispatch latency</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">LPAR flags</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">Physical processors in the system</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">Online virtual processors</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">Physical processors in the shared pool</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">Unallocated processing capacity in a partition group</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">Processing capacity</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">Variable capacity weight</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">Unallocated variable capacity weight in a partition group</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">Minimum required processing capacity</td>
</tr>
<tr>
<td align="center" valign="top">92</td>
<td align="center" valign="top">5C</td>
<td align="left" valign="top">Binary(2)</td>
<td align="left" valign="top">Interactive capacity</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">Maximum licensed capacity</td>
</tr>
<tr>
<td align="center" valign="top">100</td>
<td align="center" valign="top">64</td>
<td align="left" valign="top">BINARY(2)</td>
<td align="left" valign="top">Partition group ID</td>
</tr>
<tr>
<td align="center" valign="top">102</td>
<td align="center" valign="top">66</td>
<td align="left" valign="top">BINARY(2)</td>
<td align="left" valign="top">Shared processor pool ID</td>
</tr>
<tr>
<td align="center" valign="top">104</td>
<td align="center" valign="top">68</td>
<td align="left" valign="top">BINARY(2)</td>
<td align="left" valign="top">Interactive threshold</td>
</tr>
<tr>
<td align="center" valign="top">106</td>
<td align="center" valign="top">6A</td>
<td align="left" valign="top">CHAR(2)</td>
<td align="left" valign="top">Reserved</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">Unallocated interactive capacity in a partition group
(see <a href="#Note1">Note 1</a>)</td>
</tr>
<tr>
<td align="center" valign="top">124</td>
<td align="center" valign="top">7C</td>
<td align="left" valign="top">CHAR(4)</td>
<td align="left" valign="top">Reserved</td>
</tr>
</table>
<br><br>
<h3><a name="FMTLPMG0200DESC">Field Descriptions</a></h3>
<p><strong>Dispatch latency</strong> is the maximum time between dispatches of this partition on a physical processor (in nanoseconds).</p>
<p><strong>Interactive capacity</strong> is this partition's current (usable) portion of the physical machine interactive capacity (in units of 1/100 of a percent). For instance, if the physical machine was allowed to do 2000 units of interactive work per second, and this field was 5000, then this partition would be allowed to perform 1000 units of interactive work per second.</p>
<p><strong>Interactive CPU time</strong> is the number of nanoseconds of CPU time used by interactive processes in this partition since partition IPL. An interactive process is any process doing 5250 display device I/O. For additional information on interactive processes, see <em>SC41-0607 iSeries Performance Capabilities Reference</em> which is available in the iSeries Information Center.</p>
<p><strong>Interactive CPU time above threshold</strong> is the amount of nanoseconds of CPU time used by interactive processes while exceeding the interactive threshold. This is a total since IPL.</p>
<p><strong>Interactive threshold</strong> is the maximum interactive CPU utilization (in units of 1/100 of a percent) which can be sustained in this partition, without causing a disproportionate increase in system overhead. For example, a value of 2379 means that the threshold is 23.79%. In a partition with no limit on interactive utilization, the value returned will be 10000 (100%).</p>
<p><strong>LPAR flags</strong> indicate whether or not hardware multithreading is enabled, whether unused CPU time in a shared pool was returned and whether this is a capped partition. </p>
<p>This is a bit field and it contains the combination of the following values:</p>
<table width="100%">
<tr>
<td align="left" valign="top" width="15%">x'00000001'</td>
<td align="left" valign="top" width="60%">Unused CPU time in a shared pool was returned</td>
</tr>
<tr>
<td align="left" valign="top">x'00000002'</td>
<td align="left" valign="top">Hardware multi-threading is enabled</td>
</tr>
<tr>
<td align="left" valign="top">x'00000004'</td>
<td align="left" valign="top">The partition is capped</td>
</tr>
</table>
<br>
<p>Use the following table:</p>
<table border width="100%">
<tr>
<th align="center" valign="bottom" colspan="2">Offset</th>
<th align="left" valign="bottom" rowspan="2">Bit</th>
<th align="left" valign="bottom" rowspan="2">Type</th>
<th align="left" valign="bottom" rowspan="2">Field</th>
<th align="left" valign="bottom" rowspan="2">Description</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="6%">56</td>
<td align="center" valign="top" width="6%">38</td>
<td align="center" valign="top" width="5%"><br></td>
<td align="left" valign="top" width="11%">Binary(4)</td>
<td align="left" valign="top" width="15%">lpar_flags</td>
<td align="left" valign="top" width="58%"><br></td>
</tr>
<tr>
<td align="center" valign="top" width="6%">56</td>
<td align="center" valign="top" width="6%">38</td>
<td align="center" valign="top" width="5%">0</td>
<td align="left" valign="top" width="11%">Bit(29)</td>
<td align="left" valign="top" width="15%">Reserved</td>
<td align="left" valign="top" width="58%">Reserved</td>
</tr>
<tr>
<td align="center" valign="top" width="6%">59</td>
<td align="center" valign="top" width="6%">3B</td>
<td align="center" valign="top" width="5%">5</td>
<td align="left" valign="top" width="11%">Bit(1)</td>
<td align="left" valign="top" width="15%">lpar_capped</td>
<td align="left" valign="top" width="58%">Capped partition indicator. If on, partition is capped.
</td>
</tr>
<tr>
<td align="center" valign="top" width="6%">59</td>
<td align="center" valign="top" width="6%">3B</td>
<td align="center" valign="top" width="5%">6</td>
<td align="left" valign="top" width="11%">Bit(1)</td>
<td align="left" valign="top" width="15%">lpar_smt</td>
<td align="left" valign="top" width="58%">Hardware multi-threading indicator. If on, hardware multi-threading is enabled.
</td>
</tr>
<tr>
<td align="center" valign="top" width="6%">59</td>
<td align="center" valign="top" width="6%">3B</td>
<td align="center" valign="top" width="5%">7</td>
<td align="left" valign="top" width="11%">Bit(1)</td>
<td align="left" valign="top" width="15%">lpar_auth_pic</td>
<td align="left" valign="top" width="58%">Shared pool data indicator. If on, unused CPU time in a shared pool was returned.
</td>
</tr>
</table>
<br>
<p><strong>Maximum licensed capacity</strong> is the current limit on processing capacity of this partition (in units of 1/100 of a physical processor), imposed by the operating system software license for this partition.</p>
<p><strong>Minimum required processing capacity</strong> is the minimum amount of processing capacity (in units of 1/100 of a physical processor) that operating system in this partition requires for its operation .</p>
<p><strong>Online memory</strong> is the current (usable) amount of main storage (in units of megabytes) currently allocated to this partition.</p>
<p><strong>Online virtual processors</strong> is the number of virtual processors currently used by this partition.</p>
<p><strong>Partition group ID</strong> identifies the LPAR group that this partition is a member of.<p>
<p><strong>Physical processors in the shared pool</strong> is the number of physical processors that are allocated to the shared processor pool used by this partition. This field does not apply to dedicated partitions.</p>
<p><strong>Physical processors in the system</strong> is the number of physical processors in this physical machine that are available for customer use. This does not include processors on demand that have not been turned on.</p>
<p><strong>Processing capacity</strong> is the current (usable) amount of processing capacity (in units of 1/100 of a physical processor) available to the partition (also known as partition's entitled capacity).</p>
<p><strong>Reserved</strong> is a field reserved for alignment purposes.</p>
<p><strong>Shared processor pool ID</strong> identifies the shared processor pool this partition is a member of. A shared processor pool is a set of physical processors on the physical machine that is used to run a set of shared processor partitions. This field does not apply to dedicated partitions.</p>
<p><strong>Total CPU time</strong> is the number of nanoseconds of CPU time used by this partition since IPL.</p>
<p><strong>Unallocated interactive capacity in a partition group</strong> is the amount of interactive capacity in the partition group this partition belongs to, which is not allocated to any partition and is available for allocation.
Interactive capacity is defined as portion of total interactive capacity of the physical machine (in units of 1/100 of a percent).
</p>
<p><strong>Unallocated processing capacity in a partition group</strong> is the amount of processing capacity (in units of 1/100 of a physical processor) in the partition group this partition belongs to, which is not allocated to any partition and is available for allocation.</p>
<p><strong>Unallocated variable capacity weight in a partition group</strong> is the amount of capacity weight that is available for allocation to the partition's variable capacity weight.</p>
<p><strong>Unused CPU time in a shared pool</strong> is the number of nanoseconds of CPU time that the physical processors in a shared processor pool have been idle since system IPL. This field is only returned if the partition was authorized to retrieve shared pool data (see LPAR flags field). Otherwise, this field is set to 0.</p>
<p><strong>Variable capacity weight</strong> is the weighting factor that is used to assign additional unused CPU cycles (from the shared processor pool) to the partition.
Variable capacity weight is used for uncapped partitions when they compete for unused CPU cycles in the shared pool.
This factor is in the range of 0 - 255.
The larger the weight, the more the chance this partition will get additional CPU cycles from the pool. A value of 0 effectively caps this partition at its current (usable) processing capacity.</p>
<p><strong>Version</strong> is the version of format 2 returned by the API.</p>
<br>
<h3>Return Value</h3>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><strong>Positive value </strong></td>
<td align="left" valign="top">Partition information was successfully retrieved.
Returned value indicates number of bytes returned in the receiver variable. </td>
</tr>
<tr>
<td align="left" valign="top"><strong>Negative value </strong></td>
<td align="left" valign="top">API cannot return data because of error.
The return value will be a negative number describing the error, as follows:
<dl compact>
<dt><strong>-1</strong></dt>
<dd>Specified format is not supported by the API.</dd>
<dt><strong>-2</strong></dt>
<dd>Length of the receiver variable is negative.</dd>
<dt><strong>-3</strong></dt>
<dd>Address of the receiver variable is invalid.</dd>
<dt><strong>-4</strong></dt>
<dd>API encountered an exception during execution. (See joblog for the details about the exception)</dd>
<dt><strong>-5</strong></dt>
<dd>Required parameter omitted.</dd>
</dl>
</td>
</tr>
</table>
<p><b>Notes:</b></p>
<ol>
<li><a id="Note1" name="Note1"></a>
Firmware level SF230 or later is required to support these fields.
</li>
</ol>
<br>
<hr>
API introduced: V5R3
<hr>
<center>
<table cellpadding="2" cellspacing="2">
<tr align="center">
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href="config.htm">Configuration APIs</a> | <a href="aplist.htm">APIs by category</a></td>
</tr>
</table>
</center>
</body></html>
Reference in New Issue Copy Permalink