Analyzing return codes for agent installation, upgrade, restore, and uninstallation

Return codes that you can receive when you are installing, upgrading, restoring, or uninstalling agents. To analyze them and take corrective actions, run the following steps:

On Windows operating systems

1. Display the operation completion return code, by using the following command:

   echo %ERRORLEVEL%

2. Analyze the following table to verify how the operation completed:

   Table 1. Windows operating system agent return codes

   Error Code	Description	User action
   0	Success: The operation completed successfully without any warnings or errors.	None.
   1	Generic failure	Check the messages that are displayed on the screen by the script. Correct the error and rerun the operation. If the error persists, contact Support.
   2	The installation cannot create the HCL Workload Automation user or assign the correct permission to it.	Verify the operating system policies and configuration. Verify the input values. If necessary, create the user manually before you run the installation.
   3	The password is not correct or the installation cannot verify it.	Verify the operating system policies and configuration. Verify the input values.
   4	The HCL Workload Automation installation directory is not empty. You specified as installation folder a directory that exists.	Empty it or specify a different directory.
   5	An error occurred checking the HCL Workload Automation prerequisites on the workstation.	See the System Requirements Document at https://workloadautomation.hcldoc.com/help/topic/com.hcl.wa.doc_9.4/distrDDguides.html.
   6	The HCL Workload Automation registry is corrupted.	Use the recovInstReg option to recover the registry. Then, rerun the operation.
   7	The upgrade or restore operation cannot retrieve the information from the configuration files.	Check that the previous installation and the localopts, the globalopts, the ita.ini, and the JobManager.ini files are not corrupted. Correct the errors and try again the operation.
   8	The upgrade, restore, or uninstallation cannot proceed because there are jobs that are running.	Stop the jobs that are running or wait for these jobs to complete. Restart the operation.
   9	The upgrade, restore, or uninstallation cannot proceed because there are files that are locked.	Stop all the processes that are running and close all the activities that can block the installation path. Restart the operation.
   10	The upgrade, restore, or uninstallation cannot proceed because there are command lines opened.	Close the command lines. Restart the operation.

On UNIX and Linux operating systems:

1. Display the installation completion return code, by using the following command:

   echo $?

2. Analyze the following table to verify how the installation completed:

   Table 2. UNIX or Linux operating system agent return codes

   Error Code	Description	User action
   0	Success: The installation completed successfully without any warnings or errors.	None.
   1	Generic failure.	Check the messages that are displayed on the video by the script. Correct the error and rerun the operation. If the error persists, contact Support.
   2	The installation did not find the HCL Workload Automation user or its home directory. The HCL Workload Automation user that you specified either does not exist or does not have an associated home directory.	Verify the operating system definition of the HCL Workload Automation user.
   3	Not applicable
   4	The HCL Workload Automation installation directory is not empty. You specified as installation folder a directory that exists.	Empty it or specify a different directory.
   5	An error occurred checking the HCL Workload Automation prerequisites on the workstation.	See the System Requirements Document at https://workloadautomation.hcldoc.com/help/topic/com.hcl.wa.doc_9.4/distrDDguides.html.
   6	The HCL Workload Automation registry is corrupted.	Use the recovInstReg option to recover the registry. Then, rerun the operation.
   7	The upgrade or restore operation cannot retrieve the information from the configuration files.	Check that the previous installation and the localopts, the globalopts, the ita.ini, and the JobManager.ini files are not corrupted. Correct the errors and try again the operation.
   8	The upgrade, restore, or uninstallation cannot proceed because there are jobs that are running.	Stop the jobs that are running or wait for these jobs to complete. Restart the operation.
   9	The upgrade, restore, or uninstallation cannot proceed because there are files that are locked.	Stop all the processes that are running and close all the activities that can block the installation path. Restart the operation.
   10	The upgrade, restore, or uninstallation cannot proceed because there are command lines opened.	Close the command lines. Restart the operation.