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

1403 lines
36 KiB
HTML
Raw Permalink Blame History

<!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 Hardware Resource List (QGYRHRL, QgyRtvHdwRscList) 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. -->
<!-- This file has undergone html cleanup on 1/14/02 by JET -->
<!-- Change history: -->
<!-- 051203 caton : Added new status extended field for LI -->
<!-- F3U, changed under defect 3255.1 -->
<!-- 021104 caton : Adding a clarification, d3602 -->
<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 Hardware Resource List (QGYRHRL, QgyRtvHdwRscList) 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">Resource category</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Binary(4)</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;Service Program: QGYRHR<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Default Public Authority: *USE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: No<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The Retrieve Hardware Resource List (OPM, QGYRHRL; ILE, QgyRtvHdwRscList)
API retrieves a list of hardware resource names and other hardware resource
information fields. The list provides a summary description for each resource
in the specified resource category.</p>
<br>
<h3>Authorities and Locks</h3>
<dl compact>
<dt><em>API Public Authority</em></dt>
<dd>*USE</dd>
</dl>
<br>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>Receiver variable</strong></dt>
<dd>OUTPUT; CHAR(*)
<p> The receiver variable that receives the information requested. You can
specify the size of the area to be smaller than the format requested as long as
you specify the length parameter correctly. As a result, the API returns only
the data that the area can hold.</p>
</dd>
<dt><strong>Length of receiver variable</strong></dt>
<dd>INPUT; BINARY(4)
<p> The length of the receiver variable provided. The length of receiver
variable parameter may be specified up to the size of the receiver variable
specified in the user program. If the length of receiver variable parameter
specified is larger than the allocated size of the receiver variable specified
in the user program, the results are not predictable. The minimum length is 16
bytes.</p>
</dd>
<dt><strong>Format name</strong></dt>
<dd>INPUT; CHAR(8)
<p> The content and format of the information returned. The possible format
names are as follows:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>RHRL0100</em></td>
<td align="left" valign="top">Summary information for resources in each of the
resource categories is returned in this format. For more information, see <a
href="#HDRHRL0100">RHRL0100 Format</a>.</td>
</tr>
<tr>
<td align="left" valign="top"><em>RHRL0110</em></td>
<td align="left" valign="top">Same as <em>RHRL0100</em> with the addition of a
description text message ID field a status extended field and a
reserved field. This format cannot be used with the Local area network resources
resource category. For more information, see <a href="#HDRHRL0110">RHRL0110
Format</a>.</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Resource category</strong></dt>
<dd>INPUT; BINARY(4)
<p> The hardware resource category for which information is to be returned.
Possible values are as follows:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">All hardware resources (does not include local
area network resources)</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">Communication resources</td>
</tr>
<tr>
<td align="left" valign="top"><em>3</em></td>
<td align="left" valign="top">Local work station resources</td>
</tr>
<tr>
<td align="left" valign="top"><em>4</em></td>
<td align="left" valign="top">Processor resources</td>
</tr>
<tr>
<td align="left" valign="top"><em>5</em></td>
<td align="left" valign="top">Storage device resources</td>
</tr>
<tr>
<td align="left" valign="top"><em>6</em></td>
<td align="left" valign="top">Coupled system adapter resources</td>
</tr>
<tr>
<td align="left" valign="top"><em>7</em></td>
<td align="left" valign="top">Local area network resources</td>
</tr>
<tr>
<td align="left" valign="top"><em>8</em></td>
<td align="left" valign="top">Cryptographic resources</td>
</tr>
<tr>
<td align="left" valign="top"><em>9</em></td>
<td align="left" valign="top">Tape and optical resources</td>
</tr>
<tr>
<td align="left" valign="top"><em>10</em></td>
<td align="left" valign="top">Tape resources</td>
</tr>
<tr>
<td align="left" valign="top"><em>11</em></td>
<td align="left" valign="top">Optical resources</td>
</tr>
</table>
<p><strong>Note:</strong> When selecting Local area network resources, only
information for token-ring resources can be obtained. Information for
token-ring resources associated with a particular line description will be
returned only if the Work with LAN Adapters (<em>WRKLANADPT</em>) command has
been run with that line description specified. It is also necessary for the LAN
Manager to have been activated for that line description. The LAN Manager is
activated by running the Create Line Description Token-Ring Network
(<em>CRTLINTRN</em>) or the Change Line Description Token-Ring Network
(<em>CHGLINTRN</em>) command with keyword <em>ACTLANMGR</em> set to <em>
*YES</em>. <em>WRKLANADPT</em> must be run again after adding a new token-ring
resource in order to be able to retrieve information for that resource.</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="HDRHRL0100">RHRL0100 Format</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%">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">Number of resources returned</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">Length of resource entry</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">Resource entries</td>
</tr>
<tr>
<td align="left" valign="top" rowspan="11" colspan="2">These fields repeat for
each resource.</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Resource category</td>
</tr>
<tr>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Family level</td>
</tr>
<tr>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Line type</td>
</tr>
<tr>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Resource name</td>
</tr>
<tr>
<td align="left" valign="top">CHAR(4)</td>
<td align="left" valign="top">Type number</td>
</tr>
<tr>
<td align="left" valign="top">CHAR(3)</td>
<td align="left" valign="top">Model number</td>
</tr>
<tr>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Status</td>
</tr>
<tr>
<td align="left" valign="top">CHAR(8)</td>
<td align="left" valign="top">System to which adapter is connected</td>
</tr>
<tr>
<td align="left" valign="top">CHAR(12)</td>
<td align="left" valign="top">Adapter address</td>
</tr>
<tr>
<td align="left" valign="top">CHAR(50)</td>
<td align="left" valign="top">Description</td>
</tr>
<tr>
<td align="left" valign="top">CHAR(24)</td>
<td align="left" valign="top">Resource kind</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRHRL0110">RHRL0110 Format</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%">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">Number of resources returned</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">Length of resource entry</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">Resource entries</td>
</tr>
<tr>
<td align="left" valign="top" rowspan="14" colspan="2">These fields repeat for
each resource.</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Resource category</td>
</tr>
<tr>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Family level</td>
</tr>
<tr>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Line type</td>
</tr>
<tr>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Resource name</td>
</tr>
<tr>
<td align="left" valign="top">CHAR(4)</td>
<td align="left" valign="top">Type number</td>
</tr>
<tr>
<td align="left" valign="top">CHAR(3)</td>
<td align="left" valign="top">Model number</td>
</tr>
<tr>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Status</td>
</tr>
<tr>
<td align="left" valign="top">CHAR(8)</td>
<td align="left" valign="top">System to which adapter is connected</td>
</tr>
<tr>
<td align="left" valign="top">CHAR(12)</td>
<td align="left" valign="top">Adapter address</td>
</tr>
<tr>
<td align="left" valign="top">CHAR(50)</td>
<td align="left" valign="top">Description</td>
</tr>
<tr>
<td align="left" valign="top">CHAR(24)</td>
<td align="left" valign="top">Resource kind</td>
</tr>
<tr>
<td align="left" valign="top">CHAR(7)</td>
<td align="left" valign="top">Description text message ID</td>
</tr>
<tr>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Status extended</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRRHRLFD">Field Descriptions</a></h3>
<p><strong>Adapter address.</strong> The network address of the LAN adapter
resource.</p>
<p><strong>Bytes available.</strong> The length in bytes of all data available
to return. All available data is returned if enough space is provided.</p>
<p><strong>Bytes returned.</strong> The length in bytes of all data actually
returned.</p>
<p><strong>Description.</strong> The description of the resource.</p>
<p><strong>Description text message ID.</strong> The message from which the
text of the <strong>Description</strong> field is obtained. This message is
contained in the <strong>QCPFMSG</strong> message file. The library in which it
is found is determined by <strong>*LIBL</strong>.</p>
<p><strong>Family level.</strong> The relationship between adjacent returned
resources. Possible values are positive integers starting with 1, incrementing
as needed to match the number of existing family levels. The first three values
are as follows:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">This resource is parent to the next resource if
the next resource has a resource family level of 2.</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">This resource is child to the previous resource
that has a resource family level of 1, and is parent to the next resource if
the next resource has a resource family level of 3.</td>
</tr>
<tr>
<td align="left" valign="top"><em>3</em></td>
<td align="left" valign="top">This resource is child to the previous resource
that has a resource family level of 2, and is grandchild to the previous
resource that has a resource family level of 1. It is parent to the next
resource if the next resource has a resource family level of 4.</td>
</tr>
</table>
<p><strong>Length of resource entry.</strong> The length, in bytes, of each
resource entry.</p>
<p><strong>Line type.</strong> The line type of the LAN resource. Possible
values are as follows:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>-1</em></td>
<td align="left" valign="top">This field does not apply to this resource.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Token ring.</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">Fiber distributed data interface (FDDI).</td>
</tr>
</table>
<p><strong>Model number.</strong> The model number of the resource. For
self-configuring tape devices, this represents the emulated device model
number.</p>
<p><strong>Number of resources returned.</strong> The total number of resources
for which information is returned by the API.</p>
<p><strong>Reserved.</strong> A reserved field.</p>
<p><strong>Resource category.</strong> The hardware resource category of the
resource for which information is returned. If the input parameter Resource
category is set to the number 1 (All hardware resources), the format field
value returned here is set to one of the other more specific values. Otherwise,
the returned value matches the input value. Possible values are as follows:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">Communication resources</td>
</tr>
<tr>
<td align="left" valign="top"><em>3</em></td>
<td align="left" valign="top">Local workstation resources</td>
</tr>
<tr>
<td align="left" valign="top"><em>4</em></td>
<td align="left" valign="top">Processor resources</td>
</tr>
<tr>
<td align="left" valign="top"><em>5</em></td>
<td align="left" valign="top">Storage device resources</td>
</tr>
<tr>
<td align="left" valign="top"><em>6</em></td>
<td align="left" valign="top">Coupled system adapter resources</td>
</tr>
<tr>
<td align="left" valign="top"><em>7</em></td>
<td align="left" valign="top">Local area network resources</td>
</tr>
<tr>
<td align="left" valign="top"><em>8</em></td>
<td align="left" valign="top">Cryptographic resources</td>
</tr>
<tr>
<td align="left" valign="top"><em>9</em></td>
<td align="left" valign="top">Tape and optical resources</td>
</tr>
<tr>
<td align="left" valign="top"><em>10</em></td>
<td align="left" valign="top">Tape resources</td>
</tr>
<tr>
<td align="left" valign="top"><em>11</em></td>
<td align="left" valign="top">Optical resources</td>
</tr>
</table>
<p><strong>Resource entries.</strong> The sets of information fields that are
retrieved for each resource.</p>
<p><strong>Resource kind.</strong> The resource kind field consists of 24 bytes
of hexadecimal numbers. It can be divided into three 8-byte fields called Kind
1, Kind 2, and Kind 3. The system uses Kind 1, Kind 2, and Kind 3 to categorize
the resource. The contents of the three subfields are defined as follows:</p>
<table width="80%" border>
<tr>
<th align="left" valign="top">Kind 1</th>
<th align="left" valign="top">Returned Value</th>
</tr>
<tr>
<td align="left" valign="top" width="50%">Kind could not be determined</td>
<td align="left" valign="top" width="50%">X'0000000000000000'</td>
</tr>
<tr>
<td align="left" valign="top">Not applicable</td>
<td align="left" valign="top">X'4000000000000000'</td>
</tr>
<tr>
<td align="left" valign="top">IOP</td>
<td align="left" valign="top">X'0000000000000001'</td>
</tr>
<tr>
<td align="left" valign="top">Controller</td>
<td align="left" valign="top">X'0000000000000002'</td>
</tr>
<tr>
<td align="left" valign="top">Device</td>
<td align="left" valign="top">X'0000000000000004'</td>
</tr>
<tr>
<td align="left" valign="top">Port</td>
<td align="left" valign="top">X'0000000000000008'</td>
</tr>
<tr>
<td align="left" valign="top">Channel</td>
<td align="left" valign="top">X'0000000000000010'</td>
</tr>
<tr>
<td align="left" valign="top">Library</td>
<td align="left" valign="top">X'0000000000000020'</td>
</tr>
<tr>
<td align="left" valign="top">Bus controller</td>
<td align="left" valign="top">X'0000000000000040'</td>
</tr>
<tr>
<td align="left" valign="top">IO node</td>
<td align="left" valign="top">X'0000000000000080'</td>
</tr>
<tr>
<td align="left" valign="top">Bus</td>
<td align="left" valign="top">X'0000000000000100'</td>
</tr>
<tr>
<td align="left" valign="top">Bus extension</td>
<td align="left" valign="top">X'0000000000000200'</td>
</tr>
<tr>
<td align="left" valign="top">Path information unit (PIU)</td>
<td align="left" valign="top">X'0000000000000400'</td>
</tr>
<tr>
<td align="left" valign="top">Picker (PCK)</td>
<td align="left" valign="top">X'0000000000000800'</td>
</tr>
<tr>
<td align="left" valign="top">PCI Node</td>
<td align="left" valign="top">X'0000000000001000'</td>
</tr>
<tr>
<td align="left" valign="top">Any kind</td>
<td align="left" valign="top">X'4FFFFFFFFFFFFFFF'</td>
</tr>
</table>
<br>
<br>
<table width="80%" border>
<tr>
<th align="left" valign="top">Kind 2</th>
<th align="left" valign="top">Returned Value</th>
</tr>
<tr>
<td align="left" valign="top" width="50%">Kind could not be determined</td>
<td align="left" valign="top" width="50%">X'0000000000000000'</td>
</tr>
<tr>
<td align="left" valign="top">Not applicable</td>
<td align="left" valign="top">X'4000000000000000'</td>
</tr>
<tr>
<td align="left" valign="top">Workstation</td>
<td align="left" valign="top">X'0000000000000001'</td>
</tr>
<tr>
<td align="left" valign="top">Storage</td>
<td align="left" valign="top">X'0000000000000002'</td>
</tr>
<tr>
<td align="left" valign="top">Workstation storage</td>
<td align="left" valign="top">X'0000000000000003'</td>
</tr>
<tr>
<td align="left" valign="top">Communications</td>
<td align="left" valign="top">X'0000000000000004'</td>
</tr>
<tr>
<td align="left" valign="top">Workstation communications</td>
<td align="left" valign="top">X'0000000000000005'</td>
</tr>
<tr>
<td align="left" valign="top">Storage communications</td>
<td align="left" valign="top">X'0000000000000006'</td>
</tr>
<tr>
<td align="left" valign="top">Storage communications workstation</td>
<td align="left" valign="top">X'0000000000000007'</td>
</tr>
<tr>
<td align="left" valign="top">Shared object clustering (SOC)</td>
<td align="left" valign="top">X'0000000000000008'</td>
</tr>
<tr>
<td align="left" valign="top">Cryptography</td>
<td align="left" valign="top">X'0000000000000010'</td>
</tr>
<tr>
<td align="left" valign="top">Workstation cryptography</td>
<td align="left" valign="top">X'0000000000000011'</td>
</tr>
<tr>
<td align="left" valign="top">Storage cryptography</td>
<td align="left" valign="top">X'0000000000000012'</td>
</tr>
<tr>
<td align="left" valign="top">Storage workstation cryptography</td>
<td align="left" valign="top">X'0000000000000013'</td>
</tr>
<tr>
<td align="left" valign="top">Communication cryptography</td>
<td align="left" valign="top">X'0000000000000014'</td>
</tr>
<tr>
<td align="left" valign="top">Communication workstation cryptography</td>
<td align="left" valign="top">X'0000000000000015'</td>
</tr>
<tr>
<td align="left" valign="top">Storage communications cryptography</td>
<td align="left" valign="top">X'0000000000000016'</td>
</tr>
<tr>
<td align="left" valign="top">Storage communications workstation
cryptography</td>
<td align="left" valign="top">X'0000000000000017'</td>
</tr>
<tr>
<td align="left" valign="top">Any kind</td>
<td align="left" valign="top">X'4FFFFFFFFFFFFFFF'</td>
</tr>
</table>
<br>
<br>
<table width="80%" border>
<tr>
<th align="left" valign="top">Kind 3</th>
<th align="left" valign="top">Returned Value</th>
</tr>
<tr>
<td align="left" valign="top" width="50%">Kind could not be determined</td>
<td align="left" valign="top" width="50%">X'0000000000000000'</td>
</tr>
<tr>
<td align="left" valign="top">Not applicable</td>
<td align="left" valign="top">X'4000000000000000'</td>
</tr>
<tr>
<td align="left" valign="top">Display</td>
<td align="left" valign="top">X'0000000000000001'</td>
</tr>
<tr>
<td align="left" valign="top">Printer</td>
<td align="left" valign="top">X'0000000000000002'</td>
</tr>
<tr>
<td align="left" valign="top">DASD</td>
<td align="left" valign="top">X'0000000000000004'</td>
</tr>
<tr>
<td align="left" valign="top">Diskette</td>
<td align="left" valign="top">X'0000000000000008'</td>
</tr>
<tr>
<td align="left" valign="top">DASD Diskette</td>
<td align="left" valign="top">X'000000000000000C'</td>
</tr>
<tr>
<td align="left" valign="top">Optical</td>
<td align="left" valign="top">X'0000000000000010'</td>
</tr>
<tr>
<td align="left" valign="top">Tape</td>
<td align="left" valign="top">X'0000000000000020'</td>
</tr>
<tr>
<td align="left" valign="top">DASD Tape</td>
<td align="left" valign="top">X'0000000000000024'</td>
</tr>
<tr>
<td align="left" valign="top">DASD Tape Diskette</td>
<td align="left" valign="top">X'000000000000002C'</td>
</tr>
<tr>
<td align="left" valign="top">Tape Optical</td>
<td align="left" valign="top">X'0000000000000030'</td>
</tr>
<tr>
<td align="left" valign="top">Removable media</td>
<td align="left" valign="top">X'0000000000000038'</td>
</tr>
<tr>
<td align="left" valign="top">DASD Tape Diskette Optical</td>
<td align="left" valign="top">X'000000000000003C'</td>
</tr>
<tr>
<td align="left" valign="top">ISDN</td>
<td align="left" valign="top">X'0000000000000040'</td>
</tr>
<tr>
<td align="left" valign="top">X25</td>
<td align="left" valign="top">X'0000000000000080'</td>
</tr>
<tr>
<td align="left" valign="top">Token ring</td>
<td align="left" valign="top">X'0000000000000100'</td>
</tr>
<tr>
<td align="left" valign="top">SDLC</td>
<td align="left" valign="top">X'0000000000000200'</td>
</tr>
<tr>
<td align="left" valign="top">Ethernet</td>
<td align="left" valign="top">X'0000000000000400'</td>
</tr>
<tr>
<td align="left" valign="top">Token ring/Ethernet</td>
<td align="left" valign="top">X'0000000000000500'</td>
</tr>
<tr>
<td align="left" valign="top">FDDI</td>
<td align="left" valign="top">X'0000000000000800'</td>
</tr>
<tr>
<td align="left" valign="top">Token ring FDDI</td>
<td align="left" valign="top">X'0000000000000900'</td>
</tr>
<tr>
<td align="left" valign="top">Frame relay</td>
<td align="left" valign="top">X'0000000000001000'</td>
</tr>
<tr>
<td align="left" valign="top">Frame relay SDLC</td>
<td align="left" valign="top">X'0000000000001200'</td>
</tr>
<tr>
<td align="left" valign="top">Cryptography</td>
<td align="left" valign="top">X'0000000000002000'</td>
</tr>
<tr>
<td align="left" valign="top">Facsimile</td>
<td align="left" valign="top">X'0000000000004000'</td>
</tr>
<tr>
<td align="left" valign="top">Memory</td>
<td align="left" valign="top">X'0000000000008000'</td>
</tr>
<tr>
<td align="left" valign="top">Service processor</td>
<td align="left" valign="top">X'0000000000010000'</td>
</tr>
<tr>
<td align="left" valign="top">Main processor</td>
<td align="left" valign="top">X'0000000000020000'</td>
</tr>
<tr>
<td align="left" valign="top">Bus contoller</td>
<td align="left" valign="top">X'0000000000040000'</td>
</tr>
<tr>
<td align="left" valign="top">CEC</td>
<td align="left" valign="top">X'0000000000080000'</td>
</tr>
<tr>
<td align="left" valign="top">Control panel</td>
<td align="left" valign="top">X'0000000000100000'</td>
</tr>
<tr>
<td align="left" valign="top">Bus adaptor</td>
<td align="left" valign="top">X'0000000000200000'</td>
</tr>
<tr>
<td align="left" valign="top">SPD bus</td>
<td align="left" valign="top">X'0000000000400000'</td>
</tr>
<tr>
<td align="left" valign="top">Bus extension</td>
<td align="left" valign="top">X'0000000000800000'</td>
</tr>
<tr>
<td align="left" valign="top">System bus adapter processor</td>
<td align="left" valign="top">X'0000000001000000'</td>
</tr>
<tr>
<td align="left" valign="top">Twin optical bus controller</td>
<td align="left" valign="top">X'0000000002000000'</td>
</tr>
<tr>
<td align="left" valign="top">ASCII</td>
<td align="left" valign="top">X'0000000004000000'</td>
</tr>
<tr>
<td align="left" valign="top">ASCII display</td>
<td align="left" valign="top">X'0000000004000001'</td>
</tr>
<tr>
<td align="left" valign="top">ASCII printer</td>
<td align="left" valign="top">X'0000000004000002'</td>
</tr>
<tr>
<td align="left" valign="top">Twinaxial</td>
<td align="left" valign="top">X'0000000008000000'</td>
</tr>
<tr>
<td align="left" valign="top">Twinaxial display</td>
<td align="left" valign="top">X'0000000008000001'</td>
</tr>
<tr>
<td align="left" valign="top">Twinaxial printer</td>
<td align="left" valign="top">X'0000000008000002'</td>
</tr>
<tr>
<td align="left" valign="top">Apple</td>
<td align="left" valign="top">X'0000000010000000'</td>
</tr>
<tr>
<td align="left" valign="top">Apple token-ring LAN</td>
<td align="left" valign="top">X'0000000010000100'</td>
</tr>
<tr>
<td align="left" valign="top">Apple Ethernet</td>
<td align="left" valign="top">X'0000000010000400'</td>
</tr>
<tr>
<td align="left" valign="top">Wireless</td>
<td align="left" valign="top">X'0000000020000000'</td>
</tr>
<tr>
<td align="left" valign="top">SOC host</td>
<td align="left" valign="top">X'0000000040000000'</td>
</tr>
<tr>
<td align="left" valign="top">SOC nonhost</td>
<td align="left" valign="top">X'0000000080000000'</td>
</tr>
<tr>
<td align="left" valign="top">Internetwork Packet Exchange (IPX)</td>
<td align="left" valign="top">X'0000000100000000'</td>
</tr>
<tr>
<td align="left" valign="top">File server</td>
<td align="left" valign="top">X'0000000200000000'</td>
</tr>
<tr>
<td align="left" valign="top">ATM</td>
<td align="left" valign="top">X'0000000400000000'</td>
</tr>
<tr>
<td align="left" valign="top">ATM Ethernet</td>
<td align="left" valign="top">X'0000000400000400'</td>
</tr>
<tr>
<td align="left" valign="top">Backplane</td>
<td align="left" valign="top">X'0000000800000000'</td>
</tr>
<tr>
<td align="left" valign="top">System clock</td>
<td align="left" valign="top">X'0000001000000000'</td>
</tr>
<tr>
<td align="left" valign="top">Optical library</td>
<td align="left" valign="top">X'0000002000000000'</td>
</tr>
<tr>
<td align="left" valign="top">PCI bus</td>
<td align="left" valign="top">X'0000004000000000'</td>
</tr>
<tr>
<td align="left" valign="top">PHB bus controller</td>
<td align="left" valign="top">X'0000008000000000'</td>
</tr>
<tr>
<td align="left" valign="top">RIO bus adapter</td>
<td align="left" valign="top">X'0000010000000000'</td>
</tr>
<tr>
<td align="left" valign="top">Large read cache</td>
<td align="left" valign="top">X'0000020000000000'</td>
</tr>
<tr>
<td align="left" valign="top">Virtual SOC IOP</td>
<td align="left" valign="top">X'0000040000000000'</td>
</tr>
<tr>
<td align="left" valign="top">Virtual resource</td>
<td align="left" valign="top">X'0000080000000000'</td>
</tr>
<tr>
<td align="left" valign="top">Virtual Optical</td>
<td align="left" valign="top">X'0000080000000010'</td>
</tr>
<tr>
<td align="left" valign="top">Virtual Twin Optical bus controller</td>
<td align="left" valign="top">X'0000080002000000'</td>
</tr>
<tr>
<td align="left" valign="top">Processor capacity</td>
<td align="left" valign="top">X'0000100000000000'</td>
</tr>
<tr>
<td align="left" valign="top">Interactive</td>
<td align="left" valign="top">X'0000200000000000'</td>
</tr>
<tr>
<td align="left" valign="top">Device services</td>
<td align="left" valign="top">X'0000400000000000'</td>
</tr>
<tr>
<td align="left" valign="top">RIO controller Bus Control Chip (BuCC)</td>
<td align="left" valign="top">X'0000800000000000'</td>
</tr>
<tr>
<td align="left" valign="top">RIO bus</td>
<td align="left" valign="top">X'0001000000000000'</td>
</tr>
<tr>
<td align="left" valign="top">RIO SAN bus adapter</td>
<td align="left" valign="top">X'0002000000000000'</td>
</tr>
<tr>
<td align="left" valign="top">RIO SAN bus</td>
<td align="left" valign="top">X'0004000000000000'</td>
</tr>
<tr>
<td align="left" valign="top">RIO SAN BuCC</td>
<td align="left" valign="top">X'0008000000000000'</td>
</tr>
<tr>
<td align="left" valign="top">RIO SAN SOC IOP</td>
<td align="left" valign="top">X'0010000000000000'</td>
</tr>
<tr>
<td align="left" valign="top">Riser</td>
<td align="left" valign="top">X'0020000000000000'</td>
</tr>
<tr>
<td align="left" valign="top">L3 Cache</td>
<td align="left" valign="top">X'0040000000000000'</td>
</tr>
<tr>
<td align="left" valign="top">Backplane extender</td>
<td align="left" valign="top">X'0080000000000000'</td>
</tr>
<tr>
<td align="left" valign="top">Capacitor card</td>
<td align="left" valign="top">X'0100000000000000'</td>
</tr>
<tr>
<td align="left" valign="top">Any kind</td>
<td align="left" valign="top">X'4FFFFFFFFFFFFFFF'</td>
</tr>
</table>
<p><img src="delta.gif" alt="Start of change">
Note: There are cases where the Kind 3 value is composed of more than one
value (bit turned on), for example: the X'0000000000000400' value means
ethernet and the X'0000080000000000' value means virtual resource, so a
value of X'0000080000000400' means virtual ethernet.
<img src="deltaend.gif" alt="End of change"></p>
<p><strong>Resource name.</strong> The name of the resource for which the
information in the resource entry applies. The name can be used as input to the
Retrieve Hardware Resource Information (QGYRHRI, QgyRtvHdwRscInfo) API.</p>
<p><strong>Status.</strong> Whether the resource is operational or not.
Possible values are as follows:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">The status field does not apply to this resource
or could not be determined.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Operational. Resource is operational.</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">Inoperative. Resource is not operational.</td>
</tr>
<tr>
<td align="left" valign="top"><em>3</em></td>
<td align="left" valign="top">Not detected. Presence of resource could not be
detected.</td>
</tr>
</table>
<p><strong>Status extended.</strong> The
extended hardware status of the resource. Possible values are as follows:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">Resource is powered off or no power is being supplied
to it.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Resource has failed.</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">Resource is operational.</td>
</tr>
<tr>
<td align="left" valign="top"><em>3</em></td>
<td align="left" valign="top">Resource is operational but errors have been
detected.</td>
</tr>
<tr>
<td align="left" valign="top"><em>4</em></td>
<td align="left" valign="top">Resource is not connected.</td>
</tr>
<tr>
<td align="left" valign="top"><em>5</em></td>
<td align="left" valign="top">Resource is operational but performance is degraded.</td>
</tr>
<tr>
<td align="left" valign="top"><em>6</em></td>
<td align="left" valign="top">Resource status is unknown currently.</td>
</tr>
<tr>
<td align="left" valign="top"><em>7</em></td>
<td align="left" valign="top">Resource is currently disabled.</td>
</tr>
<tr>
<td align="left" valign="top"><em>8</em></td>
<td align="left" valign="top">Resource is not installed.</td>
</tr>
<tr>
<td align="left" valign="top"><em>10</em></td>
<td align="left" valign="top">Resource is not operational.</td>
</tr>
<tr>
<td align="left" valign="top"><em>16</em></td>
<td align="left" valign="top">Resource is failed due to a system software error.</td>
</tr>
</table>
<p><strong>System to which adapter is connected.</strong> The system to which
the coupled system adapter is connected.</p>
<p><strong>Type number.</strong> An identifier that represents the object type
of this resource. For self-configuring tape devices, this represents the
emulated device type number. <strong>Exceptions:</strong> Value of *TAP implies
that a self-configuring tape device is emulating a device type that contains
characters outside the range of 0 to 9 and A to Z.</p>
<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">CPF3C1E E</td>
<td align="left" valign="top">Required parameter &amp;1 omitted.</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">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">CPF3C90 E</td>
<td align="left" valign="top">Literal value cannot be changed.</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>
<tr>
<td align="left" valign="top">CPFA280 E</td>
<td align="left" valign="top">Resource category &amp;1 is not valid.</td>
</tr>
</table>
<br>
<hr>
API introduced: V3R7
<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">API by
category</a></td>
</tr>
</table>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink