Viewing API agents that are registered with HCL OneTest™ Server

After you install the remote HCL OneTest™ API agents and configure them with your offline user token, HCL OneTest™ API agents register with HCL OneTest™ Server, and then you can view the registered API agents on the Agents and Intercepts page.

Before you begin

You must have completed the following tasks:

Procedure

  1. Log in to HCL OneTest™ Server.

    The team space that contains your project is displayed.

  2. Click Infrastructure > Agents and Intercepts in the navigation pane.

    The Agents and Intercepts page is displayed.

    You can view the API agents, Dockers, intercepts, Kubernetes clusters, or performance agents that are registered with HCL OneTest™ Server.

  3. You can view the API agents that you own in any of the following ways:
    • Search for the API agent by entering the name of the API agent in the Search field.
      Note: You can enter either the full name or any text that is in the name. The search is enabled for case-sensitive text that you can enter.
    • Sort the Type column to sort the items and display the API agents in the rows at the top of the table.
    • Sort the Agents column and identify the API agents by their names or by their owners.
  4. Perform the following steps to view the details and capabilities of the API agents:
    1. Expand the API agent to view the details panel.
      You can find the following details of the API agent that is displayed:
      Parameter Description
      Agent ID The ID of the installed API agent.
      Identifier The unique identifier of the installed API agent that is configured in the Agent.config file for the API agent.
      Hostname The hostname of the computer on which the API agent is installed.
      Version The version of the installed API agent.
      Operating system The operating system of the computer on which the API agent is installed.
      Configuration location The path to the location of the Agent.config file on the computer where the API agent is installed.
      Tags The agent attributes or tags that exist in the Agent.config file.
    2. Expand the capabilities panel to view the system capabilities.
      You can find the following capabilities of the API agent displayed:
      Capabilities Description
      System capabilities The capabilities of the API agent.
    3. Check for the status of the API agent from the Status column.

Results

You have viewed the registered API agents from the Agents and Intercepts page.

What to do next

You can add the API agents that you own to your project. See Adding an API agent to a project.