467 lines
13 KiB
HTML
467 lines
13 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>Retrieve DASD Information (QYASRDI) 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 -->
|
|
<!-- File 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>Retrieve DASD Information (QYASRDI) API</h2>
|
|
|
|
<div class="box" style="width: 80%;">
|
|
<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="50%">Receiver variable</td>
|
|
<td align="left" valign="top" width="15%">Output</td>
|
|
<td align="left" valign="top" width="25%">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">Disk unit resource name array</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Array of CHAR(10)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">5</td>
|
|
<td align="left" valign="top">Number of disk unit resource names</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Binary(4)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">6</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: *USE<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
Threadsafe: Yes<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
</div>
|
|
|
|
<p>The Retrieve DASD Information (QYASRDI) API retrieves disk unit information.
|
|
Information for specific disk units is requested by putting the disk unit
|
|
resource names into the input parameter disk unit resource name array, along
|
|
with putting the number of requested disk unit names into the input parameter
|
|
number of disk unit resource names. Information about the requested disk units
|
|
is returned in the receiver variable.</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 receiver variable to receive the disk unit information.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Length of receiver variable</strong></dt>
|
|
|
|
<dd>INPUT; BINARY(4)
|
|
|
|
<p>The length of the receiver variable, in bytes. The minimum length is 8
|
|
bytes. If the length of the receiver variable is not large enough to hold all
|
|
repeating fields of the format name specified in the Format name parameter,
|
|
then no repeating fields are returned.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Format name</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(8)
|
|
|
|
<p>The format of the information returned from the Retrieve DASD Information
|
|
(QYASRDI) API. The DMIN0100 format is used by this API for the receiver
|
|
variable. For a detailed description of the format, see
|
|
<a href="#HDRDMINFMT">Format Descriptions</a>.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Disk unit resource name array</strong></dt>
|
|
|
|
<dd>INPUT; ARRAY OF CHAR(10)
|
|
|
|
<p>An array of one or more disk unit resource names. A disk unit resource name
|
|
identifies a disk unit. The system resource manager assigns a resource name to
|
|
every hardware device that is physically attached to the system. The following
|
|
special values are allowed:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*ALL</em></td>
|
|
<td align="left" valign="top">All disk units.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*UNCONFIG</em></td>
|
|
<td align="left" valign="top">All unconfigured disk units.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><strong>Number of disk unit resource names</strong></dt>
|
|
|
|
<dd>INPUT; BINARY(4)
|
|
|
|
<p>The number of disk unit resource names specified in the disk unit resource
|
|
names array. In the case where the special values *ALL or *UNCONFIG are
|
|
specified in the disk unit resource name array, the number of disk unit
|
|
resource names parameter must be set to 1.</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><a name="HDRDMINFMT">Format Descriptions</a></h3>
|
|
|
|
<h4>DMIN0100 Format</h4>
|
|
|
|
<p>The following shows the information returned for the DMIN0100 format. For
|
|
detailed descriptions of the fields in the table, see <a href="#HDRDMINFLD">
|
|
Field Descriptions</a>.</p>
|
|
|
|
<table border="1" 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 returned</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 available</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">8</td>
|
|
<td align="center" valign="top">8</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Offset to disk unit data records</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">12</td>
|
|
<td align="center" valign="top">C</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Number of disk unit data records</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">16</td>
|
|
<td align="center" valign="top">10</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Length of disk unit data records</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">Reserved</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="LEFT" valign="top" colspan="4"><strong>NOTE:</strong> The following
|
|
fields repeat the number of time specified in the number of disk unit parity
|
|
data records field.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top" colspan="2"> </td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">Disk unit resource name</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top" colspan="2"> </td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">Disk unit found flag</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top" colspan="2"> </td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">Tower resource name associated with disk
|
|
unit</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top" colspan="2"> </td>
|
|
<td align="left" valign="top">CHAR(4)</td>
|
|
<td align="left" valign="top">Tower number associated with disk unit</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top" colspan="2"> </td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">Disk unit allowed in new device parity set
|
|
flag</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top" colspan="2"> </td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">Disk unit allowed in existing device parity set
|
|
flag</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top" colspan="2"> </td>
|
|
<td align="left" valign="top">CHAR(5)</td>
|
|
<td align="left" valign="top">Reserved</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top" colspan="2"> </td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Device parity set number</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top" colspan="2"> </td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Capacity available after device parity
|
|
started</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
|
|
<h3><a name="HDRDMINFLD">Field Descriptions</a></h3>
|
|
|
|
<p><strong>Bytes available.</strong> The number of bytes of data available to
|
|
be returned. All available data is returned if enough space is provided.</p>
|
|
|
|
<p><strong>Bytes returned.</strong> The number of bytes of data returned.</p>
|
|
|
|
<p><strong>Capacity available after device parity started.</strong> The number
|
|
of bytes, in millions, of the capacity available of the disk unit after device
|
|
parity has been started, if included in a device parity set.</p>
|
|
|
|
<p><strong>Device parity set number.</strong> Device parity set number of disk
|
|
unit if included in a device parity set. Valid range is 0 to 255.</p>
|
|
|
|
<p><strong>Disk unit allowed in existing device parity set flag.</strong> A
|
|
boolean flag used to indicate if the disk unit, in the associated record, can
|
|
be added to an existing device parity set. Valid values are:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">The disk unit cannot be added to an existing
|
|
device parity set.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top">The disk unit can be added to an existing device
|
|
parity set.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Disk unit allowed in new device parity set flag.</strong> A boolean
|
|
flag used to indicate if the disk unit, in the associated record, can be added
|
|
to a new device parity set. Valid values are:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">The disk unit cannot be added to a new device
|
|
parity set.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top">The disk unit can be added to a new device parity
|
|
set.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Disk unit found flag.</strong> Whether the disk unit corresponding
|
|
to the disk unit resource name was found on the system. Valid values are:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">The disk unit was not found.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top">The disk unit was found.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Disk unit resource name.</strong> A disk unit. The system resource
|
|
manager assigns a resource name to every hardware device that is physically
|
|
attached to the system.</p>
|
|
|
|
<p><strong>Length of disk unit data records.</strong> The number of bytes
|
|
occupied by each disk unit data record.</p>
|
|
|
|
<p><strong>Number of disk unit data records.</strong> The number of disk unit
|
|
data records that are returned in the receiver variable. Each record has the
|
|
same format and is repeated in the receiver variable.</p>
|
|
|
|
<p><strong>Offset to disk unit data records.</strong> The offset in bytes from
|
|
the start of the receiver variable to the first requested disk unit data
|
|
record.</p>
|
|
|
|
<p><strong>Tower number associated with disk unit</strong> The tower number to
|
|
which the disk unit is attached. This field may be used to determine the
|
|
physical location of the disk unit.</p>
|
|
|
|
<p><strong>Tower resource name associated with disk unit</strong> The tower
|
|
resource name to which the disk unit is attached. This field may be used to
|
|
determine the physical location of the disk unit.</p>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Error Messages</h3>
|
|
|
|
<table width="100%" cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<th align="left" valign="top">Message ID</th>
|
|
<th align="left" valign="top">Error Message Text</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top" width="15%">CPFBA49 E</td>
|
|
<td align="left" valign="top" width="85%">Number of disk unit resource names
|
|
not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPFBA50 E</td>
|
|
<td align="left" valign="top">Number of disk unit resource names is out of
|
|
range.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3C21 E</td>
|
|
<td align="left" valign="top">Format name &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">CPF3CF1 E</td>
|
|
<td align="left" valign="top">Error code parameter 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>
|
|
</table>
|
|
|
|
<br>
|
|
|
|
|
|
<hr>
|
|
API introduced: V4R5
|
|
|
|
<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>
|
|
|