Adding an API agent to a project

Edit online

You must add the registered API agents to your projects before you select them as the location to run the virtual service resources that are in your project on IBM® DevOps Test Hub (Test Hub).

Before you begin

You must have completed the following tasks:
  • Ensured that you are assigned a role as a Project Owner or Tester in the project. See Managing access to the server projects.
  • Installed the agent by using your offline user token, which makes you the owner of the agent, or you are assigned the role of a Team Space Owner.

About this task

An owner of an API agent or team space owner can add or remove an API agent from the project. However, any member of the project with the permission to run the virtual services can initiate the run of the virtual service resources on API agents that are added to the project.

Procedure

  1. Log in to Test Hub.
    The Projects page of the initial team space is displayed.
  2. Open your project, and then click Infrastructure > Agents and Intercepts.

    The Agents and Intercepts page is displayed.

  3. Click Add > Add API agent.
    The API agents that you configured with your user token are displayed.
    Note: You can add the API agents that you own. You can add any number of API agents to your project.
  4. Select the API agents that you want to use in the project, and then click Add.

    The API agents that you added to the project are displayed.

  5. 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 added remote API agents to your project and viewed the details and capabilities of the API agent that is displayed for each agent that you own.

What to do next

Configure a run of the virtual service resources that are in your project and select an API agent as the location to run the virtual service. See Configuring a run of a virtual service.