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/qfpadold.htm

1331 lines
38 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">
<title>Open List Network Server Storage Spaces (QFPADOLD) 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. -->
<!-- QFPADOLD SCRIPT A converted by B2H R4.1 (346) (CMS) by V2DCIJB -->
<!-- at RCHVMW2 on 20 Aug 1999 at 12:37:54 -->
<!-- Nancy Kryka 12196.1 server rebranding 10/27/00 -->
<!-- Nancy Kryka 12196.1 Authority & Intro 11/06/00 V5R1 -->
<!-- Thom Haze 12406 Clustering & IASP 05/15/01 V5R2a -->
<!--File Edited Oct 2001 by Janet Brauckman -->
<!-- *************************************************************** -->
<!-- DCR/PTR Rel Date Person : Description of change -->
<!-- *************************************************************** -->
<!-- D3255 V5R3a 090302 tlhaze : Disk Extents -->
<!-- P9A23791 V5R3 030703 tlhaze : format type 253 removed -->
<!-- d3602.1 V5R4 082504 tlhaze : iSCSI Enhancements -->
<!-- d3602.1 V5R4 050305 TLHAZE : Add V5R4 change flags -->
<!-- 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 language="Javascript" src="../rzahg/synch.js" type="text/javascript">
</script>
<h2>Open List Network Server Storage Spaces (QFPADOLD) 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">List information</td>
<td align="left" valign="top">Output</td>
<td align="left" valign="top">Char(80)</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="left" valign="top">Number of records to return</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">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">6</td>
<td align="left" valign="top">Storage space name qualifier</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(*)</td>
</tr>
<tr>
<td align="center" valign="top">7</td>
<td align="left" valign="top">Length of storage space name qualifier</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Binary(4)</td>
</tr>
<tr>
<td align="center" valign="top">8</td>
<td align="left" valign="top">Network server description name qualifier</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(*)</td>
</tr>
<tr>
<td align="center" valign="top">9</td>
<td align="left" valign="top">Length of network server description name
qualifier</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Binary(4)</td>
</tr>
<tr>
<td align="center" valign="top">10</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;Default Public Authority: *USE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: No<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The Open List Network Server Storage Spaces (QFPADOLD) API retrieves a list
of storage spaces (virtual disk drives) that can be linked to a server. The
functions provided by this API are similar to the Work with Network Server
Storage Spaces (WRKNWSSTG) command.</p>
<br>
<h3>Authorities and Locks</h3>
<dl>
<dt><em>Network Server Storage Space Authority</em></dt>
<dd>*RX for IFS directory /QFPNWSSTG</dd>
<dd>*RX for IFS directory /QFPNWSSTG/name</dd>
<dd>*R for the files in IFS directory /QFPNWSSTG/name</dd>
<dd><strong>Note:</strong> In the above file paths, 'name' is the name of the
storage space.<br>
<br>
</dd>
<dt><em>Network Server Storage Space Lock</em></dt>
<dd>None</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 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 the receiver
variable parameter may be specified up to the size of the receiver variable
specified in the user program. If the length of the 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 0
bytes.</p>
</dd>
<dt><strong>List information</strong></dt>
<dd>OUTPUT; CHAR(80)
<p>Information about the list created by this program. For a description of the
layout of this parameter, see <a href="#HDRODOLDI">Format of List
Information</a>.</p>
</dd>
<dt><strong>Number of records to return</strong></dt>
<dd>INPUT; BINARY(4)
<p>The number of records in the list to put into the receiver variable. The
value must be 0 or greater.</p>
</dd>
<dt><strong>Format name</strong></dt>
<dd>INPUT; CHAR(8)
<p>The format of the information returned. You must use the following format
name:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>DOLD0100</em></td>
<td align="left" valign="top">The output storage space list structure. For more
information, see <a href="#HDRFPDOL1">DOLD0100 Format</a>.</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Storage space name qualifier</strong></dt>
<dd>INPUT; CHAR(*)
<p>A restriction on the information to be retrieved. This parameter allows the
caller to request a subset of the records that normally would be returned on a
given format. If this parameter is *ALL, no information qualification is
performed. Allowable values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*ALL</em></td>
<td align="left" valign="top">Information about all storage spaces.</td>
</tr>
<tr>
<td align="left" valign="top"><em>Storage space name</em></td>
<td align="left" valign="top">Information about the specified storage space
name record only.</td>
</tr>
<tr>
<td align="left" valign="top"><em>Generic storage space name*</em></td>
<td align="left" valign="top">Information about storage spaces matching the
generic storage space name string.</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Length of storage space name qualifier</strong></dt>
<dd>INPUT; BINARY(4)
<p>The length of the storage space name qualifier.</p>
</dd>
<dt><strong>Network server description name qualifier</strong></dt>
<dd>INPUT; CHAR(*)
<p>A restriction on the information to be retrieved. This parameter allows the
caller to request a subset of the records that normally would be returned on a
given format. If this parameter is *ALL, no information qualification is
performed. Allowable values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*ALL</em></td>
<td align="left" valign="top">Information about storage spaces for all network
server descriptions, including storage spaces that are not linked to a network
server description.</td>
</tr>
<tr>
<td valign="top"><em>Network server description name</em></td>
<td valign="top">Information about storage spaces linked to the specified
network server description name only.</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Length of network server description name qualifier</strong></dt>
<dd>INPUT; BINARY(4)
<p>The length of the network server description name qualifier.</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>. If this
parameter is omitted, diagnostic and escape messages are issued to the
application.</p>
</dd>
</dl>
<br>
<h3><a name="HDRFPDOL1"></a>DOLD0100 Format</h3>
<p>Format DOLD0100 returns storage space information.</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%">Displacement to next storage space
record</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">Length of storage space record</td>
</tr>
<tr>
<td align="center" valign="top">8</td>
<td align="center" valign="top">8</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Name</td>
</tr>
<tr>
<td align="center" valign="top">18</td>
<td align="center" valign="top">12</td>
<td align="left" valign="top">CHAR(50)</td>
<td align="left" valign="top">Description</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">Capacity</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">Percent used</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">Disk pool</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">Storage space format</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">Storage space formatting status</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">Access to storage space</td>
</tr>
<tr>
<td align="center" valign="top">92</td>
<td align="center" valign="top">5C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Displacement to list of server entries</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">Length of server list entries</td>
</tr>
<tr>
<td align="center" valign="top">100</td>
<td align="center" valign="top">64</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Number of server list entries</td>
</tr>
<tr>
<td align="center" valign="top">104</td>
<td align="center" valign="top">68</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Clustering quorum resource disk</td>
</tr>
<tr>
<td align="center" valign="top">108</td>
<td align="center" valign="top">6C</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Disk pool name</td>
</tr>
<tr>
<td align="center" valign="top">118</td>
<td align="center" valign="top">76</td>
<td align="left" valign="top">CHAR(2)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">120</td>
<td align="center" valign="top">78</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Displacement to list of extent entries</td>
</tr>
<tr>
<td align="center" valign="top">124</td>
<td align="center" valign="top">7C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of extent list entries</td>
</tr>
<tr>
<td align="center" valign="top">128</td>
<td align="center" valign="top">80</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Number of extent list entries</td>
</tr>
<tr><td><img src="delta.gif" alt="Start of change"></td></tr>
<tr>
<td align="center" valign="top">132</td>
<td align="center" valign="top">84</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Displacement to cluster quorum disk information</td>
</tr>
<tr>
<td align="center" valign="top">136</td>
<td align="center" valign="top">88</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of cluster quorum disk information</td>
</tr>
<tr><td><img src="deltaend.gif" alt="End of change"></td></tr>
<tr>
<td align="left" valign="top" colspan="2" rowspan="11">These fields repeat for
each server entry</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Dynamic link</td>
</tr>
<tr>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Link sequence position</td>
</tr>
<tr>
<td align="left" valign="top">CHAR(8)</td>
<td align="left" valign="top">Network server description name</td>
</tr>
<tr>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Displacement to server name</td>
</tr>
<tr>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of server name</td>
</tr>
<tr>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Link type</td>
</tr>
<tr><td><img src="delta.gif" alt="Start of change"></td></tr>
<tr>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Storage path identifier</td>
</tr>
<tr>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Network server host adapter name</td>
</tr>
<tr><td><img src="deltaend.gif" alt="End of change"></td></tr>
<tr>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Server name</td>
</tr>
<tr>
<td align="left" valign="top" colspan="2" rowspan="4">
These fields repeat for
each extent entry</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Extent capacity</td>
</tr>
<tr>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Extent free space</td>
</tr>
<tr>
<td align="left" valign="top">CHAR(16)</td>
<td align="left" valign="top">Extent format</td>
</tr>
<tr>
<td align="left" valign="top">CHAR(64)</td>
<td align="left" valign="top">Volume name
</td>
</tr>
<tr><td><img src="delta.gif" alt="Start of change"></td></tr>
<tr>
<td align="left" valign="top" colspan="2" rowspan="5">
These fields exist when disk is created as a cluster quorum resource disk</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Cluster name</td>
</tr>
<tr>
<td align="left" valign="top">CHAR(15)</td>
<td align="left" valign="top">Cluster domain name</td>
</tr>
<tr>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Cluster connection port</td>
</tr>
<tr>
<td align="left" valign="top">CHAR(15)</td>
<td align="left" valign="top">Cluster IP address</td>
</tr>
<tr>
<td align="left" valign="top">CHAR(15)</td>
<td align="left" valign="top">Cluster subnet mask</td>
</tr>
<tr><td><img src="deltaend.gif" alt="End of change"></td></tr>
</table>
<br>
<br>
<h3><a name="HDRFPADOLD"></a>Field Descriptions</h3>
<p><strong>Access to storage space.</strong> The type of access the server has
to the storage space data. The possible values follow:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">Exclusive update - update access; not shared</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Shared read - read access; storage space shared
with other servers</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">Shared update - update access; storage space
shared with other servers</td>
</tr>
</table>
<p><strong>Capacity.</strong> The size of the storage space, in megabytes
(MB).</p>
<img src="delta.gif" alt="Start of change">
<p><strong>Cluster connection port.</strong> The port number that was
specified when creating the cluster quorum resource disk.</p>
<p><strong>Cluster domain name.</strong> The name of the Windows cluster
domain that was specified when creating the cluster quorum resource disk.</p>
<p><strong>Cluster IP address.</strong> The internet address of the cluster
that was specified when creating the cluster quorum resource disk. </p>
<p><strong>Cluster name.</strong> The name of the Windows cluster that was
specified when creating the cluster quorum resource disk.</p>
<img src="deltaend.gif" alt="End of change">
<p><strong>Clustering quorum resource disk.</strong> Specifies whether the
storage space was created as a cluster quorum resource disk or not.</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">This storage space is not a cluster quorum
resource disk.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">This storage space is a cluster quorum resource
disk.</td>
</tr>
</table>
<img src="delta.gif" alt="Start of change">
<p><strong>Cluster subnet mask.</strong> The subnet mask of the cluster that
was specified when creating the cluster quorum resource disk.</p>
<img src="deltaend.gif" alt="End of change">
<p><strong>Description.</strong> The text description of the storage space.</p>
<p><strong>Disk pool.</strong> The disk pool that contains the storage
space.</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">System disk pool</td>
</tr>
<tr>
<td align="left" valign="top"><em>2-32</em></td>
<td align="left" valign="top">User disk pools</td>
</tr>
<tr>
<td align="left" valign="top"><em>33-255</em></td>
<td align="left" valign="top">Independent user disk pools</td>
</tr>
</table>
<p><strong>Disk pool name.</strong> The device description name
for the independent user disk pool that contains the storage space.</p>
<img src="delta.gif" alt="Start of change">
<p><strong>Displacement to cluster quorum disk information.</strong>
The displacement in bytes from the beginning of the record to the cluster
quorum disk information. If this disk is not a cluster quorum disk,
this value is zero.</p>
<img src="deltaend.gif" alt="End of change">
<p><strong>Displacement to list of extent entries.</strong> The displacement in
bytes from the beginning of the record to the list of disk drive extents
found on the storage space. If there are no disk drive extents
found on this storage space, this value is zero.</p>
<p><strong>Displacement to list of server entries.</strong> The displacement in
bytes from the beginning of the record to the list of network server
descriptions that are linked to the storage space. If there are no network
server descriptions linked to the storage space, this value is zero.</p>
<p><strong>Displacement to next storage space record.</strong> The displacement
in bytes from the beginning of the record to the next storage space record. If
this is the last record, this value is zero.</p>
<p><strong>Displacement to server name.</strong> The displacement in bytes from
the beginning of the server list entry to the server name.</p>
<p><strong>Dynamic link.</strong> Whether the storage space was linked to the
server dynamically. The possible values follow:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">The storage space was not linked
dynamically.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The storage space was linked dynamically.</td>
</tr>
</table>
<p>
<strong>Extent capacity.</strong> The size of the disk drive extent in
megabytes (MB).
</p>
<p>
<strong>Extent format.</strong> A blank padded Unicode (CCSID 13488) text
string describing the file system type formatted on the volume residing
on the disk drive extent. Expected value includes but is not limited
to one of the following.</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>FAT</em></td>
<td align="left" valign="top">File Asllocation Table (FAT) file system</td>
</tr>
<tr>
<td align="left" valign="top"><em>FAT32</em></td>
<td align="left" valign="top">32-bit File Allocation Table (FAT-32) file
system</td>
</tr>
<tr>
<td align="left" valign="top"><em>NTFS</em></td>
<td align="left" valign="top">Windows NT file system (NTFS)</td>
</tr>
<tr>
<td align="left" valign="top"><em>*NONE</em></td>
<td align="left" valign="top">The area of the disk is unallocated or
unformatted.</td>
</tr>
</table>
<p><strong>Extent free space.</strong>
The size in megabytes (MB) on this disk extent
that is not occupied by data. </p>
<img src="delta.gif" alt="Start of change">
<p><strong>Length of cluster quorum disk information.</strong>
The length of the cluster quorum disk information.</p>
<img src="deltaend.gif" alt="End of change">
<p><strong>Length of extent list entries.</strong> The length of each disk drive extent
entry.</p>
<p><strong>Length of server list entries.</strong> The length of each server
entry.</p>
<p><strong>Length of server name.</strong> The length of the server name.</p>
<p><strong>Length of storage space record.</strong> The length of the data for
the current storage space.</p>
<p><strong>Link sequence
position.</strong> The relative order that storage spaces are linked to the
network server description. Storage spaces are presented to the hosted
operating system in the order specified by the link sequence position value.
There are several types of storage space links. The link types and the
corresponding link sequence position ranges are as follows:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>Fixed</em></td>
<td align="left" valign="top">Links of this type have the <strong>dynamic
link</strong> value set to 0. The link sequence position values range from 1 to
16.</td>
</tr>
<tr>
<td align="left" valign="top"><em>Cluster quorum resource</em></td>
<td align="left" valign="top">Links of this type have the <strong>clustering
quorum resource disk</strong> value set to 1 and the <strong>access to storage
space</strong> value set to 2. The link sequence position value is 1.</td>
</tr>
<tr>
<td align="left" valign="top"><em>Cluster shared</em></td>
<td align="left" valign="top">Links of this type have the <strong>clustering
quorum resource disk</strong> value set to 0 and the <strong>access to storage
space</strong> value set to 2. The link sequence position values range from 1
to 15.</td>
</tr>
<tr>
<td align="left" valign="top"><em>Dynamic</em></td>
<td align="left" valign="top">Links of this type have the <strong>dynamic
link</strong> value set to 1. The link sequence position values range
from 1 to 64.</td>
</tr>
</table>
<p><strong>Link type.</strong> The type of linking and access mode used
for this disk drive. The possible link types are as follow:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">This disk drive is linked as a fixed disk.</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">This disk drive is linked as a dynamic disk.</td>
</tr>
<tr>
<td align="left" valign="top"><em>3</em></td>
<td align="left" valign="top">This disk drive is linked as a cluster quorum resource disk.</td>
</tr>
<tr>
<td align="left" valign="top"><em>4</em></td>
<td align="left" valign="top">This disk drive is linked as a cluster shared disk.</td>
</tr>
</table>
<p><strong>Name.</strong> The name of the storage space.</p>
<p><strong>Network server description name.</strong> The name of the network
server description that is linked to the storage space.</p>
<img src="delta.gif" alt="Start of change">
<p><strong>Network server host adapter name.</strong> The name of the network server
host adapter device description that is being used to access this disk drive.
This field will be blank if a network server host adapter is not required to access
this disk. The following special value can be returned:
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*MULTIPATH</em></td>
<td align="left" valign="top">Multiple storage paths are defined in the NWSD for
accessing this disk drive.</td>
</tr>
</table>
<img src="deltaend.gif" alt="End of change">
<p><strong>Number of extent list entries.</strong> The number of disk drive extent
entries. The maximum number of extent entries per disk drive is 32. If more
than 32 extent entries exist on the disk drive, the contents of the 32nd
extent entry will be a sum of all remaining extent entries.</p>
<p><strong>Number of server list entries.</strong> The number of server
entries.</p>
<p><strong>Percent used.</strong> The percentage of the storage space capacity
that is occupied by data.</p>
<p><strong>Reserved.</strong>
Reserved area for 4-byte boundary alignment.</p>
<p><strong>Server name.</strong> The name of the server that is linked to the
storage space.</p>
<img src="delta.gif" alt="Start of change">
<p><strong>Storage path identifier.</strong> This value represents the storage
path identifier of the network server host adapter device being used to access
this storage.
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">First storage path in NWSD</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">Second storage path in NWSD</td>
</tr>
<tr>
<td align="left" valign="top"><em>3</em></td>
<td align="left" valign="top">Third storage path in NWSD</td>
</tr>
<tr>
<td align="left" valign="top"><em>4</em></td>
<td align="left" valign="top">Fourth storage path in NWSD</td>
</tr>
<tr>
<td align="left" valign="top"><em>-1</em></td>
<td align="left" valign="top">Default storage path</td>
</tr>
<tr>
<td align="left" valign="top"><em>-2</em></td>
<td align="left" valign="top">Multipath as defined in NWSD</td>
</tr>
<tr>
<td align="left" valign="top"><em>-3</em></td>
<td align="left" valign="top">Storage path not used for accessing disk</td>
</tr>
</table>
<img src="deltaend.gif" alt="End of change">
<p><strong>Storage space format.</strong> The file system format that is used
for the storage space. The possible values follow:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">High performance file system (HPFS)</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">File Allocation Table (FAT) file system</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">NetWare file system</td>
</tr>
<tr>
<td align="left" valign="top"><em>3</em></td>
<td align="left" valign="top">AIX file system</td>
</tr>
<tr>
<td align="left" valign="top"><em>4</em></td>
<td align="left" valign="top">Windows NT file system (NTFS)</td>
</tr>
<tr>
<td align="left" valign="top"><em>6</em></td>
<td align="left" valign="top">32-bit File Allocation Table (FAT-32) file
system</td>
</tr>
<tr>
<td align="left" valign="top"><em>7</em></td>
<td align="left" valign="top">Open source file system</td>
</tr>
<tr>
<td align="left" valign="top"><em>254</em></td>
<td align="left" valign="top">Unknown (the storage space contains an unknown
format type)</td>
</tr>
<tr>
<td align="left" valign="top"><em>255</em></td>
<td align="left" valign="top">Pending (the storage space is in the process of
being created)</td>
</tr>
</table>
<p><strong>Storage space formatting status.</strong> Whether the storage space
is properly formatted for the specified file system format and ready to use.
The possible values follow:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">Unknown</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Complete</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">Incomplete</td>
</tr>
</table>
<p>
<strong>Volume name.</strong>
A blank padded Unicode (CCSID 13488) text string describing the
volume name residing on the disk drive extent.
<br>
If the disk contains more than 32 extents,
the volume name on the 32nd extent entry will be *OVERFLOW.
</p>
<br>
<br>
<h3><a name="HDRODOLDI"></a>Format of List Information</h3>
<p>The following table shows the format of the list information parameter. For
detailed descriptions of the field in the table, see <a href="#HDRFPADOLL">
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%">Total records</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">Records returned</td>
</tr>
<tr>
<td align="center" valign="top">8</td>
<td align="center" valign="top">8</td>
<td align="left" valign="top">CHAR(4)</td>
<td align="left" valign="top">Request handle</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">Record length</td>
</tr>
<tr>
<td align="center" valign="top">16</td>
<td align="center" valign="top">10</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Information complete indicator</td>
</tr>
<tr>
<td align="center" valign="top">17</td>
<td align="center" valign="top">11</td>
<td align="left" valign="top">CHAR(13)</td>
<td align="left" valign="top">Date and time created</td>
</tr>
<tr>
<td align="center" valign="top">30</td>
<td align="center" valign="top">1E</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">List status indicator</td>
</tr>
<tr>
<td align="center" valign="top">31</td>
<td align="center" valign="top">1F</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">32</td>
<td align="center" valign="top">20</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of information returned</td>
</tr>
<tr>
<td align="center" valign="top">36</td>
<td align="center" valign="top">24</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">First record in buffer</td>
</tr>
<tr>
<td align="center" valign="top">40</td>
<td align="center" valign="top">28</td>
<td align="left" valign="top">CHAR(40)</td>
<td align="left" valign="top">Reserved</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRFPADOLL">Field Descriptions</a></h3>
<p><strong>Date and time created.</strong> The date and time the list was
created. The 13 characters are:</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Century, where 0 indicates years 19<em>xx</em>
and 1 indicates years 20<em>xx</em>.</td>
</tr>
<tr>
<td align="left" valign="top"><em>2-7</em></td>
<td align="left" valign="top">The date, in YYMMDD (year, month, day)
format.</td>
</tr>
<tr>
<td align="left" valign="top"><em>8-13</em></td>
<td align="left" valign="top">The time of day, in HHMMSS (hours, minutes,
seconds) format.</td>
</tr>
</table>
<p><strong>First record in buffer.</strong> The number of the first record in
the receiver variable.</p>
<p><strong>Information complete indicator.</strong> Whether all information
requested has been supplied.</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>I</em></td>
<td align="left" valign="top">(x'C9') Incomplete information. An interruption
caused the list to contain incomplete information about a buffer or
buffers.</td>
</tr>
<tr>
<td align="left" valign="top"><em>P</em></td>
<td align="left" valign="top">(x'D7') Partial and accurate information. Partial
information is returned when the maximum space was used and not all of the
buffers requested were read.</td>
</tr>
<tr>
<td align="left" valign="top"><em>C</em></td>
<td align="left" valign="top">x'C3') Complete and accurate information. All the
buffers requested were read and returned.</td>
</tr>
</table>
<p><strong>Length of information returned.</strong> The size, in bytes, of the
information returned in the receiver variable.</p>
<p><strong>List status indicator.</strong> The status of the list building. The
indicators are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">The list building is pending.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The list is in the process of being built.</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">The list has been built completely.</td>
</tr>
<tr>
<td align="left" valign="top"><em>3</em></td>
<td align="left" valign="top">An error occurred while building the list. The
next call to QGYGTLE will cause the error to be signalled to the caller of
QGYGTLE.</td>
</tr>
</table>
<p><strong>Record length.</strong> The length of each record of information
returned. For variable length records, this value is set to 0. For variable
length records, you can obtain the length of individual records from the
records themselves.</p>
<p><strong>Records returned.</strong> The number of records returned in the
receiver variable. This is the smallest of the following values:</p>
<ul>
<li>The number of records that fit into the receiver variable.</li>
<li>The number of records in the list.</li>
<li>The number of records requested.</li>
</ul>
<p><strong>Request handle.</strong> The handle of the request that can be used
for subsequent requests of information from the list. The handle is valid until
the Close List (QGYCLST) API is called to close the list or until the job
ends.</p>
<p><strong>Note:</strong> This field should be treated as a hexadecimal field.
It should not be converted from one CCSID to another (for example, EBCDIC to
ASCII) because doing so could result in an unusable value.</p>
<p><strong>Reserved.</strong> Reserved field. Must be set to hexadecimal or
binary zero.</p>
<p><strong>Total records.</strong> The total number of records available in the
list.</p>
<br>
<h3>Error Messages</h3>
<table width="100%">
<tr>
<th align="left" valign="top">Message ID</th>
<th align="left" valign="top">Error Message Text</th>
</tr>
<tr>
<td width="15%" valign="top">CPF24B4 E</td>
<td width="85%" valign="top">Severe error while addressing parameter list.</td>
</tr>
<tr>
<td valign="top">CPF2634 E</td>
<td valign="top">Not authorized to object &amp;1.</td>
</tr>
<tr>
<td valign="top">CPF3C17 E</td>
<td valign="top">Error occurred with input data parameter.</td>
</tr>
<tr>
<td valign="top">CPF3C19 E</td>
<td valign="top">Error occurred with receiver variable specified.</td>
</tr>
<tr>
<td valign="top">CPF3C1D E</td>
<td valign="top">Length specified in parameter &amp;1 not valid.</td>
</tr>
<tr>
<td valign="top">CPF3C1E E</td>
<td valign="top">Required parameter &amp;1 omitted.</td>
</tr>
<tr>
<td valign="top">CPF3C1F E</td>
<td valign="top">Pointer is not on a 16 byte boundary.</td>
</tr>
<tr>
<td valign="top">CPF3C21 E</td>
<td valign="top">Format name &amp;1 is not valid.</td>
</tr>
<tr>
<td valign="top">CPF3C24 E</td>
<td valign="top">Length of the receiver variable is not valid.</td>
</tr>
<tr>
<td valign="top">CPF3CF1 E</td>
<td valign="top">Error code parameter not valid.</td>
</tr>
<tr>
<td valign="top">CPF3CF2 E</td>
<td valign="top">Error(s) occurred during running of &amp;1 API.</td>
</tr>
<tr>
<td valign="top">CPF3C36 E</td>
<td valign="top">Number of parameters, &amp;1, entered for this API was not
valid.</td>
</tr>
<tr>
<td valign="top">CPF9806 E</td>
<td valign="top">Cannot perform function for object &amp;2 in library
&amp;3.</td>
</tr>
<tr>
<td valign="top">CPF9872 E</td>
<td valign="top">Program or service program &amp;1 in library &amp;2 ended.
Reason code &amp;3.</td>
</tr>
</table>
<br>
<hr>
API introduced: V5R1
<hr>
<center>
<table cellpadding="2" cellspacing="2">
<tr align="center">
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
"ss1.htm">Server Support APIs</a> | <a href="aplist.htm">APIs by
category</a></td>
</tr>
</table>
</center>
</body>
</html>
Reference in New Issue Copy Permalink