249 lines
6.6 KiB
HTML
249 lines
6.6 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>Exit Program for Tailoring Operational Assistant Backup</title>
|
|
<!-- 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. -->
|
|
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
|
|
</head>
|
|
<body>
|
|
<a name="Top_Of_Page"></a>
|
|
<!-- Java sync-link -->
|
|
<script language="Javascript" src="../rzahg/synch.js" type="text/javascript">
|
|
</script>
|
|
|
|
<h2>Exit Program for Tailoring Operational Assistant Backup</h2>
|
|
|
|
<div class="box" style="width: 70%;">
|
|
<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%">Calling product</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">2</td>
|
|
<td align="left" valign="top">Exit indicator</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(10)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">3</td>
|
|
<td align="left" valign="top">Options</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">Device</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(40)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">5</td>
|
|
<td align="left" valign="top">Tape set</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(4)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">6</td>
|
|
<td align="left" valign="top">Return code</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(7)</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</div>
|
|
|
|
<p>You can tailor the Operational Assistant automatic backup by specifying an
|
|
exit program on the Change Backup (CHGBCKUP) command. If an exit program is
|
|
specified, that program is called both before the Operational Assistant backup
|
|
is run and after backup is run. You specify within the exit program when you
|
|
want your functions to run.</p>
|
|
|
|
<p> If this program ends abnormally or sends an escape message to its caller
|
|
when running before the backup, the backup will not continue.</p>
|
|
|
|
<p> When running backup, you could write your own exit program to back up some
|
|
additional objects that are not included on the folder or library backup
|
|
list.</p>
|
|
|
|
<p> Another example of using an exit program could be when you want to clean up
|
|
some items before the system does its backup. This would save time and
|
|
resources by not backing up objects you want deleted.</p>
|
|
|
|
<p> Refer to <a href="../apiref/apiexusback.htm">Using the Operational Assistant
|
|
Exit Program for Operational Assistant Backup</a> in the API Examples for an
|
|
example exit program for backup.</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>
|
|
|
|
<!-- Use this if there are no authorities and locks. -->
|
|
<p>None.</p>
|
|
|
|
<br>
|
|
<h3>Required Parameter Group</h3>
|
|
|
|
<p>Parameters your exit program should be able to handle are:</p>
|
|
|
|
<dl>
|
|
<dt><strong>Calling product</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(10)
|
|
|
|
<p>The name of the product calling the exit program. This parameter is supplied
|
|
so that the exit program can tell whether it is called from the iSeries Run
|
|
Backup (RUNBCKUP) command or from another application. When called from the
|
|
RUNBCKUP command, the value is QEZBACKUP.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Exit indicator</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(10)
|
|
|
|
<p>Whether this program is called before or after the backup is done. The
|
|
possible values are:</p>
|
|
|
|
<table cellpadding="3">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*BEFORE</em></td>
|
|
<td align="left" valign="top">This call is before the backup has started.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*AFTER</em></td>
|
|
<td align="left" valign="top">This call is after the backup has run.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><strong>Options</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(10)
|
|
|
|
<p>Indicates that the specified backup options are used. The possible values
|
|
are:</p>
|
|
|
|
<table cellpadding="3">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*DAILY</em></td>
|
|
<td align="left" valign="top">The daily backup options are used.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*WEEKLY</em></td>
|
|
<td align="left" valign="top">The weekly backup options are used.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*MONTHLY</em></td>
|
|
<td align="left" valign="top">The monthly backup options are used.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><strong>Device</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(40)
|
|
|
|
<p>The name of up to four devices to be used for the backup. Each device is
|
|
left-justified on a 10-byte boundary.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Tape set</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(4)
|
|
|
|
<p>The name of the tape set to be used for the backup. Operational Assistant
|
|
backup combines the tape set name (1 to 4 characters) with volume numbers from
|
|
01 to 99 to generate the volume IDs of the tape volumes to be used by the
|
|
backup.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Return code</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(7)
|
|
|
|
<p>The message ID of the message returned by backup. This is blank before the
|
|
backup.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Error Messages</h3>
|
|
|
|
<table width="100%" cellpadding="3">
|
|
<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">CPC1E62 C</td>
|
|
<td width="85%" valign="top">Backup successfully completed.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPF1E68 E</td>
|
|
<td valign="top">Backup incomplete.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPF1EE7 E</td>
|
|
<td valign="top">Unexpected error occurred during backup.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPF1E99 E</td>
|
|
<td valign="top">Unexpected error occurred.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
|
|
<hr>
|
|
Exit program introduced: V2R2
|
|
|
|
<hr>
|
|
<center>
|
|
<table cellpadding="2" cellspacing="2">
|
|
<tr align="center">
|
|
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
|
|
"oa1.htm">Operational Assistant APIs</a> | <a href="aplist.htm">APIs by
|
|
category</a></td>
|
|
</tr>
|
|
</table>
|
|
</center>
|
|
</body>
|
|
</html>
|
|
|