ibm-information-center/dist/eclipse/plugins/i5OS.ic.apis_5.4.0.1/dlpar_set_resources.htm

201 lines
6.0 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"><html><head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="Copyright" content="Copyright (c) 2006 by IBM Corporation">
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
<title>Modify Partition Resources (dlpar_set_resources) 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>Modify Partition Resources (dlpar_set_resources) API</h2>
<div class="box" style="width: 60%;">
<br>
&nbsp;&nbsp;Syntax:
<pre>#include &lt;qpmlpmgt.h&gt;
int dlpar_set_resources (void *attribute_value, int attribute_id);
</pre>
<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>Modify Partition Resources (dlpar_set_resources) API is used to modify the configuration
of the partition where this API was called.
The API accepts the identifier of the partition configuration attribute intended
to be modified and the new value for this attribute.
The API modifies one partition configuration attribute at a time. </p>
<p>The modification of partition configuration attributes by dlpar_set_resources() API is subject
to configuration constraints which are enforced by iSeries Hypervisor.</p>
<br>
<h3>Authorities and Locks</h3>
<p><em>*ALLOBJ special authority is required to change partition configuration.</em></p>
<br>
<h3>Parameters</h3>
<dl><dt><strong>Configuration attribute value </strong>&nbsp;(<em>attribute_value</em>)</dt><dd>INPUT; CHAR(*)</dd></dl>
<p>This parameter contains a new value for the configuration attribute identified by the
<em>Configuration attribute ID</em> parameter. This value will have a different format depending on the configuration attribute
being processed as follows:</p>
<table width="50%">
<!-- cols="20 30" -->
<tr>
<td><strong>Attribute</strong></td>
<td><strong>Format</strong></td>
</tr>
<tr>
<td>Processing capacity</td>
<td>UNSIGNED BINARY(4)</td>
</tr>
<tr>
<td>Variable capacity weight</td>
<td>UNSIGNED BINARY(4)</td>
</tr>
<tr>
<td>Interactive capacity</td>
<td>UNSIGNED BINARY(4)</td>
</tr>
<tr>
<td>Number of virtual processors</td>
<td>UNSIGNED BINARY(4)</td>
</tr>
<tr>
<td>Online memory</td>
<td>UNSIGNED BINARY(8)</td>
</tr>
</tbody></table>
<br>
<p><strong>Interactive capacity</strong> is the new value for the portion of the physical machine interactive capacity this partition can use (in units of 1/100s of a percent).<p>
<p><strong>Number of virtual processors</strong> is the new value for the number of virtual processors in this partition.</p>
<p><strong>Online memory</strong> is the new value for partition online memory size (in megabytes).
<p><strong>Processing capacity</strong> is the new value for the partition's processing capacity (in units of 1/100 of a physical processor).</p>
<p><strong>Variable capacity weight</strong> is the new value for the weighting factor that is used when assigning unused CPU cycles in the shared processor pool to the partition. This factor is in the range of 0 - 255.</p>
<br>
<dl><dt><strong>Configuration attribute ID </strong>&nbsp;(<em>attribute_id</em>)</dt><dd>INPUT; CHAR(*)</dd></dl>
<p>This parameter contains an ID of the configuration attribute to change.
The following values are valid for this parameter.:</p>
<table width="50%">
<!-- cols="10 40" -->
<tr>
<td>1</td>
<td>Processing capacity</td>
</tr>
<tr>
<td>2</td>
<td>Variable capacity weight</td>
</tr>
<tr>
<td>3</td>
<td>Interactive capacity</td>
</tr>
<tr>
<td>4</td>
<td>Number of virtual processors</td>
</tr>
<tr>
<td>5</td>
<td>Online memory</td>
</tr>
</tbody></table>
<br>
<h3>Return Value</h3>
<p>Depending on whether the call was successful, there are several
possible return values:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><strong>0</strong></td>
<td align="left" valign="top">Request to change partition configuration was accepted.
<p>Note that configuration change will happen asynchronously to the API call. Precise moment when actual configuration change is complete, is unpredictable.</p>
<p>It is possible that configuration change will only be partially satisfied, if system does not have enough resources to fulfill the request.</p></td></tr>
<tr>
<td align="left" valign="top"><strong>Negative value</strong></td>
<td align="left" valign="top">Request to change partition configuration failed.
Return value is set to indicate the kind of error that prevented the
change of the configuration attribute as follows:
<dl compact>
<dt><strong>-1</strong></dt>
<dd>API was called with incorrect parameters.</dd>
<dt><strong>-2</strong></dt>
<dd>Configuration change was rejected because some LPAR configuration constraint was violated.</dd>
<dt><strong>-3</strong></dt>
<dd>Configuration change failed because of hardware fault.</dd>
<dt><strong>-4</strong></dt>
<dd>Configuration change failed because of insufficient authority.</dd>
<dt><strong>-5</strong></dt>
<dd>Configuration change failed because of unexpected exception.
(See joblog for the details about exception.)</dd>
</dl>
</td></tr>
</table>
<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>