Retrieve Backup Schedule (QEZRTBKS) API

The Retrieve Backup Schedule (QEZRTBKS) API returns in a receiver variable information about when the Operational Assistant backups are scheduled to be run.

Authorities and Locks

User Index Authority

*USE

Job Schedule Entry Authority

*USE

User Index Lock

*SHRRD

Job Schedule Lock

*SHRRD

Required Parameter Group

Receiver variable

OUTPUT; CHAR(*)

The receiver variable that receives the information requested. You can specify the size of the area to be smaller than the format requested as long as you specify the length parameter correctly. As a result, the API returns only the data that the area can hold.

Length of receiver variable

Input; BINARY(4)

The length of the receiver variable provided. The length of receiver variable parameter may be specified up to the size of the receiver variable specified in the user program. If the length of receiver variable parameter specified is larger than the allocated size of the receiver variable specified in the user program, the results are not predictable. The minimum length is 8 bytes.

Format name

INPUT; CHAR(8)

The name of the format in which to return the backup schedule. The following format name may be used:

RBKS0100

Basic schedule information. For more information, see RBKS0100 Format.

Error code

I/O; CHAR(*)

The structure in which to return error information. For the format of the structure, see Error Code Parameter.

RBKS0100 Format

Field Descriptions

Some of the fields use a time format (HHMMSS), where:

Bytes available. The number of bytes of data available to be returned. All available data is returned if enough space is provided.

Bytes returned. The number of bytes of data returned.

Friday backup. The type of backup that is run on Friday. Possible values follow:

Friday backup time. Using the 24-hour clock, the time that the backup takes place (in format HHMMSS).

Hours before backup to send tape message. If you choose, you may have the system send a reminder to the system operator to load the tape before a backup starts. Specify the number of hours before the backup that you would like this message to be sent. Possible values follow:

Monday backup. The type of backup that is run on Monday. Possible values follow:

Monday backup time. Using the 24-hour clock, the time that the backup takes place (in format HHMMSS).

Occurrence in month to run backup. The week of the month that you want the backup to occur when the backup type is either *MONTHLY or *WEEKMONTH. Possible values follow:

Run backup using this schedule. Whether you want to use the backup schedule. Possible values follow:

Saturday backup. The type of backup that is to run on Saturday. Possible values follow:

Saturday backup time. Using the 24-hour clock, the time that the backup takes place (in HHMMSS).

Sunday backup. The type of backup that is to be run on Sunday. Possible values follow:

Sunday backup time. Using the 24-hour clock, the time that the backup takes place (in format HHMMSS).

Thursday backup. The type of backup that is run on Thursday. Possible values follow:

Thursday backup time. Using the 24-hour clock, the time that the backup takes place (in format HHMMSS).

Tuesday backup. The type of backup that is run on Tuesday. Possible values follow:

Tuesday backup time. Using the 24-hour clock, the time that the backup takes place (in format HHMMSS).

Wednesday backup. The type of backup that is run on Wednesday. Possible values follow:

Wednesday backup time. Using the 24-hour clock, the time that the backup takes place (in format HHMMSS).

Error Messages