Parameters

Edit online

The parameter definitions for CSUALGQ.

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
A pointer to an integer variable containing the number of elements in the rule_array variable. The value must be 1.
rule_array
A pointer to a string variable containing an array of keywords. The keywords are eight bytes in length and must be left-aligned and padded on the right with space characters. The rule_array keywords are described in Table 1.
Table 1. Keywords for Log Query control information
Keyword Description
Service requested (One required)
CCALGLEN Specifies to return the length of the CCA log data buffer in the log_data_length variable (the log_number_or_level parameter is ignored). No data is returned in the log_data variable.
GETCCALG Specifies to get up to log_data_length bytes of data from the current CCA log data buffer (the log_number_or_level parameter is ignored). This data is returned in the log_data variable. The returned log only contains all available CCA messages that had a return code of 4 or 8. All other messages are filtered out.
Note: If the log level (see SETLGLVL keyword) has never been set to 4 or 8 in the current boot cycle for the coprocessor, then the CCA log is empty and no data is available to return.
GETLGLVL Specifies to return the current log level in the log_number_or_level variable. The log level is used to determine which return codes the coprocessor uses to generate a log message. A return code greater than or equal to this level causes a log message to be generated. No data is returned in the log_data variable.
GETSYSLG Specifies to get up to log_data_length bytes of data from the SYSLOG (for the given log number as specified by the log_number_or_level parameter). This data is returned in the log_data variable. The returned log contains all available SYSLOG messages, including boot, major error, and CCA messages.
SETLGLVL Specifies to set the current log level inside the coprocessor to the value specified by the log_number_or_level parameter (4, 8, or 12). A CCA return code greater than or equal to the log level causes a log message to be generated. No data is returned in the log_data variable. If the log level for the coprocessor has never been set in the current boot cycle, it defaults to 12. Where the coprocessor stores a message, depends on the message return code:
  • Return code 4 and return code 8 messages are stored in the CCA log. The CCA log is stored in a volatile message data buffer and is only available for the current boot cycle.
  • Return code 12 and return code 16 messages are stored in the current boot cycle SYSLOG along with non-CCA messages. In addition to the current boot cycle SYSLOG, there are up to four SYSLOGs maintained from previous boot cycles.
SYSLGLEN Specifies to return the length of the SYSLOG data buffer in the log_data_length variable (for the given log number specified by the log_number_or_level parameter). No data is returned in the log_data variable.
log_number_or_level
A pointer to an integer variable containing the log number or level for the service requested. This parameter may be unused, but must always be declared. Table 2 describes the meaning of this parameter for the different requested services.
Table 2. Meaning of log_number_or_level for the requested service (keyword)
Service requested Direction Meaning
CCALGLEN Input The value is ignored.
GETCCALG Input The value is ignored.
GETLGLVL Output This is the current minimum level of CCA return code for which a coprocessor generates a log message. Valid values are 4, 8, or 12.
GETSYSLG Input Specifies which of five possible groups of system log message data to retrieve from the coprocessor. See the note at end of the table.
SETLGLVL Input Specifies the minimum level of the CCA return code for which a coprocessor is to generate a log message. Valid values are 4, 8, or 12. If the log level is not set, the default is 12.
Value
CCA return code that generates a log message
4
4, 8, 12, or 16
8
8, 12, or 16
12
12 or 16 (default if log level not set)
SYSLGLEN Input Specifies which length of five possible groups of SYSLOG message data to retrieve from the coprocessor. See the note at end of the table.
Note: To process the system log message data from the current boot cycle, specify 0 in the log_number_or_level parameter. To process the data from the oldest available boot cycle possible, use a log number of 4. If the log number specifies an empty slot (that is, the coprocessor has not been power-cycled enough times for the given log number to have data yet), no data is returned.
reserved0
A pointer to an integer variable. This parameter is reserved for future use. It must be a null pointer or point to a value of 0.
log_data_length
A pointer to an integer variable containing the number of bytes in the log_data variable, or the maximum number of data bytes available to retrieve for a particular log inside the coprocessor. This parameter may be unused, but must always be declared. Table 3 describes the meaning of this parameter for the different requested services.
Table 3. Meaning of log_data_length for the requested service (keyword)
Service requested Direction Meaning
CCALGLEN Output Specifies the maximum number of CCA log data bytes available to retrieve inside the Coprocessor (the log_number_or_level parameter is ignored). No data is returned in the log_data variable.
GETCCALG Input/Output On input, this variable specifies the number of bytes available in the log_data variable. On output, the variable is updated to the number of bytes of CCA log data returned in the log_data variable.
Note:
  1. To determine the maximum number of bytes that the current CCA log data buffer contains, use the CCALGLEN keyword. The maximum is less than or equal to 1024.
  2. The actual amount of data returned is variable and can be less than the maximum, depending on the amount of log messages issued so far.
  3. On input, it is acceptable to specify a value less than the total size of the available CCA log data buffer. On output, the end of the data buffer is truncated as needed.
  4. On input, it is acceptable to specify a value greater than the total size of the available CCA log data buffer. On output, the length is adjusted to the total size.
  5. Interpretation of the data is defined internally by IBM®. The data may or may not be human-readable. The data may contain truncated messages or partial messages that in some way conflict with a given editor.
GETLGLVL Input The value is ignored.
GETSYSLG Input/Output On input, this variable specifies the number of bytes available in the log_data variable. On output, the variable is updated to the number of bytes of SYSLOG data returned in the log_data variable (for the given log number as specified by the log_number_or_level parameter).
Note:
  1. To determine the maximum number of bytes that the specified SYSLOG data buffer contains, use the SYSLGLEN keyword. The maximum that can be returned is 16384.
  2. The actual amount of data returned is variable and can be less than the maximum, depending on the amount of log messages issued so far.
  3. On input, it is acceptable to specify a value less than the total size of the available SYSLOG data buffer. On output, the end of the data buffer is truncated as needed.
  4. On input, it is acceptable to specify a value greater than the total size of the available SYSLOG data buffer. On output, the length is adjusted to the total size.
  5. Interpretation of the data is defined internally by IBM. The data may or may not be human-readable. The data may contain truncated messages or partial messages that in some way conflict with a given editor.
SETLGLVL Input The value is ignored.
SYSLGLEN Output Specifies the maximum number of SYSLOG data bytes available to retrieve inside the coprocessor (for the given log number as specified by the log_number_or_level parameter). No data is returned in the log_data variable.
log_data
A pointer to a string variable containing the returned log data when keyword GETCCALG or GETSYSLG is specified in the rule array. This parameter may be unused, but must always be declared.
reserved1_length
A pointer to an integer variable containing the number of bytes of data in the reserved1 variable. This parameter must be a null pointer or point to a value of 0.
reserved1
This parameter is a pointer to a string variable. It is reserved for future use.
reserved2_length
A pointer to an integer variable containing the number of bytes of data in the reserved2 variable. This parameter must be a null pointer or point to a value of 0.
reserved2
This parameter is a pointer to a string variable. It is reserved for future use.