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

INCLUDE Record

REQUIRED

Use the INCLUDE record to specify DASD volumes, file pools, or domains (minidisks, file spaces, or directories) that contain data to back up.

At least two INCLUDE records are required in a file. For jobs that back up minidisks, one record must specify the DASD parameter and another must specify the USERID, ACCOUNT, or ACIGROUP parameter. For jobs that back up SFS data, one record must specify the FILEPOOL parameter and one must specify either the FILESPACE or DIRECTORY parameter. Each record can specify only one of these parameters.

INCLUDE {“Parms”}...

Parms:
  ACCOUNT acctnumber
| ACIGROUP group
| DASD volsers…
| DIRECTORY fqdirname
| FILEPOOL filepools…
| FILESPACE filepoolid:userid
| USERID userid vaddr

Definitions

ACCOUNT acctnumber

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

ACIGROUP group

Specifies an access control interface (ACI) security group whose minidisks the job is to back up. You can use pattern matching. Specify * for group to include all ACI groups.

DASD volsers...

Lists the volsers of DASD volumes the job is to back up. You can use pattern matching. Specify * for volser to include 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 12 volumes.

DIRECTORY fqdirname

Specifies the fully-qualified name of a directory the job is to back up. You cannot use pattern matching. You can only specify INCLUDE DIRECTORY in a full backup job template file.

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

You cannot use INCLUDE DIRECTORY and CATALOG CREATE YES in the same file.

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

FILEPOOL filepools...

Lists file pools the job is to back up. You can use pattern matching. Specify * for filepool to include every local file pool identified to CA VM:Backup. CA VM:Backup cannot back up data in remote file pools, that is file pools that are located on a different system from the CA VM:Backup service virtual machine.

FILESPACE filepoolid:userid

Specifies the name of a file space the job is to back up. You can use pattern matching. Specify * for filepoolid to include all file spaces for the specified userids in all file pools listed on the INCLUDE FILEPOOL record. Specify * for userid to include all file spaces for all userids in the specified file pool.

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

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

USERID userid vaddr

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