Syntax and options of the RESTORE SYSTEM control statement

The RESTORE SYSTEM utility control statement, with its multiple options, defines the function that the utility job performs.

Use the ISPF/PDF edit function to create a control statement and to save it in a sequential or partitioned data set. When you create the JCL for running the job, use the SYSIN DD statement to specify the name of the data set that contains the utility control statement.

When you specify RESTORE SYSTEM, you can specify only the following statements in the same step:

  • DIAGNOSE
  • OPTIONS PREVIEW
  • OPTIONS OFF
  • OPTIONS KEY
  • OPTIONS EVENT WARNING

In addition, RESTORE SYSTEM must be the last statement in SYSIN.

Start of change

Syntax diagram

Read syntax diagramSkip visual syntax diagram RESTORE SYSTEM non-LOGONLY specLOGONLYSWITCHVCATSYSVALUEDDN( ddname)
non-LOGONLY spec
Read syntax diagramSkip visual syntax diagramALTERNATE_CP( copy-pool)RESTOREBEFORE X'byte-string'FROMDUMPDUMPCLASS( dcl)RSA(' key-label')TAPEUNITS( num-tape-units)FLASHCOPY_PPRCPNOPMNOPMPREFPMREQ
End of change

Option descriptions

LOGONLY
Specifies that the database volumes have already been restored, so the RESTORE phase is skipped. Use this option when the database volumes have already been restored outside of Db2. If the subsystem is at a tracker site, you must specify the LOGONLY option.
SWITCH VCAT
Indicates that the integrated catalog facility (ICF) alias (VCAT) names are to be substituted with those names that are provided when the log is processed. Every VCAT encountered in the log must be specified in the SYSVALUEDDN data set. This option might be used in the process of cloning a Db2 subsystem.
SYSVALUEDDN ('ddname')
Specifies that the DD statement for the control statements specifying the integrated catalog facility (ICF) (VCAT) aliases used when processing log records.ddname can be up to 8 characters, and must start with an alphabetic or national character (for example: @, $, or #).

The default value is SYSVALUEDDN(SYSVALUE), where SYSVALUE identifies the primary data set.

Start of changeALTERNATE_CPEnd of change
Start of changeIndicates which system-level backups RESTORE SYSTEM can use. RESTORE SYSTEM is to consider only those system-level backups with the specified copy pool.

If the ALTERNATE_CP option is omitted from the utility control statement, all system-level backups are candidates for a restore base.

Of the qualifying system-level backups, RESTORE SYSTEM uses the most recent one before the recovery point. If the utility encounters problems with that system-level backup, the utility fails.

(copy-pool)
A string value to be used for the copy pool name. This value can be up to 14 characters. RESTORE SYSTEM uses the following copy pool names:
  • DSN$copy-pool$DB for the database copy pool
  • DSN$copy-pool$LG for the log copy pool
Related information:
End of change
Start of changeRESTOREBEFORE End of change
Start of changeLimits the system-level backups that RESTORE SYSTEM can use as the recovery base to those backups that were taken before the specified RBA or LRSN. RESTORE SYSTEM is to use the most recent system-level backup before the specified RBA or LRSN.

Use RESTOREBEFORE to avoid the use of the more recent system-level backups.

X'byte-string'
An RBA in a non-data sharing environment or an LRSN in a data sharing environment.
End of change
FROMDUMP
Indicates that you want to dump only the database copy pool to tape during the restore.
DUMPCLASS (dcl)
Indicates what DFSMShsm dump class to use for the restore.
RSA ('key-label')
Specifies that the key-label value in the utility control statement is passed to DFSMShsm to override the key-label value that would normally be used to read dump tapes. key-label can be up to 64 characters, and must start with an alphabetic or national character (for example: @, $, or #). key-label must be enclosed in single quotation marks.
The FROMDUMP and DUMPCLASS options that you specify for the RESTORE SYSTEM utility override the RESTORE_ RECOVER_FROMDUMP and UTILS_DUMP_CLASS_NAME subsystem parameter values.
TAPEUNITS
Specifies the limit on the number of tape drives that the utility dynamically allocates during the restore of the database copy pool from dumps on tape.

The default is the option that you specified for subsystem parameter RESTORE_TAPEUNITS. If no default is specified, then the RESTORE SYSTEM utility tries to use all of the tape drives in your system.

The TAPEUNITS option does not apply and is ignored when the z/OS® level is Version 1 Release 12 or later.

(num-tape-units)
Specifies the maximum number of tape drives to allocate. If you specify zero, or you do not specify a value, the utility determines the optimal number of tape units to use. RESTORE SYSTEM TAPEUNITS has a maximum value of 255.
Start of changeFLASHCOPY_PPRCPEnd of change
Start of changeSpecifies the behavior for DFSMShsm FlashCopy® requests when the Db2 production volumes are primary volumes in a Metro Mirror (Peer-to-Peer Remote Copy or PPRC) relationship.
NO
FlashCopy is not allowed to move data from the system-level backup to the Db2 production volumes. The primary volumes in PPRC pairs are not allowed to become FlashCopy targets.
PMNO
PMNO means Preserve Mirror No. PMNO specifies the following behavior:
  • The Db2 production volumes can be FlashCopy target volumes.
  • PPRC pairs are allowed to go into duplex pending status when the system-level backup is restored.
PMPREF
PMPREF means Preserve Mirror Preferred. PMPREF specifies the following behavior:
  • The Db2 production volumes can be FlashCopy target volumes.
  • The preferred behavior is that the volume pairs not go into duplex pending status when the system-level backup is restored.
PMREQ
PMREQ means Preserve Mirror Required. PMREQ specifies the following behavior:
  • The Db2 production volumes can be FlashCopy target volumes.
  • The mirror must be preserved, and the volume pairs must not go into a duplex pending status when the system-level backup is restored.
Related information:
End of change