Where allowed to run: All environments (*ALL) Threadsafe: No |
Parameters Examples Error messages |
The Save Object using BRM (SAVOBJBRM) command allows you to save individual objects or a group of objects that are in the same library.
For job queues, message queues and logical files, only the object definitions are saved, not the contents. The contents of output queues can be saved using SPLFDTA(*ALL), otherwise, only the output queue object definition is saved. The contents of save files can be saved using SAVFDTA(*YES), otherwise, only the save file object definition is saved.
The system saves the specified objects by writing a copy of each object on tape, or in a save file. The objects are not affected in the system unless the command specifies that the storage should be freed.
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:
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 |
Keyword | Description | Choices | Notes |
---|---|---|---|
LIB | Library | Name | Required, Positional 1 |
OBJ | Object | Single values: *ALL Other values (up to 50 repetitions): Generic name, name |
Required, Positional 2 |
DEV | Device | Single values: *NONE Other values (up to 4 repetitions): Name, *MEDCLS |
Required, Positional 3 |
OBJTYPE | Object type | Single values: *ALL Other values (up to 50 repetitions): Character value |
Optional |
MBR | Member | Generic name, name, *ALL | Optional |
MEDPCY | Media policy | Name, *NONE, *SYSPCY | Required, Positional 4 |
PRLRSC | Parallel device resources | Element list | Optional |
Element 1: Minimum resources | 1-32, *NONE, *AVAIL | ||
Element 2: Maximum resources | 1-32, *MIN, *AVAIL | ||
SAVACT | Save active | *NO, *LIB, *SYSDFN, *SYNCLIB | Optional |
SAVACTWAIT | Save active wait time | Element list | Optional |
Element 1: Object locks | 0-99999, 120, *NOMAX | ||
Element 2: Pending record changes | 0-99999, *LOCKWAIT, *NOMAX, *NOCMTBDY | ||
Element 3: Other pending changes | 0-99999, *LOCKWAIT, *NOMAX | ||
SAVACTMSGQ | Save active message queue | Qualified object name | Optional |
Qualifier 1: Save active message queue | Name, *NONE, *WRKSTN | ||
Qualifier 2: Library | Name, *LIBL, *CURLIB | ||
CTLGRP | Control group | Name, *NONE, *ARCGRP, *BKUGRP, *SYSGRP, *SYSTEM | 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 |
PRECHK | Object pre-check | *NO, *YES | Optional |
ACCPTH | Save access paths | *SYSVAL, *NO, *YES | Optional |
DTACPR | Data compression | *DEV, *NO, *YES | Optional |
COMPACT | Data compaction | *DEV, *NO | Optional |
SAVFDTA | Save contents of save files | *YES, *NO | Optional |
SPLFDTA | Spooled file data | *NONE, *ALL | Optional |
OBJJRN | Journaled objects | *NO, *YES | Optional |
OMITOBJ | Objects to omit | Values (up to 300 repetitions): Element list | Optional |
Element 1: Object | Qualified object name | ||
Qualifier 1: Object | Generic name, name, *NONE, *ALL | ||
Qualifier 2: Library | Generic name, name, *ALL | ||
Element 2: Object type | Character value, *ALL | ||
ASPDEV | Auxiliary storage pool | Name, *SYSBAS, *CURASPGRP | 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, *PERM, *NONE | 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 |
Specifies which library contains the objects that you want to save.
This a required parameter.
Top |
Specifies the names of one or more objects or the generic name of each group of objects to be saved. All the objects must be in the library specified on the Library (LIB) parameter. If the Object type (OBJTYPE) parameter is not specified, all the object types listed in the description of that parameter are saved, provided they are in the specified library and have the specified names.
This is a required parameter.
You can type multiple values for this parameter.
Single values
Other values (up to 50 repetitions)
Top |
Specifies the device or devices to be used by this command.
Single values
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.
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.
Note: PRLRSC must be *NONE when DEV is *NONE.
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.
Top |
Specifies the types of system objects to save. For a complete list of object types that can be saved, move the cursor to Object type (OBJTYPE) parameter and press the F4 key.
You can type multiple values for this parameter.
Single values
Other values (up to 50 repetitions)
Top |
Specifies the database file members that are saved. You can choose a specific member, a generic member name or all members. To use the Member (MBR) parameter for a member or generic member, the Object (OBJ) parameter cannot be *ALL or generic and the Object type (OBJTYPE) parameter must be *FILE.
Top |
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.
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.
Top |
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.
Element 2: Maximum Resources
Specifies the maximum number of device resources.
Top |
Specifies if an object can be updated while it is being saved.
Note: If your system is in a restricted state and the SAVACT parameter is specified, 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 library synchronization. When synchronization is detected, you can issue a command to the system.
Note: Libraries with thousands of objects may be too large for this option.
Note: Multiple checkpoints will occur when using *SYNCLIB with an incremental *ALLUSR backup item if new libraries were added to the system since the last save because synchronization is only within commands, not across libraries. New libraries are saved using Save Library (SAVLIB) command. Changed libraries are saved using the Save Changed Object (SAVCHGOBJ) command with a reference date and time that is the earliest occurance of either that last full or last incremental backup. BRMS uses its own reference dates rather than those in the object description information to protect incremental saves from being affected by native save operations.
Note: The *SYNCLIB choice cannot be used for the *IBM save type.
Note: If the libraries are being saved to save files or to TSM servers, 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.
Note: Specifying this value eliminates some size restrictions and can allow a library to be saved that could not be saved with SAVACT(*LIB).
Top |
Specifies the amount of time to wait for an object that is in use, or for transactions with pending changes to reach a commit boundary, before continuing the save operation.
Element 1: Object locks
Specifies the amount of time to wait for the object to become available for each object that is in use. If an object remains in use for the specified time, the object is not saved.
For each object that is in use, specifies the amount of time to wait for the object to become available. If an object remains in use for the specified time, the object is not saved.
Element 2: Pending record changes
For each group of objects that are checkpointed together, specifies the amount of time to wait for transactions with pending record changes to reach a commit boundary. The Save active prompt (SAVACT) parameter determines which objects are checkpointed together. If 0 is specified, all objects being saved must be at commit boundaries. If any other value is specified, all objects that are journaled to the same journals as the objects being saved must reach commit boundaries. If a commit boundary is not reached in the specified time, the save operation is ended, unless the value *NOCMTBDY is specified.
If you restore an object that was saved with pending transactions, you cannot use the object until you apply or remove journal changes (APYJRNCHG or RMVJRNCHG command) to reach commit boundaries. You will need all journal receivers that contain information about the pending transactions to apply or remove the changes. Until you apply or remove the changes, any future save of that object will include the pending transactions, even if you do not specify *NOCMTBDY.
Restrictions:
Element 3: Other pending changes
For each library, specifies the amount of time to wait for transactions with other pending changes to reach a commit boundary. Other pending changes include the following:
If a commit boundary is not reached for a library in the specified time, the library is not saved.
Top |
Specifies the message queue that the save operation uses to notify the user that the checkpoint processing for the library is complete. A separate message is sent for each library to be saved when the *SYSDFN or *LIB value is specified on the Save active (SAVACT) parameter. When the *SYNCLIB value is specified on the Save active (SAVACT) parameter, one message is sent for all libraries in the save operation.
Note: When multiple save operations are generated by BRMS, then one message is sent for each command generated.
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
Qualifier 2: Library
Restrictions: If MONSWABRM is used to monitor the save while active message queue, and LIB(*MSGQ) is specified for the MONSWABRM, the name specified here must match the name on the MSGQ parameter for the MONSWABRM command.
MONSWABRM always uses the message queue from library QUSRBRM.
Top |
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.
Note: The BRMS Advanced feature (Option 2) is required to use this value.
Top |
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.
Top |
Specifies whether or not the optimum block size is used for the save operation.
Top |
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.
Top |
Specifies the release of the operating system on which you intend to restore the objects being saved.
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.
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 |
Specifies whether uncleared volumes or save files encountered during the save operation are automatically cleared.
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.
Top |
Specifies whether the save operation ends if any of the selected objects cannot be saved.
Top |
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. All physical files on which an access path is built must be in the same library. 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.
Attention: If the based-on physical files and the logical files are in different libraries, the access paths are saved. However, if the logical files and the based-on physical files are in different libraries and the logical files or physical files do not exist at restore time (such as during disaster recovery or the files were deleted) the access paths are not restored. They are rebuilt. For the fastest possible restore operation for logical files and the based-on physical files must be in the same library and must be saved at the same time.
Top |
Specifies whether data compression is used.
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.
Top |
Specifies whether data compaction 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.
Top |
Specifies for save file objects, whether the description of a save file, or both the description and the contents of a save file, are saved on the tape or in another save file.
Top |
Specifies whether to save the spooled file data and attributes for saved output queues. The saved spooled files and attributes can be viewed after the save using the Work with Saved Spooled Files (WRKSPLFBRM) command.
Top |
This parameter is ignored for SAVOBJBRM. Since the command does not support *INCR and *CUML backup types, the OBJJRN parameter does not apply.
Top |
Specifies the objects to be excluded from the save operation. Up to 300 objects or generic object values can be specified.
If the OMITOBJ parameter is not specified, no objects are excluded from the save operation.
Element 1: Object
Qualifier 1: Object
Qualifier 2: Library
Element 2: Object type
Top |
Use this parameter to specify the auxiliary storage pools from which libraries and objects can be included in the save operation.
Top |
Specifies the expiration that you want to use for output volumes created as a result of this save operation.
Note: If *NONE is specified in the Media policy (MEDPCY) parameter, you cannot specify *MEDPCY in this parameter.
Top |
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.
Note: If *NONE is specified in the Media policy (MEDPCY) parameter, you cannot specify *MEDPCY in this parameter.
Top |
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.
Note: If *NONE is specified in the Media policy (MEDPCY) parameter, you cannot specify *MEDPCY in this parameter.
Top |
Specifies the location that you want to use for selection of output volumes used in this save operation.
Note: If *NONE is specified in the Media policy (MEDPCY) parameter, you cannot specify *MEDPCY in this parameter.
Top |
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.
Note: If *NONE is specified in the Media policy) (MEDPCY parameter, you cannot specify *MEDPCY in this parameter.
Top |
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.
Note: If *NONE is specified in the Media policy (MEDPCY) parameter, you cannot specify *MEDPCY in this parameter.
Note: UDFS, primary and secondary auxiliary storage pools are not supported for this parameter.
Top |
Specifies how long save files are to be kept that are created as a result of this save operation.
Note: If *NONE is specified in the Media policy (MEDPCY) parameter, you cannot specify *MEDPCY in this parameter.
Top |
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.
Note: If *NONE is specified in the Media policy (MEDPCY) parameter, you cannot specify *MEDPCY in this parameter.
Top |
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
Note: If *NONE is specified in the Media policy (MEDPCY) parameter, you cannot specify *MEDPCY in this parameter.
Top |
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.
Note: If *NONE is specified in the Media policy (MEDPCY) parameter, you cannot specify *MEDPCY in this parameter.
Top |
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.
Note: If *NONE is specified in the Media policy (MEDPCY) parameter, you cannot specify *MEDPCY in this parameter.
Top |
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: If *NONE is specified in the Media policy (MEDPCY) parameter, you cannot specify *MEDPCY in this parameter.
Top |
Example 1: Saving Objects of a Particular Type
SAVOBJBRM LIB(MYLIB) OBJ(AP* GLMST) DEV(TAP09) OBJTYPE(*FILE) MEDPCY(FULL)
This command saves selected file objects whose names begin with the letters 'AP' and the file object named GLMST from library MYLIB using device TAP09.
Example 2: Saving Generic Objects from a Library
SAVOBJBRM LIB(MYLIB) OBJ(DIST*) DEV(TAP09) MEDPCY(FULL)
This command saves all objects that begin with the letters 'DIST' from library MYLIB using device TAP09.
Example 3: Saving Objects of a Particular Type in Parallel
SAVOBJBRM LIB(MBALIB) OBJ(AP* GLMST) DEV(MLB01) OBJTYPE(*FILE) MEDPCY(FULL) PRLRSC(2 2)
In this example all objects are saved that begin with AP or the object called GLMST if they are object type *FILE. The objects are found in library MBALIB. They will be saved to two device resources in MLB01.
Example 4: Saving Objects of a Particular Type on an Auxiliary Storage Pool Device
SAVOBJBRM LIB(MYLIB) OBJ(AP* GLMST) DEV(TAP09) OBJTYPE(*FILE) MEDPCY(FULL) ASPDEV(PRIMETIME)
This command saves selected file objects whose names begin with the letters 'AP' and the file object named GLMST from library MYLIB which reside on auxiliary storage pool device PRIMETIME using device TAP09.
Top |
*ESCAPE Messages
Top |