Set Media Controls using BRM (SETMEDBRM)

Where allowed to run: All environments (*ALL)
Threadsafe: No
Parameters
Examples
Error messages

The Set Media Controls using BRM (SETMEDBRM) command has two distinct parts, a set of input controls and a set of output controls.

Input controls pertain only to volumes from which data is being retrieved or read.

Output controls start with the Media class (MEDCLS) parameter continue through the Text (TEXT) 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.

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.

To use this command, you must have the Backup Recovery and Media Services for iSeries, 5722-BR1, licensed program installed.

Top

Parameters

Keyword Description Choices Notes
LABEL Input controls Element list Optional
Element 1: File label Character value, *SAME, *ANY, *NONE
Element 2: Select version 1-999, *SAME, *CURRENT
ALWCNV Allow conversion *SAME, *NO, *YES Optional
MEDCLS Media class Character value, *SAME, *NONE Optional
MOVPCY Move policy Name, *SAME, *NONE Optional
VOLSEC Secure volume *SAME, *NO, *YES Optional
RET Retention Element list Optional
Element 1: Retention type *SAME, *DATE, *DAYS, *NONE, *PERM, *VERSION
Element 2: Retain media Character value, *SAME
FILEGRP File group Name, *SAME, *NONE, *ARCGRP, *BKUGRP, *SYSGRP, *SYSTEM Optional
GRPTYPE File group type Name, *SAME, *ARC, *BKU, *NONE Optional
MARKDUP Mark volumes for duplication *SAME, *NO, *YES Optional
MARKHST Mark history for duplication *SAME, *NO, *YES Optional
TEXT Text Character value, *SAME, *NONE Optional
Top

Input controls (LABEL)

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.

Element 1: File label

*SAME
The previous SETMEDBRM specification for this value, if any, is to remain in effect.
*ANY
File label, version selection controls apply to any file subsequently processed for input by this job.
*NONE
No file label, version selection controls are in effect for this job.
file-label
File label, version selection controls apply only to those files whose labels match the file label specified here.

Element 2: Select version

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.

*SAME
The previous SETMEDBRM specification for this value, if any, is to remain in effect.
*CURRENT
The most recent version of the file is to be used.
version-number
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.
Top

Allow conversion (ALWCNV)

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.

*SAME
The previous SETMEDBRM specification for this value, if any, is to remain in effect.
*NO
Do not convert ASCII data, if found on the media, to EBCDIC.
*YES
Convert ASCII data, if found on the media, to EBCDIC.
Top

Media class (MEDCLS)

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.

*SAME
The previous SETMEDBRM specification for this value, if any, is to remain in effect.
*NONE
No media class enforcement should be done.
media-class
Specify the name of a media class. Only media of this class is allowed to be used when output operations require media.
Top

Move policy (MOVPCY)

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.

*SAME
The previous SETMEDBRM specification for this value, if any, is to remain in effect.
*NONE
The volume will not be assigned a move policy.
move-policy
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.
Top

Secure volume (VOLSEC)

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.

*SAME
The previous SETMEDBRM specification for this value, if any, is to remain in effect.
*NO
The media is not secured. Media that is not secured can be read by anyone.
*YES
The media is secured. Only users with special authorities *ALLOBJ or *SAVSYS can read secured media.
Top

Retention (RET)

Specifies the type of retention that you want to use for this volume. Certain Retention type specifications require additional Retain media 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.

Element 1: Retention type

*SAME
The previous SETMEDBRM specification for this value, if any, is to remain in effect.
*DATE
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.
*DAYS
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.
*NONE
No retention type is assigned to the volume.
*PERM
You want to permanently keep the data. BRMS does not allow media containing *PERM data to expire.

Note: If you specify *PERM, Retain media specifications are is ignored.

*VERSION
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.

Element 2: Retain media

*SAME
The previous SETMEDBRM specification for this value, if any, is to remain in effect.
retention-date
Specify the retention date when the Retention type (RET) parameter is *DATE.
number-of-days
Specify the number of days when the Retention type is *DAYS.
number-of-versions
Specify the number of versions when the Retention type is *VERSION.
Top

File group (FILEGRP)

Specifies the file group that you want to use with the current SETMEDBRM command.

*SAME
The previous SETMEDBRM specification for this value, if any, is to remain in effect.
*NONE
No file group name should be assigned.
file-group
Specify the name of the file group to which the data being written belongs.
*ARCGRP
The data belongs to the default archive control group.

Note: The BRMS Advanced feature (Option 2) is required to use this value.

*BKUGRP
The data belongs to the default backup user data control group.
*SYSGRP
The data belongs to the default system data control group.
*SYSTEM
The data belongs to the default backup entire system control group.
Top

File group type (GRPTYPE)

Specifies the type of file group to which the data being written belongs.

*SAME
The previous SETMEDBRM specification for this value, if any, is to remain in effect.
*ARC
The file group type is an archive file group type.

Note: *ARC is not a special value, but rather indicates that this is an archive file group type.

Note: The BRMS Advanced feature (Option 2) is required to use this value.

*BKU
The file group type is a backup file group type.

Note: *BKU is not a special value, but rather indicates that this is a backup file group type.

*NONE
No file group type should be assigned.
file-group-type
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.
Top

Mark volumes for duplication (MARKDUP)

Specifies whether to mark the volumes for duplication after they have been duplicated.

*SAME
The previous SETMEDBRM specification for this value, if any, is to remain in effect.
*NO
Do not mark volumes for duplication.
*YES
Mark volumes for duplication.
Top

Mark history for duplication (MARKHST)

Specifies whether to mark the history items for duplication after they have been duplicated.

*SAME
The previous SETMEDBRM specification for this value, if any, is to remain in effect.
*NO
Do not mark the history items for duplication.
*YES
Mark the history items for duplication.
Top

Text (TEXT)

Specifies the text that briefly describes the data being written. This text can be displayed in the BRMS media inventory.

*SAME
The previous SETMEDBRM specification for this value, if any, is to remain in effect.
*NONE
No text is specified.
text
Specify no more than 50 characters of text, enclosed in apostrophes.
Top

Examples

Example 1: Using Input Controls

SETMEDBRM LABEL(*ANY 1) ALWCNV(*YES)

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.

Example 2: Using Output Controls

SETMEDBRM MEDCLS(QIC1000) MOVPCY(OFFSITE) RET(*DATE '3/3/03')

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.

Top

Error messages

*ESCAPE Messages

BRM1917
Feature not installed.
BRM1921
Feature not licensed.
BRM4040
Access denied for user &1.
BRM40A2
BRMS product initialization required.
CPF9800
All CPF98xx messages could be signaled. xx is from 01 to FF.
Top