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

527 lines
20 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>Work with Media using BRM (WRKMEDBRM)</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="WRKMEDBRM.Top_Of_Page"></a>
<h2>Work with Media using BRM (WRKMEDBRM)</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="#WRKMEDBRM.PARAMETERS.TABLE">Parameters</a><br>
<a href="#WRKMEDBRM.COMMAND.EXAMPLES">Examples</a><br>
<a href="#WRKMEDBRM.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="WRKMEDBRM"></a>
<p>The Work with Media using BRM (WRKMEDBRM) command works with active, expired or all media volumes in the media inventory by creation and expiration date for any or all locations. The following parameters can be used to tailor this display or printed report. The report that is produced is the Media report. The report, if printed, is written to printer file QP1AMM.
</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="#WRKMEDBRM.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="WRKMEDBRM.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="#WRKMEDBRM.TYPE"><b>TYPE</b></a></td>
<td valign="top">Select volumes</td>
<td valign="top"><b><u>*BOTH</u></b>, *ACT, *EXP</td>
<td valign="top">Optional, Positional 1</td>
</tr>
<tr>
<td valign="top" rowspan="3"><a href="#WRKMEDBRM.SLTCRTDATE"><b>SLTCRTDATE</b></a></td>
<td valign="top">Select creation dates</td>
<td valign="top"><i>Element list</i></td>
<td valign="top" rowspan="3">Optional</td>
</tr>
<tr>
<td valign="top">Element 1: Beginning creation date</td>
<td valign="top">
<i>Character value</i>, <b><u>*BEGIN</u></b>, *CURRENT</td>
</tr>
<tr>
<td valign="top">Element 2: Ending creation date</td>
<td valign="top">
<i>Character value</i>, <b><u>*END</u></b>, *CURRENT</td>
</tr>
<tr>
<td valign="top" rowspan="3"><a href="#WRKMEDBRM.SLTEXPDATE"><b>SLTEXPDATE</b></a></td>
<td valign="top">Select expiration dates</td>
<td valign="top"><i>Element list</i></td>
<td valign="top" rowspan="3">Optional</td>
</tr>
<tr>
<td valign="top">Element 1: Beginning expiration date</td>
<td valign="top">
<i>Character value</i>, <b><u>*BEGIN</u></b>, *CURRENT, *PERM</td>
</tr>
<tr>
<td valign="top">Element 2: Ending expiration date</td>
<td valign="top">
<i>Character value</i>, <b><u>*END</u></b>, *CURRENT</td>
</tr>
<tr>
<td valign="top"><a href="#WRKMEDBRM.VOL"><b>VOL</b></a></td>
<td valign="top">Volume identifier</td>
<td valign="top">Single values: <b><u>*ALL</u></b><br>Other values (up to 50 repetitions): <i>Character value</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#WRKMEDBRM.LOC"><b>LOC</b></a></td>
<td valign="top">From location</td>
<td valign="top"><i>Name</i>, <b><u>*ALL</u></b>, *HOME</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#WRKMEDBRM.CNR"><b>CNR</b></a></td>
<td valign="top">Container</td>
<td valign="top"><i>Name</i>, <b><u>*ALL</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#WRKMEDBRM.MEDCLS"><b>MEDCLS</b></a></td>
<td valign="top">Media class</td>
<td valign="top"><i>Name</i>, <b><u>*ALL</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#WRKMEDBRM.SYSNAME"><b>SYSNAME</b></a></td>
<td valign="top">System name</td>
<td valign="top"><i>Character value</i>, <b><u>*ALL</u></b>, *LCL</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#WRKMEDBRM.FILEGRP"><b>FILEGRP</b></a></td>
<td valign="top">File group</td>
<td valign="top"><i>Name</i>, <b><u>*ALL</u></b>, *NONE, *ARCGRP, *BKUGRP, *SYSGRP, *SYSTEM</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#WRKMEDBRM.GRPTYPE"><b>GRPTYPE</b></a></td>
<td valign="top">File group type</td>
<td valign="top"><i>Name</i>, <b><u>*ALL</u></b>, *ARC, *BKU, *NONE</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#WRKMEDBRM.TEXT"><b>TEXT</b></a></td>
<td valign="top">Text</td>
<td valign="top"><i>Character value</i>, <b><u>*ALL</u></b>, *NONE, '*generic*'</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#WRKMEDBRM.SORT"><b>SORT</b></a></td>
<td valign="top">Sequence</td>
<td valign="top"><b><u>*VOL</u></b>, *CRT, *EXP, *LOC</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#WRKMEDBRM.OUTPUT"><b>OUTPUT</b></a></td>
<td valign="top">Output</td>
<td valign="top"><b><u>*</u></b>, *PRINT</td>
<td valign="top">Optional</td>
</tr>
</table>
<table width="100%">
<tr><td align="right"><a href="#WRKMEDBRM.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="WRKMEDBRM.TYPE"></a>
<h3>Select volumes (TYPE)</h3>
<p>Use this parameter to specify the type of media volume that you want to display or print.
</p>
<dl>
<dt><b><u>*BOTH</u></b></dt>
<dd>Displays or prints both active and expired media volumes.
</dd>
<dt><b>*ACT</b></dt>
<dd>Displays or prints only active media volumes.
</dd>
<dt><b>*EXP</b></dt>
<dd>Displays or prints only expired media volumes.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#WRKMEDBRM.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="WRKMEDBRM.SLTCRTDATE"></a>
<h3>Select creation dates (SLTCRTDATE)</h3>
<p>Specifies a range of creation dates that you want to use when working with media. The <b>Beginning creation date </b>is the beginning of a date range of media selected and the <b>Ending creation date </b>is the end of the date range of creation dates.
</p>
<p>
<b>Note: </b>Using this parameter, it is possible to enter a date with no separator, or a number of days which can be up to 5 digits in length. For instance, if you are using month/day/year format, the number 12904 would be formatted as January 29, 2004. If on the other hand, you entered a number 13904, BRMS assume that this is not a date, but rather is a number. BRMS always tries to calculate a calendar date first when a number is entered and then if the date it calculates is not valid, assumes that it is a number of days. If the number that is entered is over 5 digits and the date that it calculates is not valid, you receive an error message.
</p>
<p><b>Element 1: Beginning creation date </b>
</p>
<dl>
<dt><b><u>*BEGIN</u></b></dt>
<dd>Uses the earliest media volume creation date that is on the file for the beginning of the creation date range.
</dd>
<dt><b>*CURRENT</b></dt>
<dd>Uses the current date as the beginning of the creation date range.
</dd>
<dt><b><i>beginning-creation-date</i></b></dt>
<dd>Specify a date that is the beginning of the creation date range. The date must be less than or equal to the current date.
</dd>
<dt><b><i>number-of-days</i></b></dt>
<dd>Specify the number of days before the current day that is used to determine the beginning date of the date range.
</dd>
</dl>
<p><b>Element 2: Ending creation date </b>
</p>
<dl>
<dt><b><u>*END</u></b></dt>
<dd>The last creation date in the media inventory is used as the end of the creation date range.
</dd>
<dt><b>*CURRENT</b></dt>
<dd>Uses the current date as the ending of the creation date range.
</dd>
<dt><b><i>ending-creation-date</i></b></dt>
<dd>Specify a date that is the ending of the creation date range. The date must be equal to or greater than the beginning creation date and less than or equal to the current date.
</dd>
<dt><b><i>number-of-days</i></b></dt>
<dd>Specify the number of days before the current day that is used to determine the ending date of the date range.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#WRKMEDBRM.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="WRKMEDBRM.SLTEXPDATE"></a>
<h3>Select expiration dates (SLTEXPDATE)</h3>
<p>Specifies a range of expiration dates that you want to use when working with media. The <b>Beginning expiration date </b>is the beginning of a date range of media selected and the <b>Ending expiration date </b>is the end of the date range of expiration dates.
</p>
<p>
<b>Note: </b>Using this parameter, it is possible to enter a date with no separator, or a number of days which can be up to 5 digits in length. For instance, if you are using month/day/year format, the number 12904 would be formatted as January 29, 2004. If on the other hand, you entered a number 13904, BRMS assume that this is not a date, but rather is a number. BRMS always tries to calculate a calendar date first when a number is entered and then if the date it calculates is not valid, assumes that it is a number of days. If the number that is entered is over 5 digits and the date that it calculates is not valid, you receive an error message.
</p>
<p><b>Element 1: Beginning expiration date </b>
</p>
<dl>
<dt><b><u>*BEGIN</u></b></dt>
<dd>Uses the earliest media volume expiration date that is on the file for the beginning of the expiration date range.
</dd>
<dt><b>*CURRENT</b></dt>
<dd>Uses the current date as the beginning of the expiration date range.
</dd>
<dt><b><i>beginning-expiration-date</i></b></dt>
<dd>Specify a date that is the beginning of the expiration date range. The date must be less than or equal to the current date.
</dd>
<dt><b><i>number-of-days</i></b></dt>
<dd>Specify the number of days before the current day that is used to determine the starting date of the date range.
</dd>
</dl>
<p><b>Element 2: Ending expiration date </b>
</p>
<dl>
<dt><b><u>*END</u></b></dt>
<dd>The last expiration date in the media inventory is used as the end of the expiration date range.
</dd>
<dt><b>*CURRENT</b></dt>
<dd>Uses the current date as the ending of the expiration date range.
</dd>
<dt><b><i>ending-expiration-date</i></b></dt>
<dd>Specify a date that is greater than or equal to the beginning expiration date.
</dd>
<dt><b><i>number-of-days</i></b></dt>
<dd>Specify the number of days after the current day that is used to determine the ending date of the date range.
</dd>
<dt><b>*PERM</b></dt>
<dd>Selects all media volumes that are marked with a permanent retention.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#WRKMEDBRM.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="WRKMEDBRM.VOL"></a>
<h3>Volume identifier (VOL)</h3>
<p>Specifies the volume or volumes that you want to display in the Work with Media display or print.
</p>
<p><b>Single values</b>
</p>
<dl>
<dt><b><u>*ALL</u></b></dt>
<dd>You want to display or print all volumes in the media inventory that meet all specified parameters.
</dd>
</dl>
<p><b>Other values (up to 50 repetitions)</b>
</p>
<dl>
<dt><b><i>generic*-volume-name</i></b></dt>
<dd>Specify the generic volume name. For example, specifying VOL* would cause all volumes whose names that begin with VOL to be included in the display or print.
</dd>
<dt><b><i>volume-name</i></b></dt>
<dd>Specify that you want to display or print the volume or volumes that meet all specified parameters.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#WRKMEDBRM.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="WRKMEDBRM.LOC"></a>
<h3>From location (LOC)</h3>
<p>Specifies the location of the media that you want to display or print.
</p>
<dl>
<dt><b><u>*ALL</u></b></dt>
<dd>Use the media volumes that reside in any storage location.
</dd>
<dt><b>*HOME</b></dt>
<dd>Use the media volumes that reside in the local storage location, *HOME.
</dd>
<dt><b><i>from-location-name</i></b></dt>
<dd>Specify the name of the media storage location.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#WRKMEDBRM.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="WRKMEDBRM.CNR"></a>
<h3>Container (CNR)</h3>
<p>Specifies the container that you want to display or print. You can select a specific container or all containers within a location.
</p>
<dl>
<dt><b><u>*ALL</u></b></dt>
<dd>Work with all containers that reside in a storage locations.
</dd>
<dt><b><i>container-ID</i></b></dt>
<dd>Specify the name of the container you want to display or print.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#WRKMEDBRM.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="WRKMEDBRM.MEDCLS"></a>
<h3>Media class (MEDCLS)</h3>
<p>Specifies the media class that you want to display or print. You can select a specific media class or all media classes.
</p>
<dl>
<dt><b><u>*ALL</u></b></dt>
<dd>Work with all media classes.
</dd>
<dt><b><i>media-class-name</i></b></dt>
<dd>Specify the name of the media class that you want to display or print.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#WRKMEDBRM.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="WRKMEDBRM.SYSNAME"></a>
<h3>System name (SYSNAME)</h3>
<p>Specifies the system name whose media inventory that you want to display or print.
</p>
<dl>
<dt><b><u>*ALL</u></b></dt>
<dd>You want to display or print the media inventory for all system names.
</dd>
</dl>
<dl>
<dt><b>*LCL</b></dt>
<dd>Specifies that the system is the local system. BRMS uses the default local location name, LCLLOCNAME and not the system name SYSNAME. In most cases, the systems have the same value specified in the LCLLOCNAME and in the SYSNAME. You can use the DSPNETA command to view the system network attributes.
</dd>
<dt><b><i>location-name</i></b></dt>
<dd>Specify the name of the remote location associated with the system. The local system's network identifier, as seen by using the DSPNETA command, is used as the system's network identifier.
<p>
<b>Note: </b>The BRMS Network feature (Option 1) is required to use this value.
</p>
</dd>
<dt><b><i>network-id.location-name</i></b></dt>
<dd>Specify the network identifier and the name of the remote location associated with the system. Specify these values using the format nnnnnnnn.cccccccc where nnnnnnnn is the network identifier and cccccccc is the remote location name.
<p>
<b>Note: </b>The BRMS Network feature (Option 1) is required to use this value.
</p>
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#WRKMEDBRM.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="WRKMEDBRM.FILEGRP"></a>
<h3>File group (FILEGRP)</h3>
<p>Specifies the file group that you want to include on the volumes that you want to display or print.
</p>
<dl>
<dt><b><u>*ALL</u></b></dt>
<dd>Include all file groups that meet the other specifications for the media that you want to display or print.
</dd>
<dt><b>*NONE</b></dt>
<dd>Do not include file groups.
</dd>
<dt><b>*ARCGRP</b></dt>
<dd>Include volumes that contain the default archive control group in the group of files.
<p>
<b>Note: </b>The BRMS Advanced feature (Option 2) is required to use this value.
</p>
</dd>
<dt><b>*BKUGRP</b></dt>
<dd>Include volumes that contain the default backup user data control group in the group of files.
</dd>
<dt><b>*SYSGRP</b></dt>
<dd>Include volumes that contain the default system data control group in the group of files.
</dd>
<dt><b>*SYSTEM</b></dt>
<dd>Include volumes that contain the default backup entire system control group in the group of files.
</dd>
<dt><b><i>file-group</i></b></dt>
<dd>Specify the name of the file group whose volumes you want to display or print.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#WRKMEDBRM.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="WRKMEDBRM.GRPTYPE"></a>
<h3>File group type (GRPTYPE)</h3>
<p>Specifies the type of file group that you want to display or print.
</p>
<dl>
<dt><b><u>*ALL</u></b></dt>
<dd>Include all types of file groups that meet the other specifications in the search.
</dd>
<dt><b>*ARC</b></dt>
<dd>Include file groups that are archive type file groups in the media that you want to display or print.
<p>
<b>Note: </b>The BRMS Advanced feature (Option 2) is required to use this value.
</p>
</dd>
<dt><b>*BKU</b></dt>
<dd>Include file groups that are backup type file groups in the media that you want to display or print.
</dd>
<dt><b>*NONE</b></dt>
<dd>Do not include any file group types in the media that you want to display or print.
</dd>
<dt><b><i>file-group-type</i></b></dt>
<dd>Specify the file group type that you want to include in the file groups that you want to display or print.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#WRKMEDBRM.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="WRKMEDBRM.TEXT"></a>
<h3>Text (TEXT)</h3>
<p>Specifies the text related to the media with which you want to work. You can search for any string of characters, and only those media inventory entries that contain the string of characters in the text are included in the display or print.
</p>
<dl>
<dt><b><u>*ALL</u></b></dt>
<dd>You want to display or print all media inventory entries, regardless of the text.
</dd>
<dt><b>*NONE</b></dt>
<dd>You want to display or print all media inventory entries that have blanks for text.
</dd>
<dt><b>*generic*-text</b></dt>
<dd>Specify that you want to display or print all media inventory entries that have the text string specified.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#WRKMEDBRM.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="WRKMEDBRM.SORT"></a>
<h3>Sequence (SORT)</h3>
<p>Specifies the sort sequence that you want to use for this display or report.
</p>
<dl>
<dt><b><u>*VOL</u></b></dt>
<dd>Sorts the display or report in volume sequence.
</dd>
<dt><b>*CRT</b></dt>
<dd>Sorts the display or report in creation date sequence.
</dd>
<dt><b>*EXP</b></dt>
<dd>Sorts the display or report in expiration date sequence.
</dd>
<dt><b>*LOC</b></dt>
<dd>Sorts the display or report in location sequence.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#WRKMEDBRM.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="WRKMEDBRM.OUTPUT"></a>
<h3>Output (OUTPUT)</h3>
<p>Specifies whether the output from the command is displayed at the requesting work station or printed with the job's spooled output.
</p>
<dl>
<dt><b><u>*</u></b></dt>
<dd>The output is displayed (if requested by an interactive job) or printed (if requested by a batch job).
</dd>
<dt><b>*PRINT</b></dt>
<dd>The output is printed with the job's spooled output.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#WRKMEDBRM.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="WRKMEDBRM.COMMAND.EXAMPLES">Examples</a> </h3>
<p><b>Example 1: Working with Expired Media</b>
</p>
<p>
<pre>
WRKMEDBRM TYPE(*EXP)
</pre>
</p>
<p>This command displays the Work with Media panel, where expired media are shown.
</p>
<p><b>Example 2: Working with Active Media Sorted by Location</b>
</p>
<p>
<pre>
WRKMEDBRM TYPE(*ACT) SYSNAME(MYSYS) SEQ(*LOC)
</pre>
</p>
<p>This command displays the Work with Media panel, where active media that is in the media inventory for a system named MYSYS are shown in location order.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#WRKMEDBRM.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="WRKMEDBRM.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>BRM40A2</b></dt>
<dd>BRMS product initialization required.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#WRKMEDBRM.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>