Template Programming Interface Guide › Restore Job Exception Files › INCLUDE Record

INCLUDE Record

OPTIONAL

Use an INCLUDE record to indicate the exact parts of domains specified on the preceding EXCEPT record that the job is to include in the restore job. You can specify:

• Count-key-data (CKD) cylinders and tracks
• Fixed-block-architecture (FBA) blocks
• CMS, SFS, or BFS files

The INCLUDE record also enables you to rename files being restored.

A file can include multiple INCLUDE records. Multiple INCLUDE records that specify the same parameter can follow one EXCEPT record, but not multiple INCLUDE records that specify different parameters. INCLUDE records that specify extents for CKD or FBA can follow the EXCEPT record in any order.

Either INCLUDE or EXCLUDE records can follow one EXCEPT record, but not both.

INCLUDE {“Parms”} 

Parms:

  CKD begcyl begtrk endcyl endtrk
| FBA begin end
| FILE filename filetype [RENAME filename filetype]
| BFSFILE filenamecomponent [OWNER owner] [RENAME filename]

Definitions

TPI domain restores search for domains, not individual files. If you submit a domain restore with an exception file that specifies particular files to be restored, and those files are not present in the domain that the job found, CA VM:Backup does not extend the search to look for those files, and the files are not restored.

CKD begcyl begtrk endcyl endtrk

Specifies the numbers of the first and last cylinders and tracks of the minidisk extent the restore job is to restore. If specified, an INCLUDE CKD record must follow an EXCEPT USERID, EXCEPT ACCOUNT, or EXCEPT ACIGROUP record. Only an authorized client can specify * * * * on this parameter.

FBA begin end

Specifies the numbers of the first and last blocks of the minidisk extent the job is to restore. If specified, an INCLUDE FBA record must follow an EXCEPT USERID, EXCEPT ACCOUNT, or EXCEPT ACIGROUP record. Only an authorized client can specify * * * * on this parameter.

FILE filename filetype [RENAME filename filetype]

Specifies a CMS or SFS file the job is to restore. You can use pattern matching. Enter * for filename to restore all files of the specified filetype; enter * for filetype to restore all files with the specified filename. If specified, an INCLUDE FILE record must follow an EXCEPT record.

RENAME tells the job to rename the restored file to the specified filename and filetype. You cannot use pattern matching, but you can enter = for filename or filetype to keep the existing filename or filetype.

Note: The RENAME parameter is available only through TPI. Using this parameter will not prevent you from managing the exception file through the CA VM:Backup screens.

BFSFILE filenamecomponent [OWNER owner] [RENAME filenamecomponent]

Specifies a BFS file the job is to restore. You can use pattern matching if you do not use the RENAME parameter.

OWNER lets you restrict the restore to files owned by the specified user. By default (*), the job restores files owned by any user.

Note: The BFSFILE parameter is available only through TPI. Using this parameter will prevent you from managing the exception file through the CA VM:Backup screens

RENAME tells the job to rename the restored file to the specified name. You cannot use pattern matching.