diff --git a/docs/troubleshoot/launcher/launcher-error-codes.md b/docs/troubleshoot/launcher/launcher-error-codes.md index e8020b6bdf..5fec3654f8 100644 --- a/docs/troubleshoot/launcher/launcher-error-codes.md +++ b/docs/troubleshoot/launcher/launcher-error-codes.md @@ -1,8 +1,10 @@ -# Error Message Codes - -The following error message codes may appear on Zowe Launcher SYSPRINT. Use the following message code references and the corresponding reasons and actions to help troubleshoot issues. - -## Zowe Launcher informational messages + + # Error Message Codes + + The following error message codes may appear on Zowe Launcher SYSPRINT. Use the following message code references and the corresponding reasons and actions to help troubleshoot issues. + + ## Zowe Launcher informational messages + ### ZWEL0001I @@ -10,7 +12,7 @@ The following error message codes may appear on Zowe Launcher SYSPRINT. Use the **Reason:** - Component `` started. + The component `` was started. **Action:** @@ -22,7 +24,7 @@ The following error message codes may appear on Zowe Launcher SYSPRINT. Use the **Reason:** - Component `` stopped. + The component `` was stopped. **Action:** @@ -34,7 +36,7 @@ The following error message codes may appear on Zowe Launcher SYSPRINT. Use the **Reason:** - Component `` initialized. + The component `` was initialized. - `restart_cnt` - Number of attempts to restart the component in case of failure - `min_uptime` - Minimum uptime that the component can be considered as successfully started - `share_as` - One of `` which indicates whether child processes of the component start in the same address space. See documentation for [_BPX_SHAREAS](https://www.ibm.com/docs/en/zos/2.4.0?topic=shell-setting-bpx-shareas-bpx-spawn-script) for details. @@ -45,11 +47,11 @@ The following error message codes may appear on Zowe Launcher SYSPRINT. Use the ### ZWEL0004I - component %s\(%d\) terminated, status = %d + component %s(%d) terminated, status = %d **Reason:** - Component ``(``) terminated with status ``. + The component ``(``) terminated with the status ``. **Action:** @@ -61,13 +63,315 @@ The following error message codes may appear on Zowe Launcher SYSPRINT. Use the **Reason:** - Component failure detected. + Next attempt to restart component `` in `` seconds. **Action:** No action required. The component `` will be restarted in `` seconds. -## Zowe Launcher error messages +### ZWEL0006I + + starting components + + **Reason:** + + Starting the components. + + **Action:** + + No action required. + +### ZWEL0007I + + components started + + **Reason:** + + The components are started. + + **Action:** + + No action required. + +### ZWEL0008I + + stopping components + + **Reason:** + + Stopping the components. + + **Action:** + + No action required. + +### ZWEL0009I + + components stopped + + **Reason:** + + The components are stopped. + + **Action:** + + No action required. + +### ZWEL0010I + + launcher has the following components: + + **Reason:** + + The launcher has the following components. + + **Action:** + + No action required. + +### ZWEL0011I + + name = %16.16s, PID = %d + + **Reason:** + + Name = ``, PID = ``. + + **Action:** + + No action required. + +### ZWEL0012I + + starting console listener + + **Reason:** + + Starting the console listener. + + **Action:** + + No action required. + +### ZWEL0013I + + command \'%s\' received + + **Reason:** + + The command `` was received. + + **Action:** + + No action required. + +### ZWEL0014I + + termination command received + + **Reason:** + + The termination command was received. + + **Action:** + + No action required. + +### ZWEL0015I + + console listener stopped + + **Reason:** + + The console listener was stopped. + + **Action:** + + No action required. + +### ZWEL0016I + + start component list: '%s' + + **Reason:** + + Start the component list `` + + **Action:** + + No action required. + +### ZWEL0017I + + ROOT_DIR is '%s' + + **Reason:** + + The ROOT_DIR (`zowe.runtimeDirectory`) is `` + + **Action:** + + No action required. + +### ZWEL0018I + + Zowe instance prepared successfully + + **Reason:** + + Zowe instance prepared successfully. + + **Action:** + + No action required. + +### ZWEL0019I + + Zowe Launcher stopping + + **Reason:** + + Zowe Launcher is stopping. + + **Action:** + + No action required. + +### ZWEL0021I + + Zowe Launcher starting + + **Reason:** + + Zowe Launcher is starting. + + **Action:** + + No action required. + +### ZWEL0022I + + Zowe Launcher stopped + + **Reason:** + + Zowe Launcher was stopped. + + **Action:** + + No action required. + +### ZWEL0023I + + Zowe YAML config file is \'%s\' + + **Reason:** + + Zowe YAML config file is ``. + + **Action:** + + No action required. + +### ZWEL0024I + + HA_INSTANCE_ID is '%s' + + **Reason:** + + The HA_INSTANCE_ID name is ``. + + **Action:** + + No action required. + +### ZWEL0025I + + restart_intervals for component '%s'= %s + + **Reason:** + + Restart intervals for component `` = `.` + Restart intervals is defined in `zowe.launcher.restartIntervals`. + + **Action:** + + No action required. + +### ZWEL0058I + + WORKSPACE_DIR is '%s' + + **Reason:** + + The WORKSPACE_DIR (`zowe.workspaceDirectory`) is ``. + + **Action:** + + No action required. + +### ZWEL0069I + + Configuration is valid + + **Reason:** + + The configuration is valid. + + **Action:** + + No action required. + + ## Zowe Launcher error messages + + +### ZWEL0026E + + %s env variable not found + + **Reason:** + + The environmental variable `` was not found. + + **Action:** + + In launcher's STC, under `DD` statement `STDENV`, review the ``. + +### ZWEL0027E + + %s env variable too large + + **Reason:** + + `` environmental variable is too large. + + **Action:** + + In launcher's STC, under `DD` statement `STDENV`, review the ``. + +### ZWEL0028E + + failed to get component list + + **Reason:** + + Failed to get the component list. + + **Action:** + + Review the components defined in configuration (identified by message `ZWEL0023I`). + +### ZWEL0029E + + start component list is empty + + **Reason:** + + Start component list is empty. + + **Action:** + + Review the components defined in configuration (identified by message `ZWEL0023I`). ### ZWEL0030E @@ -75,11 +379,95 @@ The following error message codes may appear on Zowe Launcher SYSPRINT. Use the **Reason:** - Failed to prepare the Zowe high availability (HA) instance. + Failed to prepare the zowe instance. + + **Action:** + + Check previous messages in the Zowe Launcher `SYSPRINT` to find the reason and correct it. + +### ZWEL0031E + + failed to setup signal handlers + + **Reason:** + + Failed to setup signal handlers. **Action:** - Check previous messages in the Zowe Launcher SYSPRINT to find the reason and correct it. + Contact Support. + +### ZWEL0032E + + failed to find %s='%s', check if the dir exists + + **Reason:** + + Failed to find ``=``, check if the directory exists. + + **Action:** + + Verify `` is correctly defined in configuration (identified by message `ZWEL0023I`). + +### ZWEL0033E + + failed to get ROOT_DIR dir + + **Reason:** + + Failed to get ROOT_DIR (`zowe.runtimeDirectory`). + + **Action:** + + Review `zowe.runtimeDirectory` defined in configuration (identified by message `ZWEL0023I`). + +### ZWEL0034E + + ROOT_DIR is empty string + + **Reason:** + + ROOT_DIR (`zowe.runtimeDirectory`) is empty string. + + **Action:** + + Review `zowe.runtimeDirectory` defined in configuration (identified by message `ZWEL0023I`). + +### ZWEL0035E + + invalid command line arguments, provide HA_INSTANCE_ID as a first argument + + **Reason:** + + Invalid command line arguments, provide `` as a first argument + + **Action:** + + Review the command and provide `` as a first argument. + +### ZWEL0036E + + failed to initialize launcher context + + **Reason:** + + Failed to initialize launcher context. + + **Action:** + + :x: + +### ZWEL0037E + + max component number reached, ignoring the rest + + **Reason:** + + Maximal number of components reached, ignoring the rest. + + **Action:** + + Review the components defined in configuration (identified by message `ZWEL0023I`). ### ZWEL0038E @@ -87,11 +475,23 @@ The following error message codes may appear on Zowe Launcher SYSPRINT. Use the **Reason:** - Maximum retries reached for restarting component `. + Failed to restart the component ``, maximum number of retries reached. **Action:** - Check `` configuration and correct the maximum restart count via configuration attribute `restartIntervals` if needed, then restart the component by using z/OS MODIFY command `F ZWESLSTC,APPL=STOP()` + :x: + +### ZWEL0039E + + cannot start component %s - already running + + **Reason:** + + Cannot start the component `` because it is already running. + + **Action:** + + No action required. ### ZWEL0040E @@ -99,20 +499,318 @@ The following error message codes may appear on Zowe Launcher SYSPRINT. Use the **Reason:** - Failed to start component ``. + Failed to start the component ``. + + **Action:** + + Review the component defined in configuration (identified by message `ZWEL0023I`). + +### ZWEL0041E + + bad value supplied, command ignored + + **Reason:** + + Bad value for the command supplied, such command is ignored. + + **Action:** + + Review the command. + +### ZWEL0042E + + command not recognized + + **Reason:** + + Command not recognized. + + **Action:** + + Review the command. + +### ZWEL0043E + + failed to start console thread + + **Reason:** + + Failed to start the console thread. + + **Action:** + + :x: + +### ZWEL0044E + + failed to stop console thread + + **Reason:** + + Failed to stop the console thread. + + **Action:** + + :x: + +### ZWEL0049E + + failed to restart component %s + + **Reason:** + + Failed to restart the component ``. + + **Action:** + + :x: + +### ZWEL0050E + + cannot read output from comp %s(%d) - %s + + **Reason:** + + Cannot read the output from component `` (``) - `` + + **Action:** + + :x: + +### ZWEL0055E + + failed to create file for stdin(%s) - %s + + **Reason:** + + Failed to create the file for stdin(``) - . + + **Action:** + + :x: + +### ZWEL0056E + + failed to open file for stdin(%s) - %s + + **Reason:** + + Failed to open the file for stdin(``) - . + + **Action:** + + :x: + +### ZWEL0057E + + failed to create workspace dir '%s' + + **Reason:** + + Failed to create the workspace directory ``. + + **Action:** + + :x: + +### ZWEL0059E + + failed to get WORKSPACE_DIR dir + + **Reason:** + + Failed to get the WORKSPACE_DIR (`zowe.workspaceDirectory`) directory. **Action:** - Check `` configuration and correct if needed, then either 1) start the component manually by using z/OS MODIFY command `F ZWESLSTC,APPL=STOP()` or 2) restart the entire HA instance + :x: -### ZWEL0047E +### ZWEL0060E - failed to parse zowe.yaml - %s + WORKSPACE_DIR is empty string **Reason:** - Failed to parse Zowe configuration file. + The WORKSPACE_DIR (`zowe.workspaceDirectory`) is empty string. **Action:** - Validate the format of Zowe configuration file. It should be a valid YAML file following specifications defined in https://yaml.org/. \ No newline at end of file + :x: + +### ZWEL0062E + + failed to create dir '%s' - %s + + **Reason:** + + Failed to create the directory `` - ``. + + **Action:** + + :x: + +### ZWEL0064E + + failed to run command %s - %s + + **Reason:** + + Failed to run the command `` - ``. + + **Action:** + + :x: + +### ZWEL0065E + + error reading output from command '%s' - %s + + **Reason:** + + There is an error reading the output from command `` - `` + + **Action:** + + :x: + +### ZWEL0067E + + PARMLIB() entries must all have the same member name + + **Reason:** + + PARMLIB() entries must all have the same member name. + + **Action:** + + Review the member names are identical for all PARMLIB() entries. + +### ZWEL0068E + + PARMLIB() entries must have a member name + + **Reason:** + + PARMLIB() entries must have a member name. + + **Action:** + + Review the dataset name contains the member name in PARMLIB entry. + +### ZWEL0070E + + Configuration has validity exceptions: + + **Reason:** + + Configuration has validity exceptions. + + **Action:** + + Review the exceptions and correct the configuration. + +### ZWEL0071E + + Internal failure during validation, please contact support + + **Reason:** + + Internal failure during validation, please contact support. + + **Action:** + + Contact support. + +### ZWEL0072E + + Launcher could not load configurations + + **Reason:** + + Launcher could not load the configurations. + + **Action:** + + Review the configuration entries. + +### ZWEL0073E + + Launcher could not load schemas, status=%d + + **Reason:** + + Launcher could not load schemas, status=`` + + **Action:** + + Review the runtime directory + +### ZWEL0074E + + Log context was not created + + **Reason:** + + The logging context was not created. + + **Action:** + + Contact support. + + ## Zowe Launcher warning messages + + +### ZWEL0052W + + not all components started + + **Reason:** + + Not all components were started. + + **Action:** + + No action required. + +### ZWEL0053W + + not all components stopped gracefully + + **Reason:** + + Not all components were stopped gracefully. + + **Action:** + + No action required. + +### ZWEL0054W + + component %s not found + + **Reason:** + + The component `` was not found. + + **Action:** + + No action required. + **Reason:** + + Component ``(``) will be terminated using `SIGKILL`. + + **Action:** + + No action required. + +### ZWEL0066W + + command '%s' ended with code %d + + **Reason:** + + The command `` ended with return code ``. + + **Action:** + + No action required.