364 lines
12 KiB
HTML
364 lines
12 KiB
HTML
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
||
|
|
<html>
|
||
|
|
<head>
|
||
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||
|
|
<meta name="Copyright" content="Copyright (c) 2006 by IBM Corporation">
|
||
|
|
<title>Dump Device (QTADMPDV) 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. -->
|
||
|
|
<!-- BACKMST SCRIPT A converted by B2H R4.1 (346) (CMS) by v2kea304 at -->
|
||
|
|
<!-- RCHVMW2 on 26 April 1999 at 10:21:58 -->
|
||
|
|
<!-- Change History: -->
|
||
|
|
<!-- YYMMDD USERID Change description -->
|
||
|
|
<!-- File Edited Jan 2002 -->
|
||
|
|
<!-- 050322 LANA v5r4m0 Update authority documentation -->
|
||
|
|
<!-- 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>Dump Device (QTADMPDV) API</h2>
|
||
|
|
|
||
|
|
<div class="box" style="width: 60%;">
|
||
|
|
<br>
|
||
|
|
Required Parameter Group:<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
<table width="100%">
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top" width="10%">1</td>
|
||
|
|
<td align="left" valign="top" width="50%">Device name</td>
|
||
|
|
<td align="left" valign="top" width="20%">Input</td>
|
||
|
|
<td align="left" valign="top" width="20%">Char(10)</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
Optional Parameter Group:<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
<table width="100%">
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top" width="10%">2</td>
|
||
|
|
<td align="left" valign="top" width="50%">Type of information</td>
|
||
|
|
<td align="left" valign="top" width="20%">Input</td>
|
||
|
|
<td align="left" valign="top" width="20%">Char(10)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">3</td>
|
||
|
|
<td align="left" valign="top">Problem identifier</td>
|
||
|
|
<td align="left" valign="top">Input</td>
|
||
|
|
<td align="left" valign="top">Char(10)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">4</td>
|
||
|
|
<td align="left" valign="top">Error code</td>
|
||
|
|
<td align="left" valign="top">I/O</td>
|
||
|
|
<td align="left" valign="top">Char(*)</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
Default Public Authority: *USE<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
Threadsafe: No<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
</div>
|
||
|
|
<p>The Dump Device (QTADMPDV) API collects information for your IBM service
|
||
|
|
representative. This API should be used immediately after a suspected device
|
||
|
|
and/or tape management system failure. If the API is not used immediately,
|
||
|
|
other device operations may cause the flight recorders to wrap, which could
|
||
|
|
result in lost information. A problem identifier will be created and an APAR
|
||
|
|
library will be generated similar to the Save APAR Data (SAVAPARDTA) command.
|
||
|
|
To save the APAR library, use Work with Problem (WRKPRB) command. Choose the
|
||
|
|
option to work with the problem and then the option to save the APAR library.
|
||
|
|
If an existing problem identifier is passed to this API, then the spooled files
|
||
|
|
generated will be logged against that problem identifier and no new problem
|
||
|
|
identifier will be generated.</p>
|
||
|
|
|
||
|
|
<p>The Dump Device API currently supports the following device types:</p>
|
||
|
|
|
||
|
|
<ul>
|
||
|
|
<li>Tape (TAP) devices</li>
|
||
|
|
|
||
|
|
<li>Tape media library (TAPMLB) devices</li>
|
||
|
|
|
||
|
|
<li>Optical (OPT) devices</li>
|
||
|
|
|
||
|
|
<li>Optical media library (OPTMLB) devices</li>
|
||
|
|
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<p><strong>Note:</strong> The information provided in and the number of spooled
|
||
|
|
files may change at anytime. The information provided is intended for problem
|
||
|
|
determination.</p>
|
||
|
|
|
||
|
|
<p>The Dump Device (QTADMPDV) API dumps the following information for tape or tape media library devices, into spooled files:</p>
|
||
|
|
|
||
|
|
<ul>
|
||
|
|
<li><img src="delta.gif" alt="Start of change">
|
||
|
|
Dump of the device description for the device specified in the
|
||
|
|
parameter that is passed to the program. </li>
|
||
|
|
|
||
|
|
<li>Device description details of the device.</li>
|
||
|
|
|
||
|
|
<li>Device capabilities (QTARDCAP output).</li>
|
||
|
|
|
||
|
|
<li>QTARDINF API output.</li>
|
||
|
|
|
||
|
|
<li>Licensed Internal Code tape flight recorders.</li>
|
||
|
|
|
||
|
|
<li>IOP trace for the device.</li>
|
||
|
|
|
||
|
|
<li>QSYSOPR message queue.</li>
|
||
|
|
|
||
|
|
<li>Message queue for the user/device doing the QTADMPDV call.</li>
|
||
|
|
|
||
|
|
<li>Licensed Internal Code logs from the last 24 hours.</li>
|
||
|
|
|
||
|
|
<li>Product Activity Logs from the last 24 hours.</li>
|
||
|
|
|
||
|
|
<li>The PTF list.</li>
|
||
|
|
|
||
|
|
<li>A Work with Configuration Status (WRKCFGSTS) listing.</li>
|
||
|
|
|
||
|
|
<li>Media and Storage Extensions (MSE) flight recorder. </li>
|
||
|
|
|
||
|
|
<li>The history log (QHST).</li>
|
||
|
|
|
||
|
|
<li>QTAPARB job log and display job (DSPJOB) information.</li>
|
||
|
|
|
||
|
|
<li>Job logs and display jobs (DSPJOB) of the active jobs that have used the device as indicated in the
|
||
|
|
flight recorder data.</li>
|
||
|
|
|
||
|
|
<li>The job log and display job (DSPJOB) of the job that is processing this API.</li>
|
||
|
|
|
||
|
|
<li>The Media library inventory information and display file description (DSPFD).</li>
|
||
|
|
|
||
|
|
<li>The Media library category information and display file description (DSPFD).</li>
|
||
|
|
|
||
|
|
<li>The Media library filter information and display file description (DSPFD).</li>
|
||
|
|
|
||
|
|
<li>The Display Hardware Resources output (DSPHDWRSC).</li>
|
||
|
|
|
||
|
|
<li>QTAHRSRV flight recorders.</li>
|
||
|
|
|
||
|
|
<li>The virtual tape information area.</li>
|
||
|
|
|
||
|
|
<li>The problem log summary. </li>
|
||
|
|
|
||
|
|
<li>Communication information that is associated with the media library device.
|
||
|
|
This includes the line, controller, and device descriptions.<img src="deltaend.gif" alt="End of change"></li>
|
||
|
|
</ul>
|
||
|
|
<p>Note that this API will generate multiple spooled files that may get large
|
||
|
|
depending upon the job logs that are being printed and the size of the other
|
||
|
|
device information. Submitting the call to batch may be used if system
|
||
|
|
performance is a concern. That is, if the API is called from the system console
|
||
|
|
at high priority, it may degrade performance on other critical processing.
|
||
|
|
Since many and potentially large spooled files may be generated, ensure that
|
||
|
|
there is enough system storage available to handle the request.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<!-- Please NOTE: DO NOT DELETE THIS SECTION if this API has no authorities and locks. -->
|
||
|
|
<!-- Instead, use the commented out coding below to indicate NONE. -->
|
||
|
|
<h3>Authorities and Locks</h3>
|
||
|
|
<img src="delta.gif" alt="Start of change"><dl>
|
||
|
|
<dd>Device description: *USE
|
||
|
|
<p>To dump the IOP trace you need use (*USE) authority to the Control Device API (QTACTLDV).<br><i> See the documentation for this API for additional authority requirements.</i></p>
|
||
|
|
<p>To dump the PTF details you need use (*USE) authority to the Display Program Temporary Fix (DSPPTF) command.<br><i> See the documentation for this command for additional authority requirements.</i></p>
|
||
|
|
<p>To dump the VLOGS you need use (*USE) authority to the Print Internal Data (PRTINTDTA) command and Service (*SERVICE) special authority. <br><i> See the documentation for this command for additional authority requirements.</i></p>
|
||
|
|
<p>To dump the Product Activity Logs (PALS) you need use (*USE) authority to the Print Error Log (PRTERRLOG) command. <br><i> See the documentation for this command for additional authority requirements.</i></p>
|
||
|
|
<p>To dump the QTAPARB job log and display job information, you need Job Control (*JOBCTL) and All Object (*ALLOBJ) special authorities. </p>
|
||
|
|
<p>To dump the Media Library Inventory file description, you need use (*USE) authority to the QATAMID and QLTAMID files in QUSRSYS. </p>
|
||
|
|
<p>To dump the Media Library Category file description, you need use (*USE) authority to the QATACGY and QLTACGY files in QUSRSYS. </p>
|
||
|
|
<p>To dump the Cartridge Filter file description, you need use (*USE) authority to the QATAFTR file in QUSRSYS.</p>
|
||
|
|
<p>To dump the QTAHRSRV flight recorders you need use (*USE) authority to the Dump System Object (DMPSYSOBJ) command. <br><i> See the documentation for this command for additional authority requirements.</i></p>
|
||
|
|
</dd>
|
||
|
|
</dl><img src="delta.gif" alt="End of change">
|
||
|
|
|
||
|
|
<h3>Required Parameter</h3>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><strong>Device name</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; CHAR(10)
|
||
|
|
|
||
|
|
<p>The name of the device for which debugging information is being dumped.</p>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Optional Parameter Group</h3>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><strong>Type of information</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; CHAR(10)
|
||
|
|
|
||
|
|
<p>The type of information to be dumped.<br>
|
||
|
|
Valid values are:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="15 85" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>*ALL</em></td>
|
||
|
|
<td align="left" valign="top">All information needed by IBM will be dumped to
|
||
|
|
spooled files.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>*MSE</em></td>
|
||
|
|
<td align="left" valign="top">Media and Storage Extension (MSE) flight recorder
|
||
|
|
will be dumped. <br><i><img src="delta.gif" alt="Start of change"> This is only valid for tape or tape media library devices. <img src="deltaend.gif" alt="End of change"></i></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Problem identifier</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; CHAR(10)
|
||
|
|
|
||
|
|
<p>The problem identifier of the problem being analyzed. Problems with
|
||
|
|
different system origins can have the same identifier. The possible values
|
||
|
|
are:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="15 85" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>*NEW</em></td>
|
||
|
|
<td align="left" valign="top">A problem identifier will be created.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>problem-identifier</em></td>
|
||
|
|
<td align="left" valign="top">The 10-character problem identifier of the
|
||
|
|
problem being selected.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
</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="Header_45">Examples</a></h3>
|
||
|
|
|
||
|
|
<p>The following are examples of calls to the API from command entry:</p>
|
||
|
|
|
||
|
|
<ul>
|
||
|
|
<li>CALL QTADMPDV TAP01
|
||
|
|
|
||
|
|
<p>The dump device will dump information about TAP01 and assigns it to a
|
||
|
|
created problem identifier.</p>
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li>CALL QTADMPDV TAPMLB01
|
||
|
|
|
||
|
|
<p>The dump device will dump information about TAPMLB01 and assigns it to a
|
||
|
|
created problem identifier.</p>
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li>CALL QTADMPDV (TAP01 *ALL 9628851615 x'00000000')
|
||
|
|
|
||
|
|
<p>The dump device will dump information about TAP01 and assign it to an
|
||
|
|
existing problem identifier.</p>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Error Messages</h3>
|
||
|
|
|
||
|
|
<table width="100%" cellpadding="5">
|
||
|
|
<!-- cols="15 85" -->
|
||
|
|
<tr>
|
||
|
|
<th align="left" valign="top">Message ID</th>
|
||
|
|
<th align="left" valign="top">Error Message Text</th>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td width="15%" valign="top">CPF3C90 E</td>
|
||
|
|
<td width="85%" valign="top">Literal value cannot be changed.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF6709 E</td>
|
||
|
|
<td valign="top">Parameter &3 not correct.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF6721 E</td>
|
||
|
|
<td valign="top">Device &1 not a tape device.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF673F E</td>
|
||
|
|
<td valign="top">Device &1 does not support &2.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9814 E</td>
|
||
|
|
<td valign="top">Device &1 not found.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9825 E</td>
|
||
|
|
<td valign="top">Not authorized to device &1.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9872 E</td>
|
||
|
|
<td valign="top">Program or service program &1 in library &2 ended.
|
||
|
|
Reason code &3.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<hr>
|
||
|
|
API introduced: V4R1
|
||
|
|
|
||
|
|
<hr>
|
||
|
|
<center>
|
||
|
|
<table 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>
|
||
|
|
</center>
|
||
|
|
</body>
|
||
|
|
</html>
|
||
|
|
|