ARMBSRR syntax and option descriptions
The ARMBSRR syntax and option descriptions in this section are the control statements that you use when you build ARMIN input.
For more information about online support, see Creating-a-system-resource-recovery-job-ARMBSRR.
The following figure shows the ARMBSRR syntax.
ARMBSRR syntax—Restore archive options
The following table lists the syntax options in alphabetical order.
Option | Batch Default | Reference |
|---|---|---|
ALTLOAD | None | |
ARCHIVE NOTCATLG | None | |
BSDS ARCHLIMIT | None | |
BSDS DAYSLIMIT | None | |
BSDS HOURSLIMIT | None | |
BYPASS DEACT | None | |
BYPASS QUIESCED | VALIDATE_WARN | |
COMPRESS | None | |
CONDRESTART | None | |
COPYTYPE | None | |
CREATEHIST | None | |
DATACLAS | None | |
DCTOKEN | DRECOVER | |
DISK | None | |
DREXTEND | NO | |
DSNTEP2 dataSetName | DSNLOAD | |
None | ||
EXCLUDE MEMBERS | None | |
ESTIMATE | None | |
HWCOPY | None | |
HWLEVEL | None | |
INITIALIZE ACTIVES | None | |
INITIALIZE DSNJLOGF | None | |
JCLTYPE | None | |
LIMIT DAYS | None | |
LIMIT HOURS | None | |
LIMIT LOGS | None | |
MAXCATJOBS | None | |
MAXLOGJOBS | None | |
MAXTAPEUNITS | 0 | |
MISSINGCOPIES | FAIL | |
MGMTCLAS | None | |
OFFSITE | OFFSITE NO ARCHIVE2 | |
PACLOG | None | |
PRIMEALLOC | None | |
RECOVER LOGMASTER | None | |
RECOVER REPOSITORY | None | |
RECOVER WORKFILE | Yes | |
RESTORE ARCHIVE | None | |
SIMULATE | None | |
SINGLE LPAR | None | |
STORCLAS | None | |
SYNCNAME | None | |
UNIT | None | |
UNITCNT | None | |
VOLUMES | None | |
ZIIP | ENABLED |
Option | Description | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
ALTLOAD | This option enables you to specify a load library that contains BMC AMI Recovery Manager. This load library is generated in steplibs. | ||||||||||||||||||||||
ARCHIVE NOTCATLG | This option indicates that the archive log data sets are not cataloged at the recovery site. If the operating system and tape management catalogs will not be brought up to date at the recovery site, this option lets you make that situation known to BMC AMI Recovery Manager so that all references to the archive logs will be generated with the unit and volume specified. | ||||||||||||||||||||||
BSDS ARCHLIMIT | This option specifies the maximum number of logs that you want processed by ARMBSRR. The default is to process all logs in the BSDS. This value is from 1 to 9999. This option is useful when you know that some logs are no longer cataloged and prevents BMC AMI Recovery Manager from trying to process missing or uncataloged archive logs. | ||||||||||||||||||||||
BSDS DAYSLIMIT | This option specifies the maximum number of days of logs that you want ARMBSRR to process. Valid values are from 1 to 99. This option is useful when you do not know the number of logs that you want to process, but you know the number of days. | ||||||||||||||||||||||
BSDS HOURSLIMIT | This option specifies the maximum number of hours of logs that you want ARMBSRR to process. Valid values are from 1 to 999. This option is useful when you do not know the number of logs that you want to process,, but you know the number of hours. | ||||||||||||||||||||||
BYPASS DEACT | This option excludes members that are in DEACT status from disaster recovery. | ||||||||||||||||||||||
BYPASS QUIESCED | This option ignores members that are in QUIESCED status when calculating the recovery point. If any log ranges exist after the end of the last archive log, data could be lost by recovering to the end of the last archive log. VALIDATE_WARN—writes a warning message and continues processing. VALIDATE WARN is the default. VALIDATE_FAIL—writes a message and stops processing with return code 8. | ||||||||||||||||||||||
CONDRESTART | This option controls whether a conditional restart is included in the recovery JCL during a local full subsystem recovery. CONDRESTART AUTO and NO are only available when you are using BMC AMI Recovery Manager as a component of the Recovery Management for Db2 solution. If the solution password is not found, BMC AMI Recovery Manager automatically uses CONDRESTART YES. For more information about conditional restart avoidance during local full subsystem recovery, see the Recovery Management for Db2 documentation. Valid values are:
| ||||||||||||||||||||||
COPYTYPE | This option specifies the image copy type (as indicated in the ICBACKUP column of the SYSIBM.SYSCOPY table) to be used for recovery of catalog, directory, and repository table spaces at the recovery site. If unspecified, the default is RP. Valid values are LP (local primary), LB (local backup), RP (remote primary), or RB (remote backup). This option is ignored for hardware mirroring level 2 (HWLEVEL 2). | ||||||||||||||||||||||
CREATEHIST | This option creates an archive history file even when BMC AMI Recovery Manager does not restore the archives to disk. (This archive history file is always created when the archives are restored to disk). | ||||||||||||||||||||||
DCTOKEN | DCTOKEN token is an identifier used by BMC AMI Recovery Manager to differentiate different types of data collection information. The default DCTOKEN value is DRECOVER, which turns data collection on. To turn data collection off, use DCTOKEN NO. | ||||||||||||||||||||||
DREXTEND | This option enables you to extend the recovery point at the disaster recovery site by generating JCL to run the ARMBSDR program at the disaster recovery site as part of the Phase 1 job. ARMBSDR finds the most recent BSDS and archive log (for each member if data sharing) at the recovery site and updates the BSDS. ARMBSDR also adds a new conditional restart control record to the BSDS. ARMBSRR will not generate the ARMBSDR JCL if any of the following subsystem options are specified:
Valid values for DREXTEND are:
For data sharing environments, a process is in place that coordinates all Phase 1 jobs so that ARMBSDR processes all members. If ARMBSDR fails, correct the problem and resubmit the Phase 1 job. The rest of the Phase 1 jobs wait for ARMBSDR to complete successfully. For more information about the ARMBSDR program, see ARMBSDR—Extend recovery point at disaster recovery site. | ||||||||||||||||||||||
DSNTEP2LIB dataSetName | This option specifies the library that contains DSNTEP2. If BMC AMI Recovery Manager does not find DSNTEP2LIB in the syntax, the library defaults to DSNLOAD. | ||||||||||||||||||||||
(Optional) This option enables you to request email notifications. To request email notifications, you are required to set up an email entry in the EMAILDST member of the CNTL data set. EMAIL entry name EOJ_RC n: This option specifies the email entry name. The email entry name must pass the same validation as a PDS member name. In this option, n must be a number from 0 through 254. If the ARMBSRR return code is greater than or equal to the EOJ_RC value, an End of Job email is sent. The following is an email output example: For more information about how to send email notifications, see Setting-email-entries. | |||||||||||||||||||||||
ESTIMATE | This option estimates system resource recovery for a remote site. When you specify this option, ARMBSRR produces an estimate of the amount of time that the recovery of your subsystem resources will take, and takes into consideration the options that you set and the unique configuration of your subsystem, including number of table spaces, size of table spaces, and more. The default is NO. This option is only available when you are using BMC AMI Recovery Manager as a component of the BMC AMI Recovery for Db2 solution. For more information about estimation, see the Recovery Management for Db2 documentation . | ||||||||||||||||||||||
EXCLUDE MEMBERS | This option excludes permanently quiesced members from a disaster recovery. You should use this option if the permanently quiesced members are no longer in use and do not need to be recovered even in the event of a system-wide disaster. Enter one or more Db2 member names of 1 through 8 characters in length. | ||||||||||||||||||||||
HWLEVEL 1/HWLEVEL 2 | These options specify the level of hardware mirroring implemented on the system, as follows: HWLEVEL 1—indicates hardware mirroring Level 1, which means that only the BSDS data sets and active logs are mirrored. HWLEVEL 2—indicates hardware mirroring Level 2, which means that the catalog and directory data sets as well as the BSDS and active logs are mirrored. The default is no mirroring at all. ARMBSRR does not allow the use of OFFSITE YES or INITIALIZE ACTIVES in conjunction with HWLEVEL 1 or 2. If you are using the Recovery Management for Db2 solution and you have specified hardware mirroring at the subsystem level, the subsystem mirroring settings override the HWLEVEL options. HWCOPY 1/HWCOPY 2 These options indicate that only one copy of the BSDS and active logs is being mirrored, as follows: HWCOPY 1—indicates that Copy 1 is the mirrored copy and therefore Copy 2 must be rebuilt by ARMBSRR HWCOPY 2—indicates that Copy 2 is the mirrored copy and Copy 1 must be rebuilt | ||||||||||||||||||||||
INITIALIZE ACTIVES | This option specifies whether the active logs are to be populated with the contents of the archive log data sets at the recovery site during resource recovery. When you use this option, BMC AMI Recovery Manager populates the first n-1 active logs with the contents of the last n-1 archive log data sets (where the variable n is the number of active logs that are defined in the BSDS at the recovery site). The nth active log is left empty. If you do not use this option, BMC AMI Recovery Manager initializes the logs to be empty. You can specify the number of jobs to use for initialization per subsystem by specifying the MAXLOGJOBS option. INITIALIZE ACTIVES and INITIALIZE DSNJLOGF are mutually exclusive. Be aware that INITIALIZE ACTIVES and HWLEVEL are mutually exclusive. Also, if you specify both INITIALIZE ACTIVES and RESTORE ARCHIVE, BMC AMI Recovery Manager ignores the INITIALIZE ACTIVES option.
| ||||||||||||||||||||||
INITIALIZE DSNJLOGF | This option generates JCL for ARMBACT to initialize active logs with DSNJLOGF. This is a stand-alone method to initialize all active logs for a subsystem in a single execution. INITIALIZE ACTIVES and INITIALIZE DSNJLOGF are mutually exclusive. | ||||||||||||||||||||||
LIMIT DAYS | This option specifies how many days' worth of log data sets are to be restored for each recovery-site archive log copy. Valid values are from 1 to 99. This option is useful when you do not know the number of logs you want to process, but you know the number of days. | ||||||||||||||||||||||
LIMIT HOURS | This option specifies how many hours' worth of log data sets are to be restored for each recovery-site archive log copy. Valid values are from 1 to 999. This option is useful when you do not know the number of logs you want to process, but you know the number of hours. | ||||||||||||||||||||||
LIMIT LOGS | This option specifies how many log data sets are to be restored for each recovery-site archive log copy. The variable n is the number of logs and can be any value from 1 - 9999. The default is to process all logs in the archive history file. | ||||||||||||||||||||||
MAXCATJOBS | DB2 Version 10 and later MAXCATJOBS specifies a value that is used in the PARALLEL and TAPEUNITS syntax. The result enables multitasking by DSNUTILB recovery instead of multiple jobs. Because Db2 Version 10 does not allow multiple simultaneous catalog recoveries, ARMBSRR does not generate multiple catalog recovery jobs even if MAXCATJOBS is greater than 1 when you are running under Db2 Version 10 or later. Instead, ARMBSRR generates a single catalog recovery job that uses multitasking. | ||||||||||||||||||||||
MAXLOGJOBS | For more information, see INITIALIZE ACTIVES. | ||||||||||||||||||||||
MAXTAPEUNITS | MAXTAPEUNITS is not currently used for catalog recovery. This option determines the maximum number of tape units to use at one time for repository recovery. MAXTAPEUNITS is generated in ARMBSRR syntax with a value of 0 that means that DSNUTILB RECOVER determines the maximum number of tape units. ARMBSRR accepts a range of 0 through 32 for MAXTAPEUNITS. | ||||||||||||||||||||||
MISSINGCOPIES | This option indicates whether BMC AMI Recovery Manager is to FAIL, which is the default value, or WARN if copies are missing.
| ||||||||||||||||||||||
OFFSITE | This option specifies which archive log data set is to be used at the recovery site, as follows:
| ||||||||||||||||||||||
PRIMEALLOC | This option specifies the allocations to be used when allocating VSAM files for the Db2 catalog and directory, as follows:
| ||||||||||||||||||||||
RECOVER LOGMASTER | This option recovers the Log Master repository. If you do not include this option, the recovery of the repository is omitted from the recovery job. | ||||||||||||||||||||||
RECOVER REPOSITORY | This option recovers the BMC Common Db2 repository, BMC AMI Recovery Manager repository, and the R+/CHANGE ACCUM repository, if installed. If you do not include this option, the recovery of the repository is omitted from the recovery job. Be aware of the following information:
| ||||||||||||||||||||||
RECOVER WORKFILE | This option specifies that BMC AMI Recovery Manager should recover work file database (DSND807) objects during local or remote subsystem recovery. Valid values for RECOVER WORKFILE are:
| ||||||||||||||||||||||
RESTORE ARCHIVE1 or RESTORE ARCHIVE2 | This option specifies that recovery-site archive log copies should be restored to disk. You can use either the PACLOG utility (PACLOG YES option) or the ARMBARC program to restore the logs. ARMBSRR can generate multiple ARMBARC jobs to restore the logs, based on the value that you specify for MAXLOGJOBS.
| ||||||||||||||||||||||
SIMULATE | This option simulates system resource recovery for a remote site. When you specify this option, the simulation JCL copies the BSDS and creates the proposed conditional restart control record (CRCR) in the BSDS. It also makes other checks on your specifications for disaster recovery. However, no actual conditional restart or recovery of the catalog and directory is performed. The default is NO. | ||||||||||||||||||||||
SINGLE LPAR | This option generates JCL that does not include the SYSAFF cards designed to route different JCL steps to different members. Use this option if your system is data-sharing and all members are running on a single LPAR at the remote site. If you do not specify this option, ARMBSRR generates JCL for the remote site as if the remote site configuration matches the local configuration. If your system is non-data-sharing, ARMBSRR ignores this option. | ||||||||||||||||||||||
SET OPTIONS JCLTYPE | This option specifies whether the JCL is for local point in time recoveries (LOCAL) or disaster recoveries (DR) (the default). If the recovery is local, ARMBSRR does not generate IDCAMS DELETE/DEFINE statements for
SET OPTIONS JCLTYPE DR is required for mirroring support. ARMBSRR verifies the mirroring status of the subsystem data sets if all of the following conditions are true:
If these conditions are met, ARMBSRR performs mirror verification and reports mirror information (including data set name, mirror status, VOLSER, and device address) to the ARMVRPT file. In addition, ARMBSRR prints a volume summary report for the mirror data sets to ARMVRPT. If these conditions are not met, ARMBSRR does not check the mirroring status even if the remote mirroring subsystem option is set. | ||||||||||||||||||||||
SYNCNAME | This option specifies the name of the synchronization file to be used to synchronize the generated jobs that run in parallel. The default name is userid.D date.T time.BMCSYNC, where:
If you use a different name than the default, do not enclose it in quotation marks. |
Related topic