Save Media Info using BRM (SAVMEDIBRM)

Where allowed to run: All environments (*ALL)
Threadsafe: No

The Save Media Info using BRM (SAVMEDIBRM) command saves a copy of the information required to perform recovery of items saved using BRMS. Media information can be saved at the object or library level.

Virtual media and devices can be used with this command. The following restrictions apply to the use of virtual media and virtual devices.

The Device (DEV) parameter is limited on only one device or *MEDCLS special value for serial operations.
Execute authority is required to the Load or Unload Image Catalog (LODIMGCLG) command.
*CHANGE authority is required to the image catalogs.
Execute (*X) authority is required to each directory in the image catalog path name.
Read, write, execute (*RWX) authority is required to each image file in the parent directory that will be loaded or mounted.
*USE authority is required to the virtual devices using the image catalogs.

To use this command, you must have the Backup Recovery and Media Services for IBM i licensed program installed.

Restrictions:

You must have authority to the SAVOBJ command to use this command.
This command should not be used by control group *EXIT item processing as results will be unpredictable.

You can save data to an optical device using this command. The following restrictions apply when using optical devices.

You can specify only one Device (DEV) parameter.
For the End of media (ENDOPT)parameter, *UNLOAD is the only special value supported, *REWIND and *LEAVE will be ignored.
BRMS will generate and store a unique path name for the optical file to be used on the save operation beginning with the root directory of the optical volume.

Top

Parameters

Keyword	Description	Choices	Notes
DEV	Device	Single values: NONE Other values (up to 4 repetitions): Name, MEDCLS	Required, Positional 1
MEDPCY	Media policy	Name, NONE, SYSPCY	Required, Positional 2
OPTION	Option	LIB, OBJ	Optional
CTLGRP	Control group	Name, NONE, ARCGRP, BKUGRP, SYSGRP, *SYSTEM	Optional
ENDOPT	End of media option	REWIND, LEAVE, *UNLOAD	Optional
USEOPTBLK	Use optimum block size	BKUPCY, DEV, NO, YES	Optional
SEQNBR	Sequence number	1-16777215, *END	Optional
TGTRLS	Target release	Character value, *CURRENT	Optional
CLEAR	Clear	NONE, AFTER, *ALL	Optional
ACCPTH	Save access paths	SYSVAL, NO, *YES	Optional
DTACPR	Data compression	DEV, NO, *YES	Optional
COMPACT	Data compaction	DEV, NO	Optional
EXPDATE	Expiration date	Date, MEDPCY, PERM	Optional
MOVPCY	Move policy	Name, MEDPCY, NONE	Optional
MEDCLS	Media class	Character value, MEDPCY, SYSPCY	Optional
LOC	Location	Name, MEDPCY, ANY, *HOME	Optional
SAVF	Save to save file	MEDPCY, NO, *YES	Optional
SAVFASP	Save file ASP	Character value, MEDPCY, SYSTEM	Optional
SAVFEXP	Retain save files	Date, MEDPCY, NONE, *PERM	Optional
MAXSTG	ASP storage limit	1-99, *MEDPCY	Optional
VOLSEC	Secure volume	MEDPCY, NO, *YES	Optional
MINVOL	Required volumes	1-9999, MEDPCY, NONE	Optional
MARKDUP	Mark volumes for duplication	MEDPCY, NO, *YES	Optional
MARKHST	Mark history for duplication	MEDPCY, NO, *YES	Optional

Top

Device (DEV)

Specifies the names of the devices used for save media information operation. Each device name must already be known on the system in the BRMS device table. If multiple devices are specified, they must use the same media classes. If more than one device is used, specify the names of the devices in the order in which they are used.

This is a required parameter.

You can enter multiple values for this parameter.

Single values

*MEDCLS: Any device that supports the media class specified in the media policy can be used for this save operation.

Other values (up to 4 repetitions)

*NONE: The save operation is to a save file.
device-name: Specify the name of the device or devices that you want to use for this save operation.

Top

Media policy (MEDPCY)

Specifies the media policy for the volumes you are creating as a result of saving media information.

Media policies are used to determine:

The type of retention to use, such as days, date or version, for media used in control group processing.
The move policy to use with this media policy.
The media class to use.
Whether or not to use save files.
The type of retention to use, such as days or date for save files created in control group processing.

The media policy you specify must be a media policy that is in the BRMS media policy table.

This a required parameter.

*NONE: No media policy is specified for this save operation. Media policy values must be supplied with the save command for each parameter that has a default of *MEDPCY.
*SYSPCY: The media policy specified in the system policy is assigned to output volumes from this save operation.
media-policy: Specify the name of the media policy that you want to use with this save operation.

Top

Option (OPTION)

Specifies whether you want to save media information at the object or library level.

*LIB: You save media information at the library level. Recovery can only be done for libraries, not individual objects in libraries.
*OBJ: You save media information at the object level. Recovery can be done for libraries, individual objects in libraries or members in physical files.

Top

Control group (CTLGRP)

Specifies the name of the control group that you want to associate with the objects saved by this command. The control group name is stored with the media information and can be used with the Control group (CTLGRP) parameter on other BRMS commands to filter the media information or recover saved objects by control group.

Note: None of the attributes of the control group are used for the save. However, the TEXT field will be updated with text of the control group entries for SAVxxxBRM commands.

If you are using version control for the items you are saving, this save operation will be recorded as part of the specified version control. Version control is specified in the media policy associated with this control group and can be reviewed by using the Work with Media Policies display.

*NONE: Do not specify a control group name for this command.
*ARCGRP: The name of the default archive control group.
Note: The BRMS Advanced feature (Option 2) is required to use this value.
*BKUGRP: The name of the default backup control group used to save all user data.
*SYSGRP: The name of the default system control group used to save all system data.
*SYSTEM: The name of the default system control group used to save the entire system.
control-group-name: Specify the name of the control group to be assigned to the items you are saving.

Top

End of media option (ENDOPT)

Specifies the operation that is automatically done on the tape or optical volume after the save operation ends. If more than one volume is included, this parameter applies only to the last volume used; all other volumes are rewound and unloaded when the end of the volume is reached.

Note: For optical devices, *UNLOAD is the only special value supported, *REWIND and *LEAVE will be ignored.

If you specify *LEAVE and the device is a shared device, the device will not be varied off after the save operation. If you specify *LEAVE and the device is not a shared device, the device will be varied off after the save operation.

*REWIND: The volume is automatically rewound, but not unloaded, after the operation has ended.
*LEAVE: The volume does not rewind or unload after the operation ends. It remains at the current position on the device.
*UNLOAD: The volume is automatically rewound and unloaded after the operation ends.

Top

Use optimum block size (USEOPTBLK)

Specifies whether or not the optimum block size is used for the save operation.

Note: This parameter is ignored if the Device (DEVICE) parameter specified is an optical device.

*BKUPCY: Use the value from the backup policy for the Use optimum block size parameter.

*DEV: Use the value specified on the Work with Devices display for the Use optimum block size parameter.

*NO: The optimum block size supported by the device is not used. Save commands use the default block size supported by all device types. The tape volume can be duplicated to any media format using the Duplicate Tape (DUPTAP) command or the Duplicate Media using BRM (DUPMEDBRM) command.

*YES

The optimum block size supported by the device is used for Save commands. If the block size used is larger than a block size that is supported by all device types then:

Performance may improve.
The tape file that is created is only compatible with a device that supports the block size used. Commands such as Duplicate Tape (DUPTAP) and Duplicate Media using BRM (DUPMEDBRM) do not duplicate files unless the files are being duplicated to a device which supports the same block size that was used.
The value for the Data Compression (DTACPR) parameter is ignored.

Top

Sequence number (SEQNBR)

Specifies, when tape is used, the sequence to use for the save operation. If you are saving to a BRMS volume that is expired, BRMS will begin writing information at the beginning of the volume, even though you have specified *END. If you are saving to a BRMS volume, BRMS will redirect the output to begin at the logical end of the output volume (after the end of the last active file), depending on the output device that you are using. For example, a 3490 device can write to any sequence number whereas a 6525 device can only write to sequence number 1 or *END.

*END: The save operation begins after the sequence number of the last active file on the volume.
file-sequence-number (1-16,777,215): Specify the sequence number of the file to be used for the save operation.

Top

Target release (TGTRLS)

Specifies the release of the operating system on which you intend to restore the objects being saved.

*CURRENT: The objects are to be restored on a system that is running the same release of the operating system currently running on your system. For example, if V5R2M0 is running on the system, *CURRENT means that you intend to restore the objects on a system with V5R2M0 installed. The objects can also be restored on a system with any subsequent release of the operating system installed.

*PRV: The objects are to be restored on a system that is running on the previous release with modification level 0 of the operating system. For example if V5R2M0 is running on your system, *PRV means you intend to restore the objects on a system with V5R1M0 installed. The object can also be restored on a system with any subsequent release of the operating system installed.
Note: Not all objects can be targeted to another release. Objects that are new to a release typically cannot be saved to a previous release.

target-release

Specify the release in the format VxRxMx, where Vx is the version, Rx is the release, and Mx is the modification level. For example, V5R2M0 is version 5, release 2, modification level 0.

The objects can be restored on a system with the specified release or with any subsequent release of the operating system installed.

Note: Not all objects can be targeted to another release. Objects that are new to a release typically cannot be saved to a previous release.

Valid values depend on the current version, release, and modification level, and they change with each new release. If you specify a release-level that is earlier than the earliest release level supported by this command, an error message is sent indicating the earliest supported release.

Top

Clear (CLEAR)

Specifies whether uncleared volumes or save files encountered during the save operation are automatically cleared.

*NONE: None of the uncleared volumes or save files encountered during the save operation are automatically cleared. If the save operation cannot proceed because an uncleared volume is encountered, an inquiry message is sent to the operator, allowing the ending of the save operation, or specifying that the currently selected volume be cleared so the operation can continue.
If a save file is not cleared, the inquiry message is sent to the work station message queue for an interactive job, or to the operator for a batch job. All volumes used to perform the save operation should be cleared, or the save file must be empty, before the save command is issued.
*AFTER: All the uncleared volumes after the initial volume are automatically cleared. This option is not valid for save or restore operations to a save file. If the operation cannot proceed because the first volume is uncleared, an inquiry message is sent to the system operator, allowing him to end the operation or to specify that the currently selected volume be cleared so the operation can continue.
*ALL: All the uncleared volumes or save files encountered during the save operation are automatically cleared. If tapes are used and a sequence number is specified, the volume is cleared and, starting with that sequence number, all volumes following the first volume are cleared.

Top

Save access paths (ACCPTH)

Specifies whether the logical file access paths that are dependent on the physical files being saved are also saved. The access paths are saved only if all members on which the access paths are built are included in this save operation. Informational messages are sent indicating the number of logical file access paths saved with each physical file. This parameter does not save logical objects; it only controls the saving of the access paths. Information on the restoring of saved access paths is in the Backup and Recovery Book.

*SYSVAL: The system value QSAVACCPTH determines whether to save the logical file access paths that are dependent on the physical files that are being saved.
*NO: Only those objects specified on the command are saved. No logical file access paths are saved.
*YES: The specified physical files and all eligible logical files access paths over them are saved.

Top

Data compression (DTACPR)

Specifies whether data compression is used.

*DEV

If the save is to tape and the target device supports compression, hardware compression is performed. Otherwise, no data compression is performed.

Note: If *DEV is specified on both the Data compression (DTACPR) parameter and the Data compaction (COMPACT) parameter, only device data compaction is performed if device data compaction is supported on the device. Otherwise, data compression is performed if supported on the device.

If *YES is specified on the Data compression (DTACPR) parameter and *DEV is specified on the Data compaction (COMPACT) parameter, both device data compaction and device data compression are performed if supported on the device.

*NO

No data compression is performed.

*YES

If the target device supports compression, hardware compression is performed. if compression is not supported, software compression is performed.

Top

Data compaction (COMPACT)

Specifies whether data compaction is performed.

Note: This parameter is ignored if the Device (DEVICE) parameter specified is an optical device.

*DEV

Device data compaction is performed if the data is saved to tape and all devices specified on the Device (DEV) parameter support the compaction feature.

*NO

No data compaction is performed.

Top

Expiration date (EXPDATE)

Specifies the expiration that you want to use for output volumes created as a result of this save operation.

*MEDPCY: The value for this parameter is specified in the media policy that is specified in the Media policy (MEDPCY) parameter of this save command.
Note: If *NONE is specified in the Media policy (MEDPCY) parameter, you cannot specify *MEDPCY in this parameter.
*PERM: Output volumes from this save operation are assigned a permanent expiration.
expiration-date: Specify an expiration date with or without date separators that will be assigned to output volumes from this save operation.

Top

Move policy (MOVPCY)

Specifies the move policy that you want to use for output volumes created as a result of this save operation.

*MEDPCY: The value for this parameter is specified in the media policy that is specified in the Media policy (MEDPCY) parameter of this save command.
Note: If *NONE is specified in the Media policy (MEDPCY) parameter, you cannot specify *MEDPCY in this parameter.
*NONE: There is not a move policy associated with the output volumes that are created as a result of this save operation.
move-policy: Specify a move policy that will be assigned to output volumes from this save operation.

Top

Media class (MEDCLS)

Specifies the media class that you want to use for selection of output volumes used in this save operation.

*MEDPCY: The value for this parameter is specified in the media policy that is specified in the Media policy (MEDPCY) parameter of this save command.
Note: If *NONE is specified in the Media policy (MEDPCY) parameter, you cannot specify *MEDPCY in this parameter.
*NONE: There is not a media class associated with the output volumes that are selected for this save operation.
*SYSPCY: The value for the media class in the system policy will used to select output volumes for this save operation.
media-class: Specify a media class that will be used to select output volumes for this save operation.

Top

Location (LOC)

Specifies the location that you want to use for selection of output volumes used in this save operation.

*MEDPCY: The value for this parameter is specified in the media policy that is specified in the Media policy (MEDPCY) parameter of this save command.
Note: If *NONE is specified in the Media policy (MEDPCY) parameter, you cannot specify *MEDPCY in this parameter.
*ANY: Volumes from any location are selected as output volumes for this save operation.
*HOME: Volumes from the home location are selected as output volumes for this save operation.
location: Specify the location from which volumes are selected as output volumes for this save operation.

Top

Save to save file (SAVF)

Specifies whether the output from this save operation is saved to a save file.

*MEDPCY: The value for this parameter is specified in the media policy that is specified in the Media policy (MEDPCY) parameter of this save command.
Note: If *NONE is specified in the Media policy (MEDPCY) parameter, you cannot specify *MEDPCY in this parameter.
*NO: Output from this save operation is not saved to a save file.
*YES: Output from this save operation is saved to a save file.

Top

Save file ASP (SAVFASP)

Specifies the system (1) or basic user auxiliary storage pool (2-32) to which a save file is created as a result of this save operation.

*MEDPCY: The value for this parameter is specified in the media policy that is specified in the Media policy (MEDPCY) parameter of this save command.
Note: If *NONE is specified in the Media policy (MEDPCY) parameter, you cannot specify *MEDPCY in this parameter.
*SYSTEM: The save file is saved to the system (1) auxiliary storage pool.
save-file-ASP-name: Specify the name of the auxiliary storage pool to which you are saving the save file.
save-file-ASP-number: Specify the system (1) or basic user auxiliary storage pool number (2-32) for the save file that is created as a result of the save operation.

Note: UDFS, primary and secondary auxiliary storage pools are not supported for this parameter.

Top

Retain save files (SAVFEXP)

Specifies how long save files are to be kept that are created as a result of this save operation.

*MEDPCY: The value for this parameter is specified in the media policy that is specified in the Media policy (MEDPCY) parameter of this save command.
Note: If *NONE is specified in the Media policy (MEDPCY) parameter, you cannot specify *MEDPCY in this parameter.
*NONE: Save files generated from the save operation are not kept.
*PERM: Save files generated from the save operation are kept permanently.
expiration-date: Specify the date that indicates how long save files created from this save operation are to be kept.

Top

ASP storage limit (MAXSTG)

Specifies the maximum percentage auxiliary storage pool (ASP) utilization that is acceptable during a save operation. For example, an entry of 90 would mean that a save process would continue until the auxiliary storage pool utilization exceeded 90%. If the upper limit is reached, the save process is stopped and a message sent to the BRMS log.

*MEDPCY: The value for this parameter is specified in the media policy that is specified in the Media policy (MEDPCY) parameter of this save command.
Note: If *NONE is specified in the Media policy (MEDPCY) parameter, you cannot specify *MEDPCY in this parameter.
storage-limit: Specify the maximum auxiliary storage pool utilization limit.

Top

Secure volume (VOLSEC)

Specifies whether you want to apply volume security to volumes in this media class. Volumes that are secured can only be read by users with the special authorities *ALLOBJ or *SAVSYS.

*MEDPCY: The value for this parameter is specified in the media policy that is specified in the Media policy (MEDPCY) parameter of this save command.
Note: If *NONE is specified in the Media policy (MEDPCY) parameter, you cannot specify *MEDPCY in this parameter.
*NO: Volume security has not been applied to this media class. Volumes that do not have volume security can be read by anyone.
*YES: Only users with special authorities *ALLOBJ or *SAVSYS can read media volumes in this media class.

Top

Require volumes (MINVOL)

Specifies the minimum number of expired volumes that must be present before any save can be done using this media policy. The value can also be checked by user jobs using the Check Expired Media for BRM (CHKEXPBRM) command.

Note: If the save operation that you are performing is saving data using media of class *ADSM (TSM server), you must specify *NONE in this parameter. If you specify MINVOL(*MEDPCY), then the value of the Required volumes field in the referenced media policy must be *NONE.

*MEDPCY: The value for this parameter is specified in the media policy that is specified in the Media policy (MEDPCY) parameter of this save command.
Note: If *NONE is specified in the Media policy (MEDPCY) parameter, you cannot specify *MEDPCY in this parameter.
*NONE: There is no check done to determine the minimum number of required volumes before a save operation begins.
number-of-volumes: Specify the number of expired media volumes that must be available before any BRMS save operation will begin. The number can range from 1 to 9999.

Top

Mark volumes for duplication (MARKDUP)

Specifies whether media volumes will be marked for duplication. When *YES is selected, all volumes used during a save operation are marked for duplication. You can use VOL(*SEARCH) on the Duplicate Media using BRM command to duplicate the saved items after the save has completed.

Note: If the save operation that you are performing is saving data using media of class *ADSM (TSM server), you must specify *NO in this parameter. If you specify MARKDUP(*MEDPCY), then the value of the Mark for duplication attribute in the referenced media policy must be *NO.

*MEDPCY: The value for this parameter is specified in the media policy that is specified in the Media policy (MEDPCY) parameter of this save command.
Note: If *NONE is specified in the Media policy (MEDPCY) parameter, you cannot specify *MEDPCY in this parameter.
*NO: Volumes written to during a save operation will not be marked for duplication.
*YES: Volumes written to during the save operation will be marked for duplication.

Top

Mark history for duplication (MARKHST)

Specifies whether history items will be marked for duplication. When *YES is selected, all history items created during a save operation are marked for duplication. You must use VOL(*SCHHST) on the Duplicate Media using BRM command to duplicate the saved items.

Note: If the save operation that you are performing is saving data using media of class *ADSM (TSM server), you must specify *NO in this parameter. If you specify MARKHST(*MEDPCY), then the value of the Mark history for duplication attribute in the referenced media policy must be *NO.

Note: This parameter is ignored if the Device (DEVICE) parameter specified is an optical device.

*MEDPCY: The value for this parameter is specified in the media policy that is specified in the Media policy (MEDPCY) parameter of this save command.
Note: If *NONE is specified in the Media policy (MEDPCY) parameter, you cannot specify *MEDPCY in this parameter.
*NO: History items created during the save operation will not be marked for duplication.
*YES: History items created during the save operation will be marked for duplication.

Top

Examples

Example 1: Saving Media Information for a Control Group

SAVMEDIBRM DEV(*MEDCLS) MEDPCY(FULL) OPTION(*OBJ) CTLGRP(CG01)

This command saves object level information for control group CG01. The recovery information can be written to any device that supports the media class specified in the media policy FULL.

Example 2: Saving Media Information and Access Paths

SAVMEDIBRM DEV(*MEDCLS) MEDPCY(FULL) OPTION(*OBJ) ACCPTH(*YES)

This command saves all BRMS object level recovery information including access paths to any device that supports the media class specified in the media policy FULL.

Top

Error messages

*ESCAPE Messages

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

Top