Retrieve Backup Schedule (QEZRTBKS) API
| 1 | Receiver variable | Output | Char(*) |
| 2 | Length of receiver variable | Input | Binary(4) |
| 3 | Format name | Input | Char(8) |
| 4 | Error code | I/O | Char(*) |
Default Public Authority: *USE
Threadsafe: No
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
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Bytes returned |
| 4 | 4 | BINARY(4) | Bytes available |
| 8 | 8 | BINARY(4) | Hours before backup to send tape message |
| 12 | C | BINARY(4) | Occurrence in month to run backup |
| 16 | 10 | CHAR(1) | Run backup using this schedule |
| 17 | 11 | CHAR(1) | Sunday backup |
| 18 | 12 | CHAR(6) | Sunday backup time |
| 24 | 18 | CHAR(1) | Monday backup |
| 25 | 19 | CHAR(6) | Monday backup time |
| 31 | 1F | CHAR(1) | Tuesday backup |
| 32 | 20 | CHAR(6) | Tuesday backup time |
| 38 | 26 | CHAR(1) | Wednesday backup |
| 39 | 27 | CHAR(6) | Wednesday backup time |
| 45 | 2D | CHAR(1) | Thursday backup |
| 46 | 2E | CHAR(6) | Thursday backup time |
| 52 | 34 | CHAR(1) | Friday backup |
| 53 | 35 | CHAR(6) | Friday backup time |
| 59 | 3B | CHAR(1) | Saturday backup |
| 60 | 3C | CHAR(6) | Saturday backup time |
Field Descriptions
Some of the fields use a time format (HHMMSS), where:
| HH | Hour |
| MM | Minute |
| SS | Second |
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:
| blank | No backup is scheduled for this day of the week. |
| 1 | A daily backup is run on this day. |
| 2 | A weekly backup is run on this day. |
| 3 | A monthly backup is run on this day. |
| 4 | A *WEEKMONTH backup is run on this day. A weekly backup is run on this day of the week every week except on the week that a monthly backup is run. In that case, the monthly backup is run. |
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:
| 0 | No message is sent to the system operator before the backup. |
| 1-24 | The number of hours prior to backup to send the message. |
Monday backup. The type of backup that is run on Monday. Possible values follow:
| blank | No backup is scheduled for this day of the week. |
| 1 | A daily backup is run on this day. |
| 2 | A weekly backup is run on this day. |
| 3 | A monthly backup is run on this day. |
| 4 | A *WEEKMONTH backup is run on this day. A weekly backup is run on this day of the week every week except on the week that a monthly backup is run. In that case, the monthly backup is run. |
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:
| 0 | No monthly backup is scheduled to run. |
| 1-4 | A value 1 through 4 corresponds to the week of the month that the monthly backup is run. |
| 5 | The monthly backup is run on the last week of the month. |
Run backup using this schedule. Whether you want to use the backup schedule. Possible values follow:
| 0 | A schedule has been created, but it is not being used at this time. |
| 1 | Backups are run according to the schedule. |
Saturday backup. The type of backup that is to run on Saturday. Possible values follow:
| blank | No backup is scheduled for this day of the week. |
| 1 | A daily backup is run on this day. |
| 2 | A weekly backup is run on this day. |
| 3 | A monthly backup is run on this day. |
| 4 | A *WEEKMONTH backup is run on this day. A weekly backup is run on this day of the week every week except on the week that a monthly backup is run. In that case, the monthly backup is run. |
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:
| blank | No backup is scheduled for this day of the week. |
| 1 | A daily backup is run on this day. |
| 2 | A weekly backup is run on this day. |
| 3 | A monthly backup is run on this day. |
| 4 | A *WEEKMONTH backup is run on this day. A weekly backup is run on this day of the week every week except on the week that a monthly backup is run. In that case, the monthly backup is run. |
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:
| blank | No backup is scheduled for this day of the week. |
| 1 | A daily backup is run on this day. |
| 2 | A weekly backup is run on this day. |
| 3 | A monthly backup is run on this day. |
| 4 | A *WEEKMONTH backup is run on this day. A weekly backup is run on this day of the week every week except on the week that a monthly backup is run. In that case, the monthly backup is run. |
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:
| blank | No backup is scheduled for this day of the week. |
| 1 | A daily backup is run on this day. |
| 2 | A weekly backup is run on this day. |
| 3 | A monthly backup is run on this day. |
| 4 | A *WEEKMONTH backup is run on this day. A weekly backup is run on this day of the week every week except on the week that a monthly backup is run. In that case, the monthly backup is run. |
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:
| blank | No backup is scheduled for this day of the week. |
| 1 | A daily backup is run on this day. |
| 2 | A weekly backup is run on this day. |
| 3 | A monthly backup is run on this day. |
| 4 | A *WEEKMONTH backup is run on this day. A weekly backup is run on this day of the week every week except on the week that a monthly backup is run. In that case, the monthly backup is run. |
Wednesday backup time. Using the 24-hour clock, the time that the backup takes place (in format HHMMSS).
Error Messages
| Message ID | Error Message Text |
|---|---|
| CPF1629 E | Not authorized to job schedule &1. |
| CPF1632 E | Job schedule entry &3 number &4 damaged. |
| CPF1637 E | Job schedule &1 in library &2 in use. |
| CPF1640 E | Job schedule &1 in library &2 does not exist. |
| CPF1641 E | Job schedule &1 in library &2 damaged. |
| CPF24B4 E | Severe error while addressing parameter list. |
| CPF3CF1 E | Error code parameter not valid. |
| CPF3C21 E | Format name &1 is not valid. |
| CPF3C90 E | Literal value cannot be changed. |
| CPF812C E | Job schedule &4 in &9 damaged. |
| CPF9802 E | Not authorized to object &2 in &3. |
| CPF9803 E | Cannot allocate object &2 in library &3. |
| CPF9820 E | Not authorized to use library &1. |
| CPF9872 E | Program or service program &1 in library &2 ended. Reason code &3. |
API introduced: V3R7
[ Back to top | Backup and Recovery APIs | APIs by category ]