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 completed the following tasks:

About this task

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

Procedure

  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 is available in the HCL OneTest APIinstallation directory as /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.
    • If you used a custom installation location, you must change the agent.service file, otherwise the agent does not work correctly.

    The following steps describe how to run the systemd script:

    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 systemd documentation

  2. Optional: If required, you can modify the Agent executable default settings to specify a different port by using the -p <port> argument or override the location of the config file by using the -c <config_file> argument.
    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, from the Agent installation directory, you can run the Agent at a non-default port (4492) by using the following command:

    ./Agent -p 4492

    Or if you have a customized config file, for example, Customized_Agent.config in the Agent installation directory, you can start the Agent by using the following command:

    ./Agent -c ./config/Customized_Agent.config

  3. Optional: If you are using floating licenses and the init schell script, insert the following lines that match your license server at the start of the script:

    LM_LICENSE_FILE=27000@serverhostnameexport LM_LICENSE_FILE

  4. Optional: If you are using floating licenses and the systemd script, you can add the following line to agent.service in the [Service] section:

    ENVIRONMENT="LM_LICENSE_FILE=27000@serverhostname"