Optional parameters

The following are the optional parameters of the ARCHRCOV macro:

DAOPT

specifies the type of data set accessing required after the recover of a direct access data set. This, in turn, implies the allowable target volume DASD types. The recovered data set must be non-SMS-managed. For details on DAOPT, see DAOPTION: Selecting target volume track length.

DATE

specifies the address of a field containing the date of creation of a backup version number that you wish to recover. For dateaddr, substitute the address of a field containing the date of the backup version you wish to recover in one of the following forms:

If the system date is after 1999, that field must contain 7 digits in the format yyyyddd.
If the system date is before 1 January 2000, that field may contain either (a) 7 digits in the format yyyyddd, where the first two digits are 19, 20, or 21; or (b) 5 digits in the format yyddd, where the first two digits (prefixed by 19 to form year 19yy) must be greater than 21.

The backup version that is recovered is the newest one created on or before the specified date. GEN and DATE are mutually exclusive parameters. You can use the ARCXTRCT macro in ARCXTRCT: Extracting data from DFSMShsm to obtain this backup version number creation date for backup versions that exist. This parameter applies to both SMS-managed and non-SMS-managed data sets.

FROMVOL

specifies the address of a field containing the volume serial number of the volume from which uncataloged data sets were backed up. For volseraddr, substitute the address of the six-character field that contains the volume serial number. The volume serial number must be left-justified and padded with blanks. FROMVOL applies only to non-SMS-managed data sets that were uncataloged at the time they were backed up.

GEN

specifies the address of a field containing the relative generation number that you wish to recover. For gennumaddr, substitute the address of a four-byte field that contains the fullword (binary) generation number to be recovered. You can use the ARCXTRCT macro in ARCXTRCT: Extracting data from DFSMShsm to extract data for the generation numbers that currently exist. This parameter applies to both SMS-managed and non-SMS-managed data sets. GEN applies only to active backup copies. You cannot use GEN with retained copies.

NEWNAME

specifies the address of a field containing a new name for the recovered data set. For dsnaddr, substitute the address of the 44-byte area that contains the data set name. The data set name must be left-justified and padded with blanks. This parameter applies to both SMS-managed and non-SMS-managed data sets.

RCVRQD

specifies whether to set the recovery required indicator on in the target data set. This parameter should only be used by forward recovery applications. The default is NO. This parameter applies to both SMS-managed and non-SMS-managed data sets.

REPLACE

specifies whether an existing data set with the same name is to be replaced. The default is NO. This parameter applies to both SMS-managed and non-SMS-managed data sets.

SNAPDCB

specifies the address of an open DCB that can be used for SNAP macro processing. This feature is intended for problem determination. If you specify this parameter, review Usage notes. For dcbaddr, specify the address of an open DCB.

TEST

specifies whether to refrain from sending a request for service to DFSMShsm. If YES is specified, the service request is not sent. If NO is specified, a service request is sent to DFSMShsm. In both cases the parameters specified for the macro are checked for correctness. A 4xx return code results for invalid parameters. The default is NO.

TIME

specifies the address of the field containing the creation time of the backup version that you want to recover. For timeaddr, substitute the address of the field that contains the time that the backup version was created in following form: hhmmss, where the first two digits are hours, the next two digits are minutes, and the last two digits are seconds. The range for hours is 00–23 and the range for minutes and seconds is 00–59. If a backup copy with the specified data and time does not exist, the request fails. You can use the ARCXTRCT macro to obtain the creation date and time of the backup version of an existing data set. TIME applies to both SMS-managed and non-SMS-managed data sets.

Note: If you specify TIME, you must specify DATE. If you specify TIME without DATE, the ARCHRCOV macro fails.

TOVOL

specifies the address of a field containing the volume serial number of the volume to which the data set is recovered. For volseraddr, substitute the address of the six-byte area that contains the specified volume serial number. The volume serial number must be left-justified and padded with blanks. This parameter only applies to non-SMS-managed data sets.

Note: When the TOVOL parameter is specified, the UNIT parameter must also be specified.

UNIT

specifies the address of a field containing the unit type of the volume to which the data set is to be recovered. For unitaddr, use the address of the four-byte field that contains the UCB device type. For example, X'3010200F' is the UCB unit type for a 3390 device. For a table presenting the supported unit types and UCBs, see Table 1. This parameter only applies to non-SMS-managed data sets.

Note: When the UNIT parameter is specified, the TOVOL parameter must also be specified.

VER

specifies the address of a field containing the unique version number of the particular active backed up data set that you would like to recover. For vernumaddr, substitute the address of a four-byte field that contains the fullword (binary) version number for the specified backup version. If DFSMShsm is unable to find the specified backup version, the recover fails and message ARC1128I is issued. This parameter applies to both SMS-managed and non-SMS-managed data sets. VER applies only to active backup copies. You cannot use VER with retained copies.

WAIT

specifies whether you want the application to wait until DFSMShsm has processed this request. If YES is specified, the application waits until DFSMShsm completes processing of the request. The default is NO. This parameter applies to both SMS-managed and non-SMS-managed data sets.