Retrieve Backup Options (QEZRTBKO) API
| 1 | Receiver variable | Output | Char(*) |
| 2 | Length of receiver variable | Input | Binary(4) |
| 3 | Format name | Input | Char(8) |
| 4 | Backup option | Input | Char(10) |
| 5 | Error code | I/O | Char(*) |
Default Public Authority: *USE
Threadsafe: No
The Retrieve Backup Options (QEZRTBKO) API returns in a receiver variable the backup options for the requested backup type. If you request all options, the receiver variable contains the header, which is followed by three RBKO0100 formats, one for each backup type.
Authorities and Locks
- User Index Authority
- *USE
- User Index 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 format of the backup option descriptions to be returned. The valid format names are RBKO0100 and RBKO0200.
RBKO0100 This format returns information about what the user has selected to be saved on the next backup for that type (*DAILY, *WEEKLY, or *MONTHLY). RBKO0200 This format returns information on the last backup date and time, and when the next backup date and time for that backup option are scheduled to occur.
- Backup option
- INPUT; CHAR(10)
The backup options to retrieve. Possible values follow:
*DAILY Daily backup options. *WEEKLY Weekly backup options. *MONTHLY Monthly backup options. *ALL The backup options for all types of backup (*DAILY, *WEEKLY, and *MONTHLY). - Error code
- I/O; CHAR(*)
The structure in which to return error information. For the format of the structure, see Error code parameter.
RBOH0100 Format
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Bytes returned |
| 4 | 4 | BINARY(4) | Bytes available |
| 8 | 8 | BINARY(4) | Offset to daily options |
| 12 | C | BINARY(4) | Offset to weekly options |
| 16 | 10 | BINARY(4) | Offset to monthly options |
RBKO0100 Format
Note: The following is accessed by using the offsets that are provided in format RBOH0100.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Offset to list of backup device names |
| 4 | 4 | BINARY(4) | Number of backup devices |
| 8 | 8 | BINARY(4) | Offset to list of tape sets to rotate |
| 12 | C | BINARY(4) | Number of tape sets to rotate |
| 16 | 10 | CHAR(4) | Last tape set used |
| 20 | 14 | CHAR(4) | Next tape set to be used |
| 24 | 18 | CHAR(1) | Erase tape before backup |
| 25 | 19 | CHAR(1) | Back up user libraries |
| 26 | 1A | CHAR(1) | Back up folders |
| 27 | 1B | CHAR(1) | Back up user directories |
| 28 | 1C | CHAR(1) | Back up security data |
| 29 | 1D | CHAR(1) | Back up configuration data |
| 30 | 1E | CHAR(1) | Back up OfficeVision® mail |
| 31 | 1F | CHAR(1) | Back up OfficeVision calendars |
| 32 | 20 | CHAR(1) | Submit as batch job |
| 33 | 21 | CHAR(1) | Save changed objects only |
| 34 | 22 | CHAR(1) | Print detailed report |
| 35 | 23 | CHAR(10) | User exit program name |
| 45 | 2D | CHAR(10) | User exit program library name |
| 55 | 37 | CHAR(1) | Reserved |
| 56 | 38 | BINARY(4) | Offset to additional information |
| The offsets to these fields depend on the number of backup devices and the number of tape sets to rotate. | ARRAY OF CHAR(10) | Backup devices | |
| ARRAY OF CHAR(4) | Tape sets to rotate | ||
RBKO0200 Format
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(*) | All data in format RBKO0100 |
| The offsets to these fields depend on the number of backup devices and the number of tape sets to rotate. | CHAR(7) | Last backup date | |
| CHAR(6) | Last backup time | ||
| CHAR(7) | Next backup date | ||
| CHAR(6) | Next backup time | ||
Field Descriptions
Back up configuration data. Whether to save the system configuration data. Possible values follow:
| 0 | Do not save configuration data. |
| 1 | Save configuration data. |
Backup devices. The tape devices that are used for a backup.
Back up folders. Which root folders are backed up. Possible values follow:
| 1 | The root folders that are selected for backup in the folder backup list are backed up. |
| 2 | All root folders are backed up. |
| 3 | No root folders are backed up. |
Back up OfficeVision calendars. Whether to save OfficeVision calendar data. OfficeVision calendars are also saved when QUSRSYS is saved. Possible values follow:
| 0 | Calendars are not saved when the backup is run. |
| 1 | Calendars are saved when the backup is run. |
| 9 | Calendars are not saved when the backup is run because the OfficeVision calendar function is not available. |
Back up OfficeVision mail. Whether to save OfficeVision mail. The backup ignores this option if FLR(*ALL) is specified.
| 0 | Mail is not saved when the backup is run. |
| 1 | Mail is saved when the backup is run. |
| 9 | Mail is not saved when the backup is run because the OfficeVision mail function is not available. |
Back up security data. Whether to save the system security data. Possible values follow:
| 0 | Security data is not saved when the backup is run. |
| 1 | Security data is saved when the backup is run. |
Back up user libraries. Which user libraries are saved when a backup is run. For information on user libraries, see *ALLUSR in Generic library names.
Possible values follow:
| 1 | The objects in the libraries that are selected for backup from the library backup list are backed up. |
| 2 | All user libraries are saved when the backup is run. |
| 3 | No user libraries are saved when the backup is run. |
Back up user directories. Whether to save all user directories. This does not include any IBM-supplied directories that contain user data. Some directories that are not saved include QOPT, QFileSvr.400, QSYS.LIB, and QDLS (QDLS data is saved under the option to save folders). Possible values follow:
| 2 | All user directories are saved when the backup is run. |
| 3 | Do not back up any user directories. |
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.
Erase tape before backup. Whether to clear the tape and start the save operation at sequence number 1. Possible values follow:
| 0 | The save operation continues at the next available sequence number. |
| 1 | The tape is cleared, and the save operation starts at sequence number 1. |
Last backup date. The completion date of the last Operational Assistant backup in CYYMMDD format.
Last backup time. The completion time of the last Operational Assistant backup in HHMMSS format.
Last tape set used. The tape set that was used to complete the last Operational Assistant backup.
Next backup date. The next date that an Operational Assistant backup is run in CYYMMDD format.
Next backup time. The time of the next scheduled backup. This time is in the format HHMMSS and uses the 24-hour clock.
Next tape set to be used. The tape set that is used to start the next backup.
Number of backup devices. The number of backup devices that are defined as available for use in an Operational Assistant backup.
Number of tape sets to rotate. The number of tape sets that are defined to be used in a backup.
Offset to additional information. The offset from the start of format RBOH0100 to the last backup date field.
Offset to daily options. The offset from the start of the RBOH0100 structure to the backup options.
Offset to list of backup device names. The offset from the start of the RBOH0100 structure to the list of device names. This list is defined by the user to be used during an Operational Assistant backup.
Offset to list of tape sets to rotate. The offset from the start of the RBOH0100 structure to the list of tape sets to be used in an Operational Assistant backup.
Offset to monthly options. The offset from the start of the RBOH0100 structure to the monthly backup options.
Offset to weekly options. The offset from the start of the RBOH0100 structure to the weekly backup options.
Print detailed reports. Whether each save command that supports OUTPUT(*PRINT) generates a detailed list of the objects that were saved in addition to a summary report. Possible values follow:
| 0 | Only a summary report is generated from the backup. A detailed report is not generated. |
| 1 | A detailed list of saved objects is printed. A summary report is always printed. |
Reserved. This field is ignored.
Save changed objects only. Whether to save only changed objects in the libraries, folders, and directories being backed up. Possible values follow:
| 0 | All of the objects in the requested libraries, folders, and directories are backed up. |
| 1 | Only objects that were changed since the last backup are saved. |
Submit as batch job. Whether the backup is scheduled to be submitted as a batch job. Possible values follow:
| 0 | The backup is run interactively. |
| 1 | The backup is submitted as a batch job. |
Tape sets to rotate. The name of the one or more tape sets to be used for backup rotation.
User exit program library name. The name of the library that contains the user exit program.
| blank | No exit program is defined so no library name is required. |
| *LIBL | The library list is searched to find the exit program. |
User exit program name. This exit program is run before and after a backup is run to allow users to customize their backups.
| *NONE | No exit program is run. |
Error Messages
| Message ID | Error Message Text |
|---|---|
| CPF1EC5 E | Backup option &1 is not valid. |
| CPF24B4 E | Severe error while addressing parameter list. |
| CPF3C21 E | Format name &1 is not valid. |
| CPF3C24 E | Length of the receiver variable is not valid. |
| CPF3C90 E | Literal value cannot be changed. |
| CPF3CF1 E | Error code parameter not valid. |
| 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 ]