Save Object using BRM (SAVBRM)

The Save Object using BRM (SAVBRM) command saves a copy of one or more objects that can be used in the integrated file system.

For more information about integrated file system commands, see the Integrated File System Introduction book.

Virtual tape 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 iSeries, 5722-BR1, licensed program installed.

Restrictions:

The SAVBRM command does not support optical files.
You cannot save QSYS and QDLS file systems using this command.
You must have authority to the SAV commands to use this command.
You must have *USE authority to any auxiliary storage pool device specified for the Auxiliary storage pool (ASPDEV) parameter.
This command should not be used by control group *EXIT item processing as results will be unpredictable.
For additional restrictions when using this command to save objects by using name patterns in the root directory, to save objects in libraries, or to save document library objects, see the Save Object (SAV) command in Backup and Recovery book.

You can save data to a Tivoli Storage Manager (TSM) server using this command. To save data to a TSM server, the following conditions must be met:

Only user data can be saved to TSM servers. BRMS does not allow *IBM type libraries to be saved TSM servers. Also, BRMS does not allows IBM supplied libraries that are considered user data such as QGPL, QUSRBRM, or QUSRSYS libraries to be saved TSM media.
You can only specify only one device for the Device (DEV) parameter and this device must be of category *NET or *APPC.
You can specify DEV(*MEDCLS) with the Location (LOC) parameter to identify the *NET or *APPC category device to be used.
You can specify a media policy name for the Media policy (MEDPCY) parameter if the media policy uses specifies *ADSM (TSM server) for the Media class attribute. Alternately you can specify MEDPCY(*NONE) in which can you must also specify *ADSM for the Media class (MEDCLS), Move policy (MOVPCY) and Secure volume (VOLSEC) parameters.
The Sequence number (SEQNBR) parameter must be *END.
The Save to save file (SAVF), Mark volumes for duplication (MARKDUP) and Mark history for duplication (MARKHST) parameters must be *NO. If *MEDPCY is specified for these parameters, then the respective value for the Save to save file attribute, Mark volumes for duplication attribute and Mark history for duplication attribute of the media policy specified by the Media policy (MEDPCY) parameter must be *NO.
The Required volumes (MINVOL) parameter must be *NONE. If SAVF(*MEDPCY) is specified then the value for the Required volumes attribute of the media policy specified by the Media policy (MEDPCY) parameter must be *NONE.
If *SYNCLIB is specified for the Save active (SAVACT) parameter each library is saved individually rather than as a group. Synchronization messages are therefore sent individually for each library rather than for the libraries as a group and synchronization is only within one library, not across libraries.

Parameters

Keyword	Description	Choices	Notes
CTLGRP	Control group	Name, NONE, ARCGRP, BKUGRP, SYSGRP, *SYSTEM	Optional
CTLGRPATR	Use control group attributes	NO, YES	Optional
DEV	Device	Single values: NONE Other values (up to 4 repetitions): Name, MEDCLS	Optional, Positional 1
PRLRSC	Parallel device resources	Element list	Optional
	Element 1: Minimum resources	1-32, NONE, AVAIL
	Element 2: Maximum resources	1-32, MIN, AVAIL
MEDPCY	Media policy	Name, SYSPCY, NONE	Optional, Positional 2
OBJ	Objects	Values (up to 300 repetitions): Element list	Optional
	Element 1: Name	Path name, *
	Element 2: Include or omit	INCLUDE, OMIT
SUBTREE	Directory subtree	ALL, DIR, NONE, OBJ	Optional
SAVACT	Save active	NO, SYNC, *YES	Optional
SAVACTOPT	Save active option	NONE, ALWCKPWRT	Optional
SAVACTMSGQ	Save active message queue	Qualified object name	Optional
	Qualifier 1: Save active message queue	Name, NONE, WRKSTN
	Qualifier 2: Library	Name, LIBL, CURLIB
USEOPTBLK	Use optimum block size	BKUPCY, DEV, NO, YES	Optional
SAVTYPE	Type of save	FULL, CUML, *INCR	Optional
ENDOPT	End of tape option	REWIND, LEAVE, *UNLOAD	Optional
SEQNBR	Sequence number	1-16777215, *END	Optional
TGTRLS	Target release	Character value, *CURRENT	Optional
CLEAR	Clear	NONE, AFTER, *ALL	Optional
PRECHK	Object pre-check	NO, YES	Optional
DTACPR	Data compression	DEV, NO, *YES	Optional
COMPACT	Data compaction	DEV, NO	Optional
REFDATE	Reference date	Character value, *REF	Optional
REFTIME	Reference time	Character value, *REF	Optional
EXPDATE	Expiration date	Date, MEDPCY, PERM	Optional
MOVPCY	Move policy	Name, MEDPCY, ADSM, *NONE	Optional
MEDCLS	Media class	Character value, MEDPCY, ADSM, *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, ADSM, 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
PKGID	Package identifier	NEW, PRVSAV	Optional
RCYEXITPGM	Recovery exit program	Qualified object name	Optional
	Qualifier 1: Recovery exit program	Name, *NONE
	Qualifier 2: Library	Name
RCYEXITDTA	Recovery exit program data	Character value, *NONE	Optional

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.

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.

If CTLGRPATR(*YES) is specified, then the control group must be an existing BRMS control group. If CTRLGRPATR(*NO) is specified, then you can specify an existing control group name, or a name that you want to be associated with the save operation, even if the name is not an existing control group.

Use control group attributes

Specifies whether to use control group attributes for device, parallel device resources, media policy, save type, optimum block, sequence number, target release, clear, pre-check object, compression, compaction, reference date and time, and expiration date from the control group specified in the control group (CTLGRP) parameter.

The control group must be an existing BRMS backup control group.

Media policies using versioning cannot be used with the value *YES.

*NO: Values will not be used from the specified control group. Values for device and media policy are required.
*YES: Values will be used from the specified control group.

Device (DEV)

Specifies the device or devices to be used by this command.

Single values

*MEDCLS: Devices for this policy or control group are selected based on device types that support the density for the media class specified in the media policy. The *MEDCLS special value is used for devices that are part of a device pool, such as several systems that share a single or set of devices. Devices are specified in the Work with Devices display.

Note: If you want to use more than one device for a serial save operation, the *MEDCLS can be repeated up to four times, once for each device used, except for virtual tape devices which is limited to a single value. The Parallel Device Resource (PRLRSC) parameter must be *NONE. BRMS will attempt to use the maximum number of devices that can be allocated for a save operation. If you want to use more than one device for a parallel save operation the *MEDCLS must only be specified once and the PRLRSC minimum and maximum responses must be greater than one.

Other values (up to 4 repetitions)

Specifies the name of the devices to be used for the save operation. the specified device name must already be in the BRMS device table.

You can enter multiple values for this parameter. If you are on an entry display and you need additional entry fields to enter these multiple values, type a plus sign (+) in the entry field opposite the phrase "+ for more" and press the Enter key.

Note: Multiple systems can share the use of a tape device or a media library device (MLB). When the device is a tape device (not an MLB device), BRMS can help you manage the use of the stand alone device by multiple systems if you indicate the device is shared.

You can save data to a TSM (ADSM) server using this command. You can only specify one TSM type server in the list of devices or *MEDCLS, which must select a TSM server. The device type can either be *APPC, which supports SNA network protocol, or *NET, which supports TCPIP protocol.

*NONE: There is no device for this save operation. Save files are used to store the saved data. Data in a save file created with device *NONE will never be copied by BRMS. It is intended for online access only.
device-name: Specify the names of one or more devices used for the save operation. If you are using more than one device (up to a maximum of four), specify the names of the devices in the order in which they are used.
Note: When doing a serial save, only one media library device or one virtual tape device can be specified. When doing a parallel save, multiple media library devices or virtual tape devices can be specified.

If CTLGRPATR(*YES) is specified, this parameter cannot be specified. The value for this parameter will be determined from the attributes of the control group specified on the CTLGRP parameter.

Parallel device resources (PRLRSC)

Specifies the minimum and maximum number of device resources to be used in a parallel save operation.

Note: Transferring save files to tape does not support parallel operations.

Element 1: Minimum Resources

Specifies the minimum number of device resources required for a parallel save.

Note: If a Media Library Device (MLB) is being used and the required resources are not available, the command will wait for the MLB to become available for a time period specified by the user. The wait time is determined by the value specified on the *MLB device description for INLMNTWAIT. If a *TAP device is being used and the required resources are not available, the command will fail.

*NONE: No device resources are to be used. The save will be performed as a serial save. *NONE must be specified when using a TSM or virtual tape device.
*AVAIL: Use any available devices up to the maximum of what was used for a save. Specifying this value for the minimum will allow BRMS to use any available resources, but will complete using one resource if only one is available at the start of the command.
1-32: Specify the minimum number of device resources to be used with this save command.

Element 2: Maximum Resources

Specifies the maximum number of device resources.

*MIN: Uses the value specified for the minimum number of device resources.
*AVAIL: Use any available devices for the save operation. Specifying this value for the maximum will allow BRMS to use any available resources but at a minimum the value specified in the minimum element.
1-32: Specify the maximum number of device resources to be used with this save command.

If CTLGRPATR(*YES) is specified, this parameter cannot be specified. The value for this parameter will be determined from the attributes of the control group specified on the CTLGRP parameter.

Saves using multiple parallel device resources with a target release prior to V5R4M0 will be performed using only a single device resource.

Media policy (MEDPCY)

Specifies the media policy that you want to use with this save command.

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.

*SYSPCY: The media policy specified in the system policy is assigned to output volumes from this save operation.
*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.
Note: If you specify *NONE, and you are saving data to a TSM (ADSM) server, you must specify the *ADSM special value in the MOVPCY, MEDCLS and VOLSEC parameters which are part of the media policy values for this save operation. You must still supply the additional media policy values for the remaining parameters with *MEDPCY as the default. The TSM management class STANDARD, and the TSM node *LCL, are used as default values for the save operation.
media-policy: Specify the name of the media policy that you want to use with this save operation.

If CTLGRPATR(*YES) is specified, this parameter cannot be specified. The value for this parameter will be determined from the attributes of the control group specified on the CTLGRP parameter.

Objects (OBJ)

Specifies the objects that you want to include or exclude from a list of objects you want to save. A maximum of 300 object name patterns can be specified.

For more information on specifying path names, refer to Chapter 2 of the Command Language Reference book.

Additional information about object name patterns is in the Integrated File System Introduction book.

Element 1: Name

'*'

The objects in the current directory are saved.

'object-path-name-pattern'

Specify an object path name or a pattern that can match many names.

Restriction:

You cannot list QDLS or QSYS.LIB objects in a link list. Use the appropriate *OBJ or *FLR list for objects in these file systems.

Element 2: Omit or include

The second part specifies whether names that match the pattern should be included or omitted from the operation. Note that in determining whether a name matches a pattern, relative name patterns are always treated as relative to the current working directory. The Directory subtree (SUBTREE) parameter determines whether the subtrees are included or omitted.

*INCLUDE: Objects that match the object name pattern are to be saved, unless overridden by an *OMIT specification.
*OMIT: Objects matching the object name pattern are not to be saved. This overrides a *INCLUDE specification and is intended to be used to omit a subset of a previously selected pattern.

Directory subtree (SUBTREE)

Specifies whether directory subtrees are included in the save operation.

*ALL: The entire subtree for each directory that matches the object name pattern is included. The subtree includes all subdirectories and the objects within those subdirectories.
*DIR: Objects in the first level of each directory that matches the object name pattern are included. The subdirectories of each matching directory are included, but the objects in the subdirectories are not included.
*NONE: No subtrees are included in the save operation. If a directory matches the object name pattern specified, the objects in the directory are included. If the directory has subdirectories, neither the subdirectories nor the objects in the subdirectories are included.
*OBJ: Only the objects that exactly match the object name pattern will be processed. If the object name pattern specifies a directory, objects in the directory are not included.

Save active (SAVACT)

Specifies whether an object can be updated while it is being saved.

Note: If your system is in a restricted state, this parameter is ignored and the save operation is performed as if SAVACT(*NO) was specified.

Note: If you are using the MONSWABRM command as part of an *EXIT special operation in a control group, the Save while active field must have a value of *YES for the entry that you want to save while active. The Monitor Save While Active (MONSWABRM) command reviews the save while active message queue and looks for the message indicating the end of synchronization. When synchronization is detected, you can issue a command to the system.

*NO: Objects that are not in use are not saved. Objects cannot be updated while being saved.
*SYNC: Objects can be saved and used at the same time. All of the object checkpoints occur at the same time.
*YES: Objects can be saved and used at the same time. The object checkpoints can occur at different times.

Save active message queue (SAVACTMSGQ)

Specifies the message queue that the save operation uses to notify the user that the checkpoint processing is complete.

This parameter can be used to save the objects at a known, consistent boundary to avoid additional recovery procedures following a restore operation. Applications can be stopped until the checkpoint processing complete message is received.

Qualifier 1: Save active message queue

*NONE: No notification message is sent.
*WRKSTN: The notification message is sent to the work station message queue.
message-queue-name: Specify the name of the message queue that the notification message is sent to.

Qualifier 2: Library

*LIBL: The library list is used to locate the message queue.
*CURLIB: The current library for the job is used to locate the message queue. If no library is specified as the current library for the job, the QGPL library is used.
library-name: Specify the name of the library where the message queue is located.

Use optimum block size (USEOPTBLK)

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

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

If CTLGRPATR(*YES) is specified, this parameter cannot be specified. The value for this parameter will be determined from the attributes of the control group specified on the CTLGRP parameter.

End of tape option (ENDOPT)

Specifies, when tape is used, what positioning operation is automatically done on the 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.

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.

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.

If CTLGRPATR(*YES) is specified, this parameter cannot be specified. The value for this parameter will be determined from the attributes of the control group specified on the CTLGRP parameter.

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.

If CTLGRPATR(*YES) is specified, this parameter cannot be specified. The value for this parameter will be determined from the attributes of the control group specified on the CTLGRP parameter.

Saves using a target release prior to V5R4M0 with multiple parallel device resources will be performed using only a single device resource.

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.

If CTLGRPATR(*YES) is specified, this parameter cannot be specified. The value for this parameter will be determined from the attributes of the control group specified on the CTLGRP parameter.

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.

If CTLGRPATR(*YES) is specified, this parameter cannot be specified. The value for this parameter will be determined from the attributes of the control group specified on the CTLGRP parameter.

Data compaction (COMPACT)

Specifies whether data compaction is performed.

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

If CTLGRPATR(*YES) is specified, this parameter cannot be specified. The value for this parameter will be determined from the attributes of the control group specified on the CTLGRP parameter.

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.