Add Media Information to BRM (ADDMEDIBRM)

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

The Add Media Information to BRM (ADDMEDIBRM) command adds file level detail to the BRMS media inventory content volume information.

The files, and the volumes that contain them can be from another tape inventory or from some other outside source.

The purpose of the command is to allow user applications or another volume management system to insert data (volume file descriptions) into the BRMS media contents information so that the volumes and their contents can be managed.

Multiple volumes will write a media information record for each volume with the volume sequence being increased as the records are added.

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

Restrictions:

  1. You can only add media content information to an expired volume.
  2. This command adds records to the BRMS media content information file based on the information you supply, particularly in regard to file sequence, volume and so on. It is critical that you are careful to apply the correct information and have a full understanding of the command before you use it.
  3. The volume for which you are adding content information must exist in the media inventory and the volume, file sequence and volume sequence must be unique in the BRMS media inventory contents information.
  4. You can specify only one virtual tape device for the Device (DEV) parameter.
Top

Parameters

Keyword Description Choices Notes
VOL Volume Values (up to 300 repetitions): Character value Required, Positional 1
VOLSEQ Volume sequence 1-9999 Required, Positional 2
SEQNBR Sequence number 1-16777215 Required, Positional 3
LABEL File label Character value, *TYPE Optional, Positional 4
TYPE Type *LIB, *ALLDLO, *LINK, *QHST, *SAVCFG, *SAVSECDTA, *SAVSYS Optional, Positional 5
LIB Library Name Optional
LNKLIST Link list Name, *LINK Optional
FILE File origin *FILE, *SAV, *SAVCFG, *SAVCHG, *SAVCHGOBJ, *SAVCHGDLO, *SAVDLO, *SAVLIB, *SAVOBJ, *SAVSECDTA, *SAVSYS Optional
INCTYPE Incremental type *CUML, *INCR Optional
CRTDATE Entry date Date, *CURRENT Optional
CRTTIME Entry time Time, *CURRENT Optional
EXPDATE Expiration date Character value, *PERM Optional
DEV Device Single values: *NONE
Other values (up to 4 repetitions): Name
Optional
STRVOL Beginning volume Character value, *VOL Optional
ASP Auxiliary storage pool 1-255, *SYSTEM Optional
ASPDEV Auxiliary storage pool device Name, *NONE Optional
FLR Folder Character value, *ANY Optional
OBJSAV Objects saved 1-999999, 1 Optional
OBJNOTSAV Objects not saved 0-999999, 0 Optional
CTLGRP Control group Name, *NONE, *ARCGRP, *BKUGRP, *SYSGRP, *SYSTEM Optional
RCDFMT Record format U, F, V, *NONE Optional
RCDLEN Record length 0-32760, 0 Optional
BLKLEN Block length 0-32760, 32760 Optional
BLKCNT Block count 0-999999, 1 Optional
TEXT Text Character value, *NONE Optional
Top

Volume (VOL)

Specifies the volume identifier or identifiers of the volume or volumes that contain the file that is being added to the BRMS media inventory contents information. Volumes must be enrolled in the BRMS media inventory. A maximum of 300 volumes can be specified here.

This is a required parameter.

volume-identifier
Specify the identifier of the volume that contains the file being added to the BRMS media inventory contents information. The volume identifier is a maximum of six characters in length. The volume must already exists in the BRMS media inventory.
Top

Volume sequence (VOLSEQ)

Specifies the sequence number of the volume that contains the file that you are adding to the BRMS media inventory contents information. The volume sequence number is the sequence number of the volume that contains the beginning of the file that you are adding. If you specify a volume sequence other than 1 in the Volume sequence (VOLSEQ) parameter, you must specify the beginning volume of the media set in the Beginning volume (STRVOL) parameter. If you specify a 1 in the Volume sequence (VOLSEQ) parameter, the volume specified in the Volume (VOL) parameter must match the volume specified in the Beginning volume (STRVOL) parameter or be *VOL.

This is a required parameter.

Top

Sequence number (SEQNBR)

Specifies the sequence number of the file that you are adding to the media inventory. The sequence number is the file sequence of the file on the volume that you are adding.

This is a required parameter.

Top

File label (LABEL)

Specifies the label for the file that you are adding to the media content information.

*TYPE
The label of the file is used.
label-identifier
Specify the label identifier for the file.
Top

Type (TYPE)

Specifies the special value associated with the file that you are adding to the BRMS media content information.

*LIB
The type of information that you are adding is library information. If you specify *LIB for the Type (TYPE) parameter, you must specify a library name in the Library (LIB) parameter.
*ALLDLO
The type of information that you are adding is document library information.
*LINK
The type of information that you are adding is integrated file system object information.
*QHST
The type of information that you are adding is history information.
*SAVCFG
The type of information that you are adding is configuration information.
*SAVSECDTA
The type of information that you are adding is security information.
*SAVSYS
The type of information that you are adding is system save information.
Top

Library (LIBRARY)

Specifies the library name of the library whose content information you are adding to the BRMS media content information. This parameter is required when *LIB is specified in the Type (TYPE) parameter.

Top

Link list (LNKLIST)

Specifies the link list name to be associated with the integrated file system object information that you are adding to the BRMS media content information.

*LINK
Specifies that the entry created is associated with the *LINK type save used in a control group.
list-name
Specifies the list name that the entry created is associated with.

Note: The list name that you specify is shown as the backup item name when working with media information.

Top

File origin (FILE)

Specifies the operation that was used to create the file that you are adding to the media information file.

*FILE
The file that you are adding was not created using a save operation.
*SAV
The file that you are adding to the BRMS media inventory contents information was created using a Save Object (SAV) command.
*SAVCFG
The file that you are adding to the BRMS media inventory contents information was created using a Save Configuration ( SAVCFG) command.
*SAVCHG
The file that you are adding to the BRMS media inventory contents information was created using a SAV command with a selected reference date and time.
*SAVCHGDLO
The file that you are adding to the BRMS media inventory contents information was created using a SAVDLO command with a selected reference date and time.
*SAVCHGOBJ
The file that you are adding to the BRMS media inventory contents information was created using a Save Changed Objects (SAVCHGOBJ) command.
*SAVDLO
The file that you are adding to the BRMS media inventory contents information was created using a Save Document Library Object (SAVDLO) command.
*SAVLIB
The file that you are adding to the BRMS media inventory contents information was created using a Save Library (SAVLIB) command.
*SAVOBJ
The file that you are adding to the BRMS media inventory contents information was created using a Save Object (SAVOBJ) command.
*SAVSECDTA
The file that you are adding to the BRMS media inventory contents information was created using a Save Security Data (SAVSECDTA) command.
*SAVSYS
The file that you are adding to the BRMS media inventory contents information was created using a Save System (SAVSYS) command.
Top

Incremental type (INCTYPE)

Specifies the type of incremental save for the content information that you are adding to the BRMS media content information.

*CUML
Only save items that have changed. *CUML indicates that the incremental save includes all objects that have been changed since the last full save.
*INCR
Only save changed items. *INCR indicates that the incremental save includes all objects that have been changed since the last incremental save.
Top

Entry date (CRTDATE)

Specifies the date the file was created. Dates are entered in job date format with or without date separators.

*CURRENT
The date the file was saved is the current date of the system.
entry-date
Specify the date that the file was saved.
Top

Entry time (CRTTIME)

Specifies the time that each file was created. Time is expressed in the hhmmss format where hh = hours, mm = minutes, and ss = seconds.

*CURRENT
The time the file was saved is the current time of the system.
entry-time
Specify the time the file was saved.
Top

Expiration date (EXPDATE)

Specifies the expiration date of the file that is added to the media content information. If a date is specified, the file is protected and cannot be overwritten until the expiration date has passed. Dates are entered in job date format with or without date separators.

*PERM
The file has a permanent retention and cannot be used.
*VER nnn
Specify the number of versions that are kept in the BRMS media inventory contents information. For instance, *VER 003 indicates that three versions of the save item are kept. When the fourth version of the save item is created, the earliest version is removed and replaced by the fourth version of the save.

Note: *VER 003 is not the version number. It is the number of versions as specified in the media policy.

expiration-date
Specify the date when protection for the file ends.
Top

Device (DEV)

Specifies the name of the device or devices which were used to create the file.

Single values

*NONE
No devices are to be associated with the file that you are adding to the BRMS media inventory contents information.

Other values (up to 4 repetitions)

device-name
Specify the name of the device that you want to associate with the file that you are adding to the BRMS media inventory contents information.
Top

Beginning volume (STRVOL)

Specifies the beginning volume of the media set that contains the file that you are adding to the media information. For instance if you had a 3 volume media set, T00001, T00002 and T00003 and you were adding the fourth file in the media set (which is on T00002), the value in the Volume (VOL) parameter would be T00002, the value in the Sequence number (SEQNBR) parameter would be 4, the Volume sequence (VOLSEQ) parameter would be 2 and the Beginning volume (STRVOL) parameter would be T00001.

*VOL
The first volume specified in the Volume list is the beginning volume. This can only be true when the Volume sequence is equal to 1.
volume-identifier
Specify the volume identifier that is the beginning volume for the media set that contains the file that you are adding to the BRMS media inventory contents information.
Top

Auxiliary storage pool (ASP)

Specifies the auxiliary storage pool number for the file that you are adding to the media content information.

*SYSTEM
The content information you are adding was saved from the system (1) auxiliary storage pool.
auxiliary-storage-pool-number
The content information you are adding was saved from the auxiliary storage pool identified by this number.

Note: The auxiliary storage pool number must be less than 33 if a value of *ALLDLO or *SAVCAL is specified for the Type (TYPE) parameter.

Top

Auxiliary storage pool device (ASPDEV)

Specifies the auxiliary storage pool device for the file that you are adding to the media content information.

*NONE
The content information you are adding was saved from the system (1) or a basic user (2-32) auxiliary storage pool. *NONE must be specified if the value for ASP is *SYSTEM or 1-32.
auxiliary-storage-pool-name
The content information you are adding was saved from the auxiliary storage pool device identified by this name. An auxiliary storage pool device name must be specified if the value for ASP is 33-255.
Top

Folder (FLR)

Specifies the name of the folder that is associated with the file that you are adding to the BRMS media inventory contents information. The Folder (FLR) parameter is associated with values that are specified in the Library (LIB) parameter and the File origin (FILE) parameter. If you specify *ALLDLO or QDOC in the Library (LIB) parameter, the value *ANY is defaulted in the Folder (FLR) parameter. If you specify SAVDLO or SAVCHGDLO on the File origin (FILE)parameter, you must specify either QDOC or *ALLDLO on the Library (LIB) parameter. The Folder (FLR) parameter defaults to *ANY.

*ANY
The file that you are adding to the media content information can contain any folder.
folder-name
Specify the name of the folder for the file that you are adding to the media content information.
Top

Objects saved (OBJSAV)

Specifies the number of objects saved for the file that you are adding to the media content information.

1
The number of saved objects is one.
number-of-objects-saved
Specify the number of objects saved.
Top

Objects not saved (OBJNOTSAV)

Specifies the number of objects that were not saved for the file that you are adding to the media content information.

0
The number of objects not saved is zero.
number-of-objects-not-saved
Specify the number of objects that were not saved.
Top

Control group (CTLGRP)

Specifies the control group with which you want to associate the file that you are adding to the media content information.

*NONE
You do not want to associate the file that you are adding to the media content information with a control group.
*ARCGRP
You want to associate the file that you are adding to the media content information with the archive control group.

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

*BKUGRP
You want to associate the file that you are adding to the media content information with the backup user data control group.
*SYSGRP
You want to associate the file that you are adding to the media content information with the system data control group.
*SYSTEM
You want to associate the file that you are adding to the media content information with the backup entire system control group.
control-group-name
Specify a control group name that you have defined to associate with the file that you are adding.
Top

Record format (RCDFMT)

Specifies the record format for the file that you are adding to the media content information.

U
The record format is undefined for the file that you are adding to the media content information.
F
The record format is fixed length records for the file that you are adding to the media content information.
V
The record format is variable length records for the file that you are adding to the media content information.
*NONE
There is no record format associated with the file that you are adding to the media content information.
Top

Record length (RCDLEN)

Specifies the record length of the file.

0
The record length is zero.
record-length
Specify the record length of the record in the file.
Top

Block length (BLKLEN)

Specifies the number of bytes in each block.

32760
The block length is 32760 bytes.
block-length
Specify the block length for this file.
Top

Block count (BLKCNT)

Specifies the number of blocks.

1
The block count is one.
block-count
Specify the block count for this file.
Top

Text (TEXT)

Specifies text information about the file that you are adding to the media content information.

*NONE
No text is specified for the media content.
text
Specify the text that describes the media content.
Top

Examples

Example 1: Adding Contents to a Volume

ADDMEDIBRM TYPE(*ALLDLO) VOL(T00001)
           SEQNBR(1) VOLSEQ(1)

This command adds an entry in the media inventory content information for volume T00001. The volume's contents are updated to show that a save of the document library resides as file sequence number 1 on the first volume.

Top

Error messages

*ESCAPE Messages

BRM1917
Feature not installed.
BRM1921
Feature not licensed.
BRM40A2
BRMS product initialization required.
CPF9800
All CPF98xx messages could be signaled. xx is from 01 to FF.
Top