323 lines
12 KiB
HTML
323 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">
|
||
|
|
<title>Retrieve Backup Options (RTVBCKUP)</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="RTVBCKUP.Top_Of_Page"></a>
|
||
|
|
<h2>Retrieve Backup Options (RTVBCKUP)</h2>
|
||
|
|
<table width="100%">
|
||
|
|
<tr>
|
||
|
|
<td valign="top" align="left"><b>Where allowed to run: </b>Compiled CL program or interpreted REXX (*BPGM *IPGM *BREXX *IREXX)<br>
|
||
|
|
<b>Threadsafe: </b>No
|
||
|
|
</td>
|
||
|
|
<td valign="top" align="right">
|
||
|
|
<a href="#RTVBCKUP.PARAMETERS.TABLE">Parameters</a><br>
|
||
|
|
<a href="#RTVBCKUP.COMMAND.EXAMPLES">Examples</a><br>
|
||
|
|
<a href="#RTVBCKUP.ERROR.MESSAGES">Error messages</a></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<div> <a name="RTVBCKUP"></a>
|
||
|
|
<p>The Retrieve Backup (RTVBCKUP) command is used in a CL program or REXX procedure allows the user to retrieve the options in one of the predefined backups into CL variables. More information on backup is in the Backup and Recovery book, SC41-5304.
|
||
|
|
</p>
|
||
|
|
</div>
|
||
|
|
<table width="100%">
|
||
|
|
<tr><td align="right"><a href="#RTVBCKUP.Top_Of_Page">Top</a></td></tr>
|
||
|
|
</table>
|
||
|
|
<hr size="2" width="100%">
|
||
|
|
|
||
|
|
<div>
|
||
|
|
<h3><a name="RTVBCKUP.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="#RTVBCKUP.BCKUPOPT"><b>BCKUPOPT</b></a></td>
|
||
|
|
<td valign="top">Backup options</td>
|
||
|
|
<td valign="top">*DAILY, *WEEKLY, *MONTHLY</td>
|
||
|
|
<td valign="top">Required, Positional 1</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td valign="top"><a href="#RTVBCKUP.DEV"><b>DEV</b></a></td>
|
||
|
|
<td valign="top">CL var for DEV (43)</td>
|
||
|
|
<td valign="top"><i>Character value</i></td>
|
||
|
|
<td valign="top">Optional</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td valign="top"><a href="#RTVBCKUP.TAPSET"><b>TAPSET</b></a></td>
|
||
|
|
<td valign="top">CL var for TAPSET (34)</td>
|
||
|
|
<td valign="top"><i>Character value</i></td>
|
||
|
|
<td valign="top">Optional</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td valign="top"><a href="#RTVBCKUP.CLRTAP"><b>CLRTAP</b></a></td>
|
||
|
|
<td valign="top">CL var for CLRTAP (4)</td>
|
||
|
|
<td valign="top"><i>Character value</i></td>
|
||
|
|
<td valign="top">Optional</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td valign="top"><a href="#RTVBCKUP.SBMJOB"><b>SBMJOB</b></a></td>
|
||
|
|
<td valign="top">CL var for SBMJOB (4)</td>
|
||
|
|
<td valign="top"><i>Character value</i></td>
|
||
|
|
<td valign="top">Optional</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td valign="top"><a href="#RTVBCKUP.CHGONLY"><b>CHGONLY</b></a></td>
|
||
|
|
<td valign="top">CL var for CHGONLY (4)</td>
|
||
|
|
<td valign="top"><i>Character value</i></td>
|
||
|
|
<td valign="top">Optional</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td valign="top"><a href="#RTVBCKUP.PRTRPT"><b>PRTRPT</b></a></td>
|
||
|
|
<td valign="top">CL var for PRTRPT (4)</td>
|
||
|
|
<td valign="top"><i>Character value</i></td>
|
||
|
|
<td valign="top">Optional</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td valign="top"><a href="#RTVBCKUP.LIB"><b>LIB</b></a></td>
|
||
|
|
<td valign="top">CL var for LIB (10)</td>
|
||
|
|
<td valign="top"><i>Character value</i></td>
|
||
|
|
<td valign="top">Optional</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td valign="top"><a href="#RTVBCKUP.FLR"><b>FLR</b></a></td>
|
||
|
|
<td valign="top">CL var for FLR (10)</td>
|
||
|
|
<td valign="top"><i>Character value</i></td>
|
||
|
|
<td valign="top">Optional</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td valign="top"><a href="#RTVBCKUP.DIR"><b>DIR</b></a></td>
|
||
|
|
<td valign="top">CL var for DIR (10)</td>
|
||
|
|
<td valign="top"><i>Character value</i></td>
|
||
|
|
<td valign="top">Optional</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td valign="top"><a href="#RTVBCKUP.SECDTA"><b>SECDTA</b></a></td>
|
||
|
|
<td valign="top">CL var for SECDTA (4)</td>
|
||
|
|
<td valign="top"><i>Character value</i></td>
|
||
|
|
<td valign="top">Optional</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td valign="top"><a href="#RTVBCKUP.CFG"><b>CFG</b></a></td>
|
||
|
|
<td valign="top">CL var for CFG (4)</td>
|
||
|
|
<td valign="top"><i>Character value</i></td>
|
||
|
|
<td valign="top">Optional</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td valign="top"><a href="#RTVBCKUP.MAIL"><b>MAIL</b></a></td>
|
||
|
|
<td valign="top">CL var for MAIL (4)</td>
|
||
|
|
<td valign="top"><i>Character value</i></td>
|
||
|
|
<td valign="top">Optional</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td valign="top"><a href="#RTVBCKUP.CAL"><b>CAL</b></a></td>
|
||
|
|
<td valign="top">CL var for CAL (4)</td>
|
||
|
|
<td valign="top"><i>Character value</i></td>
|
||
|
|
<td valign="top">Optional</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td valign="top"><a href="#RTVBCKUP.EXITPGM"><b>EXITPGM</b></a></td>
|
||
|
|
<td valign="top">CL var for EXITPGM (10)</td>
|
||
|
|
<td valign="top"><i>Character value</i></td>
|
||
|
|
<td valign="top">Optional</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td valign="top"><a href="#RTVBCKUP.EXITPGMLIB"><b>EXITPGMLIB</b></a></td>
|
||
|
|
<td valign="top">CL var for EXITPGMLIB (10)</td>
|
||
|
|
<td valign="top"><i>Character value</i></td>
|
||
|
|
<td valign="top">Optional</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<table width="100%">
|
||
|
|
<tr><td align="right"><a href="#RTVBCKUP.Top_Of_Page">Top</a></td></tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div> <a name="RTVBCKUP.BCKUPOPT"></a>
|
||
|
|
<h3>Backup options (BCKUPOPT)</h3>
|
||
|
|
<p>Specifies the backup options to be retrieved.
|
||
|
|
</p>
|
||
|
|
<p>This is a required parameter.
|
||
|
|
</p>
|
||
|
|
<dl>
|
||
|
|
<dt><b>*DAILY</b></dt>
|
||
|
|
<dd>The daily backup options are retrieved.
|
||
|
|
</dd>
|
||
|
|
<dt><b>*WEEKLY</b></dt>
|
||
|
|
<dd>The weekly backup options are retrieved.
|
||
|
|
</dd>
|
||
|
|
<dt><b>*MONTHLY</b></dt>
|
||
|
|
<dd>The monthly backup options are retrieved.
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
<table width="100%">
|
||
|
|
<tr><td align="right"><a href="#RTVBCKUP.Top_Of_Page">Top</a></td></tr>
|
||
|
|
</table>
|
||
|
|
<div> <a name="RTVBCKUP.DEV"></a>
|
||
|
|
<h3>CL var for DEV (43) (DEV)</h3>
|
||
|
|
<p>Specifies the name of the CL variable that receives the device value. The variable has a minimum length of 43 characters. The value returned is a character string of four 10-character device names, separated by blanks.
|
||
|
|
</p>
|
||
|
|
</div>
|
||
|
|
<table width="100%">
|
||
|
|
<tr><td align="right"><a href="#RTVBCKUP.Top_Of_Page">Top</a></td></tr>
|
||
|
|
</table>
|
||
|
|
<div> <a name="RTVBCKUP.TAPSET"></a>
|
||
|
|
<h3>CL var for TAPSET (34) (TAPSET)</h3>
|
||
|
|
<p>Specifies the name of the CL variable that receives the tape set names. The variable has a minimum length of 34 characters (seven 4-character tape set names, separated by blanks).
|
||
|
|
</p>
|
||
|
|
</div>
|
||
|
|
<table width="100%">
|
||
|
|
<tr><td align="right"><a href="#RTVBCKUP.Top_Of_Page">Top</a></td></tr>
|
||
|
|
</table>
|
||
|
|
<div> <a name="RTVBCKUP.CLRTAP"></a>
|
||
|
|
<h3>CL var for CLRTAP (4) (CLRTAP)</h3>
|
||
|
|
<p>Specifies the name of the CL variable that receives the indicator for clearing the tape for backup. The variable must have a minimum length of 4 characters. The value returned is either *YES or *NO.
|
||
|
|
</p>
|
||
|
|
</div>
|
||
|
|
<table width="100%">
|
||
|
|
<tr><td align="right"><a href="#RTVBCKUP.Top_Of_Page">Top</a></td></tr>
|
||
|
|
</table>
|
||
|
|
<div> <a name="RTVBCKUP.SBMJOB"></a>
|
||
|
|
<h3>CL var for SBMJOB (4) (SBMJOB)</h3>
|
||
|
|
<p>Specifies the name of the CL variable that receives the indicator of whether the backup is run as a batch job. The variable must have a minimum length of 4 characters. The value returned is either *YES or *NO.
|
||
|
|
</p>
|
||
|
|
</div>
|
||
|
|
<table width="100%">
|
||
|
|
<tr><td align="right"><a href="#RTVBCKUP.Top_Of_Page">Top</a></td></tr>
|
||
|
|
</table>
|
||
|
|
<div> <a name="RTVBCKUP.CHGONLY"></a>
|
||
|
|
<h3>CL var for CHGONLY (4) (CHGONLY)</h3>
|
||
|
|
<p>Specifies the name of the CL variable that receives the indicator for saving changed objects only. The variable must have a minimum length of 4 characters. The value returned is either *YES or *NO.
|
||
|
|
</p>
|
||
|
|
</div>
|
||
|
|
<table width="100%">
|
||
|
|
<tr><td align="right"><a href="#RTVBCKUP.Top_Of_Page">Top</a></td></tr>
|
||
|
|
</table>
|
||
|
|
<div> <a name="RTVBCKUP.PRTRPT"></a>
|
||
|
|
<h3>CL var for PRTRPT (4) (PRTRPT)</h3>
|
||
|
|
<p>Specifies the name of the CL variable that receives the indicator for printing a report of saved objects. The variable must have a minimum length of 4 characters. The value returned is either *YES or *NO.
|
||
|
|
</p>
|
||
|
|
</div>
|
||
|
|
<table width="100%">
|
||
|
|
<tr><td align="right"><a href="#RTVBCKUP.Top_Of_Page">Top</a></td></tr>
|
||
|
|
</table>
|
||
|
|
<div> <a name="RTVBCKUP.LIB"></a>
|
||
|
|
<h3>CL var for LIB (10) (LIB)</h3>
|
||
|
|
<p>Specifies the name of the CL variable that receives the value specifying the libraries to save with this backup. The variable must have a minimum length of 10 characters. A value of *ALLUSR, *FROMLIST, or *NONE is returned.
|
||
|
|
</p>
|
||
|
|
</div>
|
||
|
|
<table width="100%">
|
||
|
|
<tr><td align="right"><a href="#RTVBCKUP.Top_Of_Page">Top</a></td></tr>
|
||
|
|
</table>
|
||
|
|
<div> <a name="RTVBCKUP.FLR"></a>
|
||
|
|
<h3>CL var for FLR (10) (FLR)</h3>
|
||
|
|
<p>Specifies the name of the CL variable that receives the value specifying the folders to save with this backup. The variable must have a minimum length of 10 characters. A value of *ALL, *FROMLIST, or *NONE is returned.
|
||
|
|
</p>
|
||
|
|
</div>
|
||
|
|
<table width="100%">
|
||
|
|
<tr><td align="right"><a href="#RTVBCKUP.Top_Of_Page">Top</a></td></tr>
|
||
|
|
</table>
|
||
|
|
<div> <a name="RTVBCKUP.DIR"></a>
|
||
|
|
<h3>CL var for DIR (10) (DIR)</h3>
|
||
|
|
<p>Specifies the name of the CL variable that receives the value specifying the user directories to save with this backup. The variable must have a minimum length of 10 characters. A value of *ALLUSR or *NONE is returned.
|
||
|
|
</p>
|
||
|
|
</div>
|
||
|
|
<table width="100%">
|
||
|
|
<tr><td align="right"><a href="#RTVBCKUP.Top_Of_Page">Top</a></td></tr>
|
||
|
|
</table>
|
||
|
|
<div> <a name="RTVBCKUP.SECDTA"></a>
|
||
|
|
<h3>CL var for SECDTA (4) (SECDTA)</h3>
|
||
|
|
<p>Specifies the name of the CL variable that receives the indicator for saving security data. The variable must have a minimum length of 4 characters. The value returned is either *YES or *NO.
|
||
|
|
</p>
|
||
|
|
</div>
|
||
|
|
<table width="100%">
|
||
|
|
<tr><td align="right"><a href="#RTVBCKUP.Top_Of_Page">Top</a></td></tr>
|
||
|
|
</table>
|
||
|
|
<div> <a name="RTVBCKUP.CFG"></a>
|
||
|
|
<h3>CL var for CFG (4) (CFG)</h3>
|
||
|
|
<p>Specifies the name of the CL variable that receives the indicator for saving configuration data. The variable must have a minimum length of 4 characters. The value returned is either *YES or *NO.
|
||
|
|
</p>
|
||
|
|
</div>
|
||
|
|
<table width="100%">
|
||
|
|
<tr><td align="right"><a href="#RTVBCKUP.Top_Of_Page">Top</a></td></tr>
|
||
|
|
</table>
|
||
|
|
<div> <a name="RTVBCKUP.MAIL"></a>
|
||
|
|
<h3>CL var for MAIL (4) (MAIL)</h3>
|
||
|
|
<p>Specifies the name of the CL variable that receives the indicator for saving OfficeVision mail. The variable must have a minimum length of 4 characters. The value returned is either *YES or *NO.
|
||
|
|
</p>
|
||
|
|
</div>
|
||
|
|
<table width="100%">
|
||
|
|
<tr><td align="right"><a href="#RTVBCKUP.Top_Of_Page">Top</a></td></tr>
|
||
|
|
</table>
|
||
|
|
<div> <a name="RTVBCKUP.CAL"></a>
|
||
|
|
<h3>CL var for CAL (4) (CAL)</h3>
|
||
|
|
<p>Specifies the name of the CL variable that receives the indicator for saving OfficeVision calendars. The variable must have a minimum length of 4 characters. The value returned is either *YES or *NO.
|
||
|
|
</p>
|
||
|
|
</div>
|
||
|
|
<table width="100%">
|
||
|
|
<tr><td align="right"><a href="#RTVBCKUP.Top_Of_Page">Top</a></td></tr>
|
||
|
|
</table>
|
||
|
|
<div> <a name="RTVBCKUP.EXITPGM"></a>
|
||
|
|
<h3>CL var for EXITPGM (10) (EXITPGM)</h3>
|
||
|
|
<p>Specifies the name of the CL variable that receives the name of the user program to call before and after the backup is run. The variable must have a minimum length of 10 characters. If no exit program is specified, *NONE is returned.
|
||
|
|
</p>
|
||
|
|
</div>
|
||
|
|
<table width="100%">
|
||
|
|
<tr><td align="right"><a href="#RTVBCKUP.Top_Of_Page">Top</a></td></tr>
|
||
|
|
</table>
|
||
|
|
<div> <a name="RTVBCKUP.EXITPGMLIB"></a>
|
||
|
|
<h3>CL var for EXITPGMLIB (10) (EXITPGMLIB)</h3>
|
||
|
|
<p>Specifies the name of the CL variable that receives the name of the library that contains the exit program. The variable must have a minimum length of 10 characters. If no exit program is specified, blanks are returned. If *LIBL is returned, the program uses the library list.
|
||
|
|
</p>
|
||
|
|
</div>
|
||
|
|
<table width="100%">
|
||
|
|
<tr><td align="right"><a href="#RTVBCKUP.Top_Of_Page">Top</a></td></tr>
|
||
|
|
</table>
|
||
|
|
<hr size="2" width="100%">
|
||
|
|
<div><h3><a name="RTVBCKUP.COMMAND.EXAMPLES">Examples</a> </h3>
|
||
|
|
<p>
|
||
|
|
<pre>
|
||
|
|
RTVBCKUP BCKUPOPT(*DAILY) SBMJOB(&SBMJOBVAR) LIB(&LIBVAR)
|
||
|
|
</pre>
|
||
|
|
</p>
|
||
|
|
<p>This command retrieves the SBMJOB and LIB values for the daily backup into the CL variables SBMJOBVAR and LIBVAR respectively.
|
||
|
|
</p>
|
||
|
|
</div>
|
||
|
|
<table width="100%">
|
||
|
|
<tr><td align="right"><a href="#RTVBCKUP.Top_Of_Page">Top</a></td></tr>
|
||
|
|
</table>
|
||
|
|
<hr size="2" width="100%">
|
||
|
|
<div><h3><a name="RTVBCKUP.ERROR.MESSAGES">Error messages</a> </h3>
|
||
|
|
<p><b><u>*ESCAPE Messages</u></b>
|
||
|
|
</p>
|
||
|
|
<dl>
|
||
|
|
<dt><b>CPF1EE3</b></dt>
|
||
|
|
<dd>Not authorized to backup options.
|
||
|
|
</dd>
|
||
|
|
<dt><b>CPF1E6C</b></dt>
|
||
|
|
<dd>Backup options in use.
|
||
|
|
</dd>
|
||
|
|
<dt><b>CPF1E67</b></dt>
|
||
|
|
<dd>Backup options and library backup list damaged.
|
||
|
|
</dd>
|
||
|
|
<dt><b>CPF1E99</b></dt>
|
||
|
|
<dd>Unexpected error occurred.
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
<table width="100%">
|
||
|
|
<tr><td align="right"><a href="#RTVBCKUP.Top_Of_Page">Top</a></td></tr>
|
||
|
|
</table>
|
||
|
|
</body>
|
||
|
|
</html>
|