Save Restore Library (SAVRSTLIB)

The Save/Restore Library (SAVRSTLIB) command allows the user to save and restore a copy of one or more libraries to another system. The system must have a supported communication link with the restoring system.

Documents and folders contained in the QDOC library can be saved and restored by using the Save/Restore Document Library Object (SAVRSTDLO) command.

The SAVRSTLIB command saves and restores the entire library; this includes the library description, the object descriptions, and the contents of the objects in the library. For job queues, message queues, and logical files, only the object definitions are saved and restored, not the contents. Logical file access paths can be saved and restored by specifying ACCPTH(*YES). The contents of a save file can be saved and restored by specifying SAVFDTA(*YES). The contents of spooled files on output queues can be saved and restored by specifying SPLFDTA(*ALL). The contents of a data queue can be saved and restored by specifying QDTA(*DTAQ).

The libraries and their objects are not affected on the system unless the command specifies that the storage is to be freed.

The types of objects saved and restored by this command are the same as those listed in the OBJTYPE parameter description in "Commonly used parameters: Expanded descriptions" in the CL concepts and reference topic in the iSeries Information Center at http://www.ibm.com/eserver/iseries/infocenter, with the addition of *DTADCT. Certain I5/OS system objects that are not contained in user libraries (such as user profiles) are not saved and restored by this command. They can be saved by the Save System (SAVSYS) or Save Security Data (SAVSECDTA) commands, and restored by using the Restore User Profile (RSTUSRPRF) command.

Restrictions:

To use this command, the user must have either the special authority *SAVSYS specified in the user profile by the SPCAUT parameter, or the user must have:
- Read authority for, or be the owner of, each library specified.
- Object existence authority for each object in the library.
If the user does not have the correct authorities for all of the libraries and objects specified, only those for which the user does have authority are saved and restored.
No library that is being saved and restored, or the objects in the library being saved and restored, can be updated by a job that is running at the time the save and restore operation occurs unless save-while-active (SAVACT) is used.
When the contents of a save file are saved and restored by specifying SAVFDTA(*YES), the save file must be restored before objects contained in it can be restored.
Both systems intended to participate in the save and restore operation must be connected to the same APPN network or, if the OptiConnect for I5/OS option is to be used, both systems must be joined by the OptiConnect for I5/OS hardware and software.

Parameters

Keyword	Description	Choices	Notes
LIB	Library	Single values: NONSYS, ALLUSR, IBM Other values (up to 300 repetitions): Generic name, name*	Required, Positional 1
RMTLOCNAME	Remote location name	Name	Required, Positional 2
STRLIB	Starting library	Name, *FIRST	Optional
OMITLIB	Libraries to omit	Single values: NONE Other values (up to 300 repetitions): Generic name, name*	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, ALL, NONE
	Qualifier 2: Library	Generic name, name, *ALL
	Element 2: Object type	Character value, ALL, ALRTBL, BNDDIR, CHTFMT, CLD, CLS, CMD, CRG, CRQD, CSI, CSPMAP, CSPTBL, DTAARA, DTAQ, EDTD, EXITRG, FCT, FILE, FNTRSC, FNTTBL, FORMDF, FTR, GSS, IGCDCT, IGCSRT, IGCTBL, JOBD, JOBQ, JOBSCD, JRN, JRNRCV, LOCALE, MEDDFN, MENU, MGTCOL, MODULE, MSGF, MSGQ, NODGRP, NODL, ORTBL, OUTQ, OVL, PAGDFN, PAGSEG, PDFMAP, PDG, PGM, PNLGRP, PRDAVL, PSFCFG, QMFORM, QMQRY, QRYDFN, RCT, SBSD, SCHIDX, SPADCT, SQLPKG, SQLUDT, SRVPGM, SSND, SVRSTG, S36, TBL, USRIDX, USRQ, USRSPC, VLDL, WSCST
ASPDEV	ASP device	Name, , SYSBAS, *CURASPGRP	Optional
TGTRLS	Target release	Simple name, CURRENT, PRV	Optional
PRECHK	Object pre-check	NO, YES	Optional
SAVACT	Save active	NO, LIB, *SYSDFN	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, NOCMTBDY, *NOMAX
	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
ACCPTH	Save access paths	SYSVAL, NO, *YES	Optional
SAVFDTA	Save file data	YES, NO	Optional
SPLFDTA	Spooled file data	NONE, ALL	Optional
QDTA	Queue data	NONE, DTAQ	Optional
STG	Storage	KEEP, FREE	Optional
OPTION	Option	ALL, NEW, OLD, FREE	Optional
MBROPT	Data base member option	MATCH, ALL, NEW, OLD	Optional
ALWOBJDIF	Allow object differences	Single values: NONE, ALL Other values (up to 4 repetitions): AUTL, FILELVL, OWNER, PGP	Optional
RSTLIB	Restore to library	Name, *LIB	Optional
RSTASPDEV	Restore to ASP device	Name, *SAVASPDEV	Optional
RSTASP	Restore to ASP number	1-32, *SAVASP	Optional
FRCOBJCVN	Force object conversion	Single values: SYSVAL, NO Other values: Element list	Optional
	Element 1: Convert during restore	*YES
	Element 2: Objects to convert	RQD, ALL

Top

Library (LIB)

Specifies which libraries to save and restore.

Notes:

If using *NONSYS, or *IBM keywords some libraries will not be saved and restored, because they are being used for this operation.
If the user specifies *ALLUSR on this parameter, this command should be run when the specified libraries are not being used. If objects in a library are in use while the library is being saved and restored, the objects are not saved and restored. To ensure a complete save and restore of all libraries, run the SAVLIB command with the system in a restricted state. For example, if SAVRSTLIB LIB(*ALLUSR) is run when the subsystem QSNADS is active, the QAO* files are not saved and restored in library QUSRSYS. To save and restore the *QAO files, end the QSNADS subsystem before running SAVRSTLIB LIB(*ALLUSR). Some subsystems cannot be ended when using the SAVRSTLIB command. The libraries associated with these subsystems will not be saved and restored using the SAVRSTLIB command.

QSOC

if using the optical bus transport with the SAVRSTLIB command

QCMN

if using the communications transport with the SAVRSTLIB command

*NONSYS

All user-created libraries, the QGPL and QUSRSYS libraries, and licensed program libraries such as QRPG and QIDU are saved. All subsystems must be ended by the End Subsystem (ENDSBS) or End System (ENDSYS) command before this option is specified. When *NONSYS is specified, the libraries are saved in alphabetical order on the media.

*ALLUSR

All user libraries are saved and restored. All libraries with names that do not begin with the letter Q are saved and restored except for the following:

#CGULIB     #DSULIB     #SEULIB
#COBLIB     #RPGLIB
#DFULIB     #SDALIB

Although the following Qxxx libraries are provided by IBM, they typically contain user data that changes frequently. Therefore, these libraries are considered user libraries and are also saved and restored:

QDSNX       QRCLxxxxx   QUSRIJS     QUSRVxRxMx
QGPL        QSRVAGT     QUSRINFSKR
QGPL38      QSYS2       QUSRNOTES
QMGTC       QSYS2xxxxx  QUSROND
QMGTC2      QS36F       QUSRPOSGS
QMPGDATA    QUSER38     QUSRPOSSA
QMQMDATA    QUSRADSM    QUSRPYMSVR
QMQMPROC    QUSRBRM     QUSRRDARS
QPFRDATA    QUSRDIRCL   QUSRSYS
QRCL        QUSRDIRDB   QUSRVI

Note: A different library name, in the format QUSRVxRxMx, can be created by the user for each previous release supported by IBM to contain any user commands to be compiled in a CL program for the previous release. For the QUSRVxRxMx user library, VxRxMx is the version, release, and modification level of a previous release that IBM continues to support.

*IBM

Saves all system (IBM) libraries except for the following Q libraries:

QDOC        QRCL        QSYS         QUSRSYS
QDSNX       QRECOVERY   QS36F        QUSRVxRxMx
QGPL        QRPLOBJ     QTEMP
QGPL38      QSPLxxxx    QUSER38
QPFRDATA    QSRV        QUSRINFSKR

The following libraries with names that do not begin with the letter Q are also saved:

#CGULIB      #DFULIB      #RPGLIB      #SEULIB
#COBLIB      #DSULIB      #SDALIB

generic-name

Specify the generic name of the library. A generic name is a character string of one or more characters followed by an asterisk (*); for example, ABC*. The asterisk (*) substitutes for any valid characters. A generic name specifies all libraries with names that begin with the generic prefix, for which the user has authority. If an asterisk is not included with the generic (prefix) name, the system assumes it to be the complete library name. A maximum of 300 generic library names can be specified.

name

Specify the names of the library to be saved and restored. A maximum of 300 library names can be specified.

Objects to omit (OMITOBJ)

Specifies the objects to be excluded from the operation. Up to 300 objects or generic object values can be specified.

Element 1: Object

Qualifier 1: Object

*NONE: No objects are excluded from the operation.
*ALL: All objects of the specified object type are excluded from the operation.
generic-name: Specify the generic name of the objects to be excluded.
Note: A generic name is specified as a character string that contains one or more characters followed by an asterisk (*). If a generic name is specified, then all objects that have names with the same prefix as the generic object name are selected.
name: Specify the name of the object to be excluded from the operation.

Qualifier 2: Library

*ALL: The specified objects are excluded from all libraries that are part of the operation.
generic-name: Specify the generic name of the libraries that contain objects to be excluded.
Note: A generic name is specified as a character string that contains one or more characters followed by an asterisk (*). If a generic name is specified, then all objects that have names with the same prefix as the generic object name are selected.
name: Specify the name of the library that contains the object to be excluded from the operation.

Element 2: Object type

*ALL: All object types are excluded from the operation, depending on the value specified for the object name.
character-value: Specify the object type of the objects to be excluded from the operation.
To see a complete list of object types when prompting this command, position the cursor on the field for this parameter and press F4 (Prompt). For a description of the object types, see "Object types" in the CL concepts and reference topic in the iSeries Information Center at http://www.ibm.com/eserver/iseries/infocenter.

Target release (TGTRLS)

Specifies the release level of the operating system on which you intend to use the object being saved.

When specifying the target-release value, the format VxRxMx is used to specify the release, where Vx is the version, Rx is the release, and Mx is the modification level. For example, V5R3M0 is version 5, release 3, modification 0.

Valid values depend on the current version, release, and modification level of the operating system, and they change with each new release. You can press F4 while prompting this command parameter to see a list of valid target release values.

*CURRENT: The object is to be restored to, and used on, the release of the operating system currently running on your system. The object can also be restored to a system with any subsequent release of the operating system installed.
*PRV: The object is to be restored to the previous release with modification level 0 of the operating system. The object can also be restored to a system with any subsequent release of the operating system installed.
character-value: Specify the release in the format VxRxMx. The object can be restored to a system with the specified release or with any subsequent release of the operating system installed.

Save active wait time (SAVACTWAIT)

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

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.

120: The system waits up to 120 seconds for each individual object lock before continuing the save operation.
*NOMAX: No maximum wait time exists.
0-99999: Specify the number of seconds to wait for each individual object lock before continuing the save operation.

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

*LOCKWAIT

The system waits up to the value specified for Element 1 for transactions with pending record changes to reach a commit boundary.

*NOCMTBDY

The system will save objects without requiring transactions with pending record changes to reach a commit boundary. Therefore, objects may be saved with partial transactions.

If you restore an object that was saved with partial 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 partial transactions to apply or remove the changes. Until you apply or remove the changes, any future save of that object will include the partial transactions, even if you do not specify *NOCMTBDY.

Note: This value cannot be specified if the Target release (TGTRLS) parameter value is earlier than V5R3M0.

*NOMAX

No maximum wait time exists.

0-99999

Specify the number of seconds to wait for transactions with pending record changes to reach a commit boundary.

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:

Data Definition Language (DDL) object level changes for that library.
Any API commitment resource that was added without the option to allow normal save processing. For more information, see the Add Commitment Resource (QTNADDCR) API in the System API Reference information in the iSeries Information Center at http://www.ibm.com/eserver/iseries/infocenter.

If a commit boundary is not reached for a library in the specified time, the library is not saved.

*LOCKWAIT: The system waits up to the value specified for Element 1 for the types of transactions that are listed above to reach a commit boundary.
*NOMAX: No maximum wait time exists.
0-99999: Specify the number of seconds to wait for the types of transactions that are listed above to reach a commit boundary.

Save active message queue (SAVACTMSGQ)

Specifies the message queue that the save operation uses to notify the user that the checkpoint processing for a library is complete. A separate message is sent for each library to be saved when the *SYSDFN or *LIB value is specified for the Save active (SAVACT) parameter. When *SYNCLIB is specified for the SAVACT parameter, one message is sent for all libraries in the save operation.

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.

Single values

*NONE: No notification message is sent.
*WRKSTN: The notification message is sent to the work station message queue. This value is not valid in batch mode.

Qualifier 1: Save active message queue

name: Specify the name of the message queue to be used.

Qualifier 2: Library

*LIBL: All libraries in the library list for the current thread are searched until the first match is found.

*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.
name: Specify the name of the library where the message queue is located.

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 in the case of the following:

All members on which the access paths are built are included in this save operation.
The access paths are not invalid or damaged at the time of the save.

The system checks to ensure the integrity of the access paths. Any discrepancies found by the system will result in the access paths being rebuilt.

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 file objects; it only controls the saving of the access paths. More information on the restoring of saved access paths is in the Backup and Recovery book, SC41-5304.

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, the logical files and the based-on physical files must be in the same library and must be saved at the same time.

*SYSVAL: The QSAVACCPTH system value 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 file access paths over them are saved.
Note: Specifying this value does not save the logical files.

Option (OPTION)

Specifies how to handle restoring each object.

*ALL: All the objects in the saved library are restored to the library. Objects in the saved library replace the current versions in the system library. Objects not having a current version are added to the system library. Objects presently in the library, but not on the media, remain in the library.
*NEW: Only the objects in the saved library that do not exist in the current version of the system library are added to the library. Only objects not known to the system library are restored; known objects are not restored. This option restores objects that were deleted after they were saved or that are new to this library. If any saved objects have a version already in the system library, they are not restored, and an informational message is sent for each one, but the restore operation continues.
*OLD: Only the objects in the library having a saved version are restored; that is, the version of each object currently in the library is replaced by the saved version. Only objects known to the library are restored. If any saved objects are no longer part of the online version of the library, they are not added to the library; an informational message is sent for each one, but the restore continues.
*FREE: The saved objects are restored only if they exist in the system library with their space freed. The saved version of each object is restored on the system in its previously freed space. This option restores objects that had their space freed when they were saved. If any saved objects are no longer part of the current version of the library, or if the space is not free for any object, the object is not restored and an informational message is sent for each one. The restore operation continues, and all of the freed objects are restored.

Allow object differences (ALWOBJDIF)

Specifies whether differences are allowed between the saved objects and the restored objects.

Notes:

You must have all object (*ALLOBJ) special authority to specify any value other than *NONE for this parameter.
If differences are found, the final message for the restore operation is an escape message rather than the normal completion message.

The types of differences include:

Authorization list: The saved object had an authorization list, and either the object exists on the system but does not have the same authorization list, or the object does not exist and it is being restored to a different system than the save system.
Note: This parameter has no effect when the saved object did not have an authorization list. If the object exists, it is restored with the authorization list of the existing object. If it does not exist, it is restored with no authorization list.

File level id: The creation date and time of the database file on the system does not match the creation date and time of the file that was saved.

Member level id: The creation date and time of the database file member on the system does not match the creation date and time of the member that was saved.

Ownership: The owner of an object on the system is different than the owner of an object from the save operation.

Primary Group: The primary group of an object on the system is different than the primary group of an object from the save operation.

Single values

*NONE: None of the differences listed above are allowed on the restore operation. See the description of each individual value to determine how differences are handled.

*ALL: All of the differences listed above are allowed on the restore operation. File level id and member level id differences are handled differently than the *FILELVL value. If there is a file level difference and *ALL is specified for the Data base member option (MBROPT) parameter, the existing version of the file is renamed and the saved version of the file is restored. If there is a member level difference, the existing version of the member is renamed and the saved version of the member is restored. This value will restore the saved data, but the result may not be correct. You will need to choose whether the restored data or the renamed data is correct, and you will need to make the necessary corrections to the database. For other differences, see the description of each individual value to determine how differences are handled.

Other values (up to 4 repetitions)

*AUTL: Authorization list differences are allowed. If the saved object had an authorization list and the object exists on the system but does not have the same authorization list, the object is restored with the authorization list of the existing object. If the saved object had an authorization list and the object does not exist and it is being restored to a different system than the save system, the object is restored and it is linked to the authorization list. If the authorization list does not exist, the public authority is set to *EXCLUDE.
If this value is not specified, authorization list differences are not allowed. If the saved object had an authorization list and the object exists on the system but does not have the same authorization list, the object is not restored. If the saved object had an authorization list and the object does not exist and it is being restored to a different system than the save system, the object is restored, but it is not linked to the authorization list, and the public authority is set to *EXCLUDE.

*FILELVL: File level id and member level id differences are allowed. An attempt will be made to restore existing physical files even though the physical file on the save media may have a different file level id or member level id than the physical file on the system. The physical file data will only be restored for those physical files whose format level identifiers on the save media match the format level identifiers of the corresponding physical file on the system.
If this value is not specified, file level id and member level id differences are not allowed. If an object already exists on the system with a different file level id or member level id than the saved object, the object is not restored.

*OWNER: Ownership differences are allowed. If an object already exists on the system with a different owner than the saved object, the object is restored with the owner of the object on the system.
If this value is not specified, ownership differences are not allowed. If an object already exists on the system with a different owner than the saved object, the object is not restored.

*PGP: Primary group differences are allowed. If an object already exists on the system with a different primary group than the saved object, the object is restored with the primary group of the object on the system.
If this value is not specified, primary group differences are not allowed. If an object already exists on the system with a different primary group than the saved object, the object is not restored.

Restore to ASP number (RSTASP)

Specifies whether objects are restored to the auxiliary storage pool (ASP) from which they were saved or to the system ASP (ASP number 1) or to a basic user ASP (ASP numbers 2 through 32).

Some objects cannot be restored to user ASPs. More information about object types which can be restored to user ASPs is in the Backup and Recovery book, SC41-5304. If the library exists in, or is being restored to the system ASP, journals, journal receivers, and save files can be restored to basic user ASPs. All other object types will be restored to the ASP of the library.

ATTENTION: System or product libraries (libraries that begin with a Q or #) must not be created in or restored to a user ASP. Doing so can cause unpredictable results.

*SAVASP: The objects are restored to the ASP from which they were saved.
1-32: Specifies the ASP number. When the specified ASP is 1, the specified objects are restored to the system ASP, and when the specified ASP is 2 through 32, the objects are restored to the basic user ASP specified.

Force object conversion (FRCOBJCVN)

Specifies whether to convert user objects to the format required for use in the current version of the operating system when the objects are restored.

Notes:

This parameter applies only to user objects of the *MODULE, *PGM, *SRVPGM, and *SQLPKG object types.
An object must have creation data (either observable or unobservable) to be converted.
If an object needs to be converted (because it is formatted for an earlier version of the operating system), but is not converted during this restore operation, the object is automatically converted the first time it is used.

Single values

*SYSVAL: The objects are converted based on the value of the QFRCCVNRST system value.
*NO: The objects are not converted during the restore operation.
Note: If FRCOBJCVN(*NO) is specified, then the QFRCCVNRST system value must have a value of either "0" or "1".

Element 1: Convert during restore

*YES

The objects are converted during the restore operation.

Notes:

If FRCOBJCVN(*YES *RQD) is specified, then the QFRCCVNRST system value must have a value of "0", "1", or "2". FRCOBJCVN(*YES *RQD) will override a QFRCCVNRST value of "0" or "1". If FRCOBJCVN(*YES *ALL) is specfied, then QFRCCVNRST can have any valid value and FRCOBJCVN(*YES *ALL) overrides the QFRCCVNRST system value.
Specifying this value increases the time of the restore operation, but avoids the need to convert the objects when they are first used.

Element 2: Objects to convert

*RQD: The objects are converted only if they require conversion to be used by the current operating system. If the objects do not have all creation data (either observable or unobservable), the objects cannot be converted and will not be restored.
*ALL: All objects are converted regardless of their current format, including objects already in the current format. However, if the objects do not have all creation data (either observable or unobservable), the objects cannot be converted and will not be restored.

Examples

Example 1: Saving and Restoring All User Libraries

SAVRSTLIB   LIB(*ALLUSR)  RMTLOCNAME(SYSTEM1)
            STRLIB(GFM1)  OPTION(*OLD)

This command saves all user libraries beginning with the GFM1 library and restores them on a remote system named SYSTEM1. Only the objects in the library having a saved version are restored.

Example 2: Saving and Restoring Specific Libraries

SAVRSTLIB   LIB(GRUNBOK TIMON VASEK)  RMTLOCNAME(SYSTEM1)

This command saves the following libraries GRUNBOK, TIMON and VASEK and restores them on a remote system named SYSTEM1.