Save Folder List using BRM (SAVFLRLBRM)

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

The Save Folder List using BRM (SAVFLRLBRM) command saves backup or archive folder lists. Folder lists are groups of folders that you select to include in a user-defined list name. Various parameters are used to further define the save folder list process to BRMS.

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

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

Restrictions:

  1. You must have authority to the SAVDLO command to use this command.
  2. You must have *ALLOBJ or *SAVSYS special authority to use this command. Users that do not have *ALLOBJ or *SAVSYS special authority must:
    • Have *ALL authority for the documents and folder to be saved.
    • Be enrolled as Document Interchange Architecture (DIA) users.
  3. This command cannot be used while another job is running commands such as RCLDLO, SAVDLO, SAVDLOBRM, RSTDLO and RSTDLOBRM because exclusive use of internal objects may have been obtained by these commands.
  4. This command should not be used by control group *EXIT item processing as results will be unpredictable.

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:

Top

Parameters

Keyword Description Choices Notes
FLRL Folder list Name Required, Positional 1
DEV Device Single values: *NONE
Other values (up to 4 repetitions): Name, *MEDCLS
Required, Positional 2
MEDPCY Media policy Name, *NONE, *SYSPCY Required, Positional 3
SAVACT Save active *NO, *YES Optional
OBJDTL Retain DLO detail *NO, *YES Optional
CTLGRP Control group Name, *NONE, *ARCGRP, *BKUGRP, *SYSGRP, *SYSTEM Optional
SAVTYPE Type of save *FULL, *CUML, *INCR Optional
ENDOPT End of tape 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
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
Top

Folder list (FLRL)

Specifies the name of the folder list that you want to save. Lists are groups of folders that you want to save together. Lists are added, changed or displayed using the Work with Lists using BRM (WRKLBRM) command.

This is a required parameter.

Top

Device (DEV)

*MEDCLS
Devices for this command 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.

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

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.

This is a required parameter.

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.

Single values

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

Other values

*NONE
There is no device for this save operation. Save files are used to store the saved data.
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: Only one media library device or one virtual tape device can be specified.

Top

Media policy (MEDPCY)

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

Media policies are used to determine:

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

Save active (SAVACT)

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

*NO
Document library objects in use are not saved. Document library objects cannot be updated while being used.
*YES
Document library objects can be changed during the save request. Objects that are in use but are not using application recovery will not be saved. See the Backup and Recovery Bookfor more information on DLOs, saving while an object is in use, and application recovery.
Top

Retain DLO detail (OBJDTL)

You can specify whether the Document Library Object (DLO) detail is kept in the BRMS database for the DLO's saved.

*NO
DLO detail is not kept in the BRMS backup history.
*YES
DLO detail is kept in the BRMS backup history.
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.
Top

Type of save (SAVTYPE)

The Type of save parameter allows you to specify whether all documents in a folder are to be saved or only those documents that have changed.

*FULL
Save all documents in the list.
*CUML
Save only changed documents since the last full save. *CUML indicates that the incremental save includes all documents created or changed and all folders created since the last full save, and all mail.
*INCR
You only want to save changed documents. *INCR indicates that the incremental save includes all documents created or changed and all folders created since the last incremental save, and all mail.
Top

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.

Note: If no objects are saved the volume is not opened and the ENDOPT parameter is 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 rewound, but not unloaded.
*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 save operation ends.
Top

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

Data compression (DTACPR)

Specifies whether data compression is used.

*DEV
If the device has the hardware compression feature installed, processing proceeds as if DTACPR(*YES) is specified. If the compression feature is not installed or save data is written to a save file, processing proceeds as if DTACPR(*NO) is specified.

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 save is to tape and the target device supports compression, hardware compression is performed. If device compression is not supported, or if the save data is written to a save file, software compression is performed. If the save is running while other jobs on the system are active and software compression is used, the overall system performance can be affected.
Top

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.

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 compaction is performed.
Top

Reference date (REFDATE)

Works in conjunction with an incremental (save changed objects) save performed under BRMS control.

*REF
Uses the date of the last full BRMS save for this save operation as the beginning point for this incremental save.
reference-date
Specify a date for this save operation to use as a beginning point for this incremental save.
Top

Reference time (REFTIME)

Works in conjunction with an incremental (save changed objects) save performed under BRMS control.

*REF
Uses the time of the last full BRMS save for this save operation as the beginning point for this incremental save.
reference-time
Specify a time in hour, minute, second (hhmmss) format for this save operation to use as a beginning point for this incremental save.
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.

If this save operation that you are performing is saving data to a device of category *NET or *APPC, you must specify the special value *ADSM (TSM server) for the MOVPCY parameter, since a TSM server controls the use of media in this case, not BRMS.

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

*ADSM
Media movement is controlled by TSM server specifications.
*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.

If this save operation that you are performing is saving data to a device of category *NET or *APPC, you must specify the special value *ADSM (TSM server) for the MEDCLS parameter, since a TSM server controls the use of media in this case, not BRMS.

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

*ADSM
The save operation uses media that is selected and controlled by TSM server specifications.
*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.

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 SAVF(*MEDPCY), then the value of the Save to save file field 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
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.

If the save operation that you are performing is saving data to a device of category *NET or *APPC, you must specify the special value *ADSM (TSM server) for the VOLSEC parameter, since a TSM server controls volume security in this case, not BRMS

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

*ADSM
Volume security is controlled by TSM server specifications.
*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.

*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 Changed Folders in a List

SAVFLRLBRM FLRL(LISTA) DEV(TAP01 TAP02) MEDPCY(INCR) SAVTYPE(*INCR)

This command saves changed folders in folder list LISTA to tape devices TAP01 and TAP02 using media policy INCR.

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