Install Licensed Programs (QLPINSLP) API
Required Parameter Group:
| 1 | Install options | Input | Char(*) |
| 2 | Format name | Input | Char(8) |
| 3 | Interactive mode screen I/O indicator | Input | Char(1) |
| 4 | Error code | I/O | Char(*) |
Default Public Authority: *EXCLUDE
Threadsafe: No
The Install Licensed Programs (QLPINSLP) API allows you to install IBM licensed programs without having to use the GO LICPGM menu interactively. It allows both an interactive mode and a batch mode of installation to install the licensed programs. Non-IBM Licensed Programs cannot be installed using this API. The system is required to be in restricted state when using this API to install IBM supplied libraries QGPL and QUSRSYS. The system is recommended to be in restricted state to install SS1 options 1 and 3.
Authorities and Locks
- Device lock - optical media
- *SHRUPD
- Device lock - tape media
- *EXCLRD
- Product library lock
- *SHRUPD
Note: No specific special authorities are required to use this
API. However, just as with the GO LICPGM, *ALLOBJ and *SECADM special authorities
are recommended when installing IBM licensed programs. There are no checks to
ensure these special authorities as some IBM licensed programs will install
properly without them.
Required Parameter Group
- Install options
- INPUT; CHAR(*)
The install options required for installing the IBM licensed programs. The format of the install options will depend on what format is specified on the Format Name parameter (NSLP0100 or NSLP0200).
- Install options format name
- INPUT; CHAR(8)
The format of the install options. You can use one of the following format names:
NSLP0100 Work with Licensed Programs menu option 1 (Install all) parameters NSLP0200 Work with Licensed Programs menu option 11 (Install licensed programs) parameters.
- Interactive mode screen I/O indicator
- INPUT; CHAR(1)
An indicator as to whether screen I/O is desired in interactive mode. Valid values are:
0 Screen I/O is not desired 1 Screen I/O is desired Note: When the API runs in batch mode, no screen I/O is provided regardless of the value of this indicator.
- Error code
- I/O; CHAR(*)
The structure in which to return error information. For the format of the structure, see Error code parameter.
Install options format NSLP0100
For detailed descriptions of the fields in this table, see Field Descriptions.| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(1) | Install option |
| 1 | 1 | CHAR(10) | Installation device |
| 11 | C | CHAR(1) | Replace if current |
| 12 | D | CHAR(1) | Nonaccepted agreement |
| 13 | E | CHAR(1) | Automatic IPL |
Install options format NSLP0200
For detailed descriptions of the fields in this table, see Field Descriptions.| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(10) | Installation device |
| 10 | A | CHAR(1) | Objects to install |
| 11 | B | CHAR(1) | Nonaccepted agreement |
| 12 | C | CHAR(1) | Automatic IPL |
| 13 | D | CHAR(3) | Reserved |
| 16 | 10 | BIN(4) | Offset to licensed program infomration |
| 20 | 14 | BIN(4) | Number of entries in licensed program information entry |
| 24 | 18 | BIN(4) | Length of one licensed program information entry |
| This field repeats for each licensed program information entry. | CHAR(*) | Licensed program information entry (See Format of licensed program information entry for more information.) | |
Format of licensed program information entry
The licensed program information entry describes the data that is required for the NSLP0200 format. For details about the fields listed, see Field Descriptions.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| The fields repeat for each licensed program. | CHAR(10) | Licensed program | |
| CHAR(10) | Product option | ||
Field Descriptions
Automatic IPL. The supported values are:
| Y | Yes. Perform an automatic IPL after the installation process is complete. If you are not performing additional steps, such as loading and applying PTFs, you can specify 'Y'. The IPL will not be performed unless the keylock is in the normal position. |
| N | No. Do not perform an automatic IPL. |
Install option. Specifies the install option that should be used to install IBM licensed programs from media. The supported values are:
| 1 | Installed products. Install only those IBM licensed programs that replace products that already exist on the system. |
| 2 | All products. Install all IBM licensed programs found on the distribution media. |
| 3 | New products. Install only those IBM licensed programs that do not already exist on the system or that are installed with an error status. |
| 4 | Installed and additionally selected products. Install IBM licensed programs that replace installed products and to install selected additional IBM licensed programs. (You select additional licensed programs to install by using the Prepare for install option of the Work with Licensed Programs menu and selecting the option to "Work with licensed programs for target release".) |
Installation device. The device name that has the media that contains the IBM licensed programs that will be installed. The device can be an optical or tape device.
Length of one licensed program information entry.The length of the licensed program information.
Licensed program.The licensed program identifier, optional part or IBM-supplied user library you want to install. If the licensed program specified is QGPL or QUSRSYS, the remainder of the field should be padded with blanks. Diagnostic message CPDB6E1 will be sent for each invalid licensed program found in the list. Invalid licensed programs include non IBM licensed programs, 57xx999 *BASE (Licensed Internal Code) and 57xxSS1 *BASE (Base operating system).
Nonaccepted agreement. During the installation of licensed programs, if the software agreement has not been previously accepted, the nonaccepted agreement option determines if the user will be prompted to accept or decline the software agreement, or if the install will continue without installing the licensed program. The supported values are:
| 1 | Do not install licensed program. Continue the install with the next licensed program. Do not install the current licensed program. |
| 2 | Display software agreement
The install of this licensed program will wait for the user to accept or decline
the software agreement before continuing.
Note: When the API runs in batch mode, then the software agreement will not be able to be displayed, which will cause any licensed programs requiring software agreement acceptance to not be installed. |
Number of entries in licensed program information. The number of entries in the licensed program information.
Objects to install. The supported values are:
| 1 | Programs and language objects. Restore programs and language objects from the distribution media for the specified IBM licensed programs. |
| 2 | Programs. Restore only program objects from the distribution media for the specified IBM licensed programs. |
| 3 | Language objects. Restore only language objects from the distribution media for the specified IBM licensed programs. |
Offset to licensed program information.The offset from the start of the format to the start of the licensed program information.
Product option. The number or value associated with each part of a licensed program. All licensed programs have a base part and may have one or more numbered optional parts. The product option for the base would be specified as '0000'. Numbered optional parts should be specified as '00nn', where nn is the option number. For example, option 1 should be specified as '0001'. If QGPL or QUSRSYS was specified for the Licensed program field, then the Product option field will be ignored. The following special values are also allowed:
| *ALL | This indicates to install the base and all optional parts that are found on the installation media. |
| *BASE | This indicates to install the base part of the licensed program. |
Replace if current. The supported values are:
| Y | Yes. Replace products that are already installed including products installed at the same level on the installation media. |
| N | No. Do not replace products that are already installed and at the same level on the installation media. |
Error Messages
| Message ID | Error Message Text |
|---|---|
| CPF24B4 E | Severe error while addressing parameter list. |
| CPF3C21 E | Format name &1 is not valid. |
| CPF3C90 E | Literal value cannot be changed. |
| CPF3CF1 E | Error code parameter not valid. |
| CPF3DA9 E | Install Option &1 is not valid. |
| CPD3DAC E | Device &1 is not a valid installation device. |
| CPF3DAD E | Screen I/O parameter value is not valid. |
| CPF3DCB E | Replace if current value &1 is not valid. |
| CPF3DCD E | Nonaccepted agreement value &1 not valid. |
| CPF3DCE E | Automatic IPL value &1 not valid. |
| CPF3DCF E | Objects to install value &1 not valid. |
| CPF3DD9 E | Licensed program installation not complete. |
| CPF9814 E | Device &1 not found. |
| CPF9825 E | Not authorized to device &1. |
| CPF9831 E | Cannot assign device &1. |
| CPF9872 E | Program or service program &1 in library &2 ended. Reason code &3. |
API introduced: V7R2
| Top | Software Product APIs | APIs by category |