RTVBCKUP (Retrieve Backup)

RTVBCKUP Command syntax diagram

 

Purpose

The Retrieve Backup (RTVBCKUP) command is used in a CL program or REXX procedure to retrieve the options in one of the predefined backups into CL variables. More information on backup is in the Backup and recovery topic in the Information Center.

 

Required Parameters

BCKUPOPT

Specifies the backup options to be retrieved.

*DAILY: The daily backup options are retrieved.

*WEEKLY: The weekly backup options are retrieved.

*MONTHLY: The monthly backup options are retrieved.

 

Optional Parameters

DEV

Specifies the name of the CL variable that receives the device value. The variable has a minimum length of 43 characters. The value returned is a character string of four 10-character device names, separated by blanks.

TAPSET

Specifies the name of the CL variable that receives the tape set names. The variable has a minimum length of 34 characters (seven 4-character tape set names, separated by blanks).

CLRTAP

Specifies the name of the CL variable that receives the indicator for clearing the tape for backup. The variable must have a minimum length of 4 characters. The value returned is either *YES or *NO.

SBMJOB

Specifies the name of the CL variable that receives the indicator of whether the backup is run as a batch job. The variable must have a minimum length of 4 characters. The value returned is either *YES or *NO.

CHGONLY

Specifies the name of the CL variable that receives the indicator for saving changed objects only. The variable must have a minimum length of 4 characters. The value returned is either *YES or *NO.

PRTRPT

Specifies the name of the CL variable that receives the indicator for printing a report of saved objects. The variable must have a minimum length of 4 characters. The value returned is either *YES or *NO.

LIB

Specifies the name of the CL variable that receives the value specifying the libraries to save with this backup. The variable must have a minimum length of 10 characters. A value of *ALLUSR, *FROMLIST, or *NONE is returned.

FLR

Specifies the name of the CL variable that receives the value specifying the folders to save with this backup. The variable must have a minimum length of 10 characters. A value of *ALL, *FROMLIST, or *NONE is returned.

DIR

Specifies the name of the CL variable that receives the value specifying the user directories to save with this backup. The variable must have a minimum length of 10 characters. A value of *ALLUSR or *NONE is returned.

SECDTA

Specifies the name of the CL variable that receives the indicator for saving security data. The variable must have a minimum length of 4 characters. The value returned is either *YES or *NO.

CFG

Specifies the name of the CL variable that receives the indicator for saving configuration data. The variable must have a minimum length of 4 characters. The value returned is either *YES or *NO.

MAIL

Specifies the name of the CL variable that receives the indicator for saving OfficeVision mail. The variable must have a minimum length of 4 characters. The value returned is either *YES or *NO.

CAL

Specifies the name of the CL variable that receives the indicator for saving OfficeVision calendars. The variable must have a minimum length of 4 characters. The value returned is either *YES or *NO.

EXITPGM

Specifies the name of the CL variable that receives the name of the user program to call before and after the backup is run. The variable must have a minimum length of 10 characters. If no exit program is specified, *NONE is returned.

EXITPGMLIB

Specifies the name of the CL variable that receives the name of the library that contains the exit program. The variable must have a minimum length of 10 characters. If no exit program is specified, blanks are returned. If *LIBL is returned, the program uses the library list.

Example for RTVBCKUP

RTVBCKUP  BCKUPOPT(*DAILY)  SBMJOB(&SBMJOBVAR)
  LIB(&LIBVAR)

This command retrieves the SBMJOB and LIB values for the daily backup into the CL variables SBMJOBVAR and LIBVAR respectively.

Error messages for RTVBCKUP

*ESCAPE Messages

CPF1EE3

Not authorized to backup options.

CPF1E6C

Backup options in use.

CPF1E67

Backup options and library backup list damaged.

CPF1E99

Unexpected error occurred.