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

765 lines
21 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 Backup Schedule (QEZRTBKS) 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. -->
<!-- Change History: -->
<!-- YYMMDD USERID Change description -->
<!-- BACKMST SCRIPT A converted by B2H R4.1 (346) (CMS) by v2kea304 at -->
<!-- RCHVMW2 on 26 April 1999 at 10:21:58 -->
<!-- File cleanup completed Jan 2002 by v2cdijab -->
<!-- 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 Backup Schedule (QEZRTBKS) 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">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 Backup Schedule (QEZRTBKS) API returns in a receiver variable
information about when the Operational Assistant backups are scheduled to be
run.</p>
<br>
<h3>Authorities and Locks</h3>
<dl>
<dt><em>User Index Authority</em></dt>
<dd>*USE</dd>
<dt><em>Job Schedule Entry Authority</em></dt>
<dd>*USE</dd>
<dt><em>User Index Lock</em></dt>
<dd>*SHRRD</dd>
<dt><em>Job Schedule Lock</em></dt>
<dd>*SHRRD</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 name of the format in which to return the backup schedule. The following
format name may be used:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>RBKS0100</em></td>
<td align="left" valign="top">Basic schedule information. For more information,
see <a href="#HDRRBKS1">RBKS0100 Format</a>.</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>.</p>
</dd>
</dl>
<br>
<h3><a name="HDRRBKS1">RBKS0100 Format</a></h3>
<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">Hours before backup to send tape message</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">Occurrence in month to run backup</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">Run backup using this schedule</td>
</tr>
<tr>
<td align="center" valign="top">17</td>
<td align="center" valign="top">11</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Sunday backup</td>
</tr>
<tr>
<td align="center" valign="top">18</td>
<td align="center" valign="top">12</td>
<td align="left" valign="top">CHAR(6)</td>
<td align="left" valign="top">Sunday backup time</td>
</tr>
<tr>
<td align="center" valign="top">24</td>
<td align="center" valign="top">18</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Monday backup</td>
</tr>
<tr>
<td align="center" valign="top">25</td>
<td align="center" valign="top">19</td>
<td align="left" valign="top">CHAR(6)</td>
<td align="left" valign="top">Monday backup time</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">Tuesday backup</td>
</tr>
<tr>
<td align="center" valign="top">32</td>
<td align="center" valign="top">20</td>
<td align="left" valign="top">CHAR(6)</td>
<td align="left" valign="top">Tuesday backup time</td>
</tr>
<tr>
<td align="center" valign="top">38</td>
<td align="center" valign="top">26</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Wednesday backup</td>
</tr>
<tr>
<td align="center" valign="top">39</td>
<td align="center" valign="top">27</td>
<td align="left" valign="top">CHAR(6)</td>
<td align="left" valign="top">Wednesday backup time</td>
</tr>
<tr>
<td align="center" valign="top">45</td>
<td align="center" valign="top">2D</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Thursday backup</td>
</tr>
<tr>
<td align="center" valign="top">46</td>
<td align="center" valign="top">2E</td>
<td align="left" valign="top">CHAR(6)</td>
<td align="left" valign="top">Thursday backup time</td>
</tr>
<tr>
<td align="center" valign="top">52</td>
<td align="center" valign="top">34</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Friday backup</td>
</tr>
<tr>
<td align="center" valign="top">53</td>
<td align="center" valign="top">35</td>
<td align="left" valign="top">CHAR(6)</td>
<td align="left" valign="top">Friday backup time</td>
</tr>
<tr>
<td align="center" valign="top">59</td>
<td align="center" valign="top">3B</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Saturday backup</td>
</tr>
<tr>
<td align="center" valign="top">60</td>
<td align="center" valign="top">3C</td>
<td align="left" valign="top">CHAR(6)</td>
<td align="left" valign="top">Saturday backup time</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRRTBKS">Field Descriptions</a></h3>
<p>Some of the fields use a time format (HHMMSS), where:</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>HH</em></td>
<td align="left" valign="top">Hour</td>
</tr>
<tr>
<td align="left" valign="top"><em>MM</em></td>
<td align="left" valign="top">Minute</td>
</tr>
<tr>
<td align="left" valign="top"><em>SS</em></td>
<td align="left" valign="top">Second</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>Friday backup.</strong> The type of backup that is run on Friday.
Possible values follow:</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>blank</em></td>
<td align="left" valign="top">No backup is scheduled for this day of the
week.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">A daily backup is run on this day.</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">A weekly backup is run on this day.</td>
</tr>
<tr>
<td align="left" valign="top"><em>3</em></td>
<td align="left" valign="top">A monthly backup is run on this day.</td>
</tr>
<tr>
<td align="left" valign="top"><em>4</em></td>
<td align="left" valign="top">A *WEEKMONTH backup is run on this day. A weekly
backup is run on this day of the week every week except on the week that a
monthly backup is run. In that case, the monthly backup is run.</td>
</tr>
</table>
<p><strong>Friday backup time.</strong> Using the 24-hour clock, the time that
the backup takes place (in format HHMMSS).</p>
<p><strong>Hours before backup to send tape message.</strong> If you choose,
you may have the system send a reminder to the system operator to load the tape
before a backup starts. Specify the number of hours before the backup that you
would like this message to be sent. 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">No message is sent to the system operator before
the backup.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1-24</em></td>
<td align="left" valign="top">The number of hours prior to backup to send the
message.</td>
</tr>
</table>
<p><strong>Monday backup.</strong> The type of backup that is run on Monday.
Possible values follow:</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>blank</em></td>
<td align="left" valign="top">No backup is scheduled for this day of the
week.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">A daily backup is run on this day.</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">A weekly backup is run on this day.</td>
</tr>
<tr>
<td align="left" valign="top"><em>3</em></td>
<td align="left" valign="top">A monthly backup is run on this day.</td>
</tr>
<tr>
<td align="left" valign="top"><em>4</em></td>
<td align="left" valign="top">A *WEEKMONTH backup is run on this day. A weekly
backup is run on this day of the week every week except on the week that a
monthly backup is run. In that case, the monthly backup is run.</td>
</tr>
</table>
<p><strong>Monday backup time.</strong> Using the 24-hour clock, the time that
the backup takes place (in format HHMMSS).</p>
<p><strong>Occurrence in month to run backup.</strong> The week of the month
that you want the backup to occur when the backup type is either *MONTHLY or
*WEEKMONTH. 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">No monthly backup is scheduled to run.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1-4</em></td>
<td align="left" valign="top">A value 1 through 4 corresponds to the week of
the month that the monthly backup is run.</td>
</tr>
<tr>
<td align="left" valign="top"><em>5</em></td>
<td align="left" valign="top">The monthly backup is run on the last week of the
month.</td>
</tr>
</table>
<p><strong>Run backup using this schedule.</strong> Whether you want to use the
backup schedule. 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">A schedule has been created, but it is not being
used at this time.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Backups are run according to the schedule.</td>
</tr>
</table>
<p><strong>Saturday backup.</strong> The type of backup that is to run on
Saturday. Possible values follow:</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>blank</em></td>
<td align="left" valign="top">No backup is scheduled for this day of the
week.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">A daily backup is run on this day.</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">A weekly backup is run on this day.</td>
</tr>
<tr>
<td align="left" valign="top"><em>3</em></td>
<td align="left" valign="top">A monthly backup is run on this day.</td>
</tr>
<tr>
<td align="left" valign="top"><em>4</em></td>
<td align="left" valign="top">A *WEEKMONTH backup is run on this day. A weekly
backup is run on this day of the week every week except on the week that a
monthly backup is run. In that case, the monthly backup is run.</td>
</tr>
</table>
<p><strong>Saturday backup time.</strong> Using the 24-hour clock, the time
that the backup takes place (in HHMMSS).</p>
<p><strong>Sunday backup.</strong> The type of backup that is to be run on
Sunday. Possible values follow:</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>blank</em></td>
<td align="left" valign="top">No backup is scheduled for this day of the
week.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">A daily backup is run on this day.</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">A weekly backup is run on this day.</td>
</tr>
<tr>
<td align="left" valign="top"><em>3</em></td>
<td align="left" valign="top">A monthly backup is run on this day.</td>
</tr>
<tr>
<td align="left" valign="top"><em>4</em></td>
<td align="left" valign="top">A *WEEKMONTH backup is run on this day. A weekly
backup is run on this day of the week every week except on the week that a
monthly backup is run. In that case, the monthly backup is run.</td>
</tr>
</table>
<p><strong>Sunday backup time.</strong> Using the 24-hour clock, the time that
the backup takes place (in format HHMMSS).</p>
<p><strong>Thursday backup.</strong> The type of backup that is run on
Thursday. Possible values follow:</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>blank</em></td>
<td align="left" valign="top">No backup is scheduled for this day of the
week.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">A daily backup is run on this day.</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">A weekly backup is run on this day.</td>
</tr>
<tr>
<td align="left" valign="top"><em>3</em></td>
<td align="left" valign="top">A monthly backup is run on this day.</td>
</tr>
<tr>
<td align="left" valign="top"><em>4</em></td>
<td align="left" valign="top">A *WEEKMONTH backup is run on this day. A weekly
backup is run on this day of the week every week except on the week that a
monthly backup is run. In that case, the monthly backup is run.</td>
</tr>
</table>
<p><strong>Thursday backup time.</strong> Using the 24-hour clock, the time
that the backup takes place (in format HHMMSS).</p>
<p><strong>Tuesday backup.</strong> The type of backup that is run on Tuesday.
Possible values follow:</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>blank</em></td>
<td align="left" valign="top">No backup is scheduled for this day of the
week.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">A daily backup is run on this day.</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">A weekly backup is run on this day.</td>
</tr>
<tr>
<td align="left" valign="top"><em>3</em></td>
<td align="left" valign="top">A monthly backup is run on this day.</td>
</tr>
<tr>
<td align="left" valign="top"><em>4</em></td>
<td align="left" valign="top">A *WEEKMONTH backup is run on this day. A weekly
backup is run on this day of the week every week except on the week that a
monthly backup is run. In that case, the monthly backup is run.</td>
</tr>
</table>
<p><strong>Tuesday backup time.</strong> Using the 24-hour clock, the time that
the backup takes place (in format HHMMSS).</p>
<p><strong>Wednesday backup.</strong> The type of backup that is run on
Wednesday. Possible values follow:</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>blank</em></td>
<td align="left" valign="top">No backup is scheduled for this day of the
week.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">A daily backup is run on this day.</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">A weekly backup is run on this day.</td>
</tr>
<tr>
<td align="left" valign="top"><em>3</em></td>
<td align="left" valign="top">A monthly backup is run on this day.</td>
</tr>
<tr>
<td align="left" valign="top"><em>4</em></td>
<td align="left" valign="top">A *WEEKMONTH backup is run on this day. A weekly
backup is run on this day of the week every week except on the week that a
monthly backup is run. In that case, the monthly backup is run.</td>
</tr>
</table>
<p><strong>Wednesday backup time.</strong> Using the 24-hour clock, the time
that the backup takes place (in format HHMMSS).</p>
<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 align="left" valign="top" width="15%">CPF1629 E</td>
<td align="left" valign="top" width="85%">Not authorized to job schedule
&amp;1.</td>
</tr>
<tr>
<td align="left" valign="top">CPF1632 E</td>
<td align="left" valign="top">Job schedule entry &amp;3 number &amp;4
damaged.</td>
</tr>
<tr>
<td align="left" valign="top">CPF1637 E</td>
<td align="left" valign="top">Job schedule &amp;1 in library &amp;2 in
use.</td>
</tr>
<tr>
<td align="left" valign="top">CPF1640 E</td>
<td align="left" valign="top">Job schedule &amp;1 in library &amp;2 does not
exist.</td>
</tr>
<tr>
<td align="left" valign="top">CPF1641 E</td>
<td align="left" valign="top">Job schedule &amp;1 in library &amp;2
damaged.</td>
</tr>
<tr>
<td align="left" valign="top">CPF24B4 E</td>
<td align="left" valign="top">Severe error while addressing parameter
list.</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">CPF3C21 E</td>
<td align="left" valign="top">Format name &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">CPF812C E</td>
<td align="left" valign="top">Job schedule &amp;4 in &amp;9 damaged.</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">CPF9803 E</td>
<td align="left" valign="top">Cannot allocate object &amp;2 in library
&amp;3.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9820 E</td>
<td align="left" valign="top">Not authorized to use library &amp;1.</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: V3R7
<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>
Reference in New Issue Copy Permalink