Installing agents from the command line
Installing an agent from the command line involves running a batch file or shell script and specifying information about how the agent connects to the server or agent relay.
Before you begin
- For production environments, create a user account that has the required privileges for the
installation.
If the user account does ot have the necessary privileges, the installation fails.
For AIX, HP, Solaris, Windows and Mac OS, the user account must have access to all working directories used in the process the agent runs.
For Linux and Unix OS, the user account myust have root privileges in order to issue the su or sudo command when installing.
For z/OS environments, review the security requirements for the IBM z/OS computers.
- Make sure that your networks and firewalls allow communication on the required ports. See Firewall and communication configuration.
-
If the target computer has an IBM® JRE or Java™ developer kit, update to a supported version of the IBM® JRE or Java™ developer kit.
- Set the JAVA_HOME system variable to the location of the JRE or JDK that you are using.
- Ensure that there is no limit on the maximum memory size and virtual memory size.
For example, on most Linux™ systems, you can run the
ulimit -m
andulimit -v
commands and ensure that both return the valueunlimited
. To find out how to remove the limit on the maximum memory size and virtual memory size, see the documentation for the operating system.
About this task
Agents can also be installed directly from the HCL Launch web application, see Installing agents remotely.
For simple evaluations, the administrative user can run the agent on the computer where the server is located. Because agent workloads can be resource-intensive, for production environments, do not install agents on the computer where the HCL Launch server is located. If you plan to run deployments on several target servers, install a separate agent on each one. If, for example, your testing environment consists of three servers, install an agent on each one. Follow the same procedure for each environment the application uses.
Each agent requires the appropriate rights to communicate with the HCL Launch server.
At a minimum, each agent must have these permissions:
- Open a TCP connection. A JMS agent uses a TCP connection to communicate with the server's JMS port, and a Web agent uses one for its WebSocket connection.
- Open a HTTP(S) connection. The agent must be able to connect to the HCL Launch user interface to download artifacts from the CodeStation repository.
- Access the file system. Many agents need read/write permissions to items on the file system.
If the agent communicates with HCL Launch by using an agent relay, you can install the agent from the command line.
Procedure
-
Download and extract the agent installer to the computer to install the agent on. Complete one
of the following steps:
- To download the installer, log in to the server and click the Help
icon
at the upper right of any page on the server, and click Tools. Then, click HCL Launch Agent, and download and extract the file.
- To find the installer on the server with the command line, go to the following location, and
copy the file to the target computer:
installation_folder/opt/tomcat/webapps/ROOT/tools/ucd-agent.zipNote: If you are installing the agent on IBM® z/OS® by extracting files to the UNIX™ file system, you must convert the character encoding for several text-type files in the installation package to IBM®-1047 encoding. If you are installing the agent by using SMP/E, you do not have to convert the character encoding. Move the installation files to the z/OS® computer, and then extract the files. If the unzip program is not installed on the z/OS® computer, use the jar command to extract the files. For instance, type the following text on the command line:
Run the convertFilesForZos.sh script to convert the character encoding of the relevant files to IBM®-1047 encoding. After you convert the files, continue with installation.JAVA_HOME/bin/jar xvf ucd-agent.zip
If you used the jar command to extract files, add execute permission to convertFilesForZos.sh script first.
Note: If you are installing the agent on IBM® i, you must run the commands through the IBM® Portable Application Solutions Environment for i (PASE for i) shell. Move the installation files to the i system, and then extract the files. Run the ibmi-compatability-fix.sh script to update the installer to use the PASE for i shell. After you run the script, continue with installation.
- To download the installer, log in to the server and click the Help
icon
- After you download and expand the installation package, open the installer directory.
-
From this directory, run the install-agent.bat command
(Windows™) or install-agent.sh (UNIX™, Linux™, Mac OS™, or IBM® z/OS®).
Note: If you install the agent as a Windows™ service, the user account must have the following privileges:The HCL Launch agent installer is displayed and prompts you to provide the following information. You can accept the default values (displayed in brackets) by pressing Enter. If two options are given, such as
- SE_INCREASE_QUOTA_NAME "Adjust memory quotas for a process"
- SE_ASSIGNPRIMARYTOKEN_NAME "Replace a process level token"
- SE_INTERACTIVE_LOGON_NAME "Logon locally"
Y/n
, the uppercase option is the default value. Depending on the options that you select, different prompts display. -
When you install on IBM® z/OS® by using downloaded .zip file, submit a job to load the agent data
sets.
Locate the job JCL at agent install dir/mvs/BUZEXPD. The JCL, except the job parameter, has already been customized based on your input. Edit and submit the job to load the agent data sets. For example, use the following command in OMVS to edit or submit the JCL:
oedit agent install dir/mvs/BUZEXPD submit agent install dir/mvs/BUZEXPD