Template Programming Interface Guide › Restore 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.

This record is optional. You can include as many as you need in an exception file. 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 exception file.

OPTIONS {“Parms”}...

Parms:

  BFSCHECK {userid /gname | NONE}
| RESALIAS {YES | NO}
| RESAUTH {YES | NO}
| RESDATE {OLDDATE | NEWDATE}
| RESEXTERN {YES | NO}
| RESSFS {CLEAR | REPLACE | NEWFILE | RECALL}
| RESTYPE {FORMAT | REPLACE | NEWFILE | ERASE | FMTALWAYS}
| SECURITY {[AES | DES3 | DES | RC2]  hexwords… | NONE}

Definitions

BFSCHECK {userid / gname | NONE}

Specifies whether the job is to verify that the requesting user (userid/gname) has the POSIX permissions required to restore files to the specified target directory. The variable userid is a VM logon user ID. The variable gname is a POSIX group name. The variable gname is case sensitive. To restore to a directory, the user must have write permission to the directory and search permission to each of its parent directories. The permission can exist for the owner, group, or other. If the user does not have the required permissions, CA VM:Backup does not restore the files and the job continues. CA VM:Backup writes message 0376E to the job output report indicating the files could not be restored.

RESALIAS {YES | NO}

Specifies whether the job is to restore any alias files that may have been backed up with an SFS directory. The job restores alias files after it restores all data.

Note: This parameter is available only through TPI. Using the RESALIAS NO parameter will prevent you from managing the exception file through the CA VM:Backup screens.

RESAUTH {YES | NO}

Specifies whether the job is to restore any authorizations that may have been backed up with an SFS file or directory or any authorizations or permissions that may have been backed up with a BFS directory.

Note: This parameter is available only through TPI. Using the RESAUTH NO parameter will prevent you from managing the exception file through the CA VM:Backup screens

RESDATE {OLDDATE | NEWDATE}

Specifies whether the job is to restore a file and make the file date the date the file was last updated before the system backup (OLDDATE) or the current date (NEWDATE). When restoring a migrated file, CA VM:Backup ignores the RESDATE NEWDATE parameter.

Note: This parameter is available only through TPI. Using the RESDATE NEWDATE parameter will prevent you from managing the exception file through the CA VM:Backup screens.

RESEXTERN {YES | NO}

Indicates whether the job is to restore any external objects that were backed up with an SFS directory. External objects are SFS objects that exist outside SFS file pools.

Note: This parameter is available only through TPI. Using the RESEXTERN NO parameter will prevent you from managing the exception file through the CA VM:Backup screens

RESSFS {CLEAR | REPLACE | NEWFILE | RECALL}

Specifies how the job is to restore SFS and BFS data.

The action of the CLEAR option depends on the restore target.

• SFS or BFS file space

  Erases all files and directories in the file space

• SFS directory

  Erases all files in the selected directory and deletes authorizations to the selected directory. Subdirectories are not affected.

• BFS directory

  Erases all files in the selected directory. Subdirectories are not affected.

CLEAR is the only valid option for file space restores; it is the default for file space restores.

REPLACE specifies that, if a file with the same name exists, the job is to replace it with the file being restored.

NEWFILE tells the job to restore only those files that do not already exist in the directory. NEWFILE is the default for file and directory restores.

Note: The actions of the REPLACE and NEWFILE options are basically the same for SFS data as they are for BFS data; however, because BFS files can have multiple links, the results of the restore depend on how the data is linked in the backup and in the target. See the Options for Handling Existing Data in Target Entities (BFS Data) section in the Restoring Data chapter of the System Programmer Reference Guide for more information about how the REPLACE and NEWFILE options work for BFS data.

RECALL specifies that the job is to restore data to migrated files that exist in the directory; the data being restored must be the data the file contained before it was migrated.

Note: The RESSFS parameter is available only through TPI. Using this parameter will prevent you from managing the job template file through the CA VM:Backup screens. The RESSFS RECALL parameter can only be specified by an authorized client.

RESTYPE {FORMAT | REPLACE | NEWFILE | ERASE | FMTALWAYS}

Indicates how the job is to restore CMS data.

FORMAT specifies the job is to format the target minidisk before restoring the data. If the job does not find any data to restore, it does not format the target minidisk.

REPLACE specifies that CA VM:Backup is to replace files on the target minidisk that have the same name as ones being restored. The job writes the data for a file to a work file, erases the existing file from the minidisk, and renames the work file to the original filename. If the restore does not complete successfully, the existing file is left intact and the work file is erased.

NEWFILE specifies the job to restore only those files that do not already exist on the minidisk.

ERASE specifies that CA VM:Backup is to erase files on the target minidisk that have the same name as ones being restored. The job deletes the existing file before restoring the backed-up version. If the ERASE option is specified and the restore job does not complete successfully, both the existing file and the file being restored may be lost.

FMTALWAYS tells the job to always format the minidisk, even when there is no data to restore.

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

Specifies the security algorithm and security key to be 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 recommend that you 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.