Previous Topic: About the Template Programming InterfaceNext Topic: BASE TEMPLATES Record


Backup Job Template Files

This chapter describes the structure of backup job template files created using TPI and shows example files. It then describes in detail each record you can include in a TPI backup job template file. The records are listed in alphabetical order. Unless stated otherwise, the records and parameters apply to both full and incremental backup jobs.

This section contains the following topics:

Full Backup Job Template File Structure and Sample

Incremental Backup Job Template File Structure and Sample

* Record

BASE TEMPLATES Record

CATALOG Record

CHECKSUM Record

COMMENT Record

CREATE Record

EXCEPTIONS Record

EXCLUSIONS Record

INCLUDE Record

JOB Record

JOBOPTIONS Record

OPTIONS Record

OUTPUT Record

REPORT Record

Full Backup Job Template File Structure and Sample

The following table outlines the general structure of a full backup job template file. It lists the records in the order in which you or an authorized client might use them in a file.

Record

Information Specified

Required

Quantity Allowed

JOB

Type of job set up in file

Yes

1; first in file

COMMENT

Comment

No

1

*

Additional comments

No

Multiple

CATALOG

Catalog options

No

Multiple

JOBOPTIONS

General job processing options

No

Multiple

OPTIONS

Domain-level job processing options

No

Multiple

REPORT

Report options

No

Multiple

EXCEPTIONS

Name of exception file for job

No

1

EXCLUSIONS

Name of exclusion file for job

No

1

OUTPUT

Output tape to which to back up data

Yes

Multiple

INCLUDE

DASD volumes, file pools, or domains that contain data to back up

Yes

Multiple;
at least 2

CREATE

Owner and name of an abstract domain to create on the backup tape

 

Used by authorized clients only.

No

Multiple

CHECKSUM

Number that protects file from manual modification

 

Used by authorized clients only.

No

1; last in file

Example Full Backup Job Template File

The following example shows a full backup job template file named WEEKLY $TEMPLAT. This file defines a full backup of all file spaces in all file pools and the 191 minidisk belonging to user ID VMANAGER. A catalog will be created. Exceptions and exclusions defined in associated WEEKLY $XCEPT and WEEKLY $XCLUDE files will be applied. The data backed up will be written to a primary tape defined in resource pool WEEKLY and a tape copy defined in resource pool WTWIN. Several options and report settings are defined that will apply to the backup job.

JOB BACKUP TYPE FULL
COMMENT Example full backup
CATALOG CREATE YES DISCARD 30 CONDENSE 15
* Define general job processing options
JOBOPTIONS PRIORITY YES
JOBOPTIONS REDUCE TAPEUSE
JOBOPTIONS JOBEND QUIET
JOBOPTIONS ONETIME NO
JOBOPTIONS STREAMS 1

* Define weekly domain-level backup options
OPTIONS CATDETAIL DOMAIN
OPTIONS BKPTYPE LOGICAL
OPTIONS PACKDATA NO
OPTIONS CMSSWITCH YES CMSTRIES 3
OPTIONS DIRSCAN YES

* Define weekly backup report guidelines
REPORT REPDETAIL DOMAIN
REPORT REPDEST VMRMAINT
REPORT REPCLASS A
REPORT ERRDEST VMRMAINT
REPORT ERRCLASS A
REPORT KEYWORD YES

EXCEPTIONS WEEKLY
EXCLUSIONS WEEKLY

* Define weekly resource pools: 2 copies
OUTPUT 0 DSN VMBACKUP.PRIMARY
OUTPUT 0 POOL WEEKLY RETPD 30
OUTPUT 1 DSN VMBACKUP.COPY1
OUTPUT 1 POOL WTWIN RETPD 30

INCLUDE DASD *
INCLUDE FILEPOOL *
INCLUDE USERID VMANAGER 191
INCLUDE FILESPACE *:*

Incremental Backup Job Template File Structure and Sample

The following table outlines the structure of an incremental backup job template file. The table lists the records in the order you might use them in a file.

Record

Information Specified

Required

Quantity Allowed

JOB

Type of job set up in file

Yes

1; first in file

COMMENT

Comment

No

1

1

Additional comments

No

Multiple

BASE TEMPLATES

Backup job template files upon which to base incremental backup

Yes

1

CATALOG

Catalog options

No

Multiple

JOBOPTIONS

General job processing options

No

Multiple

OPTIONS

Domain-level job processing options

No

Multiple

REPORT

Report options

No

Multiple

EXCEPTIONS

Name of exception file for job

No

1

EXCLUSIONS

Name of exclusion file for job

No

1

OUTPUT

Output tape to which to back up data

Yes

Multiple

INCLUDE

DASD volumes, file pools, or domains that contain data to back up

Yes

Multiple;
at least 2

1 When a job is exported from CA VM:Backup, all * records appear in order after the COMMENT record or, if no COMMENT record is specified, after the JOB record.

Example Incremental Backup Job Template File

The following example shows an incremental backup job template file named DAILY $TEMPLAT. This file defines an incremental backup based on WEEKLY and DAILY templates of all file spaces in all file pools and the 191 minidisk belonging to user ID VMANAGER. A catalog will be created. Exceptions and exclusions defined in associated WEEKLY $XCEPT and WEEKLY $XCLUDE files will be applied. The data backed up will be written to a primary tape defined in resource pool DAILY and a tape copy defined in resource pool DTWIN. Several job options and report settings are defined that will apply to the backup job.

JOB BACKUP TYPE INCREMENTAL
COMMENT Example incremental backup
BASE TEMPLATES WEEKLY DAILY
CATALOG CREATE YES DISCARD 30 CONDENSE 15
*Define general job processing options
JOBOPTIONS REDUCE TAPEUSE
JOBOPTIONS ONETIME NO
JOBOPTIONS STREAMS 1

* Define daily domain-level backup options
OPTIONS CATDETAIL DOMAIN
OPTIONS BKPTYPE LOGICAL
OPTIONS PACKDATA NO
OPTIONS CMSSWITCH YES CMSTRIES 3
OPTIONS CMSCHANGE DATE PHYSCHANGE HASH
OPTIONS DIRSCAN YES

* Define daily backup report guidelines
REPORT REPDETAIL DOMAIN
REPORT REPDEST VMRMAINT
REPORT REPCLASS A
REPORT ERRDEST VMRMAINT
REPORT ERRCLASS A
REPORT KEYWORD YES

EXCEPTIONS WEEKLY
EXCLUSIONS WEEKLY

* Define daily resource pools: 2 copies
OUTPUT 0 DSN VMBACKUP.PRIMARY
OUTPUT 0 POOL DAILY RETPD 30
OUTPUT 1 DSN VMBACKUP.COPY1
OUTPUT 1 POOL DTWIN RETPD 30

INCLUDE DASD *
INCLUDE FILEPOOL *
INCLUDE USERID VMANAGER 191
INCLUDE FILESPACE *:*

* Record

OPTIONAL

Use the * record to add comments to job template files in addition to the comment specified on the COMMENT record. When you manage job template files through the CA VM:Backup screens, CA VM:Backup displays the comment on the COMMENT record on the screen; comments on * records are not displayed on the screen.

You can use * records with the COMMENT record or by themselves, and you can include as many as you need. You can place * records anywhere in the file after the JOB record; however, when the file is exported, CA VM:Backup places all * records in order after the COMMENT record or, if no COMMENT record exists, after the JOB record.

Note: The * record is available only through TPI. However, using it will not prevent you from managing the template through the CA VM:Backup screens.

* [text]

Definitions

text

Can include up to 80 characters of comment text; any additional text is truncated. You must type the asterisk in column 1 of the record. You can use uppercase and lowercase letters; when you import or export the file, text case is preserved.

Example:

You want to document when you began including the VMSYSU file pool in the weekly backup job. Include the following * record in the backup job template file:

* Added INCLUDE VMSYSU file pool to weekly backup mm/dd/yy.