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

INCLUDE Record

REQUIRED

Use the INCLUDE record to specify DASD volumes, file pools, or domains that are to be restored.

A restore job template file requires at least two INCLUDE records, as follows:

Each record can specify only one parameter.

INCLUDE {“Parms”}...

Parms:

  ABSTRACT owner domainname
| ACCOUNT acctnumber
| ACIGROUP group
| BFSDIRECTORY filespace fulldirpathname
| DASD volsers…
| DIRECTORY dirname
| FILEPOOL filepools…
| FILESPACE filepoolid:userid
| PUBLIC filepoolid
| USERID userid vaddr

Definitions

ABSTRACT owner domainname

Specifies the owner and name of an abstract domain the job is to restore. Use up to 153 non-blank characters for domainname; you can use the characters * or %, but they will not be used as pattern-matching characters.

Note: This parameter is available only through TPI and can only be specified by an authorized client.

ACCOUNT acctnumber

Specifies the number of an account whose minidisks the job is to restore. You can use pattern matching. Enter * for acctnumber to specify all account numbers.

ACIGROUP group

Specifies an access control interface (ACI) security group whose minidisks the job is to restore. You can use pattern matching. Enter * for group to specify all ACI groups.

BFSDIRECTORY filespace fulldirpathname

Specifies the file space and full directory pathname of a BFS directory that is to be restored. You cannot use pattern matching.

Note: You cannot use INCLUDE BFSDIRECTORY and INCLUDE FILESPACE in the same file.

You cannot use INCLUDE BFSDIRECTORY and INCLUDE PUBLIC in the same file.

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

DASD volsers...

Lists the volsers of volumes the job is to restore. You can use pattern matching. Enter * for volser to specify all DASD volumes.

Note: If you want to be able to work with a file through CA VM:Backup screens, do not list more than 24 volumes.

DIRECTORY dirname

Specifies the fully-qualified name of an SFS directory the job is to restore. You cannot use pattern matching.

Note: You cannot use INCLUDE DIRECTORY and INCLUDE FILESPACE in the same file.

You cannot use INCLUDE BFSDIRECTORY and INCLUDE PUBLIC in the same file.

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

FILEPOOL filepools...

Lists file pools the job is to restore. You can use pattern matching. Enter * for filepool to specify every file pool identified to CA VM:Backup.

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

FILESPACE filepoolid:userid

Specifies the name of a file space the job is to restore. You can use pattern matching. Enter * for filepoolid to specify all file spaces for the specified user IDs in all file pools listed on the INCLUDE FILEPOOL record. Enter * for userid to specify all file spaces for all user IDs in the specified file pool.

An INCLUDE FILESPACE *:* record tells the job to restore all file spaces for all file pools that are specified on the INCLUDE FILEPOOL record.

Note: You cannot use INCLUDE FILESPACE and INCLUDE DIRECTORY in the same file. With job type VOLSER, pattern matching cannot be used.

You cannot use INCLUDE FILESPACE and INCLUDE BFSDIRECTORY in the same file.

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

PUBLIC filepoolid

Specifies that CA VM:Backup is to issue the ENROLL PUBLIC command for the file pool. Issuing the ENROLL PUBLIC command is one of two actions required to enable users not enrolled in a particular file pool to access files and directories of users who are enrolled in that file pool. The other required action is for the users who are enrolled in the file pool to grant access to their files and directories to either PUBLIC or the users who are not enrolled in the file pool.

For detailed information on the ENROLL PUBLIC command, see the IBM SFS and CRR Planning, Administration, and Operation publication.

Note: You cannot use INCLUDE PUBLIC and INCLUDE DIRECTORY in the same file.

You cannot use INCLUDE PUBLIC and INCLUDE BFSDIRECTORY in the same file.

USERID userid vaddr

Specifies a user ID and virtual address of a minidisk the job is to restore. Enter * for userid to specify the minidisks of all user IDs with the specified virtual address. Enter * for vaddr to specify all minidisks for the specified user IDs. An INCLUDE USERID * * record tells the job to restore all minidisks for all user IDs.