Add License Key Information (QLZAADDK) API
Required Parameter Group:
| 1 | License key information | Input | Char(*) |
| 2 | License key information format name | Input | Char(8) |
| 3 | Number of license key records added | Output | Binary(4) |
| 4 | Error code | I/O | Char(*) |
Default Public Authority: *EXCLUDE
Threadsafe: No
The Add License Key Information (QLZAADDK) API allows you to add license key information to the license repository. The license repository is used to store license key information. It contains a record for each license for every unique product, license term, feature, and system. The repository may contain licenses for any system, and the product does not need to be installed.
If a key already exists in the repository for the given product, license term, feature, and system, it is replaced. If the product is installed on the system and the license is for that system, the license is also installed. That is, the usage limit is changed from the product's default usage limit to the licensed usage limit. The expiration date is also set based on the license key.
If this is the first license key added for this product, the threshold is set to 90 percent of the usage limit. Message queues default to the message queues defined in the licensed information for the operating system. Violations are not logged. If a license was already installed on the system, these values are not changed. To change any of these default values, you must use the Change License Information (CHGLICINF) command.
Authorities and Locks
- API QLZAADDK Authority
- *PUBLIC(*EXCLUDE)
Required Parameter Group
- License key information
- INPUT; CHAR(*)
The license key information that is to be added to the repository. The structure of this information is determined by the name of the format.
- License key information format name
- INPUT; CHAR(8)
The name of the format containing the license key information.
The format name is:
LICA0100 The license key information to be added to the repository. For details, see LICA0100 Format.
- Number of license key records added
- OUTPUT; BINARY(4)
The number of license key records that were successfully added to the repository.
- Error code
- I/O; CHAR(*)
The structure in which to return error information. For the format of the structure, see Error code parameter.
LICA0100 Format
The following is the license information which is to be added to the repository. For detailed descriptions of the fields, see Field Descriptions.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Size of structure |
| 4 | 4 | BINARY(4) | Offset to the first license key record |
| 8 | 8 | BINARY(4) | Number of license key records in list |
| 12 | C | BINARY(4) | Size of license key record |
| 16 | 10 | BINARY(4) | Reserved |
| Note: The offsets of the following fields vary. These fields repeat, in the order listed, for each license key record. | |||
| CHAR(7) | Product ID | ||
| CHAR(6) | License term | ||
| CHAR(4) | Feature | ||
| CHAR(8) | System serial number | ||
| CHAR(4) | Processor group | ||
| CHAR(3) | Reserved | ||
| BINARY(4) | Usage limit | ||
| CHAR(7) | Expiration date | ||
| CHAR(8) | Vendor data | ||
| CHAR(18) | License key | ||
| CHAR(15) | Reserved | ||
| CHAR(*) | Reserved | ||
Field Descriptions
Expiration date. The date the license will expire.
The valid values are:
| CYYMMDD | C is the century, YY is the year, MM is the
month, and DD is the day. Century, where 0 indicates years 19xx and 1 indicates years 20xx.
The date must be numeric as follows:
|
Feature. The feature of the product. Valid values for the feature are 5001 through 9999.
License key. The license key provided by the vendor. The license key contains only the letters A - F and the numbers 0 - 9.
License term. The extent of time the authorized usage limit for a product lasts. Each time a new license term is installed for a product, the authorized usage limit must be set by:
- Obtaining a new license key.
- Using the Add License Key Information (ADDLICKEY) command.
Possible values are:
| Vx or vv | The authorized usage limit is valid for the entire version of the product or feature. |
| VxRy or vvrr | The authorized usage limit is valid only for the entire release of the product or feature. |
| VxRyMz | The authorized usage limit is valid only for the modification level of the product. |
| vvrrmm | The authorized usage limit is valid only for the modification level of the product. This format must be used if you need to license the modification level of the product and the version or release of the product is greater than 9. |
Where the x and y can be a number from 0 through 9. Z can be a number 0 through 9 or a letter A through Z.
Where vv are any numeric characters 00 through 35 representing the version of the product, rr are any numeric characters 00 through 35 representing the release of the product, and mm can be 00 through 09 or 0A through 0Z representing the modification of the product.
Number of license key records in list. The number of license key records in the list.
Offset to the first license key record. The byte offset from the beginning of the license key information variable to the start of the license key information records.
Processor group. The processor group that this license is for. This field is left justified.
The valid special value is:
| *ANY | The license key is valid for any processor group. |
Product ID. The product ID of the product or feature for which license key information is to be added to the repository.
Reserved. If this field is input, character fields must be set to blanks and binary fields must be set to hexadecimal zeros.
Size of license key record. The size of each license key record. This field can be used to get the offset of the next license key record.
Size of structure. The size of the entire data passed in on this parameter.
System serial number. The system serial number for which license key information is added to the repository.
The valid special value is:
| *LOCAL | License key information for only this local system will be added to the repository. |
The special values are left justified. A value other than a special value must be right justified.
Usage limit. The usage limit for this license.
| -1 | There is no maximum number of license users for this product. |
| 0-999999 | The maximum number of license users for this product. |
Vendor data. The data for this field, along with the license key information, comes from the software provider.
Error Messages
| Message ID | Error Message Text |
|---|---|
| CPD9E2D E | Usage limit cannot be less than current usage. |
| 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. |
| CPF9822 E | Not authorized to file &1 in library &2. |
| CPF9826 E | Cannot allocate file &2. |
| CPF9872 E | Program or service program &1 in library &2 ended. Reason code &3. |
| CPF9E15 E | Error in license management function. |
| CPF9E54 E | License term &1 not valid. |
| CPF9E59 E | Expiration date &1 is not valid. |
| CPF9E5A E | Usage limit not valid. |
| CPF9E6C E | The license key cannot be used for processor group &2. |
| CPF9E68 E | Product &1 license term &2 feature &3 not found. |
| CPF9E6D E | Feature &3 not valid. |
| CPF9E6E E | Product identifier &1 not valid. |
| CPF9E74 E | License key not valid. |
| CPF9E81 E | Cannot install keys for product &1. |
API introduced: V3R1