418 lines
12 KiB
HTML
418 lines
12 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">
|
|
<title>Perform Hardware Configuration Operation (QYHCHCOP) 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. -->
|
|
<!-- Change History: -->
|
|
<!-- YYMMDD USERID Change description -->
|
|
<!-- Created for V5R1 -->
|
|
<!-- File tagging cleanup completed Oct 2001 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>Perform Hardware Configuration Operation (QYHCHCOP) API</h2>
|
|
|
|
<div class="box" style="width: 90%;"><br>
|
|
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="45%">Hardware configuration request</td>
|
|
<td align="left" valign="top" width="20%">Input</td>
|
|
<td align="left" valign="top" width="25%">Char(*)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">2</td>
|
|
<td align="left" valign="top">Hardware configuration request length</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Binary(4) Unsigned</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">3</td>
|
|
<td align="left" valign="top">Request type</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Binary(4) Unsigned</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">4</td>
|
|
<td align="left" valign="top">Receiver variable</td>
|
|
<td align="left" valign="top">Output</td>
|
|
<td align="left" valign="top">Char(*)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">5</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) Unsigned</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">6</td>
|
|
<td align="left" valign="top">Bytes of return data available</td>
|
|
<td align="left" valign="top">Output</td>
|
|
<td align="left" valign="top">Binary(4) Unsigned</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">7</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>
|
|
Default Public Authority: *EXCLUDE<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
Threadsafe: Yes<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
</div>
|
|
|
|
<p>The Perform Hardware Configuration Operation (QYHCHCOP) API allows for
|
|
viewing, changing, and checking the status of certain parts of the system's
|
|
hardware configuration. This API allows the following activities:</p>
|
|
|
|
<ul>
|
|
<li>view the logical partition configuration</li>
|
|
|
|
<li>change the logical partition configuration</li>
|
|
|
|
<li>check the status of a logical partition configuration change</li>
|
|
|
|
<li>view the disk unit and ASP configuration</li>
|
|
|
|
<li>change the disk unit and ASP configuration</li>
|
|
|
|
<li>check the status of disk unit and ASP configuration change</li>
|
|
</ul>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Authorities and Locks</h3>
|
|
|
|
<p>This API is shipped with *EXCLUDE public authority.</p>
|
|
|
|
<p>To use this API you must:</p>
|
|
|
|
<ul>
|
|
<li>be explicitly authorized to the API, or call the API from a program that
|
|
adopts enough authority to call the API and have *IOSYSCFG and *SERVICE special
|
|
authority.<br>
|
|
<br>
|
|
</li>
|
|
|
|
<li>have set the password level of the Dedicated Service Tools (DST). This is
|
|
done through the service tools security data option, followed by the password
|
|
level option. When this option has been activated, service tools user ID
|
|
passwords are case sensitive.<br>
|
|
<br>
|
|
</li>
|
|
|
|
<li>have a service tools user ID and password that has been authorized to
|
|
perform the task you are requesting. Service tools user IDs are configured
|
|
using Dedicated Service Tools (DST).<br>
|
|
<br>
|
|
</li>
|
|
|
|
<li>have a service tools user ID and password that match the i5/OS user
|
|
profile and password of the user that is calling this API. Care must be taken
|
|
to make sure the password cases match between the i5/OS user profile and the
|
|
service tools user ID.</li>
|
|
</ul>
|
|
|
|
<p>The port name "as-sts" must be unblocked and enabled for this API to process
|
|
successfully. If the port name is not unblocked, this this API will return a
|
|
CPFBA03 message.</p>
|
|
|
|
<p>The service authority required to perform an operation depends on the
|
|
operation you are trying to perform. To see what authority a specific operation
|
|
requires, consult the logical partition configuration markup language document
|
|
or the disk management configuration markup language document. The following
|
|
table summarizes the authority required for various operations.</p>
|
|
|
|
<table border width="70%">
|
|
<tr>
|
|
<th align="left" valign="top">Operation Type</th>
|
|
<th align="left" valign="top">Authority Required</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">View LPAR configuration</td>
|
|
<td align="left" valign="top">LPAR operator</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">Check LPAR operation status</td>
|
|
<td align="left" valign="top">LPAR operator</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">Perform LPAR operator operation</td>
|
|
<td align="left" valign="top">LPAR operator</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">Perform LPAR administrator operation</td>
|
|
<td align="left" valign="top">LPAR administrator</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">View disk configuration</td>
|
|
<td align="left" valign="top">None</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">Check disk operation status</td>
|
|
<td align="left" valign="top">None</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">Perform disk operator operation</td>
|
|
<td align="left" valign="top">Disk operator</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">Perform disk administration operation</td>
|
|
<td align="left" valign="top">Disk administrator</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
|
|
<h3>Required Parameter Group</h3>
|
|
|
|
<dl>
|
|
<dt><strong>Hardware Configuration Request</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(*)
|
|
|
|
<p>The information for the request. The type of information provided is
|
|
described in the request type parameter.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Hardware Configuration Request Length</strong></dt>
|
|
|
|
<dd>INPUT; BINARY(4) Unsigned
|
|
|
|
<p>The length of the hardware configuration request buffer.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Request type</strong></dt>
|
|
|
|
<dd>INPUT; BINARY(4) Unsigned
|
|
|
|
<p>The type of request being made. The following constants are defined for the
|
|
request type.</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top" nowrap><em>LPARRequest = 1</em></td>
|
|
<td align="left" valign="top">Change, view, or check the status of
|
|
the logical partition configuration using the Logical Partition Markup
|
|
Language. For the format of the markup language, see <a href=
|
|
"LPARConfigurationScript_main.htm">LPARConfigurationScript Specification, Version 10</a>.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>DiskRequest = 2</em></td>
|
|
<td align="left" valign="top">Change, view, or check the status of the disk and
|
|
ASP configuration using the Disk Management Markup Language. For the format of
|
|
the markup language, see <img src="delta.gif" alt="Start of change">
|
|
<a href="DMConfigurationScript_main.htm">DMConfigurationScript Specification, Version 30</a>.
|
|
<img src="deltaend.gif" alt="End of change">
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</dd>
|
|
|
|
<dt><strong>Receiver variable</strong></dt>
|
|
|
|
<dd>OUTPUT; CHAR(*)
|
|
|
|
<p>The receiver variable that is to receive the response from the hardware
|
|
configuration request. The format of this variable is determined by the type of
|
|
hardware configuration request submitted.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Length of receiver variable</strong></dt>
|
|
|
|
<dd>INPUT; BINARY(4) Unsigned
|
|
|
|
<p>The length of the receiver variable, in bytes.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Bytes of return data available</strong></dt>
|
|
|
|
<dd>OUTPUT; BINARY(4) Unsigned
|
|
|
|
<p>The number of bytes that is available for return. If this value is larger
|
|
than the receiver variable, some of the return data was lost.</p>
|
|
</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>.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
<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">CPF2203 E</td>
|
|
<td align="left" valign="top">User profile &1 not correct.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF2204 E</td>
|
|
<td align="left" valign="top">User profile &1 not found.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF22E2 E</td>
|
|
<td align="left" valign="top">Password not correct for user profile
|
|
&1.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF22E3 E</td>
|
|
<td align="left" valign="top">User profile &1 is disabled.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF22E4 E</td>
|
|
<td align="left" valign="top">Password for user profile &1 has
|
|
expired.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF22E5 E</td>
|
|
<td align="left" valign="top">No password associated with user profile
|
|
&1.</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">CPF3C24 E</td>
|
|
<td align="left" valign="top">Length of the receiver variable is not
|
|
valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3C36 E</td>
|
|
<td align="left" valign="top">Number of parameters, &1 entered for this API
|
|
was not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3C4B E</td>
|
|
<td align="left" valign="top">Value not valid for field &1.</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">CPF3CF2 E</td>
|
|
<td align="left" valign="top">Error(s) occurred during running of &1
|
|
API.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9872 E</td>
|
|
<td align="left" valign="top">Program or service program &1 in library
|
|
&2 ended. Reason code &3.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPFB0CE E</td>
|
|
<td align="left" valign="top">&1 special authority is required.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPFBA01 E</td>
|
|
<td align="left" valign="top">Incorrect authorization to perform
|
|
operation.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPFBA02 E</td>
|
|
<td align="left" valign="top">Request typeout of range.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPFBA03 E</td>
|
|
<td align="left" valign="top">Error connecting to service.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPFBA04 E</td>
|
|
<td align="left" valign="top">Error sending request to service.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPFBA05 E</td>
|
|
<td align="left" valign="top">Error retrieving data from service.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<hr>
|
|
API introduced: V5R1
|
|
|
|
<hr>
|
|
<table align="center" 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>
|
|
</body>
|
|
</html>
|
|
|