Running HCL OneTest API Agent on Unix-like systems

On Unix-like systems, you can start HCL OneTest™ API Agent by running the Agent executable in the root of the HCL OneTest API Agent installation directory (for example, /opt/HCL/HCLProducts/Agent/).

Before you begin

You must have met the following requirements:
  • Read and understood licensing for HCL OneTest API Agent. See the related links at the end of this page.
  • Acquired the necessary permissions to write to the various files and folders in the installation directory.

About this task

You can use either an init shell script or a systemd script to automatically start the agent.


  1. Edit the configurations for server start-up and shut-down scripts. You can work with your system administrator if required to edit the scripts.
    Note: A sample Agent start-up script (init shell script or systemd script) is available in the directory, <HCL OneTest API installed location>\examples\ExampleInitScripts that you can include into the system start-up script to ensure that the Agent is always started when the server starts. The temporary files are stored in /var/tmp folder if the installation folder is not specified at the time of installing.

    The following steps describe how to run the systemd script from an Administrator command prompt.

    1. Install the file and set permissions:
      sudo cp agent.service /etc/systemd/system/agent.service
      sudo chmod 644 /etc/systemd/system/agent.service
    2. Start the service:
      sudo systemctl start agent
    3. Enable automatic startup:
      sudo systemctl enable agent
    4. Check the status:
      sudo systemctl status agent

      For more information about systemd, see the systemd documentation.

  2. Optional: If required, you can modify the Agent executable to specify a different port by using the -p <port> argument or override the location of the config file.
    Note: The Agent executable runs the agent by using the default port (4476) and points to the default Agent configuration file (config/Agent.config).

    For example, change the port in the configuration file by using the following command:

    ./Agent -p 4492 -c ./config/Agent.config