ARMBSRR option descriptions


This section contains description of ARMBSRR syntax options.

Option

Description

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

  • Db2 catalog and directory data sets
  • BMC Common Db2, BMC AMI Recovery Manager, and R+/CHANGE ACCUM repository data sets (if the RECOVER REPOSITORY keyword is specified)
  • Log Master repository data sets (if the RECOVER LOGMASTER keyword is specified)

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:

  • The BMC Recovery Management for Db2 solution password is applied
  • Remote mirroring is specified in the subsystem recovery options
  • SET OPTIONS JCLTYPE DR is specified in the ARMBSRR syntax

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.

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.

OFFSITE

This option specifies which archive log data set is to be used at the recovery site, as follows:

  • Specify OFFSITE YES if using the recovery site archive log data sets generated by ARMBARC or PACLOG.
  • Specify OFFSITE NO ARCHIVE2 or OFFSITE NO ARCHIVE1 if sending one of the local copies offsite instead of using the recovery site archive log data sets generated by ARMBARC or PACLOG. To provide compatibility with the OFFSITE NO option of early releases, the default is OFFSITE NO ARCHIVE2.

 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.

Important

RESTORE ARCHIVE1 or RESTORE ARCHIVE2 is mutually exclusive with ARCHIVE NOTCATLG (see SET OPTIONS JCLTYPE) and INITIALIZE ACTIVES (see INITIALIZE ACTIVES).

ZIIP

The ZIIP option specifies whether to attempt to use IBM System z Integrated Information Processors (zIIPs). BMC AMI Recovery Manager can use enclave service request blocks (SRBs) to enable zIIP processing automatically while running jobs. Using zIIP processing can reduce the overall CPU time for BMC AMI Recovery Manager jobs.

You can specify one of the following values:

  • ENABLED tells BMC AMI Recovery Manager to attempt to offload eligible processing to an available zIIP. If the zIIP is busy or not available, normal processing continues on a general-purpose processor.
  • DISABLED tells BMC AMI Recovery Manager to not attempt to use zIIP processing.

To enable and use zIIP processing with BMC AMI Recovery Manager, you must:

  • Have an installed authorized version of XBM or SUF
  • Start and maintain an XBM subsystem in your environment
  • Have a zIIP available in your environment

You can specify a particular XBM subsystem to use by specifying a value for the XBMID option (with a length of up to 8 characters), or BMC AMI Recovery Manager will discover an XBM subsystem that meets the requirements for zIIP processing

XBM and SUF are licensed, installed, and maintained separately from BMC AMI Recovery Manager. You can use either XBM or SUF, depending on the license that you have obtained:

  • A license for the full version of the XBM product authorizes you to use all features of XBM.
  • A license for SUF authorizes you to use only the snapshot and zIIP-processing features of XBM.

PACLOG

This option specifies whether to use 

PACLOG

 or the ARMBARC program to restore the archive logs. Use 

PACLOG

 YES if you have

PACLOG

 installed.

DISK

The options under DISK specify functions related to disk usage.

Option

Description

UNIT

This option specifies the name of the recovery-site disk drive unit to be used when restoring the recovery site archive log data set copies to disk.

UNITCNT

This option specifies the number of units to be allocated for the output log copies. The default is to leave this option blank, which enables the unit count to be controlled by SMS. If you want to override the system value for this option, you can specify an integral number from 1 to 59.

DATACLAS

This option specifies a valid Storage Management Subsystem (SMS) data class name for the log data sets to be restored to Direct Access Storage Device (DASD) at the recovery site (not to exceed 8 characters). Use this option only when you use SMS.

MGMTCLAS

This option specifies a valid SMS management class name for the log data sets to be restored to DASD at the recovery site (not to exceed 8 characters). Use this option only when you use SMS.

STORCLAS

This option specifies a valid SMS management class name for the log data sets to be restored to DASD at the recovery site (not to exceed 8 characters). Use this option only when you use SMS.

VOLUMES

This option specifies a valid volume for the log data sets to be restored to DASD at the recovery site (not to exceed 8 characters).

COMPRESS

This option specifies whether PACLOG will compress the data when you restore a log copy to disk at the recovery site. This prompt is valid only when you use PACLOG to restore the archive logs.

Important

 You should specify COMPRESS NO when you have DASD hardware compression enabled.


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.

MAXLOGJOBS

This option specifies the number of jobs to use per member for initialization when INITIALIZE ACTIVES is chosen. Valid values are 1 through 10.

MAXLOGJOBS also specifies the number of ARMBARC jobs generated when you specify RESTORE ARCHIVES.

Warning

Do not specify a value that is higher than the number of initiators available. Doing so may cause an unending wait situation.

Multiple jobs cannot be created if the archive logs are stacked on the same tape and have not been restored to disk. BMC AMI Recovery Manager performs stacked tape analysis prior to creating the Phase 1 JCL. The number of log copy jobs may vary based on this analysis and may possibly be less than you requested with the MAXLOGJOBS 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.

CREATEHIST

This option creates an archive history file even when BMC AMI Recovery Manager does not restore the archives to disk. (This archived history file is always created when the archives are restored to disk).

BSDS ARCHLIMIT

This option specifies the maximum number of logs that you want to be 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.

Important

If you specify INITIALIZE ACTIVES, the limit you use should be greater than the number of active logs minus 1. Otherwise, not all of the active logs will be populated.

 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:

  • You must recover the repository at the disaster recovery site to use the data collection feature of the Recovery Management for Db2 solution.
  • The R+/CHANGE ACCUM repository objects are included with the BMC AMI Recovery Manager repository if R+/CHANGE ACCUM is installed.
  • If mirroring is enabled and the repository is designated as mirrored, ARMBSRR does not include the repository in the mirrored JCL. However, if nonmirrored JCL is generated, ARMBSRR includes the repository even if you do not specify RECOVER REPOSITORY.

 RECOVER LOGMASTER

This option recovers the BMC AMI Log Master repository. If you do not include this option, the recovery of the repository is omitted from the recovery job.

Important

If mirroring is enabled and the BMC AMI Log Master repository is designated as mirrored, ARMBSRR does not include the repository in the mirrored JCL. However, if nonmirrored JCL is generated, ARMBSRR includes the repository even if you do not specify RECOVER LOG MASTER.

MAXCATJOBS

MAXCATJOBS specifies a value that is used in the PARALLEL and TAPEUNITS syntax. The result enables multitasking by DSNUTILB recovery instead of multiple jobs. 

MAXLOGJOBS

For more information, see INITIALIZE ACTIVES.

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

Important

BMC AMI Copy cannot make RP Flash copies of the Db2 catalog.

CONDRESTART

This option controls whether a conditional restart is included in the recovery JCL during a local full subsystem recovery.

Important

BMC AMI Log Master for Db2 determines if DDL activity exists for the Db2 Catalog and Directory and if any quiet points are found for the specified recovery range.

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:

  • AUTO—(the default if the Recovery Management for Db2 solution password is found) This parameter instructs ARMBSRR to avoid a conditional restart if possible but to include it if required. If no DDL activity occurred, recovery of the catalog and directory is not required and is not included in the recovery JCL. If quiet points are found within the specified time range, ARMBSRR generates JCL to perform the recovery to the most recent point without the conditional restart. If no quiet points are found, BMC AMI Recovery Manager generates a recovery to the end point of the specified time range and DSNUTILB handles any inflight transactions.
  • YES—(the default if the Recovery Management for Db2 solution password is not found) This parameter instructs ARMBSRR to generate conditional restart JCL for the recovery, regardless of whether quiet points are available within the specified time range.
  • NO—This parameter instructs ARMBSRR to avoid a conditional restart. If quiet points are found within the specified time range, the recovery is performed to the most recent point. When no quiet points are found, BMC AMI Recovery Manager generates a recovery to the end point of the specified time range and DSNUTILB handles any inflight transactions.

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:

  • DREXTEND is NO or DREXTEND is not specified.
  • SIMULATE is YES.
  • JCLTYPE is LOCAL.
  • INITIALIZE ACTIVES is specified.
  • MAXLOGJOBS is greater than 1.
  • MIRROR is YES.

Valid values for DREXTEND are:

  • NO(Default) DREXTEND NO instructs ARMBSRR to not generate the ARMBSDR JCL.
  • YES—DREXTEND YES instructs ARMBSRR to generate JCL to run the ARMBSDR program at the disaster recovery site as part of the Phase 1 job.

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.

ALTLOAD

This option enables you to specify a load library that contains BMC AMI Recovery Manager. This load library is generated in steplibs.

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:

  • The date is in the format yymmdd
  • Time is in the format hhmmss

If you use a different name than the default, do not enclose it in quotation marks.

 EMAIL

(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 nThis 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: 

Example

PGM ARMBSRR IN STEP ARM0000  IN JOB ARMJOB01 J0744296 ENDED WITH RETURN CODE 8

For more information about how to send email notifications, see Setting-email-entries.

BSDS ARCHLIMIT

This option specifies the maximum number of logs that you want to be 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.

Important

If you specify INITIALIZE ACTIVES, the limit you use should be greater than the number of active logs minus 1. Otherwise, not all of the active logs will be populated.

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.

RECORD VALIDATION REPORT

(BMC.DB2.SPE2210)


This option writes a validation report to the RECOVERY_EXCEPTIONS table. You can view the contents of the RECOVERY_EXCEPTIONS table in Command Center.

Valid values for Record Validation Report are as follows:

  • YES(Default) Writes validation report to the RECOVERY_EXCEPTIONS table
  • NO—Disables inserts into the RECOVERY_EXCEPTIONS table regardless of whether a solution password exists

BYPASS ENCRYPTION

(BMC.DB2.SPE2210)

This option checks whether the object is encrypted or not. The BMC AMI Recovery Manager system resources recovery performs this check by default.

Valid values for Record Validation Report are as follows:

  • YES—Bypasses encryption checking done by system resources recovery and disables encryption checking inserts into the RECOVERY_EXCEPTIONS table.
  • NO(Default) Checks whether objects required for system resources recovery are encrypted.             

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

EXCLUDE MEMBERS

This option excludes permanently quiesced members from 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.

Important

EXCLUDE MEMBERS replaces QUIESCED MEMBER, which is available in BMC AMI Recovery Manager.

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.

BYPASS DEACT

This option excludes members that are in DEACT status from disaster recovery.

PRIMEALLOC

This option specifies the allocations to be used when allocating VSAM files for the Db2 catalog and directory, as follows:

  • PRIMEALLOC ASIS—BMC AMI Recovery Manager uses the same primary and secondary space allocations that are used at the local site
  • PRIMEALLOC ALL—BMC AMI Recovery Manager uses all required space in the primary extent

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.

Important

ARCHIVE NOTCATLG is not valid if you specify that the archive logs are to be restored to disk (see RESTORE ARCHIVE1 or RESTORE ARCHIVE2). Restoration to disk requires that all archive logs be cataloged.

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

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.

Important

You must have BMC AMI Recover to use this option.

MISSINGCOPIES

This option indicates whether BMC AMI Recovery Manager is to FAIL, which is the default value, or WARN if copies are missing.

  • When MISSINGCOPIES FAIL is specified in the JCL, BMC AMI Recovery Manager sets RC=8, issues message BMC80622W, and stops processing if missing copies are detected.

    Following is an example of output when MISSINGCOPIES FAIL is specified and missing copies are detected:

    BMC80622W NO COPIES FOUND FOR DSNDB01.SYSUTILX. CONTINUING WITHOUT COPY ANALYSIS
    BMC80622W NO COPIES FOUND FOR DSNDB01.DBD01. CONTINUING WITHOUT COPY ANALYSIS   
    BMC80622W NO COPIES FOUND FOR DSNDB01.SYSDBDXA. CONTINUING WITHOUT COPY ANALYSIS   
    BMC80622W NO COPIES FOUND FOR DSNDB06.SYSCOPY. CONTINUING WITHOUT COPY ANALYSIS
    BMC80622W COPY NOT CATALOGED FOR DSNDB06.SYSGRTNS. CONTINUING WITHOUT COPY ANALYSIS
    BMC80799W   COPY DSNAME = RDAJLW.DSNDB06.SYSGRTNS.LP100727.T112311              
    BMC80799E JCL NOT GENERATED DUE TO MISSING OR UNCATALOGED COPIES                               
    BMC80570I COMMAND COMPLETE RC = 8
  • If you specify MISSINGCOPIES WARN in the JCL, BMC AMI Recovery Manager sets RC=4, issue message BMC80622W, and continue processing if missing copies are detected.

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, which means that DSNUTILB RECOVER determines the maximum number of tape units. ARMBSRR accepts a range of 0 through 32 for MAXTAPEUNITS.

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.

LIMIT DAYS

This option specifies how many days' worth of log data sets is 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 is 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.

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.

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:

  • YES—(Default) instructs ARMBSRR to include work file database objects in the recovery job.
  • NO—instructs ARMBSRR to exclude work file database objects from the recovery job.

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.

 DSNTEP2PLAN planName

(BMC.DB2.SPE2304)

Specifies the plan name for the DSNTEP2 program. The default plan name is DSNTEP2.       

If you do not use this option, ARMBSRR searches for the DSNTEP2 plan name in the POF (product options file).

To register the DSNTEP2 plan name in the POF, specify one of the following options:

For the SSID level, ssid.DSNTEP2PLAN=planName
For the global level,  DSNTEP2PLAN=planName

Rules for naming Plan name

  • A plan name cannot be longer than eight characters.
  • The plan name character must be either a letter or one of the following three special characters: #, @, $.
  • The remaining seven characters can be letters, numbers, or one of the following special characters: #, @, or $.
  • A plan name cannot contain a hyphen (-).
  • A plan name cannot contain quotes (' ') or (" ").
  • A plan name cannot contain accented characters (à, é, è, and so on).

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*