Template Programming Interface Guide › Backup Job Exception Files › OPTIONS Record

OPTIONS Record

OPTIONAL

Use OPTIONS records to specify processing options the job is to apply to domains the exception file identifies.

A file can include multiple OPTIONS records. You can specify more than one parameter on an OPTIONS record; however, you can use each parameter only once for each domain specified on an EXCEPT record in the file.

OPTIONS [“Keywords”]...

Keywords:

  BKPFILE {STANDARD | EXPANDED}
| BKPDETAIL {DOMAIN | FILE}
| BKPTYPE {ARCHIVE | LOGICAL | CMS | PHYSICAL | CMSALLOC | SFS}
| CATDETAIL {DOMAIN | FILE}
| CMSCHANGE {DATE | HASH}
| CMSSWITCH {YES | NO}
| CMSTRIES number
| PACKDATA {YES | NO}
| PHYSCHANGE {HASH | NONE}
| QUIESCE {YES | NO}
| SECURITY {[AES | DES3 | DES | RC2]  hexwords... | NONE}
| SFSTRIES number

Definitions

BKPFILE {STANDARD | EXPANDED}

Specifies whether CA VM:Backup is to store additional file information with the file. STANDARD indicates that CA VM:Backup is not to store the additional file information; EXPANDED indicates that CA VM:Backup is to store the additional file information on the tape.

Note: This parameter is only available through TPI. Using BKPFILE STANDARD will not prevent you from managing the job template file through CA VM:Backup screens.

The BKPFILE EXPANDED parameter can only be used by an authorized client.

BKPDETAIL {DOMAIN | FILE}

For an incremental backup job, specifies the level of detail the job is to back up-the entire domain or just the portion that has changed since the previous backup. DOMAIN specifies detail at the domain level. FILE specifies detail at the file level.

BKPTYPE {ARCHIVE | LOGICAL | CMS | PHYSICAL | CMSALLOC | SFS}

Specifies the type of backup format the job is to use. For explanations of the backup formats, see the Systems Programmer Reference.

Note: CA VM:Backup always exports the BKPTYPE SFS parameter as BKPTYPE LOGICAL. If an EXCEPT record specifies SFS data, CA VM:Backup performs an SFS backup of that data, regardless of backup format specifications on corresponding OPTIONS records.

BKPTYPE SFS is available only through TPI; using this parameter will not prevent you from managing the exception file using CA VM:Backup screens. BKPTYPE ARCHIVE is available only through TPI and can be used only by an authorized client.

CA VM:Backup uses the SFS backup type for BFS data as well.

CATDETAIL {DOMAIN | FILE}

Specifies the level of detail the job is to include in a catalog. DOMAIN specifies detail at the domain level. FILE specifies detail at the file level.

CMSCHANGE {DATE | HASH}

Specifies change detection information for data backed up in CMS format. For a full backup, CMSCHANGE specifies what to save in the catalog to use for comparison during an incremental backup to detect if data has changed. For an incremental backup, it specifies what values should be compared with the values stored in the catalog to determine whether data has changed. For more information, see the change detection information in the Administration Guide.

CMSSWITCH {YES | NO}

Specifies how the job is to handle a CMS minidisk that is still changing after trying to back it up the number of times specified by the CMSTRIES parameter. NO tells the job to skip the minidisk. YES tells the job to switch to a physical backup of this minidisk.

CMSTRIES number

Specifies the number of times the job is to try to back up a CMS minidisk that changes during the backup. Enter an integer from 1 through 9 for number. After number tries, the job either skips the minidisk or switches to a physical backup of the minidisk, as specified by the CMSSWITCH parameter. The default is 3.

PACKDATA {YES | NO}

Specifies whether the job is to pack data.

PHYSCHANGE {HASH | NONE}

Specifies change detection information for data backed up in physical format. For a full backup, PHYSCHANGE specifies what to save in the catalog to use for comparison during an incremental backup to detect if data has changed. For an incremental backup, it specifies what values should be compared with the values stored in the catalog to determine whether data has changed. See the change detection information in the Administration Guide.

QUIESCE {YES | NO}

Specifies whether the job is to quiesce the minidisk or file space.

SFSTRIES number

Specifies the maximum number of times the job is to check for changes in a file space during a backup. If after number checks CA VM:Backup still detects changes, the job backs up the file space, but writes a message in the job output report indicating that it could not obtain a consistent point-in-time view of the file space. Enter an integer from 0 through 9. The default is 0, which means that CA VM:Backup. does not perform a consistency check. This default is suitable for most sites because SFS guarantees a consistent view of individual files. However, if you run applications that require files to be maintained at the same commit level (synchronized), have CA VM:Backup perform one or more consistency checks, or quiesce the file space.

Note: This option has no effect on BFS file spaces. BFS files are update-in-place files; CA VM:Backup cannot detect changes in these files. To ensure a consistent point-in-time view of a BFS file space, you must quiesce the file space during backups.

SECURITY {[AES | DES3 | DES | RC2] hexwords… | NONE}

Specifies the security algorithm and the security key as three to eight words of hexadecimal (depending on the security algorithm) that will be used to encrypt or decrypt the data it is backing up.

Note: For backward compatibility, DES and RC2 do not need to be specified. However, we encourage you to specify a security algorithm name, even if you chose to use DES or RC2.

For more information, see the Security Algorithm Name and Security Key information in the CA VM:Backup Administration Guide.