Parameters

The parameters for CSNBCKRL.

For the definitions of the return_code, reason_code, exit_data_length, and exit_data parameters, see Parameters common to all verbs.

rule_array_count
Direction: Input
Type: Integer
The rule_array_count parameter is a pointer to an integer variable containing the number of elements in the rule_array variable. The value must be 1.
rule_array
Direction: Input
Type: String
A pointer to a string variable containing an array of keywords that provide control information to the verb. Each keyword is left-aligned in 8-byte fields and padded on the right with blanks. All keywords must be in contiguous storage. The rule_array keywords are described in Table 1.
Table 1. Keywords for Combined Key Record List control information

Keywords for Combined Key Record List control information

Keyword Description
Key Block Algorithm (one required).
AES Specifies that the key token denoted by the key_label parameter is an AES key token (external, internal, and null AES and HMAC key tokens).
DES Specifies that the key token denoted by the key_label parameter is a DES key token (external, internal, and null DES key tokens).
PKA Specifies that the key token denoted by the key_label parameter is a PKA (ECC, QSA, or RSA) key token. This record can be an external, internal, or null PKA key token.
key_label
Direction: Input
Type: String
A pointer to a string variable containing the key label of a key token record in key-storage. In a key label, you can use a wildcard (*) to identify multiple records in key storage.
dataset_name_length
Direction: Input
Type: Integer
A pointer to an integer variable containing the number of bytes of data returned by the verb in the file denoted by the dataset_name variable. The maximum returned length is 1024 bytes.
dataset_name
Direction: Input
Type: String
A pointer to a string variable containing the name of the dataset returned by the verb. The dataset contains the key record information.

The path to the dataset name returned by this verb is defined by the CSUCMBLD environment variable. The verb returns the dataset name as a fully qualified file specification. For example, /opt/IBM/CCA/keys/cmblist/KYRLT<nnn>.LST), where nnn is the numeric portion of the name. This value increases by one every time that you use this verb. When this value reaches 999, it resets to 001.

When the verb stores a key-record-list dataset, it overlays any older dataset with the same name.

reserved_length
Direction: Input/Output
Type: Integer
A pointer to an integer variable containing the number of bytes of data in the reserved variable. Reserved for future use. This parameter must be a null pointer or point to a value of 0.
reserved
Direction: Input/Output
Type: String
A pointer to a string variable. Reserved for future use. This parameter must be null.