ARMBGPV SET OPTIONS option descriptions

In the ARMIN input data set, provide the optional SET OPTIONS control statement.

If you do not code a SET OPTIONS control card, you receive all possible reports by default.

Related topic

ARMBGPS-syntax-and-option-descriptions


Value

Description

CLONES ONLY

Specify whether to include only clones in the revalidation processing. This option is not valid with compatibility mode.

RECOVERABILITY

Validates the recoverability of each object in the object set to the selected recovery point. This validation enables you to verify recoverability by identifying recoverability exceptions (for example, data sets for which no copies were found). The report is written to the data set that is defined by the ARMXCEPT DD statement. The default is YES.

RESOURCES

Reports the resources needed for the recovery of a object set. These resources include image copy data sets, log data sets, and R+/CHANGE ACCUM files. Use this report as a checklist of data sets that must be taken offsite in preparation for disaster recovery.

If the current subsystem is a member of a data-sharing object set, the resources report is for the object set. Otherwise, the report is for the current subsystem. The report is written to the data set that is defined by the ARMRESRC DD statement. The default is YES.

RECALL

Produces a report of the archived data sets that are needed for recovery. The report is written to the data set that is defined by the ARMRCALL DD statement. The default is YES.

UNRECOVER_RC

Specify a return code that ARMBGPV should issue if it encounters an unrecoverable object during revalidation. The UNRECOVER_RC option is ignored if you choose the RECOVERABILITY NO option.

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

Unrecoverable objects are listed in the exception report (ARMXCEPT) if you request it using the RECOVERABILITY YES option, whether or not you specify UNRECOVER_RC.

An object is considered to be unrecoverable by ARMBGPV if it exists in any of the following states or if it has missing recovery resources:

  • ALTER IX
  • BAD TYPE
  • DS LEVEL
  • ENCRYPTION_REQUIRED
  • LOG GONE
  • NOCOPIES
  • NOTAVAIL
  • NOTCTLG
  • TSREORP
  • TS STAT

Important

The following statuses are unique to ARMBGPV:

  • ENCRYPTION_REQUIRED — if set to YES, sets the unrecoverable return code
  • LOG GONE — indicates that one or more of the logs that are required for recovery are missing
  • NOTCTLG — one or more recovery resources are uncatalogued

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

You can use the Health Check option with UNRECOVER_RC.

  • The HEALTHCHECK command must always end with RC 0 unless UNRECOVER_RC is used to override it.
  • Use the UNRECOVER_RC n option in conjunction with the EMAIL entry name EOJ_RC n to receive an email notification when a health check finds something that needs to be addressed.
  • The changed objects option is not affected by UNRECOVER_RC.

PICKLIST

Produces a report of the tape volumes that are needed for recovery This report enables tape operators to locate the required tapes prior to recovery and is written to the data set defined by the ARMPICK DD statement. The default is YES.

SITETYPE

Determines whether the selected reports are generated by using the local site or recovery site resources. The default is LOCAL.

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.

LOGCOPY

Specifies which copy of the archive log (1, 2, or 3) to report or verify. If SITETYPE LOCAL is used, the value is always set to 1. If SITETYPE RECOVERY is used, the default is 3.

BACKOUT

Validates the availability of resources required for a BACKOUT AUTO, BACKOUT NO, or BACKOUT YES recovery. This option is available when using BMC AMI Recover or Db2 RECOVER (DSNUTILB) as the recovery utility.

BACKOUT AUTO is only available when you are using the Recovery Management solution password. The default is AUTO if you are using BMC AMI Recovery Manager as part of the Recovery Management solution. Otherwise, the default is NO.

You must specify QUIESCE or SPECIFIC LOGPOINT as the recovery point to use BACKOUT AUTO or BACKOUT YES. If you specify TOCURRENT, BMC AMI Recovery Manager overrides the BACKOUT AUTO and converts the option to BACKOUT NO.

JCLTYPE

Specifies whether the JCL is for use at the remote or local site. This option is used for mirroring support only. The default is the value specified in SITETYPE. For information about mirror revalidation, see Revalidating mirroring for object sets.

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 and is available only with the Recovery Management for Db2 solution. For more information, see the section about timestamp recovery in the Recovery Management for Db2 documentation.

EMAIL

(Optional) Enables you 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 SUMMARY :  Use the EMAIL entryName SUMMARY option to email a Summary Report. The entry name must pass the same validation as a PDS member name.

  • 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 ARMBGPV return code is greater than or equal to the EOJ_RC value, an End of Job email is sent.  
    For more information about how to send email notifications, see Setting-email-entries.
    The following is an Email output example: 

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

RECORD RECOVERY EXCEPTIONS

(BMC.DB2.SPE2210)

Specifies whether to populate the RECOVERY_EXCEPTIONS table and also improve ARMBGPV performance if the RECOVERY_EXCEPTIONS table is not updated

The valid values are as follows:

Value

Description

Yes

(Default) Writes all recoverability exceptions to the RECOVERY_EXCEPTIONS table.

No

Disables inserts into the RECOVERY_EXCEPTIONS table regardless of whether the solution password exists.

UNRECOVERABLE_EVENTS


Checks each object in the object set for unrecoverable events, including events that occurred:

  • Between the specified recovery point and the current time for backout recovery
  • From the specified image copy type to the recovery point

The valid values are YES and NO. The default value is NO.

Important

Use UNRECOVERABLE_EVENTS only for the Health Check option.

ARCHIVE_LOGS

Checks that the required archive logs exist for each object in the object set, including events that occurred:

  • Between the specified recovery point and the current time for backout recovery
  • From the specified image copy type to the recovery point   

The valid values are YES and NO. The default value is NO.

Important

Use ARCHIVE_LOGS only for the Health Check option.

IMAGE_COPIES 

Checks whether an image copy of a specified copy type has as been created within the specified number of hours or days.

The valid values are YES and NO. The default value is NO.

(BMC.DB2.SPE2304)

Type—Specifies the image copy type to check for. Valid values are as follows. 

Value

Description

Any

(Default) Checks for objects that have copies if either a full or incremental copy is available for each object in the object set. 

Full

Checks for image copies that include at least one full copy within the specified range.

Taken within—Checks whether an image copy has been created within the specified number of hours (1 through 960) or days (1 through 40). You can't specify both hours and days.

Value

Description

COPIES_HOURS nnn

Verifies that an image copy has been created within the specified number of hours. The valid range is from 1 through 960 hours.

This option is mutually exclusive with COPIES_DAYS nnn.

COPIES_DAYS nn

Verifies that an image copy has been created within the specified number of days. The valid range is from 1 through 40 days.

This option is mutually exclusive with COPIES_HOURS nn.

Important

Use IMAGE_COPIES only for the Health Check option.

CHANGED_OBJECTS 

Checks if objects have been changed since the specified recovery point. Each object in the object set is checked for a log range between the specified recovery point and the current time.

The valid values are YES and NO. The default value is NO.

Important

Use CHANGED_OBJECTS only for the Health Check option.

ENCRYPTED_OBJECTS

Checks whether objects in the object sets are encrypted. Each table space in the object set is checked for encryption.

The valid values are YES and NO. The default value is NO.

Important

Use ENCRYPTED_OBJECTS only for the Health Check option.

EXCEPTION_STATUS 

Checks for each object in the object set for an exception status. EXCEPTION_STATUS is defined as not in RW status.

The valid values are YES and NO. The default value is NO.

Important

Use EXCEPTION_STATUS only for the Health Check option.

SYSCOPY_ENTRIES

Checks for entries in SYSCOPY/BMCXCOPY older than the timestamp. Each object in the object set is checked for SYSCOPY or BMCXCOPY rows older than the specified timestamp. This helps to determine which objects have rows that are obsolete and should be deleted.

The valid values are YES and NO. The default value is NO.

Important

Use SYSCOPY_ENTRIES only for the Health Check option.

RECOVERY_POINT

Specifies by Timestamp, Current minus hours, or Current minus days to check for unrecoverable events and verify required archive logs, changed objects, and SYSCOPY/BMCXCOPY entries.

You can choose any one of the following values:

Value

Description

TIMESTAMP

Timestamp is specified in YYYY-MM-DD-HH.MM.SS format. The date cannot be a future date. If you specify current minus hours or current minus days, then that is used instead of Timestamp.

CURRENT_MINUS_HOURS n

Current minus hours specified with a range of 1–960. This is an alternate way of specifying the Timestamp. This option is mutually exclusive with CURRENT_MINUS_DAYS n.

CURRENT_MINUS_DAYS n                            

Current minus days specified with a range of 1–40. This is an alternate way of specifying the Timestamp. This option is mutually exclusive with CURRENT_MINUS_HOURS n.

Important

Use RECOVERY_POINT only for the Health Check option.

COPY_TYPE  

Checks for unrecoverable events, verifying required archive logs, and verifying image copies. The COPY_TYPE values are LP, LB, RP, RB, or FC. The default value is LP.

Important

Use COPY_TYPE only for the Health Check option.

REBUILD_INDEXES 

Specifies whether BMC AMI Recovery Manager should rebuild indexes. This is required to check for unrecoverable events and verify required archive logs and image copies. Rebuild indexes specified as YES or NO. The default value is NO.

Important

Use REBUILD_INDEXES only for the Health Check option.

 

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