Output variables

The following REXX variable are returned by HZSLSTRT:
Table 1. HZSLSTRT output variables
Variable name Description
HZSLSTRT_RSN The reason code explaining a RESULT value of 8 or more. The reason codes are as follows:
00000858
Meaning: HZS_HANDLE was not valid.

Action: Make sure that the HZSLSTRT service is only called from a REXX exec called by IBM® Health Checker for z/OS®. The check must not modify output variable HZS_HANDLE. If this function is used within a procedure, make sure you used the EXPOSE option to make HZS_HANDLE accessible to the procedure code

xxxx08xx
Meaning: HZSCHECK REQUEST=OPSTART returned the HzscheckRC_InvParm reason code equate symbol.

Action: Refer to the action under the individual reason code for the HZSCHECK macro.

Meaning: Action:
00000C16
Meaning: The HZSLSTRT function has been invoked by a non-SYSREXX caller.

Action: Ensure that HZSLSTRT is only called from a REXX health check routine.

xxxx0Cxx
Meaning: HZSCHECK REQUEST=OPSTART returned the HzscheckRC_EnvError reason code equate symbol.

Action: Refer to the action under the individual reason code for the HZSCHECK macro.

00001003
Meaning: A service used by HZSLSTRT failed.

Action: Retry the service. If HZSLSTRT continues to fail, obtain the value of the REXX variable HZSLSTRT_SYSTEMDIAG, and contact IBM service.

HZSLSTRT_SYSTEMDIAG Diagnostic data returned by the failed service that HZSLSTRT uses.
HZS_PQE_ENTRY_CODE Contains the numeric identifier (entry code) assigned for the REXX check in the check definition. The entry code is used when a REXX exec contains multiple checks. The system sets this field on entry to the REXX check.
HZS_PQE_DOM_CHECK Indicates how the DOM(SYSTEM | CHECK) parameter was set when the check was added to IBM Health Checker for z/OS for the current check:
1
The check was added with DOM(CHECK).
0
The check was added with or defaulted to DOM(SYSTEM).
For information on how DOM=CHECK works, see Controlling check exception message WTOs and their automation consequences.
HZS_PQE_AllowDynSev Indicates how the ALLOWDYNSEV(YES | NO) parameter was set when the check was added to IBM Health Checker for z/OS for the current check:
1
The check was added with ALLOWDYNSEV(YES).
0
The check was added with or defaulted to ALLOWDYNSEV(NO).
For information on how ALLOWDYNSEV(YES) works, see Writing a check with dynamic severity levels.
HZS_PQE_FUNCTION_CODE Contains the function code in text form for the REXX check. The REXX check receives control in response to either the "RUN" or "INITRUN"function code. The system sets this field on entry to the REXX check.
HZS_PQE_VERSION The version of the HZSPQE that is used to represent this check.
HZS_PQE_CHECK_COUNT Number of times this check has been called since the check was initialized.
HZS_PQE_CUM_CHECK_COUNT The cumulative check iteration number since initialized. This differs from HZS_PQE_CHECK_COUNT in that it is not reset when a refresh occurs. It is updated just before calling the check function, but the check itself might not have confirmed that it got control.
HZS_PQE_ENVIRONMENT _XCFLOCAL Indicates whether the system is in XCF local mode:
1
Boolean TRUE - System is XCF local mode.
0
Boolean FALSE - System is not XCF local mode.
HZS_PQE_ENVIRONMENT _XCFMONOPLEX Indicates whether the system is in XCF monoplex mode:
1
Boolean TRUE - System is XCF monoplex mode.
0
Boolean FALSE - System is not XCF monoplex l mode.
HZS_PQE_CHECKOWNER The product, component, or element that owns the check.
HZS_PQE_CHECKNAME Check name.
HZS_PQE_GLOBAL _CHECK Indicates whether the check is defined as global:
1
Boolean TRUE - check is defined as global.
0
Boolean FALSE - check is not defined as global.
HZS_PQE_DEBUG Indicates whether the check is running in debug mode:
1
Boolean TRUE - check is running in debug mode.
0
Boolean FALSE - check is running in debug mode,
HZS_PQE_LOOKATPARMS Indicates whether the check should look at the parameter values, either because check parameter values have changed since the last time this check ran, or because it is the first time the check has run after it was in a DISABLED or INACTIVATE state:
1
Boolean TRUE - The check should look at the parameter values.
0
Boolean FALSE - The check does not need to look at the parameter values.
HZS_PQE_VERBOSE Indicates whether the check is running in verbose mode:
1
Boolean TRUE - The check is running in verbose mod.
0
Boolean FALSE - The check is not is running in verbose mod.
HZS_PQE_REASON Current value of the check reason text.
HZS_PQE_PARMAREA Current check parameter(s). If LENGTH(HZS_PQE_PARMAREA)=0, then no parameters are currently defined for this check.
HZS_PQE_CHKWORK Current value of the PQE_CHKWORK area saved by the HZSLSTOP service the last time the check ran. Only a maximum of 2048 characters HZS_PQE_CHKWORK will be saved and restored. HZS_PQE_CHCKWORK is reset before the check is run for the following reasons:
  • When the check is to run for the first time.
  • When the check is REFRESHed.
  • When the check becomes either INACTIVE or DISABLED for any reason besides invalid parameters.