Change Backup Options (CHGBCKUP)

Where allowed to run: All environments (*ALL)
Threadsafe: No
Parameters
Examples
Error messages

The Change Backup Options (CHGBCKUP) command allows the user to change the options in one of the predefined backups. More information on backup is in the Backup and Recovery book, SC41-5304.

Top

Parameters

Keyword Description Choices Notes
BCKUPOPT Backup options *DAILY, *WEEKLY, *MONTHLY Required, Key, Positional 1
DEV Device Single values: *SAME
Other values (up to 4 repetitions): Name
Optional
TAPSET Tape set Single values: *SAME, *ANY
Other values (up to 7 repetitions): Character value
Optional
CLRTAP Clear the tape *SAME, *YES, *NO Optional
SBMJOB Submit to batch *SAME, *YES, *NO Optional
CHGONLY Changed objects only *SAME, *YES, *NO Optional
PRTRPT Print detailed report *SAME, *YES, *NO Optional
LIB Library *SAME, *ALLUSR, *FROMLIST, *NONE Optional
FLR Folder *SAME, *ALL, *FROMLIST, *NONE Optional
DIR Directory *SAME, *ALLUSR, *NONE Optional
SECDTA Save security data *SAME, *YES, *NO Optional
CFG Save configuration data *SAME, *YES, *NO Optional
MAIL Save mail *SAME, *YES, *NO Optional
CAL Save calendar data *SAME, *YES, *NO Optional
EXITPGM User exit program Single values: *SAME, *NONE
Other values: Qualified object name
Optional
Qualifier 1: User exit program Name
Qualifier 2: Library Name, *LIBL, *CURLIB
Top

Backup options (BCKUPOPT)

Specifies the backup options to be changed.

This is a required parameter.

*DAILY
The options for the daily backup are changed.
*WEEKLY
The options for the weekly backup are changed.
*MONTHLY
The options for the monthly backup are changed.
Top

Device (DEV)

Specifies the tape device to use for the backup.

Single values

*SAME
The tape device name stored in the specified options is not changed.

Other values (up to 4 repetitions)

name
Specify a list of tape device names to use with the specified backup options. If you are using a virtual tape devices you can only specify one device name.
Top

Tape set (TAPSET)

Specifies the name of the tape set to be used.

Single values

*SAME
The tape set name stored in the specified options is not changed.
*ANY
The tapes mounted on the backup devices are used for the backup. Tape volume IDs are not checked.

Other values (up to 7 repetitions)

character-value
Specify a list of 4-character names of tape volume sets to be rotated for the backup. The tape volume IDs for the backup are generated by concatenating sequential numbers starting with '01' to the specified prefix.
Top

Clear the tape (CLRTAP)

Specifies whether to clear the tape and start the save at sequence number 1.

*SAME
The Clear Tape indicator stored in the specified options is not changed.
*YES
The tape is cleared and the save starts at sequence number 1 (equivalent to CLEAR(*ALL) SEQNBR(1) on the SAVxxx commands).
*NO
The tape is not cleared and the save starts after the last active file on the tape (equivalent to CLEAR(*NONE) SEQNBR(*END) on the SAVxxx commands).
Top

Submit to batch (SBMJOB)

Specifies whether to submit the backup as a batch job when the RUNBCKUP menu is used to run a backup using these options.

Note: This parameter is ignored when the RUNBCKUP command is used to run a backup.

*SAME
The Submit Job indicator stored in the specified options is not changed.
*YES
The backup is submitted as a batch job when the menu is used to perform the backup.
*NO
The backup is run interactively when the menu is used to perform the backup.
Top

Changed objects only (CHGONLY)

Specifies whether to save only changed objects in the libraries and folders to be backed up.

*SAME
The Save Changed Only indicator stored in the specified options is not changed.
*YES
Only objects changed since the last backup are saved.
*NO
All of the objects in the requested libraries and folders are backed up.
Top

Print detailed report (PRTRPT)

Specifies whether a detailed list of saved objects is printed. A summary report is always printed.

*SAME
The Print Report indicator stored in the specified options is not changed.
*YES
A detailed list of saved objects and a summary report are printed.
*NO
A summary report is printed.
Top

Library (LIB)

Specifies which libraries are backed up.

*SAME
The libraries specified in the options are not changed.
*ALLUSR
Performs a backup of all user libraries. All libraries with names that do not begin with the letter Q are backed up except for the following:

#CGULIB     #DSULIB     #SEULIB
#COBLIB     #RPGLIB
#DFULIB     #SDALIB

Although the following Qxxx libraries are provided by IBM, they typically contain user data that changes frequently. Therefore, these libraries are considered "user libraries", and are also backed up:

QDSNX       QRCLxxxxx   QUSRIJS     QUSRVxRxMx
QGPL        QSRVAGT     QUSRINFSKR
QGPL38      QSYS2       QUSRNOTES
QMGTC       QSYS2xxxxx  QUSROND
QMGTC2      QS36F       QUSRPOSGS
QMPGDATA    QUSER38     QUSRPOSSA
QMQMDATA    QUSRADSM    QUSRPYMSVR
QMQMPROC    QUSRBRM     QUSRRDARS
QPFRDATA    QUSRDIRCL   QUSRSYS
QRCL        QUSRDIRDB   QUSRVI

Note: A different library name, in the format QUSRVxRxMx, can be created by the user for each previous release supported by IBM to contain any user commands to be compiled in a CL program for the previous release. For the QUSRVxRxMx user library, VxRxMx is the version, release, and modification level of a previous release that IBM continues to support.

*FROMLIST
The libraries selected for backup in the library backup list are backed up.
*NONE
No libraries are backed up.
Top

Folder (FLR)

Specifies which folders are backed up.

*SAME
The folders specified in the options are not changed.
*ALL
All folders are backed up.
*FROMLIST
The folders selected for backup in the folder backup list are backed up.
*NONE
No folders are backed up.
Top

Directory (DIR)

Specifies which user directories are backed up.

*SAME
The directories specified in the options are not changed.
*ALLUSR
All user directories are backed up.
*NONE
No directories are backed up.
Top

Save security data (SECDTA)

Specifies whether to save the system security data.

*SAME
The Security Data indicator stored in the specified options is not changed.
*YES
Security data is saved when this backup is run.
*NO
Security data is not saved.
Top

Save configuration data (CFG)

Specifies whether to save the system configuration data.

*SAME
The Configuration Data indicator stored in the specified options is not changed.
*YES
Configuration data is saved when this backup is run.
*NO
Configuration data is not saved.
Top

Save mail (MAIL)

Specifies whether to save OfficeVision mail. This parameter is ignored if FLR(*ALL) is specified.

*SAME
The Mail indicator stored in the specified options is not changed.
*YES
Mail is saved when this backup is run.
*NO
Mail is not saved.
Top

Save calendar data (CAL)

Specifies whether to save OfficeVision calendar data. OfficeVision calendars are also saved when QUSRSYS is saved.

*SAME
The calendar indicator stored in the specified options is not changed.
*YES
Calendars are saved when this backup is run.
*NO
Calendars are not saved.
Top

User exit program (EXITPGM)

Specifies the user program to call before the backup begins and again after the backup is complete.

Single values

*SAME
The program name stored in the specified options is not changed.
*NONE
No exit program is called.

Qualifier 1: User exit program

name
Specify the name of the program to call before and after the backup.

Qualifier 2: Library

*LIBL
All libraries in the library list for the current thread are searched until the first match is found.
*CURLIB
The current library for the job is used to locate the program. If no library is specified as the current library for the job, the QGPL library is used.
name
Specify the name of the library where the program is located.
Top

Examples

Example 1: Changing the Daily Backup Options

CHGBCKUP   BCKUPOPT(*DAILY)  MAIL(*YES)  CAL(*YES)

This command changes the daily backup to save the OfficeVision mail and calendar data.

Example 2: Changing the Monthly Backup Options

CHGBCKUP   BCKUPOPT(*MONTHLY)  DEV(TAP01 TAP02)
           TAPSET(RED GRN BLU)

This command changes the monthly backup to use tape devices TAP01 and TAP02 and tape sets RED, GRN, and BLU.

Top

Error messages

*ESCAPE Messages

CPF1EEA
Not authorized to library backup list.
CPF1EEB
Not authorized to folder backup list.
CPF1EE0
Device &1 specified more than once.
CPF1EE1
Tape set name &1 specified more than once.
CPF1EE2
Cannot specify *ANY and a tape set name.
CPF1EE3
Not authorized to backup options.
CPF1EE4
Not authorized to run backup.
CPF1EE5
Device &1 not a tape device.
CPF1E6C
Backup options in use.
CPF1E6E
Nothing selected for backup.
CPF1E6F
Tape set name &1 is not valid.
CPF1E67
Backup options and library backup list damaged.
CPF1E99
Unexpected error occurred.
Top