Viewing running agents

Depending on the version of HCL Quality Server that you are using, you have different options to view agents that are currently running. You can view the agents and the routing or recording rules if the security settings are enabled for you to view them.

About this task

HCL OneTest™ API Agent engines execute stubs that have been published to HCL Quality Server. A HCL OneTest API Agent engine must be installed on each computer where you want to run stubs and there must be at least one HCL OneTest API Agent engine in an environment. Each HCL OneTest API Agent engine must register with a HCL Quality Server instance so that it can accept requests to run stubs.


  1. Log in to HCL Quality Server.

    The application window is displayed.

  2. To view all agents that are registered with the current HCL Quality Server instance, complete the following tasks:
    1. Click the Infrastructure icon or navigation link.

      The Infrastructure dashboard is displayed. Any HCL OneTest API Agents or proxies registered with visible domains and that are currently running are displayed.

      You can by expanding the card, view the details such as identity, domain and environment, current status, recipient, for each of the agents or proxies. You can also find other details such as capabilities, software version number, configuration file location, system, log file location, ports, and attributes under the Details section for each agent.

    2. Expand the agent or proxy card to display all the attributes defined for the registered agents or proxies under the Details section.
      The operating system upon which the agents run is the only attribute that is available by default. You can define custom attributes in the following ways:
      • Insert attributes in the <agentAttributes> section of the Agent.config file located in <HCL OneTest API Agent installation directory>\config.
      • If you are using the Ant client, then you can specify a comma-separated list of attributes in the "attributes" property of the <startStub> task element. If you are using the sample start-stop-stub.xml file available in the tool package, you can set the property in either of the following ways:
        • Open the start-stop-stub.xml file for editing and specify the comma-separated list of attributes against the "attributes" property.
        • On the Ant command line, run the following command: ant -f start-stop-stub.xml -Dattributes=<comma-separated list of attributes>. For example, ant -f start-stop-stub.xml -Dattributes="Windows,My Attribute".
        Note: Starting in version 9.1.1, the Ant Client file was renamed to from
    3. You can open the running stub in the Environments dashboard when you are viewing agents in the Infrastructure dashboard and you want to perform operations on the running stub containing the agent without navigating to the Environments dashboard and looking up the stub. You must complete the following steps to go to the stub from the Infrastructure dashboard:
      1. Expand the AGENT.
      2. Expand the Engines tab.
      3. Click the engine running the stub.
      4. Click the stub listed in the Stubs field.
      The action displays the Environments Dashboard with the selected stub in focus.
      Note: The Identity column shows the Identifier for agents and proxies, that was configured in the agent or proxy configuration file. If not configured, the Identity column displays the host name of the machine that is running the agent or proxy.
    4. You can remove an agent when HCL OneTest Virtualization agents are disconnected, that remain in the Disconnected state in the Infrastructure dashboard. You can remove them individually by using the Delete icon displayed for a disconnected agent on the Infrastructure dashboard. In contrast, HTTP, TCP, and other proxy agents remove themselves from the Infrastructure dashboard automatically after a minute of being in the Disconnected state.
    5. If any HCL OneTest Virtualization agent reconnects without changing its configuration (even after a restart), its status will be changed to Connected. That is, a new row will not be created on the Infrastructure dashboard and the old row on the Infrastructure dashboard will be reused. However, if the configuration of any HCL OneTest Virtualization, agent has been changed before restarting, a new row will be created on the Infrastructure dashboard and the old row will remain visible on the Infrastructure dashboard with the status of Disconnected.
    6. Configure an instance name for each HCL OneTest API Agent that is registered with HCL Quality Server. Assign a name to identify a specific agent when there are two or more agents of the same type registered with HCL Quality Server. Configure an instance name by uncommenting and editing the identifier name setting in the configuration file of the agent and then restart the agent.
    To view all HCL OneTest API Agents running for a specific environment or domain, you must use the Search icon to narrow the list of relevant agents.
    Note: The Agent console output is not viewable in the HCL Quality Server. Therefore, you must view the console output of an agent on the computer where it is running.

    To view details about any routing rules defined for the agent, see Viewing recording or routing rules.