DSF RESTORE Statement

RESTORE statement syntax

RESTORE statement

The RESTORE statement is required for a RESTORE operation. Only one is allowed per execution, and it must be the first control statement. One or more SELECT statements must follow it, with optional EXCLUDE statements, to specify the data sets or tracks to be restored.

DSF reads each backup file specified on a TAPEx DD statement and restores one or more data sets as indicated by the SELECT and EXCLUDE statements that follow (see DSF-SELECT-and-EXCLUDE-Statement-for-RESTORE). The backup files are read one at a time (in the order that the TAPEx DD statements exist in the step JCL) but while reading a backup file, DSF can restore the selected data sets to one or more output DASD volumes concurrently.

Target DASD volume selection rules

The target DASD volume is selected for each data set by the following rules, in this order:

• If the NVOL= operand is specified on the SELECT statement that selected this data set, that volume or volumes are used. See NVOL= for details of target volume selection.
• If the step JCL contains a DISKx DD statement (other than DD DUMMY) matching the TAPEx DD statement from which the data set is being restored, then the DASD volume where it points is selected for output.
• If the output data set name is cataloged, then the volume where it is cataloged is chosen. The output data set name is the original name or the new name if a NEWNAME=, NEWGROUP=, or NEWINDEX= operand is specified on the SELECT statement that selected the data set. If the data set is cataloged as being on multiple volume serials, then the volume serial number is selected from that list based on the volume sequence number in the F1 DSCB (field DS1VOLSQ) of the input data set.
• If none of the above applies, then the serial of the volume from which the data set was dumped, as recorded on the backup data set, is used.

If System Managed Storage (SMS) is active on this system, and the data set does not already exist on the volume selected by the rules above, SMS is invoked to decide if the data set should be SMS-managed. If so, SMS selects an output volume that may be totally different from the target volume chosen by DSF. SMS rules are detailed in SMS Support and Working-with-System-Managed-Storage.

RESTORE statement operands

TYPE=DSF

Specifies a data set restore. It is required.

BLKF=

nn

Changes the block size of certain RECFM=FB and VB data sets. BLKF= specifies blocks per track (1 to 10) and calculates a new block size based on the output track size.

DSORG=PS (sequential) data sets are physically reblocked during the restore. DSORG=PO (partitioned) data sets use the new block size for new members. Other data set types are not reblocked.

Default: Data sets are not reblocked during restore.

BYPASSACS

The SMS Automatic Class Selection (ACS) routines are not to invoked for data sets that must be allocated. If a data set has a SMS storage class assigned (see “STORCLAS=” in Section 20.9) it is SMS-managed, and SMS is invoked to allocate the data set on an SMS chosen volume, but SMS is not allowed to override the storage class or management class assigned to the data set.

Default: The SMS Automatic Class Selection (ACS) routines is invoked for every data set that has to be allocated. A data set is passed to SMS for allocation if the storage class Automatic Class Selection (ACS) routine assigns a storage class to the data set.

BYPASSSMS

SMS-managed data sets are directly allocated on SMS-managed volumes, bypassing normal SMS storage group and volume selection. The selected output volume must be a SMS-managed DASD volume, and the data sets being restored must have a SMS storage class assigned (see BYPASSACS and STORCLAS=).

Normal SMS facilities do not allow allocation of data sets on specific volume serials, but BYPASSSMS does, allowing data sets to be located for performance or other reasons. If BYPASSACS is also specified, the assigned SMS classes is not validity- or authority-checked.

Default: For data sets that have a storage class and must be allocated, the SMS storage group Automatic Class Selection (ACS) routine is invoked to select a storage group and SMS selects a SMS-managed volume and allocates and catalogs the data sets.

CATIFALLOC

Non-VSAM output data sets are cataloged even if they were preallocated (not allocated by the restore), subject to the NOCAT and RECAT operands.

Default: Output data sets are cataloged only when the restore allocates them.

cloudname

the name of the cloud from which the data is restored. This operand is only needed when restoring a backup control file from the cloud.

Default: If the TAPEx DD statement points to a conventional backup file on tape or disk, the data is restored from that backup file. If the TAPEx DD statement points to a backup control file for a backup to the cloud, the data is restored from the cloud specified in the backup control file.

CONFMESS=

Begin the restore immediately.

Before beginning any restore that includes an absolute track request (SELECT FROM/TO), the z/OS operator must reply to a console WTOR message FDRW02.

Default: CONFMESS=YES. Restores of data sets do not require confirmation.

cloudcontainer

The name of the container in the cloud from which the data is restored. The name must start with FDR. This operand is only needed when restoring a backup control file from the cloud.

Default: If the TAPEx DD statement points to a conventional backup file on tape or disk, the data is restored from that backup file. If the TAPEx DD statement points to a backup control file for a backup to the cloud, the data is restored from the container specified in the backup control file. If a backup control file is being restored from the cloud, the default for the container name is FDR.DSF.BACKUP, or other name specified by the CLOUDCND option in the FDR Global Options.

DATA=

All of the allocated tracks in each data set are restored; should not be specified unless the backup was taken using the DATA=ALL option. DATA=ALL should not be specified with the RLSE and %FREE operands.

Only the used portion of Physical Sequential (PS) and PO (partitioned) data sets is restored.

Default: DATA=USED.

DSNENQ=

Specifies whether a SYSDSN enqueue should be issued for each of the data sets being restored. See “Data Set Enqueue Option” in Section 20.2 for more details. If you are restoring over an existing data set and the enqueue fails, the data set is bypassed with an error message. If the restore must allocate the output data set and the enqueue fails, no error message is issued and the restore is still done.

The options for DSNENQ= are:

Enqueue the data sets. If an enqueue fails, ask the operator what to do.

No data set enqueue is issued.

Do not enqueue the data sets, but test to see if they are enqueued to another task.

Enqueue the data sets. This is the most frequently used option.

EATTR=OPT

Allows FDRDSF to allocate non-VSAM data sets in cylinder-managed space on Extended Address Volumes (EAVs), unless the DSCB for the data set specifies EATTR=NO. (VSAM data sets are eligible by default to be allocated in cylinder-managed space, and are not affected by this operand.) See “EATTR=OPT Considerations” for additional information on how data sets are allocated on Extended Address Volumes (EAVs).

EMSG=

Used when the FDR e-mail notification facility has been invoked by including an FDREMAIL DD statement in the FDR execution JCL.

E-mail notifications are sent from successful FDR operations as well as failures.

Default: E-mail notifications are sent only for FDR failures.

ICFCAT=

Applies to VSAM files only. Specifies the source of the catalog name to be used if a VSAM cluster must be allocated.

Determine the catalog from the alias name in the master catalog. Multi-Level Alias (MLA) is supported.

Use the catalog in which the original cluster was cataloged.

Default: ICFCAT=ORIGINAL, except that if the cluster is being restored to a new name (NEWGROUP= or NEWINDEX= specified) the default is ICFCAT=ALIAS. If the output cluster is SMS-managed, ICFCAT=ALIAS is forced.

MAXCARDS=

nnnn

Accept additional SELECT/EXCLUDE statements (over 250).

Default: MAXCARDS=250.

MAXERR=

nnnn

Specifies the number of tape or DASD errors (1 to 9999) that, if reached, cause the operation to abend. Each error is indicated by a message and possible mini-dump.

Default: 20.

NOCAT

Specifies that output data sets are not cataloged. This option is ignored for VSAM clusters and SMS-managed data sets, since these must always be cataloged.

RECAT

Specifies that non-VSAM output data sets are cataloged even if they are currently cataloged to another volume. If a data set by that name actually exists on the volume where it is currently cataloged, and it is SMS-managed, it is deleted; otherwise, it becomes an uncatalogued data set.

Default: Catalog output non-VSAM data sets only if they are not currently cataloged.

NOCAT and RECAT are mutually exclusive. The restore catalogs only data sets that it allocates (not preallocated) unless CATIFALLOC is also specified.

PRESTAGE

Output data sets that already exist on the target output volume are NOT restored. This may be used to avoid restoring data sets that have already been restored. If the output data sets do not exist on the target volume, they are allocated and restored.

Default: Preallocated data sets have their contents overlaid.

RLSE

%FREE=

All of the unused space in the output Physical Sequential (PS) and PO (partitioned) data sets is released.

%FREE=nn

A percentage (nn%) of the PS and PO data sets to be left free after the restore. However, the data sets are never made larger than their original size. “nn” may range from zero (0), which frees all of the free space (same as RLSE) to 99 which attempts to leave the data sets with 99% free space. Space is released only from data sets allocated by the restore; space is actually released by recalculating the required space during the allocation.

Default: The output data sets are allocated the same size as the input data sets (unless overridden by TRK=/CYL= on the SELECT statement).

SELTERR=

Specifies what happens at step termination if one or the SELECT or EXCLUDE statements was never referenced (no data set on any backup was selected by the statement):

A condition code or abend is not to be issued at step termination. You might use SELTERR=NO when you expect some unmatched SELECT or EXCLUDE statements, perhaps because some data sets may not exist.

A condition code or abend is issued at step termination to call attention to a possible control statement error.

Default: YES unless overridden in the FDR Global Options (see SELTERR in General-Options).

SMSGDG=

Specifies the status of SMS-managed Generation Data Group (GDG) data sets, if allocated by the restore.

Sets the GDG to ACTIVE status.

Sets the GDG to DEFERRED status.

Sets the GDG to the original SMS status of the GDG generation, as recorded on the backup tape. If the original GDG was non SMS-managed, it is set ACTIVE if that generation is currently cataloged, otherwise DEFERRED.

Sets the GDG to ROLLEDOFF status.

Default: SMSGDG=DEFERRED.

VRECAT

Allows VSAM clusters to be allocated and cataloged even if they already exist in the target catalog. If an attempt to define a cluster fails with a code indicating the cluster or component name already exists in the catalog, the cataloged cluster is scratched (by DELETE or, if that fails, DELETE NOSCRATCH). The define is then re-issued. VRECAT is useful when restoring a cluster when its catalog has been restored, but the cluster on DASD has not, or when restoring a cluster to a new volume.

VRECAT is ignored when:

• Restoring a catalog.
• The restore does not include the base data component (such as restoring an alternate index on a volume by itself or a volume containing only a base index component).
• The required components of the cluster do exist on the volume to which FDR is restoring. In this case, FDR will restore on top of that existing cluster and VRECAT is not involved.

Default: VSAM clusters cannot be allocated if the cluster name already exists in the catalog (even if the catalog points to the output volume).