Retrieve IPL Attributes (QWCRIPLA) API
Required Parameter Group:
| 1 | Receiver variable | Output | Char(*) |
| 2 | Length of receiver variable | Input | Binary(4) |
| 3 | Format of IPL attributes | Input | Char(8) |
| 4 | Error Code | I/O | Char(*) |
Default Public Authority: *USE
Threadsafe: No
The Retrieve IPL Attributes (QWCRIPLA) API returns the settings of attributes that are used during the IPL. This API provides support similar to the Display IPL Attributes (DSPIPLA) command.
Authorities and Locks
None.
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 of IPL attributes
- INPUT CHAR(8)
The format of the IPL attributes being returned. The format names that can be used are as follows:IPLA0100 This format returns all of the IPL attributes. See format IPLA0100 for details.
- Error code
- I/O; CHAR(*)
The structure in which to return error information. For the format of the structure, see Error code parameter.
Format IPLA0100
The following information is returned by this API when format IPLA0100 is used:
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Bytes returned |
| 4 | 4 | BINARY(4) | Bytes available |
| 8 | 8 | CHAR(1) | Restart type |
| 9 | 9 | CHAR(1) | Keylock position |
| 10 | A | CHAR(1) | Hardware diagnostics |
| 11 | B | CHAR(1) | Compress job tables |
| 12 | C | CHAR(1) | Check job tables |
| 13 | D | CHAR(1) | Rebuild product directory |
| 14 | E | CHAR(1) | Mail Server Framework recovery |
| 15 | F | CHAR(1) | Clear job queues |
| 16 | 10 | CHAR(1) | Clear output queues |
| 17 | 11 | CHAR(1) | Clear incomplete job logs |
| 18 | 12 | CHAR(1) | Start print writers |
| 19 | 13 | CHAR(1) | Start system to restricted state |
| 20 | 14 | CHAR(1) | Display status |
| 21 | 15 | CHAR(1) | Start TCP/IP |
| 22 | 16 | CHAR(1) | Spooled file recovery |
Field Description
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.
Check job tables. When to perform particular damage checks on the job tables.
| 0 | The job table checks are performed during abnormal IPLs only. |
| 1 | The job table checks are performed during all IPLs. |
| 2 | The job table checks are performed synchronously during all IPLs. |
Clear incomplete job logs. Whether or not to delete the job logs for jobs that were active at the time of the last system power down. This value is reset to 0 after each IPL.
| 0 | The job logs are produced after the IPL. |
| 1 | The job logs are deleted during the IPL. |
Clear job queues. Whether or not to clear the jobs from all job queues. This value is reset to 0 after each IPL.
| 0 | The job queues are not cleared. |
| 1 | The job queues are cleared during the IPL. |
Clear output queues.Whether or not to clear all output queues in libraries that are in the system auxiliary storage pool (ASP number 1) or basic user auxiliary storage pools (ASP numbers 2-32), thus removing all spooled output from those output queues. This value is reset to 0 after each IPL.
Note: If 1 is the value for this field, and 1 is also the value for both the Clear job queues and Clear incomplete job logs fields, then spooled files will be removed only if 1 is the value for the Spooled file recovery field.
| 0 | The output queues are not cleared. |
| 1 | The output queues are cleared during the IPL unless 1 is also the value for the Clear job queues and Clear incomplete job logs fields and 0 is the value for the Spooled file recovery field. In that case, the spooled files will be detached from the jobs, but will not be removed from the output queues. |
Compress job tables. When the job tables should be compressed to remove excess unused entries.
| 0 | The job tables are compressed during abnormal IPLs only. |
| 1 | The job tables are compressed during all IPLs. |
| 2 | The job tables are not compressed during any IPL. |
| 3 | The job tables are compressed during normal IPLs only. |
| 4 | The job tables are compressed during the following IPL. This attribute is reset to 2 after job table compression is started. |
Display status. When the status of IBM® i IPL steps is displayed on the console during IPL. Status is not displayed during install IPLs or when the console is not powered on.
| 0 | Status is displayed during attended IBM i IPLs and abnormal IBM i IPLs. |
| 1 | Status is not displayed during IBM i IPLs. |
| 2 | Status is displayed during attended IBM i IPLs. |
| 3 | Status is displayed during abnormal IBM i IPLs. |
| 4 | Status is displayed during all IBM i IPLs, except as noted above. |
Hardware diagnostics. Whether or not certain hardware diagnostics should be performed during the IPL.
| 0 | All hardware diagnostics are run. |
| 1 | The minimum set of hardware diagnostics is run. |
Keylock position. The keylock position.
| 0 | The keylock position is set to auto. |
| 1 | The keylock position is set to manual. |
| 2 | The keylock position is set to normal. |
| 3 | The keylock position is set to secure. |
Mail Server Framework recovery. Whether or not Mail Server Framework recovery should be done during IPL. The possible values are:
| 0 | Mail Server Framework recovery is not done during IPL. Recovery is done when Mail Server Framework starts. |
| 1 | Mail Server Framework recovery is done during abnormal IPLs. |
Rebuild product directory. When the product directory information is rebuilt.
| 0 | The product directory information is rebuilt during abnormal IPLs only. |
| 1 | The product directory information is rebuilt during all IPLs. |
| 2 | The product directory information is not rebuilt during IPL. |
| 3 | The product directory information is rebuilt during normal IPLs only. |
Restart type. The type of restart operation to perform when the Power Down System (PWRDWNSYS) command is used with RESTART(*YES).
| 0 | All portions of the system, including the hardware, are restarted. |
| 1 | The operating system is restarted. The hardware is restarted only if you apply a PTF that requires a hardware restart. This value can reduce the time required to restart the system. |
Spooled file recovery. What should be done with all spooled files during IPL when a job table is detected as damaged, or if 1 is the value for these three fields: Clear job queues, Clear output queues, and Clear incomplete job logs.
| 0 | Spooled files are detached from the job and remain on the system. |
| 1 | Spooled files are removed from the system. |
Start print writers. Whether or not print writers should be started at the time of the IPL. This value is reset to 1 after each IPL.
| 0 | The print writers are not started at IPL time. |
| 1 | The print writers are started at IPL time. |
Start system to restricted state. Whether or not the system should be started in the restricted state. If the system is started in the restricted state, only the system console is active. This value is reset to 0 after each IPL.
| 0 | The system is not started in the restricted state. |
| 1 | The system is started in the restricted state. |
Start TCP/IP. Whether the STRTCP command is submitted automatically at the completion of IPL and when the controlling subsystem is restarted from the restricted state. The STRTCP command is not submitted during install IPLs or when the system is starting to the restricted state. See the STRTCP command help for more information.
| 0 | The system does not automatically submit the STRTCP command at the completion of IPL. |
| 1 | The system automatically submits the STRTCP command at the completion of IPL. |
Error Messages
| Message ID | Error Message Text |
|---|---|
| CPF24B4 E | Severe error while addressing parameter list. |
| CPF3CF1 E | Error code parameter not valid. |
| CPF3CF2 E | Error(s) occurred during running of &1 API. |
| CPF3C19 E | Error occurred with receiver variable specified. |
| 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. |
| CPF9872 E | Program or service program &1 in library &2 ended. Reason code &3. |
API introduced: V4R2