Change Backup Schedule (QEZCHBKS) API
| 1 | Input structure | Input | Char(*) |
| 2 | Length of input structure | Input | Binary(4) |
| 3 | Format name | Input | Char(8) |
| 4 | Error code | I/O | Char(*) |
Default Public Authority: *USE
Threadsafe: No
The Change Backup Schedule (QEZCHBKS) API allows the user to change the Operational Assistant backup schedules.
Authorities and Locks
- Special Authority
- *JOBCTL and *SAVSYS
- User Index Authority
- *CHANGE
- User Index Lock
- *EXCL
Required Parameter Group
- Input structure
- INPUT; CHAR(*)
The variable that contains the backup schedule changes. The layout of this parameter is defined by the format name parameter.
- Length of input structure
- INPUT; BINARY(4)
Length of the change request structure. A minimum length of 58 is required for the CBKS0100 format.
- Format name
- INPUT; CHAR(8)
The format of the input structure data. Format CBKS0100 contains the information regarding changes to the Operational Assistant backup schedule. For more information, see CBKS0100 Format.
- Error code
- I/O; CHAR(*)
The structure in which to return error information. For the format of the structure, see Error code parameter.
CBKS0100 Format
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Hours before backup to send load-tape message |
| 4 | 4 | BINARY(4) | Occurrence of week in month to run backup |
| 8 | 8 | CHAR(1) | Run backup using this schedule |
| 9 | 9 | CHAR(1) | Sunday backup |
| 10 | A | CHAR(6) | Sunday backup time |
| 16 | 10 | CHAR(1) | Monday backup |
| 17 | 11 | CHAR(6) | Monday backup time |
| 23 | 17 | CHAR(1) | Tuesday backup |
| 24 | 18 | CHAR(6) | Tuesday backup time |
| 30 | 1D | CHAR(1) | Wednesday backup |
| 31 | 1F | CHAR(6) | Wednesday backup time |
| 37 | 22 | CHAR(1) | Thursday backup |
| 38 | 23 | CHAR(6) | Thursday backup time |
| 44 | 2C | CHAR(1) | Friday backup |
| 45 | 2D | CHAR(6) | Friday backup time |
| 51 | 33 | CHAR(1) | Saturday backup |
| 52 | 34 | CHAR(6) | Saturday backup time |
Field Descriptions
Friday backup. The backup type to be performed on Friday. Possible values follow:
| 1 | *DAILY |
| 2 | *WEEKLY |
| 3 | *MONTHLY |
| 4 | *WEEKMONTH. The weekly backup options are used to run the backup every week except for the week that the monthly backup is to occur. The monthly backup week is determined by the value that the user specifies for the occurrence of week in month to run backup field. |
| 9 | *SAME. No change is made to the current backup schedule for the specified day of the week. |
| blank | No backup is scheduled for the specified day of the week. |
Friday backup time. The time that the backup should occur on Friday. Possible values follow:
| HHMMSS | The time that the backup operation should occur for the specified day of the week. A 24-hour format is used. |
| blank | No backup operations are scheduled to be performed for the specified day of the week. |
| *SAME | No change should be made to the current backup operations that are scheduled for the specified day of the week. |
Hours before backup to send load-tape message. The number of hours prior to a backup for a system-operator load-tape-message reminder to be sent. The possible values follow:
| 0 | *NOMSG. No message is sent. |
| 1-24 | The number of hours prior to backup to send the message. |
| -1 | *SAME. No change is made to the scheduled hours before backup to send the load-tape message. |
Monday backup. The backup type to be performed on Monday. Possible values follow:
| 1 | *DAILY |
| 2 | *WEEKLY |
| 3 | *MONTHLY |
| 4 | *WEEKMONTH. The weekly backup options are used to run the backup every week except for the week that the monthly backup is to occur. The monthly backup week is determined by the value that the user specifies for the occurrence of week in month to run backup field. |
| 9 | *SAME. No change is made to the current backup schedule for the specified day of the week. |
| blank | No backup is scheduled for the specified day of the week. |
Monday backup time. The time that the backup should occur on Monday. Possible values follow:
| HHMMSS | The time that the backup operation should occur for the specified day of the week. A 24-hour format is used. |
| blank | No backup operations are scheduled to be performed for the specified day of the week. |
| *SAME | No change should be made to the current backup operations that are scheduled for the specified day of the week. |
Occurrence of week in month to run backup. The week of the month that you want the backup to occur when the backup type is *MONTHLY or *WEEKMONTH. Possible values follow:
| -1 | *SAME. No changes are made to this value. |
| 0 | No monthly backups are scheduled. (If there are no days specified with *MONTHLY or *WEEKMONTH, this value is not used and is ignored.) |
| 1-4 | The corresponding week of the month during which the monthly backup occurs. |
| 5 | *LAST. The monthly backup should be run on the last week for any given month. |
Run backup using this schedule. Whether the backup schedule should be used to run backups. Possible values follow:
| 0 | No. Save all the schedule values, but do not run the backups. |
| 1 | Yes. Allow backups to run according to this schedule. |
| blank | *SAME. Use the existing Run backup using this schedule value. |
Saturday backup. The backup type to be performed on Saturday. Possible values follow:
| 1 | *DAILY |
| 2 | *WEEKLY |
| 3 | *MONTHLY |
| 4 | *WEEKMONTH. The weekly backup options that are used to run the backup every week except for the week that the monthly backup is to occur. The monthly backup week is determined by the value that the user specifies for the occurrence of week in month to run monthly backup field. |
| 9 | *SAME. No change is made to the current backup schedule for the specified day of the week. |
| blank | No backup is scheduled for the specified day of the week. |
Saturday backup time. The time the backup should occur on Saturday. Possible values follow:
| HHMMSS | The time that the backup operation should occur for the specified day of the week. A 24-hour format is used. |
| blank | No backup operations are scheduled to be performed for the specified day of the week. |
| *SAME | No change should be made to the current backup operations that are scheduled for the specified day of the week. |
Sunday backup. The backup type to be performed on Sunday. Possible values follow:
| 1 | *DAILY |
| 2 | *WEEKLY |
| 3 | *MONTHLY |
| 4 | *WEEKMONTH. The weekly backup options are used to run the backup every week except for the week that the monthly backup is to occur. The monthly backup week is determined by the value that the user specifies for the occurrence of week in month to run backup field. |
| 9 | *SAME. No change is made to the current backup schedule for the specified day of the week. |
| blank | No backup is scheduled for this day of the week. |
Sunday backup time. The time that the backup should occur on Sunday. Possible values follow:
| HHMMSS | The time that the backup operation should occur for the specified day of the week. A 24-hour format is used. |
| blank | No backup operations are scheduled to be performed for the specified day of the week. |
| *SAME | No change should be made to the current backup operations that are scheduled for the specified day of the week. |
Thursday backup. The backup type to be performed on Thursday. Possible values follow:
| 1 | *DAILY |
| 2 | *WEEKLY |
| 3 | *MONTHLY |
| 4 | *WEEKMONTH. The weekly backup options are used to run the backup every week except for the week that the monthly backup is to occur. The monthly backup week is determined by the value that the user specifies for the occurrence of week in month to run backup field. |
| 9 | *SAME. No change is made to the current backup schedule for the specified day of the week. |
| blank | No backup is scheduled for the specified day of the week. |
Thursday backup time. The time the backup should occur on Thursday. Possible values follow:
| HHMMSS | The time that the backup operation should occur for the specified day of the week. A 24-hour format is used. |
| blank | No backup operations are scheduled to be performed for the specified day of the week. |
| *SAME | No change should be made to the current backup operations that are scheduled for the specified day of the week. |
Tuesday backup. The backup type to be performed on Tuesday. Possible values follow:
| 1 | *DAILY |
| 2 | *WEEKLY |
| 3 | *MONTHLY |
| 4 | *WEEKMONTH. The weekly backup options are used to run the backup every week except for the week that the monthly backup is to occur. The monthly backup week is determined by the value that the user specifies for the occurrence of week in month to run backup field. |
| 9 | *SAME. No change is made to the current backup schedule for the specified day of the week. |
| blank | No backup is scheduled for the specified day of the week. |
Tuesday backup time. The time that the backup should occur on Tuesday. Possible values follow:
| HHMMSS | The time that the backup operation should occur for the specified day of the week. A 24-hour format is used. |
| blank | No backup operations are scheduled to be performed for the specified day of the week. |
| *SAME | No change should be made to the current backup operations that are scheduled for the specified day of the week. |
Wednesday backup. The backup type to be performed on Wednesday. Possible values follow:
| 1 | *DAILY |
| 2 | *WEEKLY |
| 3 | *MONTHLY |
| 4 | *WEEKMONTH. The weekly backup options are used to run the backup every week except for the week that the monthly backup is to occur. The monthly backup week is determined by the value that the user specifies for the occurrence of week in month to run backup field. |
| 9 | *SAME. No change is made to the current backup schedule for the specified day of the week. |
| blank | No backup is scheduled for the specified day of the week. |
Wednesday backup time. The time the backup should occur on Wednesday. Possible values follow:
| HHMMSS | The time that the backup operation should occur for the specified day of the week. A 24-hour format is used. |
| blank | No backup operations are scheduled to be performed for the specified day of the week. |
| *SAME | No change should be made to the current backup operations that are scheduled for the specified day of the week. |
Error Messages
| Message ID | Error Message Text |
|---|---|
| CPF1061 E | Time not valid. |
| CPF1099 E | Subsystem not started because system ending. |
| CPF1629 E | Not authorized to job schedule &1. |
| CPF1637 E | Job schedule &1 in library &2 in use. |
| CPF1EC0 E | Job schedule in use by another user. |
| CPF1EC3 E | Not authorized to Backup Schedule. |
| CPF1EC4 E | Cannot display Backup Schedule. |
| CPF1EC5 E | Backup option &1 is not valid. |
| CPF1EC6 E | Value &1 for run backup not valid. |
| CPF1EC8 E | Value &1 for hours before backup not valid. |
| CPF1EC9 E | Value &1 for occurrence of week not valid. |
| CPF1E99 E | Unexpected error occurred. |
| CPF1EE3 E | Not authorized to backup options. |
| CPF24B4 E | Severe error while addressing parameter list. |
| CPF3C17 E | Error occurred with input data parameter. |
| CPF3C21 E | Format name &1 is not valid. |
| CPF3C90 E | Literal value cannot be changed. |
| CPF3CF1 E | Error code parameter not valid. |
| CPF8122 E | &8 damage on library &4. |
| CPF9802 E | Not authorized to object &2 in &3. |
| CPF9803 E | Cannot allocate object &2 in library &3. |
| CPF9807 E | One or more libraries in library list deleted. |
| CPF9808 E | Cannot allocate one or more libraries on library list. |
| CPF9810 E | Library &1 not found. |
| CPF9820 E | Not authorized to use library &1. |
| CPF9830 E | Cannot assign library &1. |
| CPF9838 E | User profile storage limit exceeded. |
| CPF9872 E | Program or service program &1 in library &2 ended. Reason code &3. |
| CPF9999 E | Function check. &1 unmonitored by &2 at statement &5, instruction &3. |
API introduced: V3R7
[ Back to top | Backup and Recovery APIs | APIs by category ]