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

483 lines
18 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 Media Controls using BRM (SETMEDBRM)</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="SETMEDBRM.Top_Of_Page"></a>
<h2>Set Media Controls using BRM (SETMEDBRM)</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="#SETMEDBRM.PARAMETERS.TABLE">Parameters</a><br>
<a href="#SETMEDBRM.COMMAND.EXAMPLES">Examples</a><br>
<a href="#SETMEDBRM.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="SETMEDBRM"></a>
<p>The Set Media Controls using BRM (SETMEDBRM) command has two distinct parts, a set of input controls and a set of output controls.
</p>
<p>Input controls pertain only to volumes from which data is being retrieved or read.
</p>
<p>Output controls start with the <b>Media class (MEDCLS)</b> parameter continue through the <b>Text (TEXT)</b> parameter, and pertain to volumes on which data is being written. For example, if you plan to perform a CPYTOTAP operation, you can use the SETMEDBRM command beforehand to assign a move policy and retention period for the volumes that are used.
</p>
<p>The controls you specify with SETMEDBRM remain in effect for your job until they are reset or otherwise changed by another SETMEDBRM command. To see control values that are currently in effect, type the SETMEDBRM 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>
</div>
<table width="100%">
<tr><td align="right"><a href="#SETMEDBRM.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="SETMEDBRM.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" rowspan="3"><a href="#SETMEDBRM.LABEL"><b>LABEL</b></a></td>
<td valign="top">Input controls</td>
<td valign="top"><i>Element list</i></td>
<td valign="top" rowspan="3">Optional</td>
</tr>
<tr>
<td valign="top">Element 1: File label</td>
<td valign="top">
<i>Character value</i>, <b><u>*SAME</u></b>, *ANY, *NONE</td>
</tr>
<tr>
<td valign="top">Element 2: Select version</td>
<td valign="top">
1-999, <b><u>*SAME</u></b>, *CURRENT</td>
</tr>
<tr>
<td valign="top"><a href="#SETMEDBRM.ALWCNV"><b>ALWCNV</b></a></td>
<td valign="top">Allow conversion</td>
<td valign="top"><b><u>*SAME</u></b>, *NO, *YES</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#SETMEDBRM.MEDCLS"><b>MEDCLS</b></a></td>
<td valign="top">Media class</td>
<td valign="top"><i>Character value</i>, <b><u>*SAME</u></b>, *NONE</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#SETMEDBRM.MOVPCY"><b>MOVPCY</b></a></td>
<td valign="top">Move policy</td>
<td valign="top"><i>Name</i>, <b><u>*SAME</u></b>, *NONE</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#SETMEDBRM.VOLSEC"><b>VOLSEC</b></a></td>
<td valign="top">Secure volume</td>
<td valign="top"><b><u>*SAME</u></b>, *NO, *YES</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top" rowspan="3"><a href="#SETMEDBRM.RET"><b>RET</b></a></td>
<td valign="top">Retention</td>
<td valign="top"><i>Element list</i></td>
<td valign="top" rowspan="3">Optional</td>
</tr>
<tr>
<td valign="top">Element 1: Retention type</td>
<td valign="top">
<b><u>*SAME</u></b>, *DATE, *DAYS, *NONE, *PERM, *VERSION</td>
</tr>
<tr>
<td valign="top">Element 2: Retain media</td>
<td valign="top">
<i>Character value</i>, <b><u>*SAME</u></b></td>
</tr>
<tr>
<td valign="top"><a href="#SETMEDBRM.FILEGRP"><b>FILEGRP</b></a></td>
<td valign="top">File group</td>
<td valign="top"><i>Name</i>, <b><u>*SAME</u></b>, *NONE, *ARCGRP, *BKUGRP, *SYSGRP, *SYSTEM</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#SETMEDBRM.GRPTYPE"><b>GRPTYPE</b></a></td>
<td valign="top">File group type</td>
<td valign="top"><i>Name</i>, <b><u>*SAME</u></b>, *ARC, *BKU, *NONE</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#SETMEDBRM.MARKDUP"><b>MARKDUP</b></a></td>
<td valign="top">Mark volumes for duplication</td>
<td valign="top"><b><u>*SAME</u></b>, *NO, *YES</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#SETMEDBRM.MARKHST"><b>MARKHST</b></a></td>
<td valign="top">Mark history for duplication</td>
<td valign="top"><b><u>*SAME</u></b>, *NO, *YES</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#SETMEDBRM.TEXT"><b>TEXT</b></a></td>
<td valign="top">Text</td>
<td valign="top"><i>Character value</i>, <b><u>*SAME</u></b>, *NONE</td>
<td valign="top">Optional</td>
</tr>
</table>
<table width="100%">
<tr><td align="right"><a href="#SETMEDBRM.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="SETMEDBRM.LABEL"></a>
<h3>Input controls (LABEL)</h3>
<p>Specifies the file label and version selection controls enforced for your job on subsequent input operations involving media. These controls remain in effect for your job until they are reset or otherwise changed by another SETMEDBRM command.
</p>
<p><b>Element 1: File label </b>
</p>
<dl>
<dt><b><u>*SAME</u></b></dt>
<dd>The previous SETMEDBRM specification for this value, if any, is to remain in effect.
</dd>
<dt><b>*ANY</b></dt>
<dd>File label, version selection controls apply to any file subsequently processed for input by this job.
</dd>
<dt><b>*NONE</b></dt>
<dd>No file label, version selection controls are in effect for this job.
</dd>
<dt><b><i>file-label</i></b></dt>
<dd>File label, version selection controls apply only to those files whose labels match the file label specified here.
</dd>
</dl>
<p><b>Element 2: Select version </b>
</p>
<p>In addition to the file label, you can specify which version of the file to use. BRMS uses the file label and version specified here along with its inventory of media content to determine which volume should be mounted. If the volume is not found, a message is issued to indicate this.
</p>
<dl>
<dt><b><u>*SAME</u></b></dt>
<dd>The previous SETMEDBRM specification for this value, if any, is to remain in effect.
</dd>
<dt><b>*CURRENT</b></dt>
<dd>The most recent version of the file is to be used.
</dd>
<dt><b><i>version-number</i></b></dt>
<dd>Specify which version of the file relative to the *CURRENT version should be mounted. For example, version 1 means the version taken just prior to the *CURRENT version.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#SETMEDBRM.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="SETMEDBRM.ALWCNV"></a>
<h3>Allow conversion (ALWCNV)</h3>
<p>Specifies whether conversion controls are enforced for your job on subsequent input operations involving media. These controls remain in effect for your job until they are reset or otherwise changed by another SETMEDBRM command.
</p>
<dl>
<dt><b><u>*SAME</u></b></dt>
<dd>The previous SETMEDBRM specification for this value, if any, is to remain in effect.
</dd>
<dt><b>*NO</b></dt>
<dd>Do not convert ASCII data, if found on the media, to EBCDIC.
</dd>
<dt><b>*YES</b></dt>
<dd>Convert ASCII data, if found on the media, to EBCDIC.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#SETMEDBRM.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="SETMEDBRM.MEDCLS"></a>
<h3>Media class (MEDCLS)</h3>
<p>Specifies the type of media to be used when output operations require media. The media class that you specify here is used by BRMS to control subsequent mount operations. These controls remain in effect for your job until they are reset or otherwise changed by another SETMEDBRM command.
</p>
<dl>
<dt><b><u>*SAME</u></b></dt>
<dd>The previous SETMEDBRM specification for this value, if any, is to remain in effect.
</dd>
<dt><b>*NONE</b></dt>
<dd>No media class enforcement should be done.
</dd>
<dt><b><i>media-class</i></b></dt>
<dd>Specify the name of a media class. Only media of this class is allowed to be used when output operations require media.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#SETMEDBRM.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="SETMEDBRM.MOVPCY"></a>
<h3>Move policy (MOVPCY)</h3>
<p>You can specify which move policy should be used for media once it has been written on by your job. This value remains in effect for your job until it is reset or otherwise changed by another SETMEDBRM command.
</p>
<dl>
<dt><b><u>*SAME</u></b></dt>
<dd>The previous SETMEDBRM specification for this value, if any, is to remain in effect.
</dd>
<dt><b>*NONE</b></dt>
<dd>The volume will not be assigned a move policy.
</dd>
<dt><b><i>move-policy</i></b></dt>
<dd>Specify the name of a move policy which will be used to control the physical movement of media once your job writes data on it. This move policy is not assigned when the media already has a move policy in effect.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#SETMEDBRM.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="SETMEDBRM.VOLSEC"></a>
<h3>Secure volume (VOLSEC)</h3>
<p>Specifies whether the volume is secured against subsequent read operations. Volumes that are secured can only be read by users with the special authorities *ALLOBJ or *SAVSYS. This value remains in effect for your job until it is reset or otherwise changed by another SETMEDBRM command.
</p>
<dl>
<dt><b><u>*SAME</u></b></dt>
<dd>The previous SETMEDBRM specification for this value, if any, is to remain in effect.
</dd>
<dt><b>*NO</b></dt>
<dd>The media is not secured. Media that is not secured can be read by anyone.
</dd>
<dt><b>*YES</b></dt>
<dd>The media is secured. Only users with special authorities *ALLOBJ or *SAVSYS can read secured media.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#SETMEDBRM.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="SETMEDBRM.RET"></a>
<h3>Retention (RET)</h3>
<p>Specifies the type of retention that you want to use for this volume. Certain <b>Retention type </b>specifications require additional <b>Retain media </b>detail. The Retention type parameter specifies the type of retention and the Retain media parameter specifies a number or a date as appropriate with the specified Retention type. For instance, if Retention type is specified as *VERSION and Retain media is 4, then 4 versions of the information on the media will be managed by BRMS.
</p>
<p><b>Element 1: Retention type </b>
</p>
<dl>
<dt><b><u>*SAME</u></b></dt>
<dd>The previous SETMEDBRM specification for this value, if any, is to remain in effect.
</dd>
<dt><b>*DATE</b></dt>
<dd>You want to assign a retention date. Dates are specified in job date format with or without date separators. BRMS does not allow media that is assigned the specified retention date to expire until the date passes.
</dd>
<dt><b>*DAYS</b></dt>
<dd>You want to assign a retention period measured in days, which begins when data is written on the media. An expiration date is calculated based on the number of days specified. BRMS does not allow media with this retention to expire until the date passes.
</dd>
<dt><b>*NONE</b></dt>
<dd>No retention type is assigned to the volume.
</dd>
<dt><b>*PERM</b></dt>
<dd>You want to permanently keep the data. BRMS does not allow media containing *PERM data to expire.
<p>
<b>Note: </b>If you specify *PERM, <b>Retain media </b>specifications are is ignored.
</p>
</dd>
<dt><b>*VERSION</b></dt>
<dd>You want to keep a selected number of versions for this file on media. BRMS does not allow media with this retention to expire until the number of versions in the BRMS inventory exceeds the number of versions specified.
</dd>
</dl>
<p><b>Element 2: Retain media </b>
</p>
<dl>
<dt><b><u>*SAME</u></b></dt>
<dd>The previous SETMEDBRM specification for this value, if any, is to remain in effect.
</dd>
<dt><b><i>retention-date</i></b></dt>
<dd>Specify the retention date when the <b>Retention type (RET)</b> parameter is *DATE.
</dd>
<dt><b><i>number-of-days</i></b></dt>
<dd>Specify the number of days when the Retention type is *DAYS.
</dd>
<dt><b><i>number-of-versions</i></b></dt>
<dd>Specify the number of versions when the Retention type is *VERSION.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#SETMEDBRM.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="SETMEDBRM.FILEGRP"></a>
<h3>File group (FILEGRP)</h3>
<p>Specifies the file group that you want to use with the current SETMEDBRM command.
</p>
<dl>
<dt><b><u>*SAME</u></b></dt>
<dd>The previous SETMEDBRM specification for this value, if any, is to remain in effect.
</dd>
<dt><b>*NONE</b></dt>
<dd>No file group name should be assigned.
</dd>
<dt><b><i>file-group</i></b></dt>
<dd>Specify the name of the file group to which the data being written belongs.
</dd>
<dt><b>*ARCGRP</b></dt>
<dd>The data belongs to the default archive control group.
<p>
<b>Note: </b>The BRMS Advanced feature (Option 2) is required to use this value.
</p>
</dd>
<dt><b>*BKUGRP</b></dt>
<dd>The data belongs to the default backup user data control group.
</dd>
<dt><b>*SYSGRP</b></dt>
<dd>The data belongs to the default system data control group.
</dd>
<dt><b>*SYSTEM</b></dt>
<dd>The data belongs to the default backup entire system control group.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#SETMEDBRM.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="SETMEDBRM.GRPTYPE"></a>
<h3>File group type (GRPTYPE)</h3>
<p>Specifies the type of file group to which the data being written belongs.
</p>
<dl>
<dt><b><u>*SAME</u></b></dt>
<dd>The previous SETMEDBRM specification for this value, if any, is to remain in effect.
</dd>
<dt><b>*ARC</b></dt>
<dd>The file group type is an archive file group type.
<p>
<b>Note: </b>*ARC is not a special value, but rather indicates that this is an archive file group type.
</p>
<p>
<b>Note: </b>The BRMS Advanced feature (Option 2) is required to use this value.
</p>
</dd>
<dt><b>*BKU</b></dt>
<dd>The file group type is a backup file group type.
<p>
<b>Note: </b>*BKU is not a special value, but rather indicates that this is a backup file group type.
</p>
</dd>
<dt><b>*NONE</b></dt>
<dd>No file group type should be assigned.
</dd>
<dt><b><i>file-group-type</i></b></dt>
<dd>Specify the name of the file group type to which the data being written belongs. An example file group type is QBRMBKUP which indicates that it is a backup control group file group type.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#SETMEDBRM.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="SETMEDBRM.MARKDUP"></a>
<h3>Mark volumes for duplication (MARKDUP)</h3>
<p>Specifies whether to mark the volumes for duplication after they have been duplicated.
</p>
<dl>
<dt><b><u>*SAME</u></b></dt>
<dd>The previous SETMEDBRM specification for this value, if any, is to remain in effect.
</dd>
<dt><b>*NO</b></dt>
<dd>Do not mark volumes for duplication.
</dd>
<dt><b>*YES</b></dt>
<dd>Mark volumes for duplication.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#SETMEDBRM.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="SETMEDBRM.MARKHST"></a>
<h3>Mark history for duplication (MARKHST)</h3>
<p>Specifies whether to mark the history items for duplication after they have been duplicated.
</p>
<dl>
<dt><b><u>*SAME</u></b></dt>
<dd>The previous SETMEDBRM specification for this value, if any, is to remain in effect.
</dd>
<dt><b>*NO</b></dt>
<dd>Do not mark the history items for duplication.
</dd>
<dt><b>*YES</b></dt>
<dd>Mark the history items for duplication.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#SETMEDBRM.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="SETMEDBRM.TEXT"></a>
<h3>Text (TEXT)</h3>
<p>Specifies the text that briefly describes the data being written. This text can be displayed in the BRMS media inventory.
</p>
<dl>
<dt><b><u>*SAME</u></b></dt>
<dd>The previous SETMEDBRM specification for this value, if any, is to remain in effect.
</dd>
<dt><b>*NONE</b></dt>
<dd>No text is specified.
</dd>
<dt><b><i>text</i></b></dt>
<dd>Specify no more than 50 characters of text, enclosed in apostrophes.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#SETMEDBRM.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="SETMEDBRM.COMMAND.EXAMPLES">Examples</a> </h3>
<p><b>Example 1: Using Input Controls</b>
</p>
<p>
<pre>
SETMEDBRM LABEL(*ANY 1) ALWCNV(*YES)
</pre>
</p>
<p>This command sets the input controls so that any file with a version number 1 greater than the most current version is read. If ASCII data is found, convert it to EBCDIC.
</p>
<p><b>Example 2: Using Output Controls</b>
</p>
<p>
<pre>
SETMEDBRM MEDCLS(QIC1000) MOVPCY(OFFSITE) RET(*DATE '3/3/03')
</pre>
</p>
<p>This command sets the output controls so that output operations will use media class QIC1000, a move policy of OFFSITE and a retention date of 3/3/2003 will be assigned to any volumes produced while these output controls are in effect.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#SETMEDBRM.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="SETMEDBRM.ERROR.MESSAGES">Error messages</a> </h3>
<p><b><u>*ESCAPE Messages</u></b>
</p>
<dl>
<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="#SETMEDBRM.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>