ARMBGEN SET OPTIONS option descriptions


In the ARMIN input data set, provide the optional SET OPTIONS control statement. You can have multiple SET OPTIONS statements in the control data set.

Each SET OPTIONS statement applies to the GENJCL control statement immediately following it.


Option

Description

SIMULATE

Simulates disaster recovery for the objects in the object set or object sets. The recovery simulation feature simulates all aspects of recovery up to, but not including, the actual I/O. You might find disaster recovery simulation useful in reducing your disaster recovery testing costs. The default is NO. SIMULATE is a feature of the Recovery Management solution and requires the solution password.

You must specify the following options to use SIMULATE YES:

Option

Specification

RECOVER TO

Specify one of the following values:

  • CURRENT
  • COMMON RECOVERY POINT
  • SPECIFIC LOGPOINT
  • RESTART RBA
  • TIMESTAMP

SITETYPE

Specify one of the following values:

  • RECOVERY 1
  • LOCAL

SIMULATE RECOVERY

YES

1 If you specify Sitetype=Recovery, you must have RP or RB copies.

Important

  • SIMULATE YES is valid only when BMC AMI Recover is the recovery utility.
  • When you are using SIMULATE YES, you cannot set a value for Max concurrents jobs greater than 1.
  • SIMULATE YES is not valid with the BMC AMI Recover options LOGSCAN YES or UNLOADKEYS/BLDINDEX YES. If these options are specified for the object sets for which you are simulating recovery, ARMBGEN issues an error message and does not generate the JCL.
  • If you specify SIMULATE YES for an object set that uses DSNUTILB as the recovery utility, any JCL that is generated will not execute due to JCL logic that is generated by simulation mode.
  • ARMBGEN simulates the recovery of application resources only. The ARMBSRR program can simulate the recovery of the Db2 system resources. Online support for both system and application recovery simulation is also available. For more information, see the Recovery Management for Db2 documentation.

ESTIMATE

Estimates application resource recovery for a remote site. When you specify this option, ARMBGEN produces an estimate of the amount of time the recovery of your application resources will take, considering the options that you set and the unique configuration of your subsystem, including the number of table spaces, the 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 Recovery Management for Db2 solution. For more information about estimation and simulation, see the Recovery Management for Db2 documentation.

BACKOUT

Specifies whether the BACKOUT option is using BMC AMI Recover or IBM Db2 RECOVER (DSNUTILB) as the recovery utility. The BACKOUT option invokes the backout strategy for point-in-time recovery by using log points (TOLOGPOINT, TOQUIESCE) or a timestamp (Recovery Management solution only). This strategy assumes that spaces are undamaged and that you require a reset to a point in time. The spaces are used along with the log records between the point in time and the current point to back out to the required state. LOGSORT is required to properly order the log records. The default is NO when using BMC AMI Recovery Manager alone or when DSNUTILB is the recovery utility. The default is AUTO when using BMC AMI Recovery Manager as part of the Recovery Management for Db2 solution.

Specify one of the following values:

Value

Description

NO

Do not perform backout recovery

YES

Perform backout recovery for all objects in the object set

AUTO

Use the backout-to-forward recovery strategy and not valid with DSNUTILB

(For more information, see the Recovery Management for Db2 documentation .)

Be aware of the following information when using BACKOUT:

  • If you do not code the BACKOUT option at all in the JCL and you are using AFRMAIN as the recovery utility, ARMBGEN defaults to
    • BACKOUT AUTO if you are using BMC AMI Recovery Manager as part of the Recovery Management solution
    • BACKOUT NO if you are using BMC AMI Recovery Manager outside the solution.
  • If you are using DSNUTILB as the recovery utility, BACKOUT AUTO is invalid. If you specify DSNUTILB using the online interface, the program overrides BACKOUT AUTO and converts the request to BACKOUT NO during JCL generation.
  • If you specify BACKOUT AUTO or BACKOUT YES, you must choose one of the following recovery points:
    • TOQUIESCE
    • TOCOMMONRECPT
    • TOLOGPOINT
    • TOTIMESTAMP

(Recovery to CURRENT, TOCOPY, or TORESTARTRBA are not valid choices with a backout recovery.)

See About BACKOUT recovery for a list of options that conflict with BACKOUT AUTO.

ANALYZE

Prints a recovery plan before executing the plan. Specify one of the following values:

  • YES—prints a recovery plan and generates JCL for recovery. YES is the default value. Information that is printed includes
    • Names of any required image copy data sets
    • Names of any required log data sets
    • Log ranges, if any
    • Phases that will occur during execution
    • Number of log pages to be read
    • Record sizes for index sort work data sets
    • Steps to occur within each phase
  • NO—prints only the information in the first four bullets and generates JCL for recovery.
  • ONLY— terminates after the information is printed.

BMC AMI Recovery Manager sets ANALYZE to NO if the recovery utility is DSNUTILB.

SITETYPE

Specifies whether the JCL created by ARMBGEN is to be run at the local site (the default) or at a recovery site. If you specify SITETYPE RECOVERY, ARMBGEN automatically sets the following object set options to Yes:

  • DELETE_STOGROUP_OBJ
  • REDEFINE_VCAT_OBJ

If you specify Db2 Recover (DSNUTILB) as the recovery utility for the object set and if you specify the DSNUTILB site type in the DSNUTILB-specific options, then the SITETYPE option is ignored. Also, if you use BMC AMI Recover alternate resources and you select the RP or RB copy as your first choice for the image copy in the recovery options, BMC AMI Recovery Manager considers the site type to be RECOVERY regardless of what you specify here. For more information about setting recovery utility options using the online interface, see Setting-utility-options.

UNRECOVER_RC

Specifies a return code that ARMBGEN should issue if it encounters an object that cannot or will not be recovered.

Valid values are 0 through 254, and the default value is 4. A value of zero causes no return code to be issued and values (even those higher than 4) do not affect the step execution. This return code does not control the overall job return code. If BMC AMI Recovery Manager encounters errors other than unrecoverable data, it sets the return code based on the most severe condition code of all of the types of errors found.

An object is considered to be unrecoverable by ARMBGEN if it exists in any of the following states:

  • ALTER IX
  • BAD TYPE
  • DS LEVEL
  • NOTAVAIL
  • TSREORP
  • TS STAT

For more information about object status, see BMC-AMI-Recovery-Manager-object-exception-status.

RESOLVE_INFLIGHTS

Specifies whether inflight units of work are to be resolved during a recovery to a user-specified RBA or LRSN. This option is only valid for a recovery using TOLOGPOINT or TOLOGMARK and is available only with the Recovery Management for Db2 solution.

JCLTYPE

Specifies whether the JCL used is for the remote or local site. This option is used for mirroring support only. The default is the value specified in SITETYPE.

ARMBGEN only verifies that resources are actively mirrored if all of the following conditions are true:

  • The JCLTYPE is DR
  • Mirroring level 2 or higher has been established at the subsystem level
  • The recovery is TORESTARTRBA
  • The Recovery Management for Db2 solution password is in effect

Important

JCLTYPE DR does not turn on the Delete Stogroup Objects option. The Delete Stogroup Objects option must be set in the object set options.

REPORTIX

Specifies whether to create a report showing all indexes that are associated with table spaces in the object set, but that are not included in the recovery because they are not in the object set.

REPORTLOBS

Specifies whether to create a report showing LOB-related spaces that are associated with table spaces in the object set, but that are not included in the recovery because they are not in the object set.

REPORTXML

Specifies whether to create a report showing XML-related spaces that are associated with table spaces in the object set, but that are not included in the recovery because they are not in the object set.

REPORTRI

Specifies whether to create a report showing all spaces related by referential integrity with table spaces in the object set, but that is not included in the recovery because they are not in the object set.

REPORTHISTORY

Specifies whether to create a report showing spaces that are associated with table spaces in the object set by a history (versioning) relationship, but that is not included in the recovery because they are not in the object set.

REPORTARCHIVE

Specifies whether to create a report showing archive table spaces that meet both of these conditions:

  • Are associated with table spaces in the object set
  • Are not included in the recovery because they are not in the object set

CLONES ONLY

Specifies whether to include only clones in the processing. Non-cloned objects will be excluded. This option is not valid with compatibility mode.

SYNC

Specifies whether to use synchronization steps to control the running of multi-job JCL. SYNC YES generates synchronization steps, which ensure that the jobs are run automatically in the most efficient way possible. SYNC NO causes multi-job JCL to be generated without the synchronization steps. You must run the jobs manually in the correct sequence. The default is YES.

This option requires the MAX_CONCURRENT_JOB option to be greater than 1 and is incompatible with UNLOADKEYS_BUILDINDEX=YES, which requires synchronization steps. SYNC is not available in the online interface.

LOGONLY

Specifies whether the recovery is a log-only recovery. The default value is NO.

Important

Use this option only when the target application data sets exist at the disaster recovery site.

LOGONLY is not allowed with the following options:

  • SIMULATE YES
  • TOCOPY
  • BACKOUT

OBJECTSET

Specifies whether BMC AMI Recover is to use the repository to identify the objects in the object set, which means that you do not need to regenerate the recovery JCL when objects in the object set to change. The default value is YES.

BMC AMI Recovery Manager generates the TABLESPACE OBJECTSET option and the INDEX OBJECTSET option in the recovery JCL.

EMAIL ENTRY NAME

Specifies the email entry name. The email entry name must pass the same validation as a member name.

EOJ_RC n

The value of n must be a number from 0 through 254. If the ARMBGEN return code is greater than or equal to the EOJ_RC value, an end-of-job email is sent. Emailing the end-of-job notification is optional. For more information about how to send email notifications, see Setting-email-entries.

The following is an email output example: 

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


EMAIL TIME EXCEEDED

Use the EMAIL TIME EXCEEDED option to request an email notification if the email time exceeded is specified , ARMBGEN completes, and the time estimate exceeds the time objective.

INDEP OUTSPACE


Specifies whether to recover to an independent outspace and not the table spaces. To use this option, you must have BMC AMI Recover. The default value is NO.

Field

Description

MODEL

(Optional) BMC AMI Recover uses a default model if you do not enter a value.

(BMC.DB2.SPE2410) BMC AMI Recovery Manager allows the use of the concatenation operator (||) to append text to symbolic variables. For example, &TS||A1. The concatenation operator is supported wherever data set name patterns are specified.

TO_SSID

BMC AMI Recover fills in the local objects DBID, PSID, and OBID. If the target Db2 is on the same LPAR and active, then DBID, PSID, and OBID are also filled in. 

If Db2 is not on the same LPAR, you must enter the correct SSID for the correct DBID, PSID, and OBID translation of the target Db2 subsystem that matches the objects. If the target Db2 subsystem is remote and not on the same LPAR, the SSID is omitted and default values are entered for the target DBID, PSID, and OBID.

LISTDEFDD


Specifies the ddname of the LISTDEF definition library. A LISTDEF library is a data set that contains only LISTDEF utility control statements.

Value

Description

DSN

Specifies the data set name of the LISTDEFDD

For a partitioned data set, include the member name.

LIST_NAME

Specifies the name of the list that is defined by using the LISTDEF control statement.

TEMPLATEDD


Specifies the ddname of the TEMPLATE definition library. A TEMPLATE library is a data set that contains only TEMPLATE utility control statements.

Value

Description

DSN

Specifies the data set name of the TEMPLATEDD. For a partitioned data set, include the member name.

TEMPLATE_NAME

Specifies the name of the template that is defined by using the TEMPLATE control statement.

 

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