OPTIONS Record

Template Programming Interface Guide › Restore Job Template Files › OPTIONS Record

OPTIONS Record

OPTIONAL

Use the OPTIONS record to specify processing options for the job to apply to the domains it restores, unless an exception file specifies different options for a particular domain.

A file can include multiple OPTIONS records. Each record can specify more than one parameter; however, a file can include only one of each parameter.

Note: The JOBEND and ONETIME parameters have been replaced by equivalent parameters on the JOBOPTIONS record.

OPTIONS {“Options”}...

Options:

  BFSCHECK {userid | gname | NONE }
| DIRSCAN {YES | NO}
| RESALIAS {YES | NO}
| RESAUTH {YES | NO}
| RESDATE {OLDDATE | NEWDATE}
| RESDEV {SOURCE | EXCEPTION | RDR}
| RESEXTERN {YES | NO}
| RESFPOOL {ALL | SKIP}
| RESHALT {YES | NO}
| RESLINK {WRITE | MULT}
| RESSFS {CLEAR | REPLACE | NEWFILE | RECALL}
| RESTYPE {FORMAT | REPLACE | NEWFILE | ERASE | FMTALWAYS}

Definitions

BFSCHECK {userid | gname | NONE}

Specifies whether the job is to verify that the requester has the POSIX permissions required to restore files to the 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 permission, 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.

DIRSCAN {YES | NO}

Specifies whether the job is to scan the CP online directory and SFS file pools for domain information.

DIRSCAN NO does not mean that the job will never read the CP online directory; the job may scan the directory for information that will enable CA VM:Backup to link to target minidisks. The job does not query the SFS file pool to search for file space or directory information. This information is included in the job template file and any associated exception file, and CA VM:Backup considers it valid.

Only VOLSER restore job template files can specify DIRSCAN NO. (CATSEARCH and VOLSEARCH restore job templates must specify DIRSCAN YES.) When a VOLSER restore job template file specifies DIRSCAN NO:

The job considers the minidisk information indicated in the job template file and any associated exception file valid and uses it.
You must identify the file pool information to CA VM:Backup on the FILEPOOL configuration file record, and CA VM:Backup must be an administrator of that file pool.
The INCLUDE records in the job template file must explicitly specify the domains the job is to restore; the records cannot use pattern matching.

Note: A file that specifies DIRSCAN NO cannot use ALTERNATE, INCLUDE ACCOUNT, or INCLUDE ACIGROUP records. Those records require the job to scan the CP online directory for minidisk and volume information.

This parameter is available only through TPI. Using the DIRSCAN NO parameter will prevent you from managing the job template file through the CA VM:Backup screens.

RESALIAS {YES | NO}

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

Note: This parameter is available only through TPI. Using the RESALIAS NO parameter will prevent you from managing the job template 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 job template 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 data to 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 job template file through the CA VM:Backup screens.

RESDEV {SOURCE | EXCEPTION | RDR}

Specifies where the job is to restore data. The RESDEV option does not apply to BFS data.

SOURCE specifies that the job is to restore data to the same domain from which it was backed up. For VOLSER restore jobs, the exception file can contain a RESTO record that can override where the job restores the data.

This option is available only through TPI.

Note: RDR specifies that the job is to restore the data to the virtual reader of the user ID from which the data was backed up. File-level catalogs must be available. You can use this option in a CATSEARCH restore job template file. You cannot use this option in a VOLSEARCH job.

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 job template file through the CA VM:Backup screens.

RESFPOOL {ALL | SKIP}

Specifies how the job is to handle existing file spaces in the file pool it is restoring.

ALL indicates that the job is to restore all file spaces from the backed-up file pool, whether they already exist in the target file pool or not. Restore processing is as follows:

If a file space exists in the backed-up file pool but not in the target, CA VM:Backup enrolls the file space in the target file pool using the backup enrollment information.
If a file space exists in the target file pool but not in the backed-up file pool, CA VM:Backup leaves the file space untouched in the target file pool.
If a file space exists in both the target and backed-up file pools, CA VM:Backup replaces the file space in the target file pool with the file space from the backed-up file pool but does not modify the enrollment information.

Note: If you want to remove file spaces that exist in the target but not in the back up (that is, you want the restored file pool to look just like the version in the backup), manually clear the file pool before running the restore.

SKIP specifies that the job is to restore only those file spaces that exist in the backed-up file pool but not in the target file pool. Restore processing is as follows:

If a file space exists in the backed-up file pool but not in the target, CA VM:Backup enrolls the file space in the target file pool using the backed-up enrollment information.
If a file space exists in the target file pool but not in the backed-up file pool, CA VM:Backup leaves the file space in the target file pool untouched.
If a file space exists in both the target and backed-up file pools, CA VM:Backup leaves the file space in the target file pool untouched.

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

RESHALT {YES | NO}

Indicates whether the job waits for users to detach a minidisk so it can get write access to the minidisk. NO tells the job to skip restoring that backup of the minidisk and go on to the next minidisk; the job includes this information in the restore job detail report. YES tells the job to send detach messages to users and stop until one of the following occurs:

All linked users detach the minidisk
A user cancels the detach request, which tells the job not to restore the minidisk
The wait time specified in the USERWAIT configuration file record expires

RESLINK {WRITE | MULT}

Specifies the type of link the job is to obtain to the minidisk to which it is restoring data.

WRITE tells the job to obtain a write link to a target minidisk only if no other user ID is linked to the disk in either read-only or write-access mode. If another user ID is linked, CA VM:Backup does not establish a link. CA VM:Backup requires write access to restore data to a minidisk.

MULT tells the job to obtain a write link to a minidisk unless another user ID already has write access, even if other user IDs have read access.

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 default and only valid option 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 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 section Options for Handling Existing Data in Target Entities (BFS Data) in the chapter "Restoring Data" 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 is 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 specifies that the job is to always format the minidisk, even when there is no data to restore.