Agent installation procedure

Before you begin

  1. Before you start to install, upgrade, or uninstall, verify that the user that runs the installation process has the following authorization requirements:
    Windows™ operating system
    If you set the Windows User Account Control (UAC), your login account must be a member of the Windows™ Administrators group or domain administrators with the rights Act as Part of the Operating System.

    If you set the Windows User Account Control (UAC) on the workstation, you must run the installation as administrator.

    UNIX™ and Linux™ operating systems

    To install a fault-tolerant agent, the user must have root access.

    To install a dynamic agent, the user is not required to have root access.
    • If the installer has root privileges, the uname keyword can be omitted if the username value is meant to be root, or can be set to a username value other than root.
    • If the installer is not the root user, this has some implications on the use of the uname keyword of the twsinst command, which becomes an optional parameter, and on its effect on the username of the dynamic agent. That is:
      • The uname keyword can be omitted, but username is automatically set to the login name of the installer. If the installer specifies a uname with a different username value, an error message is returned.
      • As a consequence, the agent can run jobs uniquely with the user name of that installer.
      • Future upgrades, modifications, and removal of the agent can be made exclusively with the same login used for installation. To keep track of the login name used by the installer, at installation time the read-only InstallationLoginUser parameter is recorded with the login name in the JobManager.ini configuration file in the agent.

      Also, if you install the agent as non-root on UNIX workstations, when running conman and composer commands it is mandatory to set the environment first, by using the tws_env script as described in Setting the environment variables.

  2. Ensure that you downloaded the HCL Workload Automation agent eImage (for details, see the Download Document at Product Requirements).
  3. Ensure that you have enough temporary space before you start the installation process.

About this task

You can install a fault-tolerant or dynamic agent in a distributed or an end-to-end environment.

To install an HCL Workload Automation agent, perform the following steps:
On Windows™ operating systems:
  1. Download the agent eImage. For more information, see Product Requirements.
  2. Log in as administrator on the workstation where you want to install the product.
  3. From the image_directory\TWS\operating_system directory, run twsinst by using the following syntax:
    cscript twsinst.vbs -new -uname username -password user_password -acceptlicense yes
    For a description of the syntax parameters and a complete list of them, see Agent installation parameters - twsinst script.
    Note: twsinst for Windows™ is a Visual Basic Script (VBS) that you can run in CScript and WScript mode.

    The HCL Workload Automation user is automatically created. The software is installed by default in the HCL Workload Automation installation directory. The default value is %ProgramFiles%\HCL\TWA.

    If you enabled the Security Warning, a dialog box is displayed during the installation. In this case answer Run to continue.

On UNIX™ and Linux™ operating systems:
  1. Download the agent eImage. For more information about eImages, see Downloading installation images on your workstation or the Product Requirements.
  2. If you plan to login as root on the workstation where you will install the agent, create the HCL Workload Automation user. The software is installed by default in the user's home directory, referred to as /installation_dir/TWS.
    User:
    TWS_user
    Home:
    /installation_dir/TWS (for example: /home/user1/TWS where user1 is the name of HCL Workload Automation user). Ensure this directory has 755 permission.
    If you plan to log in as a non-root user (available only for dynamic agents), your login will become by default the only possible user of the agent. You do not need to create another HCL Workload Automation user, but make sure that you have a home directory (where the agent will be installed), and that it has 755 permission.
    Important: If you use the -su non-root username command in the shell where you are about to run twsinst, make sure that $HOME is set on your home directory as a non-root user (use echo $HOME to verify that the value returned corresponds to your home directory).
  3. Log in on the workstation where you want to install the product.
  4. From the image_directory/TWS/operating_system directory, run twsinst by using the following syntax: 
    ./twsinst -new -uname username -acceptlicense yes
    For a description of the syntax parameters, see Agent installation parameters - twsinst script
If the installation fails, to understand the cause of the error see Analyzing return codes for agent installation, upgrade, restore, and uninstallation.
After a successful installation, perform one of the following configuration tasks, depending on the type of agent you installed:
On Windows™ operating systems:
Show command usage and version
cscript twsinst.vbs -u | -v
Install a new instance
cscript twsinst.vbs -new 
   -acceptlicense yes|no
   [-reset_perm]
   [-uname username]
   [-data_dir data_directory]
   [-agent dynamic|fta|both|zcentric]
   [-addjruntime true|false]
   [-inst_dir install_dir]
   [-lang lang_id]
   [-skipcheckprereq]
   [-skip_usercheck]
   [-work_dir working_dir]
   [-agentid id]
   [-company company_name] 
   [-master master_cpu_name]
   [-port port_number]
   [-netmansslport port_number]
   [-thiscpu workstation]
   [-encryptionpassword password]
   [-useencryption boolean]
   [-gateway local|remote|none]
   [-gwid gateway_id]
   [-gweifport gateway_eif_port]
   [-displayname agentname]
   [-hostname host_name]
   [-jmport port_number]
   [-jmportssl true|false]
   [-tdwbhostname host_name]
   [-tdwbport tdwbport_number]
   [-create_link]
   [-sslpassword ssl_password]
   [-sslkeysfolder ssl_folder]
   [-jwt true | false]
   [-wauser wauser -wapassword wapassword] | [-apikey apikey]
On UNIX™ and Linux™ operating systems
Show command usage and version
./twsinst -u | -v
Install a new instance
./twsinst -new -uname username
   -acceptlicense yes|no
   [-reset_perm]
   [-uname username]
   [-data_dir data_directory]
   [-agent dynamic|fta|both|zcentric]
   [-addjruntime true|false]
   [-inst_dir install_dir]
   [-lang lang_id]
   [-skipcheckprereq]
   [-skip_usercheck]
   [-work_dir working_dir]
   [-agentid id]
   [-company company_name] 
   [-master master_cpu_name]
   [-port port_number]
   [-netmansslport port_number]
   [-thiscpu workstation]
   [-encryptionpassword password]
   [-useencryption boolean]
   [-gateway local|remote|none]
   [-gwid gateway_id]
   [-gweifport gateway_eif_port]
   [-displayname agentname]
   [-hostname host_name]
   [-jmport port_number]
   [-jmportssl true|false]
   [-tdwbhostname host_name]
   [-tdwbport tdwbport_number]
   [-create_link]
   [-sslpassword ssl_password]
   [-sslkeysfolder ssl_folder]
   [-jwt true | false]
   [-wauser wauser -wapassword wapassword] | [-apikey apikey]