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

1185 lines
36 KiB
HTML
Raw Permalink 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>Retrieve Device Status (QTARDSTS) 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. -->
<!-- Created on 18 January 2001 by JKOCHAN -->
<!-- Change History: -->
<!-- YYMMDD USERID Change description -->
<!-- File cleanup completed Feb 2002 by v2cdijab -->
<!-- Minor corrections on 20 March 2002 by JKOCHAN -->
<!-- V5R3 changes on 15 May 2002 by JKOCHAN -->
<!-- V5R4 changes on 14 January 2005 by LANA -->
<!-- V5R4 changes on 04 Febuary 2005 by LANA -->
<!-- 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 Device Status (QTARDSTS) API</h2>
<div class="box" style="width: 80%;">
&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">Device description</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(10)</td>
</tr>
<tr>
<td align="center" valign="top">5</td>
<td align="left" valign="top">Resource name</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(10)</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>
&nbsp;&nbsp;Default Public Authority: *USE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: No<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The Retrieve Device Status (QTARDSTS) API retrieves dynamic status
information for the specified device and for any currently mounted tape
cartridge. The device description must be varied on. The resource that is
associated with a specified tape media library device description must
currently exist on the system.</p>
<p><strong>Note:</strong> If the device status has been changed by a manual
operation or by another system sharing the device, the information will not be
accurate.</p>
<p>The QTARDSTS API currently supports the following device types:</p>
<ul>
<li>Tape (TAP) devices</li>
<li>Tape media library (TAPMLB) devices</li>
</ul>
<br>
<h3>Authorities and Locks</h3>
<dl>
<dt><em>Device Description 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 8
bytes.</p>
</dd>
<dt><strong>Format name</strong></dt>
<dd>INPUT; CHAR(8)
<p>The content and format of the information being returned.</p>
<p>The RDST0100 format must be used for the tape device status information. See
<a href="#HDRRDST0100">RDST0100 Format</a> to view the information returned for
this format.</p>
</dd>
<dt><strong>Device description</strong></dt>
<dd>INPUT; CHAR(10)
<p>The name of the device description for which the data is returned.</p>
</dd>
<dt><strong>Resource name</strong></dt>
<dd>INPUT; CHAR(10)
<p>When the Device description parameter specifies a tape media library device
description, this parameter can be used to specify the resource name of a tape
device within the tape media library for which data is returned. This parameter must
be set to blanks when only the tape media library information is needed, or
when the device description is for a tape device.</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="HDRRDST100">RDST0100 Format</a></h3>
<p>The following table shows the information that is returned for the RDST0100
format. For more details about the fields in the following table, see <a href=
"#HDRFLDXX">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%">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 current cartridge information</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 current cartridge information
entries</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 current cartridge information
entry</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">Offset to device information</td>
</tr>
<tr>
<td align="center" valign="top">24</td>
<td align="center" valign="top">18</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Number of device information entries</td>
</tr>
<tr>
<td align="center" valign="top">28</td>
<td align="center" valign="top">1C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of device information entry</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">Offset to label information</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">Number of label information entries</td>
</tr>
<tr>
<td align="center" valign="top">40</td>
<td align="center" valign="top">28</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of label information entry</td>
</tr>
<tr>
<td align="center" valign="top">44</td>
<td align="center" valign="top">2C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Offset to position information</td>
</tr>
<tr>
<td align="center" valign="top">48</td>
<td align="center" valign="top">30</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Number of position information entries</td>
</tr>
<tr>
<td align="center" valign="top">52</td>
<td align="center" valign="top">34</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of position information entry</td>
</tr>
<tr>
<td align="center" valign="top">56</td>
<td align="center" valign="top">38</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Offset to tape media library information</td>
</tr>
<tr>
<td align="center" valign="top">60</td>
<td align="center" valign="top">3C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Number of tape media library information
entries</td>
</tr>
<tr>
<td align="center" valign="top">64</td>
<td align="center" valign="top">40</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of tape media library information
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">Current cartridge information</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">Device information</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">Label information</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">Position information</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">Tape media library information</td>
</tr>
</table>
<br>
<br>
<h3><a name="CTGINFO">Current cartridge information</a></h3>
<p>The following table shows the current cartridge information that is
returned. This information is only available when a command was
previously issued to use the device and one or more of the following
conditions are present:</p>
<ul>
<li>There is an open tape file for the device.</li>
<li>The device is in leave processing.</li>
<li>The device is varied on with assign(*YES).</li>
<li>><img src="delta.gif" alt="Start of change">The device is a virtual tape device and an Image catalog is loaded.<img src="deltaend.gif" alt="End of change"></li>
</ul>
<p>This information is not returned when the specified device description is a
tape media library and no device resource is provided. The information
returned may not be accurate if there was an error reported during
the previously issued command. For more details about the
fields in the following table, see <a href="#HDRFLDXX">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%">CHAR(6)</td>
<td align="left" valign="top" width="60%">Volume ID</td>
</tr>
<tr>
<td align="center" valign="top">6</td>
<td align="center" valign="top">6</td>
<td align="left" valign="top">CHAR(6)</td>
<td align="left" valign="top">Cartridge ID</td>
</tr>
<tr>
<td align="center" valign="top">12</td>
<td align="center" valign="top">C</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Current cartridge density</td>
</tr>
<tr>
<td align="center" valign="top">22</td>
<td align="center" valign="top">16</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Write protected</td>
</tr>
<tr>
<td align="center" valign="top"><img src="delta.gif" alt="Start of change">23</td>
<td align="center" valign="top">17</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Image catalog name</td>
</tr>
<tr>
<td align="center" valign="top">33</td>
<td align="center" valign="top">21</td>
<td align="left" valign="top">CHAR(6)</td>
<td align="left" valign="top">Mounted volume ID<img src="deltaend.gif" alt="End of change"></td>
</tr>
</table>
<br>
<br>
<h3><a name="DEVINFO">Device information</a></h3>
<p>The following table shows the device information that is returned. This
information is only available when there is an active job using the tape
device or the specified device description is a tape media library and a
device resource is provided that is owned by the tape media library.
For more details about the fields in the following table, see
<a href="#HDRFLDXX">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%">CHAR(10)</td>
<td align="left" valign="top" width="60%">Current command</td>
</tr>
<tr>
<td align="center" valign="top">10</td>
<td align="center" valign="top">A</td>
<td align="left" valign="top">CHAR(26)</td>
<td align="left" valign="top">Job using the device</td>
</tr>
<tr>
<td align="center" valign="top">36</td>
<td align="center" valign="top">24</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Category is mounted</td>
</tr>
<tr>
<td align="center" valign="top">37</td>
<td align="center" valign="top">25</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Mounted category name</td>
</tr>
<tr>
<td align="center" valign="top">47</td>
<td align="center" valign="top">2F</td>
<td align="left" valign="top">CHAR(8)</td>
<td align="left" valign="top">Mounted category system</td>
</tr>
<tr>
<td align="center" valign="top">55</td>
<td align="center" valign="top">37</td>
<td align="left" valign="top">CHAR(6)</td>
<td align="left" valign="top">Mounted cartridge ID</td>
</tr>
<tr>
<td align="center" valign="top">61</td>
<td align="center" valign="top">3D</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Cartridge order for category</td>
</tr>
<tr>
<td align="center" valign="top">62</td>
<td align="center" valign="top">3E</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Target category</td>
</tr>
<tr>
<td align="center" valign="top">72</td>
<td align="center" valign="top">48</td>
<td align="left" valign="top">CHAR(8)</td>
<td align="left" valign="top">Target system</td>
</tr>
<tr>
<td align="center" valign="top">80</td>
<td align="center" valign="top">50</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Mount identifier</td>
</tr>
</table>
<br>
<br>
<h3><a name="LBLINFO">Label information</a></h3>
<p>The following table shows the label information that is returned. This
information is only available when there is an open tape file for the tape
device or the device is in leave processing. This information is not returned
when the specified device description is a tape media library and no device resource
is provided. For more details about the fields in the following table, see <a
href="#HDRFLDXX">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%">CHAR(1)</td>
<td align="left" valign="top" width="60%">Label type</td>
</tr>
<tr>
<td align="center" valign="top">1</td>
<td align="center" valign="top">1</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Tape encoding</td>
</tr>
<tr>
<td align="center" valign="top">2</td>
<td align="center" valign="top">2</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Current file sequence number</td>
</tr>
<tr>
<td align="center" valign="top">12</td>
<td align="center" valign="top">C</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Current multi-volume sequence number</td>
</tr>
<tr>
<td align="center" valign="top">22</td>
<td align="center" valign="top">16</td>
<td align="left" valign="top">CHAR(80)</td>
<td align="left" valign="top">Volume label</td>
</tr>
<tr>
<td align="center" valign="top">102</td>
<td align="center" valign="top">66</td>
<td align="left" valign="top">CHAR(80)</td>
<td align="left" valign="top">Last processed HDR1/TRL1 label</td>
</tr>
<tr>
<td align="center" valign="top">182</td>
<td align="center" valign="top">B6</td>
<td align="left" valign="top">CHAR(80)</td>
<td align="left" valign="top">Last processed HDR2/TRL2 label</td>
</tr>
</table>
<br>
<br>
<h3><a name="POSINFO">Position information</a></h3>
<p>The following table shows the position information that is returned. This
information is only available when there is an open tape file for the tape
device or the device is in leave processing. This information is not returned
when the specified device description is a tape media library and no device resource
is provided. For more details about the fields in the following table, see <a
href="#HDRFLDXX">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%">CHAR(1)</td>
<td align="left" valign="top" width="60%">In leave processing</td>
</tr>
<tr>
<td align="center" valign="top">1</td>
<td align="center" valign="top">1</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">At logical EOT</td>
</tr>
<tr>
<td align="center" valign="top">2</td>
<td align="center" valign="top">2</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">At logical BOT</td>
</tr>
<tr>
<td align="center" valign="top">3</td>
<td align="center" valign="top">3</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Reserved</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">Current tape mark count</td>
</tr>
</table>
<br>
<br>
<h3><a name="TLINFO">Tape media library information</a></h3>
<p>The following table shows the tape media library information that is returned.
This information is only available when the specified device description is a
tape media library and a command was previously issued to use the tape media library. For
more details about the fields in the following table, see <a href="#HDRFLDXX">
Field Descriptions</a>.</p>
<p><strong>Note:</strong> For a 3494 tape media library device the tape media library
information is only updated when a DSPTAPSTS command is issued.</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%">Number of used slots</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">Number of available slots</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 high capacity slots</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 import/export stations</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRFLDXX">Field Descriptions</a></h3>
<p><strong>At logical BOT.</strong> Whether the media is currently positioned
at logical BOT.
For standard labeled format tapes this indicator is set whenever
the tape is positioned within the first label group. For non-labeled
format tapes this indicator is set whenever the tape is positioned
within the first file on tape.
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 media is not currently positioned at logical
BOT.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The media is currently positioned at logical
BOT.</td>
</tr>
</table>
<p><strong>At logical EOT.</strong> Whether the media is currently positioned
at logical EOT. 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 media is not currently positioned at logical
EOT.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The media is currently positioned at logical
EOT.</td>
</tr>
</table>
<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>Cartridge ID.</strong> The Cartridge identifier for the currently
mounted media. This field will be blank if the tape does not have a bar code
label or if it is not in a tape media library with a bar code reader.</p>
<p><strong>Cartridge order for category.</strong>When there is a category
mounted on the specified resource within a tape media library this field
shows the cartridge order. Possible values follow:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">The cartridges will be mounted in
next available (*NEXTAVAIL) order.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The cartridges will be mounted in
sequential (*SEQ) order.</td>
</tr>
<tr>
<td align="left" valign="top"><em>blank</em></td>
<td align="left" valign="top">There is no category mounted.</td>
</tr>
</table>
<p><strong>Category is mounted.</strong> Whether there currently is a category
mounted on the device. 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">There is not a category mounted on the
device.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">There is a category mounted on the device.</td>
</tr>
<tr>
<td align="left" valign="top"><em>blank</em></td>
<td align="left" valign="top">The device is not allocated to a tape media
library.</td>
</tr>
</table>
<p><strong>Current cartridge density.</strong> The density of the currently
mounted media.</p>
<p><strong>Current command.</strong> The current command executed against the
tape device. If the specific command is not known, one of the following values
is returned:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>CPP CMD</em></td>
<td align="left" valign="top">A CL command was executed.</td>
</tr>
<tr>
<td align="left" valign="top"><em>SAVE CMD</em></td>
<td align="left" valign="top">A save command was executed.</td>
</tr>
<tr>
<td align="left" valign="top"><em>RST CMD</em></td>
<td align="left" valign="top">A restore command was executed.</td>
</tr>
<tr>
<td align="left" valign="top"><em>COMMAND</em></td>
<td align="left" valign="top">An unknown type of command was executed.</td>
</tr>
</table>
<p><strong>Current file sequence number.</strong> The current sequence number
of the file being processed. This field will be blanks if no files have been
processed yet.</p>
<p><strong>Current multi-volume sequence number.</strong> The current
multi-volume sequence number for the mounted media. This field will be blank if
no media is mounted or if the tape is a non-labeled tape.</p>
<p><strong>Current tape mark count.</strong> The current number of tape marks
away from BOT.</p>
<p><img src="delta.gif" alt="Start of change"><strong>Image catalog name.</strong>The name of the image catalog loaded on the virtual tape device. When there is no image catalog loaded, the field will be set to blanks.<img src="deltaend.gif" alt="End of change"></p>
<p><strong>In leave processing.</strong> Whether the last completed tape
command used an ending option of *LEAVE. 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 media is not currently left in position.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The media is currently left in position.</td>
</tr>
</table>
<p><strong>Job using the device.</strong> The qualified job name of the job
currently using the device. This field will be all blanks if there is no active
job using the device.</p>
<p><strong>Label type.</strong> The label format of the currently mounted tape.
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 media uses standard label format.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The media uses non-labeled format.</td>
</tr>
</table>
<p><strong>Last processed HDR1/TRL1 label.</strong> The last processed HDR1 or
TRL1 label on the media. This field will be all blanks for a Non-labeled tape,
or if no labels have been processed yet.</p>
<p><strong>Last processed HDR2/TRL2 label.</strong> The last processed HDR2 or
TRL2 label on the media. This field will be all blanks for a Non-labeled tape
or if no labels have been processed yet.</p>
<p><strong>Length of current cartridge information entry.</strong> When current
cartridge information is available this field is set to the length, in bytes,
of a single current cartridge information entry. A value of zero is returned if
the current cartridge information is not available.</p>
<p><strong>Length of device information entry.</strong> When device information
is available this field is set to the length, in bytes, of a single device
information entry. A value of zero is returned if the device information is not
available.</p>
<p><strong>Length of label information entry.</strong> When label information
is available this field is set to the length, in bytes, of a single label
information entry. A value of zero is returned if the label information is not
available.</p>
<p><strong>Length of position information entry.</strong> When position
information is available this field is set to the length, in bytes, of a single
position information entry. A value of zero is returned if the position
information is not available.</p>
<p><strong>Length of tape media library information entry.</strong> When tape
media library information is available this field is set to the length, in
bytes, of a single tape media library information entry. A value of zero is
returned if the tape media library information is not available.</p>
<p><strong>Mounted cartridge ID.</strong>For a resource within a
tape media library device the cartridge identifier for the
cartridge that was last mounted is returned. When the specified device
description is a tape device, the field is set to blanks.</p>
<p><strong>Mounted category name.</strong> The name of the category mounted on
the specified resource within a tape media library.
When there is no category mounted, the field is set to blanks.</p>
<p><strong>Mounted category system.</strong>The name of the system owning
the category mounted on the specified resource within a tape media
library. When there is no category mounted or the category is not owned
by a specific system, the field is set to blanks.</p>
<p><strong>Mount identifier.</strong>The mount identifier assigned to
the category mounted on the specified resource within a tape media
library. When there is no mount identifier assigned the value *NONE
is returned. When there is no category mounted, the field is set to
blanks.</p>
<p><img src="delta.gif" alt="Start of change"><strong>Mounted volume ID.</strong>The name of the volume which is currently mounted on the virtual tape device. When there is no image catalog loaded or no volume mounted, the field is set to blanks.<img src="deltaend.gif" alt="End of change"></p>
<p><strong>Number of available slots.</strong> The number of empty storage
slots in the tape media library.</p>
<p><strong>Number of current cartridge information entries.</strong> If current
cartridge information is available, a value of one is returned. A value of zero
is returned if the current cartridge information is not available.</p>
<p><strong>Number of device information entries.</strong> If device information
is available, a value of one is returned. A value of zero is returned if the
device information is not available.</p>
<p><strong>Number of high capacity slots.</strong> The number of high
capacity storage slots in the tape media library.</p>
<p><strong>Number of import/export stations.</strong> The number of
import/export stations for the tape media library.</p>
<p><strong>Number of label information entries.</strong> If label information
is available, a value of one is returned. A value of zero is returned if the
label information is not available.</p>
<p><strong>Number of position information entries.</strong> If position
information is available, a value of one is returned. A value of zero is
returned if the position information is not available.</p>
<p><strong>Number of tape media library information entries.</strong> If tape
media library information is available, a value of one is returned. A value of
zero is returned if the tape media library information is not available.</p>
<p><strong>Number of used slots.</strong> The number of storage slots in the
tape media library that are currently being used.</p>
<p><strong>Offset to current cartridge information.</strong> The offset, in
bytes, to the current cartridge information. A value of zero is returned if the
current cartridge information is not available.</p>
<p><strong>Offset to device information.</strong> The offset, in bytes, to the
current job information. A value of zero is returned if the device information
is not available.</p>
<p><strong>Offset to label information.</strong> The offset, in bytes, to the
label information. A value of zero is returned if the label information is not
available.</p>
<p><strong>Offset to position information.</strong> The offset, in bytes, to
the position information. A value of zero is returned if the position
information is not available.</p>
<p><strong>Offset to tape media library information.</strong> The offset, in
bytes, to the tape media library information. A value of zero is returned if
the tape media library information is not available.</p>
<p><strong>Tape Encoding.</strong> The encoding scheme being used for the
mounted media. 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">ASCII format tape.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">EBCDIC format tape.</td>
</tr>
</table>
<p><strong>Target category.</strong> The category that the cartridges will
be changed to after they are used.
When there is no category mounted, the field is set to blanks.</p>
<p><strong>Target system.</strong>The name of the system owning
the target category. When there is no category mounted, the field is
set to blanks.</p>
<p><strong>Volume ID.</strong> The Volume identifier for the currently mounted
media. This field will be blank for non-labeled tapes or if the tape cannot be
read.</p>
<p><strong>Volume label.</strong> The volume label for the currently mounted
media. This field will be blank for a non-labeled tape or if the tape cannot be
read.</p>
<p><strong>Write protected.</strong> Whether the mounted media is write
protected. Possible values follow:</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">The media is not write protected.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The media is write protected.</td>
</tr>
<tr>
<td align="left" valign="top"><img src="delta.gif" alt="Start of change"><em>blank</em></td>
<td align="left" valign="top">Write protect status is unknown.<img src="deltaend.gif" alt="End of change"></td>
</tr>
</table>
<br>
<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" width="15%">CPF24B4 E</td>
<td align="left" valign="top" width="85%">Severe error while addressing parameter
list.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C19 E</td>
<td align="left" valign="top">Error occurred with receiver variable
specified.</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">CPF3C3C E</td>
<td align="left" valign="top">Value for parameter &amp;1 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">CPF3CF1 E</td>
<td align="left" valign="top">Error code parameter not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF6708 E</td>
<td align="left" valign="top">Command ended due to error.</td>
</tr>
<tr>
<td align="left" valign="top">CPF6721 E</td>
<td align="left" valign="top">Device &amp;1 not a tape device.</td>
</tr>
<tr>
<td align="left" valign="top">CPF672F E</td>
<td align="left" valign="top">Resource &amp;1 not found.</td>
</tr>
<tr>
<td align="left" valign="top">CPF67B0 E</td>
<td align="left" valign="top">Tape resource &amp;2 not in specified library
device.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9802 E</td>
<td align="left" valign="top">Not authorized to object &amp;2 in &amp;3.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9814 E</td>
<td align="left" valign="top">Device &amp;1 not found.</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>
</table>
<br>
<hr>
API introduced: V5R2
<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=
"back1.htm">Backup and Recovery APIs</a> | <a href="aplist.htm">APIs by
category</a></td>
</tr>
</table>
</body>
</html>
Reference in New Issue Copy Permalink