ibm-information-center/dist/eclipse/plugins/i5OS.ic.cl_5.4.0.1/dmptap.htm

461 lines
20 KiB
HTML
Raw Normal View History

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">
<title>Dump Tape (DMPTAP)</title>
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
</head>
<body bgcolor="white">
<script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<a name="DMPTAP.Top_Of_Page"></a>
<h2>Dump Tape (DMPTAP)</h2>
<table width="100%">
<tr>
<td valign="top" align="left"><b>Where allowed to run: </b>All environments (*ALL)<br>
<b>Threadsafe: </b>No
</td>
<td valign="top" align="right">
<a href="#DMPTAP.PARAMETERS.TABLE">Parameters</a><br>
<a href="#DMPTAP.COMMAND.EXAMPLES">Examples</a><br>
<a href="#DMPTAP.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="DMPTAP"></a>
<p>The DMPTAP (Dump Tape) command dumps label information or data blocks (or both) from standard-labeled tapes or tapes with no labels to a spooled printer file named QPTAPDMP. This command allows the user to dump one or more data files from the tape volume, writing the information to a printer file.
</p>
<p>The tape volume being dumped must be on the specified device. After the DMPTAP command is entered, as much of the tape as necessary is read before the requested information is printed.
</p>
<p>Data files on secured tapes can be dumped by the security officer only; any user can dump label information on secured tapes.
</p>
<p>When the default values for the parameters of the DMPTAP command are used, the tape label areas and a minimal amount of data from the first file are printed. This command can help determine the record format of a data file on a tape with no label, or it can determine the exact contents of all label information for a labeled data file.
</p>
<p><b>Restrictions:</b>
</p>
<ol>
<li>Only a user with all object special authority (*ALLOBJ) can dump a tape using TYPE(*HEX).
</li>
</ol>
</div>
<table width="100%">
<tr><td align="right"><a href="#DMPTAP.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="DMPTAP.PARAMETERS.TABLE">Parameters</a></h3>
<table border="1" cellpadding="4" cellspacing="0">
<!-- col1="10" col2="15" col3="30" col4="10" -->
<tr>
<th bgcolor="aqua" valign="bottom" align="left">Keyword</th>
<th bgcolor="aqua" valign="bottom" align="left">Description</th>
<th bgcolor="aqua" valign="bottom" align="left">Choices</th>
<th bgcolor="aqua" valign="bottom" align="left">Notes</th>
</tr>
<tr>
<td valign="top"><a href="#DMPTAP.DEV"><b>DEV</b></a></td>
<td valign="top">Tape device</td>
<td valign="top"><i>Name</i></td>
<td valign="top">Required, Positional 1</td>
</tr>
<tr>
<td valign="top"><a href="#DMPTAP.VOL"><b>VOL</b></a></td>
<td valign="top">Volume identifier</td>
<td valign="top"><i>Character value</i>, <b><u>*MOUNTED</u></b></td>
<td valign="top">Optional, Positional 2</td>
</tr>
<tr>
<td valign="top" rowspan="3"><a href="#DMPTAP.SEQNBR"><b>SEQNBR</b></a></td>
<td valign="top">Range of sequence numbers</td>
<td valign="top">Single values: *ALL, *SEARCH<br>Other values: <i>Element list</i></td>
<td valign="top" rowspan="3">Optional, Positional 3</td>
</tr>
<tr>
<td valign="top">Element 1: Starting file sequence number</td>
<td valign="top">
1-16777215, <b><u>*FIRST</u></b></td>
</tr>
<tr>
<td valign="top">Element 2: Ending file sequence number</td>
<td valign="top">
1-16777215, <b><u>*ONLY</u></b>, *LAST</td>
</tr>
<tr>
<td valign="top"><a href="#DMPTAP.LABEL"><b>LABEL</b></a></td>
<td valign="top">File label</td>
<td valign="top"><i>Character value</i>, <b><u>*NONE</u></b></td>
<td valign="top">Optional, Positional 4</td>
</tr>
<tr>
<td valign="top"><a href="#DMPTAP.TYPE"><b>TYPE</b></a></td>
<td valign="top">Data file information to dump</td>
<td valign="top">Single values: <b><u>*BASIC</u></b>, *ALL, *NONE, *HEX<br>Other values (up to 3 repetitions): *HDRLBL, *DTABLK, *TLRLBL</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top" rowspan="3"><a href="#DMPTAP.DTABLK"><b>DTABLK</b></a></td>
<td valign="top">Data blocks to dump</td>
<td valign="top">Single values: *ALL, *LAST<br>Other values: <i>Element list</i></td>
<td valign="top" rowspan="3">Optional</td>
</tr>
<tr>
<td valign="top">Element 1: Starting data block number</td>
<td valign="top">
1-2147483647, <b><u>*FIRST</u></b></td>
</tr>
<tr>
<td valign="top">Element 2: Ending data block number</td>
<td valign="top">
1-2147483647, <b><u>*ONLY</u></b>, *LAST</td>
</tr>
<tr>
<td valign="top"><a href="#DMPTAP.VOLLBL"><b>VOLLBL</b></a></td>
<td valign="top">Dump volume label</td>
<td valign="top"><b><u>*YES</u></b>, *NO</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#DMPTAP.CODE"><b>CODE</b></a></td>
<td valign="top">Code</td>
<td valign="top"><b><u>*EBCDIC</u></b>, *ASCII</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#DMPTAP.ENDOPT"><b>ENDOPT</b></a></td>
<td valign="top">End of tape option</td>
<td valign="top"><b><u>*REWIND</u></b>, *LEAVE, *UNLOAD</td>
<td valign="top">Optional</td>
</tr>
</table>
<table width="100%">
<tr><td align="right"><a href="#DMPTAP.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="DMPTAP.DEV"></a>
<h3>Device (DEV)</h3>
<p>Specifies the tape device in which the volume being dumped is placed. The volume may or may not be labeled. Specify the name of the tape or media library device.
</p>
<p>This is a required parameter.
</p>
<dl>
<dt><b><i>name</i></b></dt>
<dd>Specify the name of the tape device.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#DMPTAP.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="DMPTAP.VOL"></a>
<h3>Volume identifier (VOL)</h3>
<p>Specifies the volume identifier of the labeled tape being dumped, or indicates that the tape volume in the specified tape drive is dumped.
</p>
<p>
<b>Note: </b>If the device specified is a media library device, or virtual tape device, then the volume specified should be the cartridge identifier or virtual volume name to be mounted and used.
</p>
<dl>
<dt><b><u>*MOUNTED</u></b></dt>
<dd>The volume on the specified device is dumped. The volume may or may not be labeled. For a volume that is not labeled, *MOUNTED must be specified for the VOL parameter and *NONE must be specified for the <b>File label (LABEL)</b> parameter. For a media library device, the volume to be used is the next cartridge in the category mounted by the Set Tape Category (SETTAPCGY) command. For a virtual tape device, the volume to be used is the currently mounted one, or if there is not a currently mounted volume, the next volume in loaded status in the image catalog will be used.
</dd>
<dt><b><i>character-value</i></b></dt>
<dd>Specify the identifier of the labeled volume being dumped. This value can be specified only for dumping a labeled volume. If the tape on the specified device has a different volume identifier than the one specified here, or if it is not labeled, an error message is sent to the user of the Dump Tape (DMPTAP) command and the tape is not dumped.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#DMPTAP.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="DMPTAP.SEQNBR"></a>
<h3>Range of sequence numbers (SEQNBR)</h3>
<p>Specifies the range of sequence numbers for the data files that are dumped. Note that the data files dumped may be further restricted by using the <b>File label (LABEL)</b> parameter.
</p>
<p><b>Single values</b>
</p>
<dl>
<dt><b>*ALL</b></dt>
<dd>All data files on the volume that are placed in the specified device are dumped.
</dd>
<dt><b>*SEARCH</b></dt>
<dd>A search is made for a data file that has an identifier that matches the value specified for the LABEL parameter. If *SEARCH is specified, the volume must be labeled and a file label must be specified for the LABEL parameter. An escape message is sent if the file is not found.
</dd>
</dl>
<p><b>Element 1: Starting file sequence number</b>
</p>
<dl>
<dt><b><u>*FIRST</u></b></dt>
<dd>The range of data files being dumped starts with the first file on the tape volume (regardless of its sequence number).
</dd>
<dt><b><i>1-16777215</i></b></dt>
<dd>The range of data files being dumped starts with the data file with the specified sequence number. Specify a number that is less than or equal to the end-file-sequence-number value.
</dd>
</dl>
<p><b>Element 2: Ending file sequence number</b>
</p>
<dl>
<dt><b><u>*ONLY</u></b></dt>
<dd>Only a single data file (specified by the start-file-sequence-number) is dumped.
</dd>
<dt><b>*LAST</b></dt>
<dd>The range of data files being dumped begins with the starting sequence number data file and ends with the last data file on the reel.
</dd>
<dt><b><i>1-16777215</i></b></dt>
<dd>The range of data files being dumped ends with the specified sequence number data file. Specify a number that is greater than or equal to the starting file sequence number.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#DMPTAP.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="DMPTAP.LABEL"></a>
<h3>File label (LABEL)</h3>
<p>Specifies the identifier of the specific data files that are dumped. The file identifier for a tape data file is stored on labels ahead of and following the data in the file.
</p>
<dl>
<dt><b><u>*NONE</u></b></dt>
<dd>All data files on the volume in the specified SEQNBR range are dumped. For a volume that is not labeled, *MOUNTED must be specified for the <b>Volume identifier (VOL)</b> parameter and *NONE must be specified for the LABEL parameter.
</dd>
<dt><b><i>identifier</i></b></dt>
<dd>Specify the data file identifier of the data files being dumped. The system compares this identifier with the data file identifier on the labels of each file in the range specified by the <b>Range of sequence numbers (SEQNBR)</b> parameter. All data files with an identifier that matches this data file identifier are dumped; any data file with an identifier that does not match this identifier is not dumped.
</dd>
<dt><b><i>generic-identifier</i></b></dt>
<dd>Specifies a character string for a generic file identifier, which contains one or more characters followed by an asterisk (*). Any tape file that has a file identifier with the same prefix as the generic file identifier is dumped.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#DMPTAP.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="DMPTAP.TYPE"></a>
<h3>Data file information to dump (TYPE)</h3>
<p>Specifies the type of information being dumped. The dump output may consist of the data file header labels or trailer labels, data blocks from the data portion of the file, or all three types of information. If a tape volume that is placed in the device is not labeled, only the values *BASIC, *ALL, *HEX, or *DTABLK can be specified for this parameter; otherwise, an error message is sent to the user of the command and the volume is not dumped.
</p>
<p><b>Single values</b>
</p>
<dl>
<dt><b><u>*BASIC</u></b></dt>
<dd>For a standard-labeled volume, the information dumped includes header labels and the data blocks specified by the <b>Data blocks to dump (DTABLK)</b> parameter. For a volume that is not labeled, only the data blocks are dumped.
</dd>
<dt><b>*ALL</b></dt>
<dd>For a standard-labeled volume, the dump includes header labels, trailer labels, and data blocks. For a volume that is not labeled, a value of *ALL dumps only data blocks.
</dd>
<dt><b>*NONE</b></dt>
<dd>No data file is dumped. If *NONE is specified, the tape volume being dumped must be labeled, and *YES must be specified for the <b>Dump volume label (VOLLBL)</b> parameter; otherwise, an error message is sent to the user of the Dump Tape (DMPTAP) command.
</dd>
<dt><b>*HEX</b></dt>
<dd>For a standard-labeled volume, the data is dumped as if the volume is a non-labeled tape. The header labels, data blocks, and trailer labels for a standard labeled file will appear to be three separate non-labeled tape files. For a non-labeled volume, the data is dumped the same as if *DTABLK is specified.
</dd>
</dl>
<p><b>Other values (up to 3 repetitions)</b>
</p>
<dl>
<dt><b>*HDRLBL</b></dt>
<dd>The data file header labels are dumped. All header labels for the specified data files are dumped, including user-specified header labels. *HDRLBL is not valid for volumes that are not labeled.
</dd>
<dt><b>*DTABLK</b></dt>
<dd>One or more data blocks from the file data are dumped. The blocks in the data file that are dumped are specified by the <b>Data blocks to dump (DTABLK)</b> parameter.
</dd>
<dt><b>*TLRLBL</b></dt>
<dd>All data file trailer labels are dumped. All the trailer labels for the specified data files are dumped, including user-specified trailer labels. *TLRLBL is not valid for volumes that are not labeled.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#DMPTAP.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="DMPTAP.DTABLK"></a>
<h3>Data blocks to dump (DTABLK)</h3>
<p>Specifies which data blocks are dumped. This parameter is used to limit the amount of tape file data dumped to the printer. If neither *BASIC nor *ALL is specified for the <b>Data file information to dump (TYPE)</b> parameter, and the TYPE parameter also does not include *DTABLK, this parameter is ignored.
</p>
<p><b>Single values</b>
</p>
<dl>
<dt><b>*ALL</b></dt>
<dd>All data blocks in the specified data files on this volume are dumped. If a data file is continued from another volume or continues to another volume, only the part of the data file that is stored on this volume is dumped.
</dd>
<dt><b>*LAST</b></dt>
<dd>Only the last data block in the data file is dumped.
</dd>
</dl>
<p><b>Element 1: Starting data block number</b>
</p>
<dl>
<dt><b><u>*FIRST</u></b></dt>
<dd>The data blocks being dumped start with the first block in the data file.
</dd>
<dt><b><i>1-2147483647</i></b></dt>
<dd>Specify the number of the first data block in each file that is dumped. If this number is greater than the number specified for the ending data block element, an error message is sent to the user who requested the dump, and the tape is not dumped. If the starting data block number is larger than the actual number of data blocks in the data file, then the last data block in the file is dumped (with no error messages).
</dd>
</dl>
<p><b>Element 2: Ending data block number</b>
</p>
<dl>
<dt><b><u>*ONLY</u></b></dt>
<dd>Only the data block specified as the starting data block is dumped.
</dd>
<dt><b>*LAST</b></dt>
<dd>The range of data blocks that are dumped starts with the data block specified by the starting data block value and goes to the last block in the file.
</dd>
<dt><b><i>1-2147483647</i></b></dt>
<dd>Specify the number of the last data block in each file to dump. If this number is less than the number specified for the starting data block, an error message is sent to the user who requested the dump, and the tape is not dumped. If the ending data block number is larger than the actual number of data blocks in the data file, all blocks from the starting data block to the end of the file are dumped (with no error messages).
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#DMPTAP.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="DMPTAP.VOLLBL"></a>
<h3>Dump volume label (VOLLBL)</h3>
<p>Specifies whether volume labels are dumped. This parameter is ignored for volumes that are not labeled or when *HEX is specified for the <b>Data file information to dump (TYPE)</b> parameter for a standard labeled tape.
</p>
<dl>
<dt><b><u>*YES</u></b></dt>
<dd>All volume labels (including user-specified labels) are dumped.
</dd>
<dt><b>*NO</b></dt>
<dd>No volume labels are dumped; the volume listing does, however, include the volume identifier of a labeled volume and other basic information for any dumped tape.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#DMPTAP.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="DMPTAP.CODE"></a>
<h3>Code (CODE)</h3>
<p>Specifies the type of character code used for the data recorded on the tape. For a labeled volume, this parameter is ignored because the tape labels determine whether the data is recorded in EBCDIC or ASCII character code.
</p>
<dl>
<dt><b><u>*EBCDIC</u></b></dt>
<dd>The tape contains data in the EBCDIC character code. The dump output contains the hexadecimal value and the EBCDIC character equivalent of each data byte.
</dd>
</dl>
<dl>
<dt><b>*ASCII</b></dt>
<dd>The ASCII character code is used.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#DMPTAP.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="DMPTAP.ENDOPT"></a>
<h3>End of tape option (ENDOPT)</h3>
<p>Specifies whether the tape is rewound only or rewound and unloaded after the operation ends.
</p>
<dl>
<dt><b><u>*REWIND</u></b></dt>
<dd>The tape is automatically rewound, but not unloaded, after the operation has ended.
</dd>
</dl>
<dl>
<dt><b>*LEAVE</b></dt>
<dd>The tape does not rewind or unload after the operation ends. It remains at the current position on the tape drive.
</dd>
</dl>
<dl>
<dt><b>*UNLOAD</b></dt>
<dd>The tape is automatically rewound and unloaded after the operation ends.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#DMPTAP.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="DMPTAP.COMMAND.EXAMPLES">Examples</a> </h3>
<p>
<pre>
DMPTAP DEV(QTAPE2) SEQNBR(5) TYPE(*DTABLK) DTABLK(3 7)
</pre>
</p>
<p>This command dumps information from the tape volume that is on device QTAPE2. Data blocks 3 through 7 within the data file specified by sequence number 5 are dumped to a printer file.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#DMPTAP.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="DMPTAP.ERROR.MESSAGES">Error messages</a> </h3>
<p><b><u>*ESCAPE Messages</u></b>
</p>
<dl>
<dt><b>CPF222E</b></dt>
<dd>&amp;1 special authority is required.
</dd>
<dt><b>CPF6708</b></dt>
<dd>Command ended due to error.
</dd>
<dt><b>CPF6718</b></dt>
<dd>Cannot allocate device &amp;1.
</dd>
<dt><b>CPF6720</b></dt>
<dd>Incorrect volume &amp;2 found on device &amp;1.
</dd>
<dt><b>CPF6721</b></dt>
<dd>Device &amp;1 not a tape device.
</dd>
<dt><b>CPF6723</b></dt>
<dd>File not found on volume &amp;2 on device &amp;1.
</dd>
<dt><b>CPF6724</b></dt>
<dd>File label &amp;5 not found on volume &amp;2.
</dd>
<dt><b>CPF6725</b></dt>
<dd>Ending file sequence number less than starting sequence number.
</dd>
<dt><b>CPF6726</b></dt>
<dd>Ending data block less than starting block.
</dd>
<dt><b>CPF6727</b></dt>
<dd>Dump type not allowed for nonlabeled volume on device &amp;1.
</dd>
<dt><b>CPF6728</b></dt>
<dd>LABEL(*NONE) or CRTDATE(*NONE) required.
</dd>
<dt><b>CPF6729</b></dt>
<dd>No authority to file data on volume &amp;2 device &amp;1.
</dd>
<dt><b>CPF6730</b></dt>
<dd>Cannot access file sequence number &amp;5.
</dd>
<dt><b>CPF6731</b></dt>
<dd>File label &amp;5 not found on volume &amp;2.
</dd>
<dt><b>CPF6745</b></dt>
<dd>Device &amp;1 not a media library device.
</dd>
<dt><b>CPF6751</b></dt>
<dd>Load failure occurred on device &amp;4.
</dd>
<dt><b>CPF6760</b></dt>
<dd>Device &amp;1 not ready.
</dd>
<dt><b>CPF6772</b></dt>
<dd>Volume on device &amp;1 cannot be processed.
</dd>
<dt><b>CPF9814</b></dt>
<dd>Device &amp;1 not found.
</dd>
<dt><b>CPF9825</b></dt>
<dd>Not authorized to device &amp;1.
</dd>
<dt><b>CPF9845</b></dt>
<dd>Error occurred while opening file &amp;1.
</dd>
<dt><b>CPF9846</b></dt>
<dd>Error while processing file &amp;1 in library &amp;2.
</dd>
<dt><b>CPF9847</b></dt>
<dd>Error occurred while closing file &amp;1 in library &amp;2.
</dd>
<dt><b>CPF9850</b></dt>
<dd>Override of printer file &amp;1 not allowed.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#DMPTAP.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>