541 lines
15 KiB
HTML
541 lines
15 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>Change Job Media Library Attributes (QTACJMA) 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 -->
|
|
<!-- 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>Change Job Media Library Attributes (QTACJMA) API</h2>
|
|
|
|
<div class="box" style="width: 80%;">
|
|
Required Parameter Group:<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
<table width="100%">
|
|
<tr>
|
|
<td align="right" valign="top" width="10%">1</td>
|
|
<td align="left" valign="top" width="50%">Media library attributes
|
|
description</td>
|
|
<td align="left" valign="top" width="20%">Input</td>
|
|
<td align="left" valign="top" width="20%">Char(*)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="right" valign="top">2</td>
|
|
<td align="left" valign="top">Length of media library attributes
|
|
description</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Binary(4)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="right" 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="right" valign="top">4</td>
|
|
<td align="left" valign="top">Qualified job name</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(26)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="right" valign="top">5</td>
|
|
<td align="left" valign="top">Internal job identifier</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(16)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="right" 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>
|
|
Default Public Authority: *USE<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
Threadsafe: Yes<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
</div>
|
|
<p>The Change Job Media Library Attributes (QTACJMA) API changes the specified
|
|
job's settings for the media library attributes. For more information on tape
|
|
management, see <a href="../rzam4/rzam4tape.htm">Tape</a> information in the
|
|
Storage Solutions topic.</p>
|
|
|
|
<br>
|
|
|
|
<h3>Authorities and Locks</h3>
|
|
|
|
|
|
<dl><dt><em><img src="delta.gif" alt="Start of change">Device Description Authority</em></dt>
|
|
|
|
<dd>*CHANGE<img src="deltaend.gif" alt="End of change"></dd>
|
|
|
|
<dt><em>Job Authority</em></dt>
|
|
|
|
<dd>*JOBCTL, if the job for which information is changed has a different user
|
|
profile from that of the job that calls the QTACJMA API. *JOBCTL special
|
|
authority is required when changing or replacing the resource allocation
|
|
priority.</dd>
|
|
</dl>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Required Parameter Group</h3>
|
|
|
|
<dl>
|
|
<dt><strong>Media library attributes description</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(*)
|
|
|
|
<p>The media library attributes. Either the entire list of attributes will be
|
|
replaced or only specified entries will be changed by this specification.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Length of media library attributes description</strong></dt>
|
|
|
|
<dd>INPUT; BINARY(4)
|
|
|
|
<p>The length of the media library attributes description, in bytes.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Format name</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(8)
|
|
|
|
<p>The format name CJMA0100 is the only valid format name used by this API. For
|
|
more information, see <a href="#HDRCJMA1">CJMA0100 Format</a>.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Qualified job name</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(26)
|
|
|
|
<p>The name of the job for which information is to be changed. The qualified
|
|
job name has three parts:</p>
|
|
|
|
<dl>
|
|
|
|
<dt><em>Job name</em></dt>
|
|
<dd>CHAR(10). A specific job name or the following
|
|
special value:
|
|
<br><br>
|
|
<dl>
|
|
<dt><em>*</em></dt>
|
|
<dd>The job that this program is running in. The rest
|
|
of the qualified job name parameter must be blank.<br><br></dd>
|
|
|
|
<dt><em>*INT</em></dt>
|
|
<dd>The internal job identifier locates the job. The
|
|
user name and job number must be blank.<br><br></dd>
|
|
</dl>
|
|
</dd>
|
|
|
|
<dt><em>User name</em></dt>
|
|
<dd>CHAR(10). A specific user profile name, or blanks
|
|
when the job name is a special value or *INT.<br><br></dd>
|
|
|
|
<dt><em>Job number</em></dt>
|
|
<dd>CHAR(6). A specific job number, or blanks when
|
|
the job name specified is a special value or *INT.<br><br></dd>
|
|
</dl>
|
|
|
|
</dd>
|
|
|
|
<dt><strong>Internal job identifier</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(16)
|
|
|
|
<p>The internal identifier for the job. The List Job (QUSLJOB) API creates this
|
|
identifier. If you do not specify *INT for the job name parameter, this
|
|
parameter must contain blanks. With this parameter, the system can locate the
|
|
job more quickly than with a job name.</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="HDRCJMA1">CJMA0100 Format</a></h3>
|
|
|
|
<p>The following table lists the fields for the media library attributes
|
|
description in the CJMA0100 format. For more information about each field, see
|
|
<a href="#HDRCJMAFD">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%">Option</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">10</td>
|
|
<td align="center" valign="top">A</td>
|
|
<td align="left" valign="top">CHAR(2)</td>
|
|
<td align="left" valign="top">Reserved</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 device entries</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top" colspan="2" rowspan="6">Offsets vary. These
|
|
fields repeat in the order listed, for each media library device that is to
|
|
have attributes defined.</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">Media library device</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CHAR(6)</td>
|
|
<td align="left" valign="top">Reserved</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Resource allocation priority</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Wait time for initial amount</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Wait time for end of volume mount</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CHAR(4)</td>
|
|
<td align="left" valign="top">Reserved</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
|
|
<h3><a name="HDRCJMAFD">Field Descriptions</a></h3>
|
|
|
|
<p><strong>Media library device.</strong> The name of the media library device
|
|
that the attributes apply to. The special values supported are:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*ALL</em></td>
|
|
<td align="left" valign="top">The attributes apply to all media libraries. The
|
|
value *ALL is only allowed when changing the attributes and must be the first
|
|
and only device entry.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*DEFAULT</em></td>
|
|
<td align="left" valign="top">The attributes apply to all media libraries that do not have
|
|
specific attributes defined for the specified job. The *DEFAULT device is only
|
|
allowed when replacing the attribute list and must be specified as the first
|
|
device entry.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Number of device entries.</strong> The number of entries in the
|
|
device list changed for this format. There must be at least one entry defined.
|
|
The maximum number of device entries allowed is 1000.</p>
|
|
|
|
<p><strong>Option.</strong> An option specifying the action to take. Special
|
|
values are:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*CHANGE</em></td>
|
|
<td align="left" valign="top">The media library attributes are changed by using
|
|
the device entries specified in the media library attributes description. If an
|
|
entry already exists for a specified device, that entry will be replaced. If no
|
|
entry exists for a specified device, an entry will be created.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*REPLACE</em></td>
|
|
<td align="left" valign="top">The entire list of media library attributes are replaced by
|
|
the device entries specified in the media library attributes description. The
|
|
first entry must be for the *DEFAULT device.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Reserved.</strong> This field must be set to hexadecimal zeros.</p>
|
|
|
|
<p><strong>Resource allocation priority.</strong> The priority the specified
|
|
job will be given when the job requests a tape resource within a media library
|
|
device.</p>
|
|
|
|
<p>Valid values range from 1 (highest) through 99 (lowest).</p>
|
|
|
|
<p><em>Exceptions:</em></p>
|
|
|
|
<ul>
|
|
<li>Value of -1 implies *SAME. The resource allocation priority will remain the
|
|
same. This value is only allowed for the *CHANGE option.</li>
|
|
|
|
<li>Value of -2 implies *DEV. The priority specified in the device description
|
|
will be used when the job requests a tape resource.</li>
|
|
|
|
<li>Value of -31 implies *JOB. The specified job's run-time priority will be
|
|
used for the resource allocation priority when the job requests a tape
|
|
resource.</li>
|
|
</ul>
|
|
|
|
<p><strong>Wait time for end of volume mount.</strong> The maximum amount of
|
|
time, in minutes, a request will wait for the allocation of a tape resource to
|
|
mount the next volume after the end of volume is reached. Valid values range
|
|
from 1 through 600.</p>
|
|
|
|
<p><em>Exceptions:</em></p>
|
|
|
|
<ul>
|
|
<li>Value of -1 implies *SAME. The wait time for the end of volume mount will
|
|
remain the same. This value is only allowed for the *CHANGE option.</li>
|
|
|
|
<li>Value of -2 implies *DEV. The end of volume mount wait time specified in
|
|
the device description will be used.</li>
|
|
|
|
<li>Value of -8 implies *NOMAX. The specified job will wait until a resource
|
|
becomes available.</li>
|
|
|
|
<li>Value of -31 implies *JOB. The specified job's default wait time will be
|
|
used to calculate the wait time. The time is calculated by rounding the default
|
|
wait time, in seconds, to the next highest minute.</li>
|
|
|
|
<li>Value of -32 implies *IMMED. The specified job will not wait for a resource
|
|
to become available.</li>
|
|
</ul>
|
|
|
|
<p><strong>Wait time for initial mount.</strong> The maximum amount of time, in
|
|
minutes, a request will wait for the allocation of a tape resource to mount the
|
|
first volume. Valid values range from 1 through 600.</p>
|
|
|
|
<p><em>Exceptions:</em></p>
|
|
|
|
<ul>
|
|
<li>Value of -1 implies *SAME. The wait time for the initial mount will remain
|
|
the same. This value is only allowed for the *CHANGE option.</li>
|
|
|
|
<li>Value of -2 implies *DEV. The initial mount wait time specified in the
|
|
device description will be used.</li>
|
|
|
|
<li>Value of -8 implies *NOMAX. The specified job will wait until a resource
|
|
becomes available.</li>
|
|
|
|
<li>Value of -31 implies *JOB. The specified job's default wait time will be
|
|
used to calculate the wait time. The time is calculated by rounding the default
|
|
wait time, in seconds, to the next highest minute.</li>
|
|
|
|
<li>Value of -32 implies *IMMED. The specified job will not wait for a resource
|
|
to become available.</li>
|
|
</ul>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Error Messages</h3>
|
|
|
|
<table width="100%" cellpadding="5">
|
|
|
|
<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">CPF1343 E</td>
|
|
<td width="85%" valign="top">Job &3/&2/&1 not valid job type for
|
|
function.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPF136A E</td>
|
|
<td valign="top">Job &3/&2/&1 not active.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPF24B4 E</td>
|
|
<td valign="top">Severe error while addressing parameter list.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPF3C1D E</td>
|
|
<td valign="top">Length specified in parameter &1 not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPF3C21 E</td>
|
|
<td valign="top">Format name &1 is not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPF3C39 E</td>
|
|
<td valign="top">Value for reserved field not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPF3C51 E</td>
|
|
<td valign="top">Internal job identifier not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPF3C52 E</td>
|
|
<td valign="top">Internal job identifier no longer valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPF3C53 E</td>
|
|
<td valign="top">Job &3/&2/&1 not found.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPF3C54 E</td>
|
|
<td valign="top">Job &3/&2/&1 currently not available.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPF3C55 E</td>
|
|
<td valign="top">Job &3/&2/&1 does not exist.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPF3C58 E</td>
|
|
<td valign="top">Job name specified is not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPF3C59 E</td>
|
|
<td valign="top">Internal identifier is not blanks and job name is not
|
|
*INT.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPF3C90 E</td>
|
|
<td valign="top">Literal value cannot be changed.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPF3CF1 E</td>
|
|
<td valign="top">Error code parameter not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPF6708 E</td>
|
|
<td valign="top">Command ended due to error.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPF67B1 E</td>
|
|
<td valign="top">Option value &1 not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPF67B2 E</td>
|
|
<td valign="top">Number of devices entries &1 not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPF67B3 E</td>
|
|
<td valign="top">Media library device &1 not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPF67B4 E</td>
|
|
<td valign="top">Value &1 in field &2 not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPF67B5 E</td>
|
|
<td valign="top">&3/&2/&1 not authorized to change attribute.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPF67B6 E</td>
|
|
<td valign="top">&3/&2/&1 not authorized to do requested
|
|
operation.</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: V4R3
|
|
|
|
<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>
|
|
|