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

643 lines
30 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>Set Retrieve Controls for BRM (SETRTVBRM)</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="SETRTVBRM.Top_Of_Page"></a>
<h2>Set Retrieve Controls for BRM (SETRTVBRM)</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="#SETRTVBRM.PARAMETERS.TABLE">Parameters</a><br>
<a href="#SETRTVBRM.COMMAND.EXAMPLES">Examples</a><br>
<a href="#SETRTVBRM.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="SETRTVBRM"></a>
<p>The Set Retrieve Controls for BRM (SETRTVBRM) command can be used to change the way that retrieve operations work when performed by your job.
</p>
<p>The controls you specify with SETRTVBRM remain in effect for the duration of your job or until they are reset or otherwise changed by another SETRTVBRM command. The controls you specify with this command are not kept when the job ends. To see control values that are currently in effect, type the SETRTVBRM command on a command line and press F4.
</p>
<p>To use this command, you must have the Backup Recovery and Media Services for iSeries, 5722-BR1, licensed program installed.
</p>
<p><b>Restrictions: </b>
</p>
<ol>
<li>The BRMS Advanced feature (Option 2) is required to use this command.
</li>
<li>You can retrieve data from a TSM server device by using this command. You can only specify one TSM device of *MEDCLS, which must select a TSM device. The TSM device selected can either be *APPC, which supports SNA, or *NET, which supports TCP/IP.
</li>
<li>*ALLOBJ special authority is required to use any value other than *NONE for the ALWOBJDIF parameter.
</li>
<li>This command should not be used by control group *EXIT item processing as results will be unpredictable.
</li>
<li>You can select only one virtual tape device for serial retrieve operations. In addition, only one *MEDCLS can be specified when using media classes which specify a virtual tape device density.
</li>
</ol>
</div>
<table width="100%">
<tr><td align="right"><a href="#SETRTVBRM.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="SETRTVBRM.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="#SETRTVBRM.DEV"><b>DEV</b></a></td>
<td valign="top">Retrieve device</td>
<td valign="top">Single values: <b><u>*SAME</u></b><br>Other values (up to 4 repetitions): <i>Character value</i></td>
<td valign="top">Optional, Positional 1</td>
</tr>
<tr>
<td valign="top" rowspan="3"><a href="#SETRTVBRM.PRLRSC"><b>PRLRSC</b></a></td>
<td valign="top">Parallel device resources</td>
<td valign="top"><i>Element list</i></td>
<td valign="top" rowspan="3">Optional</td>
</tr>
<tr>
<td valign="top">Element 1: Minimum resources</td>
<td valign="top">
1-32, <b><u>*SAV</u></b>, *AVAIL, *NONE</td>
</tr>
<tr>
<td valign="top">Element 2: Maximum resources</td>
<td valign="top">
1-32, <b><u>*MIN</u></b>, *AVAIL</td>
</tr>
<tr>
<td valign="top" rowspan="3"><a href="#SETRTVBRM.RECALL"><b>RECALL</b></a></td>
<td valign="top">Retrieve confirmation</td>
<td valign="top"><i>Element list</i></td>
<td valign="top" rowspan="3">Optional</td>
</tr>
<tr>
<td valign="top">Element 1: Interactive operation</td>
<td valign="top">
<b><u>*SAME</u></b>, *DELAY, *NONE, *NOTIFY, *RTVPCY, *SBMJOB, *VERIFY</td>
</tr>
<tr>
<td valign="top">Element 2: Batch operation</td>
<td valign="top">
<b><u>*SAME</u></b>, *DELAY, *NONE, *NOTIFY, *RTVPCY, *VERIFY</td>
</tr>
<tr>
<td valign="top"><a href="#SETRTVBRM.RTVAUT"><b>RTVAUT</b></a></td>
<td valign="top">Retrieve authorization</td>
<td valign="top"><b><u>*SAME</u></b>, *ADD, *ALL, *CHANGE, *DLT, *OBJEXIST, *OBJMGT, *OBJOPR, *READ, *RTVPCY, *UPD, *USE</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#SETRTVBRM.ENDOPT"><b>ENDOPT</b></a></td>
<td valign="top">End of tape option</td>
<td valign="top"><b><u>*SAME</u></b>, *LEAVE, *REWIND, *RTVPCY, *UNLOAD</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#SETRTVBRM.RSTOPT"><b>RSTOPT</b></a></td>
<td valign="top">Option</td>
<td valign="top"><b><u>*SAME</u></b>, *ALL, *FREE, *NEW, *OLD, *RTVPCY</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#SETRTVBRM.ALWOBJDIF"><b>ALWOBJDIF</b></a></td>
<td valign="top">Allow object differences</td>
<td valign="top">Single values: <b><u>*SAME</u></b>, *ALL, *NONE, *RTVPCY<br>Other values (up to 4 repetitions): *AUTL, *FILELVL, *OWNER, *PGP</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#SETRTVBRM.STG"><b>STG</b></a></td>
<td valign="top">ASP high storage threshold</td>
<td valign="top">1-95, <b><u>*SAME</u></b>, *ASP, *RTVPCY, *SYS</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#SETRTVBRM.RET"><b>RET</b></a></td>
<td valign="top">Retrieved object retention</td>
<td valign="top">0-9999, <b><u>*SAME</u></b>, *ARC, *NOMAX, *RTVPCY</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#SETRTVBRM.EXTEND"><b>EXTEND</b></a></td>
<td valign="top">Extend retention on usage</td>
<td valign="top">0-9999, <b><u>*SAME</u></b>, *RTVPCY</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#SETRTVBRM.RESET"><b>RESET</b></a></td>
<td valign="top">Reset days used counter</td>
<td valign="top"><b><u>*SAME</u></b>, *NO, *RTVPCY</td>
<td valign="top">Optional</td>
</tr>
</table>
<table width="100%">
<tr><td align="right"><a href="#SETRTVBRM.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="SETRTVBRM.DEV"></a>
<h3>Retrieve device (DEV)</h3>
<p>Specifies the device name to be used for retrieve operations. You must use a single device for retrieve processing.
</p>
<p>You can restore data from a TSM (ADSM) server using this command. You can only specify one TSM type server or *MEDCLS, which must select a TSM server. The device selected can either be *APPC, which supports SNA network protocol, or *NET, which supports TCPIP protocol.
</p>
<p><b>Single values</b>
</p>
<dl>
<dt><b><u>*SAME</u></b></dt>
<dd>The previous specification for this value, if any, is used.
</dd>
</dl>
<p><b>Other values (up to 4 repetitions)</b>
</p>
<dl>
<dt><b>*MEDCLS</b></dt>
<dd>BRMS determines the media class of the media on which the requested item is saved. Once the media class is determined,, a device supporting the density specified in the media class is selected to retrieve the requested save item or items.
</dd>
<dt><b><i>device-name</i></b></dt>
<dd>Specify the name of the device that is to be used for retrieve operations.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#SETRTVBRM.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="SETRTVBRM.PRLRSC"></a>
<h3>Parallel device resources (PRLRSC)</h3>
<p>Specifies the minimum and maximum number of device resources to be used in a restore operation.
</p>
<p><b>Element 1: Minimum Resources</b>
</p>
<p>Specifies the minimum number of device resources required for a parallel restore.
</p>
<p>
<b>Note: </b>If a Media Library Device (MLB) is being used and the required resources are not available, the command will wait for the MLB to become available for a time period specified by the user. The wait time is determined by the value specified on the *MLB device description for INLMNTWAIT. If a *TAP device is being used and the required resources are not available, the command will fail.
</p>
<p>
<b>Note: </b>Transferring save files to tape does not support parallel operations.
</p>
<dl>
<dt><b><u>*SAV</u></b></dt>
<dd>Specifies that the same number of device resources used for the save will be used for the restore. If the save was a serial save, then the restore will also be serial.
</dd>
<dt><b>*AVAIL</b></dt>
<dd>Use any available devices up to the maximum specified. Specifying this value for the minimum will allow BRMS to use any available resources, but will complete using one resource if only one is available at the start of the command.
</dd>
<dt><b>*NONE</b></dt>
<dd>No device resources are to be used. The restore will be performed as a serial restore.
</dd>
<dt><b><i>1-32</i></b></dt>
<dd>Specify the minimum number of device resources to be used with this restore command, up to the maximum of what was used for the save.
</dd>
</dl>
<p><b>Element 2: Maximum Resources</b>
</p>
<dl>
<dt><b><u>*MIN</u></b></dt>
<dd>Uses the value specified for the minimum number of device resources.
</dd>
<dt><b>*AVAIL</b></dt>
<dd>Use any available devices. Specifying this value for the maximum will allow BRMS to use any available resources but at a minimum use the value specified in the minimum element.
</dd>
<dt><b><i>1-32</i></b></dt>
<dd>Specify the maximum number of device resources to be used with this restore command, up to the maximum of what was used for the save.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#SETRTVBRM.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="SETRTVBRM.RECALL"></a>
<h3>Retrieve confirmation (RECALL)</h3>
<p>Specifies how retrieve operations are processed in an interactive job or a batch job.
</p>
<p><b>Element 1: Interactive operation </b>
</p>
<dl>
<dt><b><u>*SAME</u></b></dt>
<dd>The previous specification for this value, if any, is used.
</dd>
<dt><b>*DELAY</b></dt>
<dd>You want to postpone retrieve operations. These objects can be retrieved later using the Resume Retrieve using BRM (RSMRTVBRM) command.
</dd>
<dt><b>*NONE</b></dt>
<dd>You do not want BRMS to perform retrieve operations.
</dd>
<dt><b>*NOTIFY</b></dt>
<dd>The object is to be retrieved immediately. Status messages indicate that the retrieve operation is taking place.
</dd>
<dt><b>*RTVPCY</b></dt>
<dd>The value from the retrieve policy is used for this value.
</dd>
<dt><b>*SBMJOB</b></dt>
<dd>You want the retrieved object to be retrieved using a batch job.
</dd>
<dt><b>*VERIFY</b></dt>
<dd>A message is sent for each object that is retrieved. You can proceed with the retrieve operation, delay or cancel it.
</dd>
</dl>
<p><b>Element 2: Batch operation </b>
</p>
<dl>
<dt><b><u>*SAME</u></b></dt>
<dd>The previous specification for this value, if any, is used.
</dd>
<dt><b>*DELAY</b></dt>
<dd>You want to postpone retrieve operations. These objects can be retrieved later using the Resume Retrieve using BRM (RSMRTVBRM) command.
</dd>
<dt><b>*NONE</b></dt>
<dd>You want to bypass retrieve processing.
</dd>
<dt><b>*NOTIFY</b></dt>
<dd>The object is to be retrieved immediately. Status messages indicate that the retrieve operation is taking place.
</dd>
<dt><b>*RTVPCY</b></dt>
<dd>The value specified in the retrieve policy is used.
</dd>
<dt><b>*VERIFY</b></dt>
<dd>A message is sent for each object that is retrieved. You can proceed with the retrieve operation, delay or cancel it.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#SETRTVBRM.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="SETRTVBRM.RTVAUT"></a>
<h3>Retrieve authorization (RTVAUT)</h3>
<p>Specifies the minimum authority required to allow BRMS to process a retrieve request. The value specified in the <b>Retrieve authorization (RTVAUT)</b> parameter is checked against the authority level of the user making the request. The authority list is checked at the time of the retrieve. If the user's authority level to the requested object is equal to or greater than the authority level specified in the <b>Retrieve authorization (RTVAUT)</b> parameter, then BRMS allows the object to be retrieved. If the user's authority to an object is less than the authority specified in the <b>Retrieve authorization (RTVAUT)</b> parameter, then the retrieve request does not take place.
</p>
<p>For example, if the value in the <b>Retrieve authorization (RTVAUT)</b> parameter is *READ and the user has *OBJEXIST authority to the object, then BRMS will retrieve the requested object since the user's authority to the object is greater than the minimum authority specified in the retrieve policy. If the value in the <b>Retrieve authorization (RTVAUT)</b> parameter is *OBJEXIST and the user has *READ authority for the requested object, the retrieve request will not be processed since the user's authority is less than the minimum required authority specified in the retrieve policy.
</p>
<dl>
<dt><b><u>*SAME</u></b></dt>
<dd>The previous specification for this value, if any, is used.
</dd>
</dl>
<dl>
<dt><b>*ADD</b></dt>
<dd>Add authority is checked.
</dd>
<dt><b>*ALL</b></dt>
<dd>Object operational authority, object management authority, object existence authority and all data authority for the object are checked regardless of the object type.
</dd>
<dt><b>*CHANGE</b></dt>
<dd>Object operational authority and all data authority for the object are checked regardless of the object type.
</dd>
<dt><b>*DLT</b></dt>
<dd>Delete authority is checked.
</dd>
<dt><b>*OBJEXIST</b></dt>
<dd>Object existence authority, which provides the authority to control object ownership and existence, is checked. These authorities are necessary for a user who wants to delete, free storage, save, retrieve or transfer ownership of an object. (If a user has the special save system (*SAVSYS) authority, he does not need object existence authority.)
</dd>
<dt><b>*OBJMGT</b></dt>
<dd>Object management authority, which provides the authority to manage the access and availability of an object, is checked. A user with object management authority can grant (and revoke) the authority that he has, as well as move and rename objects, and add members to database files.
</dd>
<dt><b>*OBJOPR</b></dt>
<dd>Object operational authority, which provides authority to manage the access and availability of an object, is checked. Object operational authority has no data authorities associated with it.
</dd>
<dt><b>*READ</b></dt>
<dd>Read authority is checked.
</dd>
</dl>
<dl>
<dt><b>*RTVPCY</b></dt>
<dd>The value from the retrieve policy is used for this value.
</dd>
</dl>
<dl>
<dt><b>*UPD</b></dt>
<dd>Update authority is checked.
</dd>
<dt><b>*USE</b></dt>
<dd>Object operational authority and read authority are checked regardless of the object type.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#SETRTVBRM.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="SETRTVBRM.ENDOPT"></a>
<h3>End of tape option (ENDOPT)</h3>
<p>Specifies, when tape is used, what positioning operation is automatically done on the volume after the retrieve operation ends. If more than one volume is included, this parameter applies only to the last volume used; all other volumes are rewound and unloaded when the end of the volume is reached.
</p>
<p>If you specify *LEAVE and the device is a shared device, the device will not be varied off after the save operation. If you specify *LEAVE and the device is not a shared device, the device will be varied off after the save operation.
</p>
<dl>
<dt><b><u>*SAME</u></b></dt>
<dd>The previous specification for this value, if any, is used.
</dd>
</dl>
<dl>
<dt><b>*LEAVE</b></dt>
<dd>The volume does not rewind or unload after the operation ends. It remains at the current position on the device.
</dd>
<dt><b>*REWIND</b></dt>
<dd>The volume is automatically rewound but not unloaded after the retrieve operation ends.
</dd>
</dl>
<dl>
<dt><b>*RTVPCY</b></dt>
<dd>The value from the retrieve policy is used for this value.
</dd>
</dl>
<dl>
<dt><b>*UNLOAD</b></dt>
<dd>The volume is automatically rewound and unloaded after the retrieve operation ends.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#SETRTVBRM.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="SETRTVBRM.RSTOPT"></a>
<h3>Option (RSTOPT)</h3>
<p>Specifies which objects are retrieved, depending on whether the objects exist in a library on the system.
</p>
<dl>
<dt><b><u>*SAME</u></b></dt>
<dd>The previous specification for this value, if any, is used.
</dd>
</dl>
<dl>
<dt><b>*ALL</b></dt>
<dd>All the objects in the saved library are retrieved to the library. Old objects on volume or in a save file replace the current versions in the library on the system. Objects not having a current version are added to the library on the system. Objects presently in the library, but not on the media, remain in the library.
</dd>
<dt><b>*FREE</b></dt>
<dd>The saved objects are retrieved only if they exist in the system library with their space freed. The saved version of each object is retrieved in the system in its previously freed space. This option retrieves objects that had their space freed when they were saved. If any saved objects are no longer part of the current version of the library, or if the space is not free for any object, the object is not retrieved. The retrieve operation continues, and all of the freed objects are retrieved.
</dd>
<dt><b>*NEW</b></dt>
<dd>Only the objects in the saved library that do not exist in the current version of the library on the system are added to the library. Only objects not known to the library on the system are retrieved; known objects are not retrieved. This option retrieves objects that were deleted after they were saved or that are new to this library. If any saved objects have a version already in the library on the system, they are not retrieved, and an informational message is sent for each one, but the retrieve operation continues.
</dd>
<dt><b>*OLD</b></dt>
<dd>Only the objects in the library having a saved version are retrieved; that is, the version of each object currently in the library is replaced by the saved version. Only objects known to the library are retrieved. If any saved objects are no longer part of the online version of the library, they are not added to the library; an informational message is sent for each one, but the retrieve continues.
</dd>
</dl>
<dl>
<dt><b>*RTVPCY</b></dt>
<dd>The value from the retrieve policy is used for this value.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#SETRTVBRM.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="SETRTVBRM.ALWOBJDIF"></a>
<h3>Allow object differences (ALWOBJDIF)</h3>
<p>Specifies whether differences are allowed between the saved objects and the restored objects. These differences include:
</p>
<ul>
<li><b>Authorization list: </b>The authorization list of an object on the system is different than the authorization list of an object from the save operation. Or the system on which a new object with an authorization list is being restored is different from the system on which it was saved.
</li>
</ul>
<ul>
<li><b>File level identifier: </b>The creation date and time of the database file on the system does not match the creation date and time of the file that was saved.
</li>
</ul>
<ul>
<li><b>Member level identifier: </b>The creation date and time of the database file member on the system does not match the creation date and time of the member that was saved.
</li>
</ul>
<ul>
<li><b>Ownership: </b>The owner of an object on the system is different than the owner of an object from the save operation.
</li>
</ul>
<ul>
<li><b>Primary Group: </b>The primary group of an object on the system is different than the primary group of an object from the save operation.
</li>
</ul>
<p>
<b>Note: </b>To use this parameter, you need *ALLOBJ special authority.
</p>
<p><b>Single values</b>
</p>
<dl>
<dt><b><u>*SAME</u></b></dt>
<dd>The previous specification for this value, if any, is used.
</dd>
</dl>
<dl>
<dt><b>*ALL</b></dt>
<dd>All of the differences listed above are allowed on the restore operation. File level identifier and member level identifier differences are handled differently than the *FILELVL value. If there is a file level difference and *ALL is specified on the <b>Data base member option (MBROPT)</b> parameter, the existing version of the file is renamed and the saved version of the file is restored. If there is a member level difference, the existing version of the member is renamed and the saved version of the member is restored. This value will restore the saved data, but the result may not be correct. For other differences, see the description of each individual value to determine how differences are handled.
<p>
<b>Note: </b>If restoring objects that were saved with SAVOBJ or SAVCHGOBJ, BRMS will change the parameter to ALWOBJDIF(*FILELVL *AUTL *OWNER *PGP) for these objects to prevent the renaming.
</p>
</dd>
<dt><b>*NONE</b></dt>
<dd>None of the differences listed above are allowed on the restore operation. See the description of each individual value to determine how differences are handled.
</dd>
</dl>
<dl>
<dt><b>*RTVPCY</b></dt>
<dd>The value from the retrieve policy is used for this value.
</dd>
</dl>
<p><b>Other values (up to 4 repetitions)</b>
</p>
<dl>
<dt><b>*AUTL</b></dt>
<dd>Authorization list differences are allowed.
<p>If an object already exists on the system with a different authorization list than the saved object, the object is restored with the authorization list of the object on the system. New objects that are being restored to a system that is different from which they were saved are restored and linked to their authorization list. If the authorization list does not exist on the new system, the public authority is set to *EXCLUDE.
</p>
<p>If this value is not specified, authorization list differences are not allowed. If an object already exists on the system with a different authorization list than the saved object, the object is not restored. New objects that are being restored to a system that is different from which they were saved are restored, but they are not linked to the authorization list, and the public authority is set to *EXCLUDE.
</p>
</dd>
</dl>
<dl>
<dt><b>*FILELVL</b></dt>
<dd>File level identifier and member level identifier differences are allowed.
<p>An attempt will be made to restore existing physical files even though the physical file on the save media may have a different file level identifier or member level identifier than the physical file on the system. The physical file data will only be restored for those physical files whose format level identifiers on the save media match the format level identifiers of the corresponding physical file on the system.
</p>
<p>If this value is not specified, file level identifier and member level identifier differences are not allowed. If an object already exists on the system with a different file level identifier or member level identifier than the saved object, the object is not restored.
</p>
</dd>
</dl>
<dl>
<dt><b>*OWNER</b></dt>
<dd>Ownership differences are allowed.
<p>If an object already exists on the system with a different owner than the saved object, the object is restored with the owner of the object on the system.
</p>
<p>If this value is not specified, ownership differences are not allowed. If an object already exists on the system with a different owner than the saved object, the object is not restored.
</p>
</dd>
</dl>
<dl>
<dt><b>*PGP</b></dt>
<dd>Primary group differences are allowed.
<p>If an object already exists on the system with a different primary group than the saved object, the object is restored with the primary group of the object on the system.
</p>
<p>If this value is not specified, primary group differences are not allowed. If an object already exists on the system with a different primary group than the saved object, the object is not restored.
</p>
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#SETRTVBRM.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="SETRTVBRM.STG"></a>
<h3>ASP high storage threshold (STG)</h3>
<p>Specifies the auxiliary storage pool high threshold value that cannot be exceeded when retrieving an object. If the limit is exceeded, the object is not retrieved, but is put on a list of objects to be retrieved later (using the RSMRTVBRM command) with an indication that a lack of space is the reason for postponing retrieval. The special value, *SYS, indicates that BRMS is to reference system information for the auxiliary storage pool's high storage threshold value.
</p>
<dl>
<dt><b><u>*SAME</u></b></dt>
<dd>The previous specification for this value, if any, is used.
</dd>
</dl>
<dl>
<dt><b>*ASP</b></dt>
<dd>The value for auxiliary storage pool high threshold value specified in the BRMS auxiliary storage pool descriptions is used. You can view the auxiliary storage pool high threshold value by processing the Work with ASP Descriptions (WRKASPBRM) command. If the reference value is *NONE, indicating that the auxiliary storage pool is not managed by BRMS, the object will not be retrieved, and a message is placed into the BRMS log to indicate that retrieval did not occur because the auxiliary storage pool high storage threshold is *NONE. Otherwise BRMS uses the referenced limit and the size of the object being retrieved to determine if the threshold will be exceeded. If so, the object is not retrieved, but is put on a list of objects to be retrieved later (using the RSMRTVBRM command) with an indication that a lack of space is the reason for postponing retrieval. If no BRMS information exists for the auxiliary storage pool, BRMS uses the operating system's high threshold value for the auxiliary storage pool.
</dd>
</dl>
<dl>
<dt><b>*RTVPCY</b></dt>
<dd>The value from the retrieve policy is used for this value.
</dd>
</dl>
<dl>
<dt><b>*SYS</b></dt>
<dd>The high storage threshold as identified by the system's auxiliary storage pool threshold is used.
</dd>
<dt><b><i>ASP-high-storage-threshold</i></b></dt>
<dd>Specify the maximum percentage of an auxiliary storage pool's storage capacity that cannot be exceeded as a result of an object being retrieved. The percentage can range from 1 to 95.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#SETRTVBRM.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="SETRTVBRM.RET"></a>
<h3>Retrieved object retention (RET)</h3>
<p>Specifies how long objects that have been retrieved, are kept on the system. After the object retention period has passed, the storage associated with the object is freed when maintenance is run.
</p>
<dl>
<dt><b><u>*SAME</u></b></dt>
<dd>The previous specification for this value, if any, is used.
</dd>
</dl>
<dl>
<dt><b>*ARC</b></dt>
<dd>The retrieved objects use the retention values specified, if any, when the archive process occurred. If no object retention was specified when the object was archived, BRMS uses *NOMAX.
</dd>
<dt><b>*NOMAX</b></dt>
<dd>The retrieved objects are kept indefinitely.
</dd>
</dl>
<dl>
<dt><b>*RTVPCY</b></dt>
<dd>The value from the retrieve policy is used for this value.
</dd>
</dl>
<dl>
<dt><b><i>number-of-days</i></b></dt>
<dd>Specify the number of days that retrieved objects should remain available before their storage is freed. The number of days can range from 0 to 9999.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#SETRTVBRM.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="SETRTVBRM.EXTEND"></a>
<h3>Extend retention on usage (EXTEND)</h3>
<p>Specifies the number of days to extend the retention of a retrieved object if it is used again after the retrieval operation. You can select the number of days, ranging from 0 to 9999 to add to the date of last use to determine a new retention date.
</p>
<dl>
<dt><b><u>*SAME</u></b></dt>
<dd>The previous specification for this value, if any, is used.
</dd>
</dl>
<dl>
<dt><b>*RTVPCY</b></dt>
<dd>The value from the retrieve policy is used for this value.
</dd>
</dl>
<dl>
<dt><b><i>number-of-days</i></b></dt>
<dd>Specify the number of days to extend the retention of a retrieved object if it is used again after the retrieval operation. The number of days can range from 0 to 9999.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#SETRTVBRM.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="SETRTVBRM.RESET"></a>
<h3>Reset (RESET)</h3>
<p>Specifies whether the days used count counter will be reset on the dynamic retrieval of an object.
</p>
<dl>
<dt><b><u>*SAME</u></b></dt>
<dd>The previous specification for this value, if any, is used.
</dd>
<dt><b>*NO</b></dt>
<dd>The days used count will not be reset to zero on the dynamic retrieval of an object.
</dd>
<dt><b>*RTVPCY</b></dt>
<dd>The value from the retrieve policy is used for this parameter.
</dd>
<dt><b>*YES</b></dt>
<dd>The days used count will be reset to zero on the dynamic retrieval of an object.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#SETRTVBRM.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="SETRTVBRM.COMMAND.EXAMPLES">Examples</a> </h3>
<p><b>Example 1: Resetting Control Values for BRMS Retrieve Operations in Your Job</b>
</p>
<p>
<pre>
SETRTVBRM DEV(TAP01) RECALL(*NOTIFY *NOTIFY) RTVAUT(*READ)
</pre>
</p>
<p>This command will set control values so that retrieve operations that occur during your job will use device TAP01, will simply notify you when they occur, and require that you only need read authority to be able to retrieve an object.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#SETRTVBRM.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="SETRTVBRM.ERROR.MESSAGES">Error messages</a> </h3>
<p><b><u>*ESCAPE Messages</u></b>
</p>
<dl>
<dt><b>BRM1134</b></dt>
<dd>Device &amp;1 not found.
</dd>
<dt><b>BRM1917</b></dt>
<dd>Feature not installed.
</dd>
<dt><b>BRM1921</b></dt>
<dd>Feature not licensed.
</dd>
<dt><b>BRM4040</b></dt>
<dd>Access denied for user &amp;1.
</dd>
<dt><b>BRM40A2</b></dt>
<dd>BRMS product initialization required.
</dd>
<dt><b>CPF9800</b></dt>
<dd>All CPF98xx messages could be signaled. xx is from 01 to FF.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#SETRTVBRM.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>