267 lines
12 KiB
HTML
267 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>Check Expired Media for BRM (CHKEXPBRM)</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="CHKEXPBRM.Top_Of_Page"></a>
|
|
<h2>Check Expired Media for BRM (CHKEXPBRM)</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="#CHKEXPBRM.PARAMETERS.TABLE">Parameters</a><br>
|
|
<a href="#CHKEXPBRM.COMMAND.EXAMPLES">Examples</a><br>
|
|
<a href="#CHKEXPBRM.ERROR.MESSAGES">Error messages</a></td>
|
|
</tr>
|
|
</table>
|
|
|
|
<div> <a name="CHKEXPBRM"></a>
|
|
<p>The Check Expired Media for BRM (CHKEXPBRM) command is used to check to see if there is enough expired media to satisfy the media requirements of a save operation. The command calculates the media of a specified media class available for a save operation, taking into account the location of the media based on the location specified in the media policy or a location that you specify. You can calculate the available media for single or multiple media classes, with single or multiple location combinations depending on the values that you specify in the command.
|
|
</p>
|
|
<p>For instance, if you specified 20 in the Required volumes field, FMT2GB in the Media class field and *HOME in the Location field, you would have one media class, location combination. If you changed the Location field to *ANY, you could potentially receive messages about media class availability for each of the locations that you have set up that have the specified media class. If you had a situation where you specified *MEDPCY in the Required volumes field, *CTLGRP in the Media policy field and *ALL in the Control group field, then you would expect to have multiple media class, location combinations. The command returns messages that specify whether enough media is available for each media class, location combination.
|
|
</p>
|
|
<p>This command works in conjunction with the value specified in the <b>Required volumes </b>field. The value can be a specified number of volumes or a special value for media policy. The number of available volumes calculated by the CHKEXPBRM command is compared against the value in the <b>Required volumes </b>field. If the expired media calculated by the CHKEXPBRM command is greater than or equal to the <b>Required volumes </b>field value, the save operation can continue. If the value is less, then the save operation is canceled.
|
|
</p>
|
|
<p>The number of expired volumes can also be checked by user jobs using the CHKEXPBRM command. For example, the CHKEXPBRM command could be incorporated into a job scheduler and used to determine at various times if there is enough expired media available for a save operation.
|
|
</p>
|
|
<p>This command is used by all BRMS save operations.
|
|
</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="#CHKEXPBRM.Top_Of_Page">Top</a></td></tr>
|
|
</table>
|
|
<hr size="2" width="100%">
|
|
|
|
<div>
|
|
<h3><a name="CHKEXPBRM.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="#CHKEXPBRM.EXPMED"><b>EXPMED</b></a></td>
|
|
<td valign="top">Required volumes</td>
|
|
<td valign="top">1-9999, *MEDPCY</td>
|
|
<td valign="top">Required, Positional 1</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top"><a href="#CHKEXPBRM.MEDCLS"><b>MEDCLS</b></a></td>
|
|
<td valign="top">Media class</td>
|
|
<td valign="top"><i>Name</i></td>
|
|
<td valign="top">Optional</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top"><a href="#CHKEXPBRM.LOC"><b>LOC</b></a></td>
|
|
<td valign="top">Location</td>
|
|
<td valign="top"><i>Name</i>, <b><u>*ANY</u></b>, *HOME</td>
|
|
<td valign="top">Optional</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top"><a href="#CHKEXPBRM.MEDPCY"><b>MEDPCY</b></a></td>
|
|
<td valign="top">Media policy</td>
|
|
<td valign="top"><i>Name</i>, *CTLGRP</td>
|
|
<td valign="top">Optional</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top"><a href="#CHKEXPBRM.CTLGRP"><b>CTLGRP</b></a></td>
|
|
<td valign="top">Control group</td>
|
|
<td valign="top">Single values: <b><u>*ALL</u></b><br>Other values (up to 50 repetitions): <i>Name</i>, *BKUGRP, *SYSGRP, *SYSTEM</td>
|
|
<td valign="top">Optional</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top"><a href="#CHKEXPBRM.DATE"><b>DATE</b></a></td>
|
|
<td valign="top">Date for save</td>
|
|
<td valign="top"><i>Character value</i>, <b><u>*CURRENT</u></b></td>
|
|
<td valign="top">Optional</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<table width="100%">
|
|
<tr><td align="right"><a href="#CHKEXPBRM.Top_Of_Page">Top</a></td></tr>
|
|
</table>
|
|
</div>
|
|
<div> <a name="CHKEXPBRM.EXPMED"></a>
|
|
<h3>Required volumes (EXPMED)</h3>
|
|
<p>Specifies the number of expired volumes required to process a save operation. You can specify a number of volumes or you can specify that you want to base the number of required volumes on a media policy. When the command is processed the number of available expired volumes that meet the criteria are counted and compared against the value specified here.
|
|
</p>
|
|
<p>
|
|
<b>Note: </b>If you specify *MEDPCY, the <b>Media policy (MEDPCY)</b> parameter is a required parameter.
|
|
</p>
|
|
<dl>
|
|
<dt><b>*MEDPCY</b></dt>
|
|
<dd>The number of expired volumes required to process a save operation is the number of volumes specified in the <b>Required volumes </b>field of the media policy specified in the <b>Media policy (MEDPCY)</b> parameter.
|
|
</dd>
|
|
<dt><b><i>number-of-volumes</i></b></dt>
|
|
<dd>Specify the number of volumes required for the save operation.
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<table width="100%">
|
|
<tr><td align="right"><a href="#CHKEXPBRM.Top_Of_Page">Top</a></td></tr>
|
|
</table>
|
|
<div> <a name="CHKEXPBRM.MEDCLS"></a>
|
|
<h3>Media class (MEDCLS)</h3>
|
|
<p>Specifies the media class of the expired volumes that you want to count.
|
|
</p>
|
|
<p>This is a required parameter when a number is entered in the <b>Required volumes (EXPMED)</b> parameter. If you enter a media policy, the media class is derived from the media policy.
|
|
</p>
|
|
</div>
|
|
<table width="100%">
|
|
<tr><td align="right"><a href="#CHKEXPBRM.Top_Of_Page">Top</a></td></tr>
|
|
</table>
|
|
<div> <a name="CHKEXPBRM.LOC"></a>
|
|
<h3>Location (LOC)</h3>
|
|
<p>Specifies the location of the media to be included in the count of expired volumes.
|
|
</p>
|
|
<dl>
|
|
<dt><b><u>*ANY</u></b></dt>
|
|
<dd>Expired volumes of the media class or classes at each location are included in the count of expired volumes available for a save operation.
|
|
</dd>
|
|
<dt><b>*HOME</b></dt>
|
|
<dd>Only expired volumes at the home location are included in the count of expired volumes available for a save operation.
|
|
</dd>
|
|
<dt><b><i>location</i></b></dt>
|
|
<dd>Specify the location whose expired volumes are to be included in the count of expired volumes.
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<table width="100%">
|
|
<tr><td align="right"><a href="#CHKEXPBRM.Top_Of_Page">Top</a></td></tr>
|
|
</table>
|
|
<div> <a name="CHKEXPBRM.MEDPCY"></a>
|
|
<h3>Media policy (MEDPCY)</h3>
|
|
<p>Specifies the media policy that you want to use to determine the required number of expired volumes for the save operation.
|
|
</p>
|
|
<p>This a required parameter when *MEDPCY is specified in the <b>Required volumes (EXPMED)</b> parameter.
|
|
</p>
|
|
<dl>
|
|
<dt><b>*CTLGRP</b></dt>
|
|
<dd>Use the media policy associated with a control group to determine the number of expired volumes required for the save operation. The <b>Control group (CTLGRP)</b> parameter is a default with the *CTLGRP choice.
|
|
</dd>
|
|
<dt><b><i>media-policy</i></b></dt>
|
|
<dd>Specify the media policy to use to determine the number of expired volumes required for the save operation.
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<table width="100%">
|
|
<tr><td align="right"><a href="#CHKEXPBRM.Top_Of_Page">Top</a></td></tr>
|
|
</table>
|
|
<div> <a name="CHKEXPBRM.CTLGRP"></a>
|
|
<h3>Control group (CTLGRP)</h3>
|
|
<p>Specifies the name of the control group or all control groups whose media policy you want to use to determine the required number of expired volumes required for the save operation.
|
|
</p>
|
|
<p>This is a default field when *CTLGRP is specified in the <b>Media policy (MEDPCY)</b> parameter.
|
|
</p>
|
|
<p><b>Single values</b>
|
|
</p>
|
|
<dl>
|
|
<dt><b><u>*ALL</u></b></dt>
|
|
<dd>The media policy of each backup control group is used to determine the number of volumes required for each media class, location combination for the save operation.
|
|
</dd>
|
|
</dl>
|
|
<p><b>Other values (up to 50 repetitions)</b>
|
|
</p>
|
|
<dl>
|
|
<dt><b>*BKUGRP</b></dt>
|
|
<dd>The media policy used by the default backup user data control group is used to determine the number of volumes required for the media class, location combination for the save operation.
|
|
</dd>
|
|
<dt><b>*SYSGRP</b></dt>
|
|
<dd>The media policy used by the default system data control group is used to determine the number of volumes required for the media class, location combination for the save operation.
|
|
</dd>
|
|
<dt><b>*SYSTEM</b></dt>
|
|
<dd>The media policy used by the default backup entire system control group is used to determine the number of volumes required for the media class, location combination for the save operation.
|
|
</dd>
|
|
<dt><b><i>control-group-name</i></b></dt>
|
|
<dd>Specify the name of the backup control group, such as WEEKLY that you want to use to determine the number of volumes required for the media class, location combination for the save operation.
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<table width="100%">
|
|
<tr><td align="right"><a href="#CHKEXPBRM.Top_Of_Page">Top</a></td></tr>
|
|
</table>
|
|
<div> <a name="CHKEXPBRM.DATE"></a>
|
|
<h3>Date for save (DATE)</h3>
|
|
<p>Specifies the date that the control group was saved.
|
|
</p>
|
|
<dl>
|
|
<dt><b><u>*CURRENT</u></b></dt>
|
|
<dd>The current date is used to determine the control group and its associated media policy.
|
|
</dd>
|
|
<dt><b><i>expiration-date</i></b></dt>
|
|
<dd>Specify the date to use to determine the control group and its associated media policy.
|
|
</dd>
|
|
<dt><b><i>number-of-days</i></b></dt>
|
|
<dd>Specify a number of days to calculate a future date to be associated with a control group.
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<table width="100%">
|
|
<tr><td align="right"><a href="#CHKEXPBRM.Top_Of_Page">Top</a></td></tr>
|
|
</table>
|
|
<hr size="2" width="100%">
|
|
<div><h3><a name="CHKEXPBRM.COMMAND.EXAMPLES">Examples</a> </h3>
|
|
<p><b>Example 1: Checking on Available Volumes</b>
|
|
</p>
|
|
<p>
|
|
<pre>
|
|
CHKEXPBRM EXPMED(50) MEDCLS(FMT2GB) LOC(*HOME)
|
|
</pre>
|
|
</p>
|
|
<p>This command checks to see if there are 50 expired volumes of media class FMT2GB available for a save operation at the home location.
|
|
</p>
|
|
</div>
|
|
<table width="100%">
|
|
<tr><td align="right"><a href="#CHKEXPBRM.Top_Of_Page">Top</a></td></tr>
|
|
</table>
|
|
<hr size="2" width="100%">
|
|
<div><h3><a name="CHKEXPBRM.ERROR.MESSAGES">Error messages</a> </h3>
|
|
<p><b><u>*ESCAPE Messages</u></b>
|
|
</p>
|
|
<dl>
|
|
<dt><b>BRM1118</b></dt>
|
|
<dd>No active entries found in control group &1.
|
|
</dd>
|
|
<dt><b>BRM1157</b></dt>
|
|
<dd>Control group &1 not found.
|
|
</dd>
|
|
<dt><b>BRM1169</b></dt>
|
|
<dd>Policy &1 not found.
|
|
</dd>
|
|
<dt><b>BRM1441</b></dt>
|
|
<dd>Media usage not valid, control group not processed;
|
|
</dd>
|
|
<dt><b>BRM1917</b></dt>
|
|
<dd>Feature not installed.
|
|
</dd>
|
|
<dt><b>BRM1921</b></dt>
|
|
<dd>Feature not licensed.
|
|
</dd>
|
|
<dt><b>BRM1930</b></dt>
|
|
<dd>Request for &1 expired volumes for media class &3 was not successful.
|
|
</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="#CHKEXPBRM.Top_Of_Page">Top</a></td></tr>
|
|
</table>
|
|
</body>
|
|
</html>
|