Viewing running agents

Depending on the version of HCL DevOps Test Virtualization Control Panel (Test Virtualization Control Panel) 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.

You can perform the following operations on the agents and on the engines running the agents:

View running agents
Define custom attributes and instance name of agents
Open the stub from the engine details section
Remove an agent
Stop the engine running on the agent

About this task

HCL DevOps Test Integrations and APIs Agent (Test Integrations and APIs Agent) engines run stubs that were published to Test Virtualization Control Panel. You must install a Test Integrations and APIs Agent engine on each system where you want to run stubs and there must be at least one Test Integrations and APIs Agent engine in an environment. Each Test Integrations and APIs Agent engine must register with an instance of Test Virtualization Control Panel so that the engine can accept requests to run stubs.

Procedure

Log in to Test Virtualization Control Panel.

The Test Virtualization Control Panel landing page is displayed.
To view all agents that are registered with the current Test Virtualization Control Panel instance, click the Infrastructure icon or navigation link.

The Infrastructure Dashboard is displayed. Any Test Integrations and APIs Agent or proxy registered with visible domains and that is currently running is displayed.

Expand the agent card to view details of the agent under different tabbed sections.

Table 1. Details of the agent in the Infrastructure Dashboard

Tab

Description

Details

Displays information about the following details:


Parameter	Description
Capabilities	Displays the configured capabilities of the agent.
Config Location	Displays the location where the Agent.config file resides.
Log File Location	Displays the location where the log file resides.
Version	Displays the version of the Test Virtualization Control Panel on which the agent is registered.
System	Displays the details of the system hosting the Test Virtualization Control Panel.
Ports	Displays the port number configured for communication between the agent and Test Virtualization Control Panel.
Agent Tags	The tags or attributes that are configured for the agent in the Agent.config file are displayed. The operating system of the computer that hosts Test Virtualization Control Panel is displayed. The tags that you configured for the domain are also displayed. You can customize the agent tags. For more information, see Defining custom tags or instance name for a running agent. Note: If you have added a tag for a scheduled test, the tag is displayed in the Details panel for a running agent and is not removed from the display when the agent is disconnected from Test Virtualization Control Panel. You can use the tags in filters as the tags are available in the system. The tag is not removed from the system until a system restart.

Engines

Displays the following information about the engines:

Domain, Environment, Identifier, Process ID, Memory Usage, Number of stubs are displayed in sequence, separated by commas in a parenthesis for each engine. You can hover over the item to view the hover message about the item. You can view these details without having to expand the panel for each engine.

Details about the engine when you expand the engine panel, as described in the following table:


Parameter	Description
Identifier	A unique value or name that identifies the instance of the engine running on the agent.
Domain	The domain under which the virtualized service is published to in Test Virtualization Control Panel.
Environment	The environment under which the virtualized service is published to in Test Virtualization Control Panel.
Project Location	Displays the location where the project run by the engines reside.
Log Location	Displays the location where the log file resides.
Process ID	Displays the operating system's unique process ID for the engine process running on the agent.
Memory Usage	Displays the memory used by the engine.
Stubs	Displays the name of the published stubs run on the engines. You can open the stub in the Environments dashboard by clicking the stubs listed.

Activity Log

Lists the log of the activities in a tabular view. Details displayed are about the date and time of the activity, the system running the agent, the log level set for the agent, and the message for the activity.

To view all Test Integrations and APIs Agents running for a specific environment or domain, you must use the Search icon to find the list of relevant agents.

Note: The Agent console output is not viewable in the Test Virtualization Control Panel. Therefore, you must view the console output of an agent on the system where it is running.

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

Defining custom tags or instance name for a running agent

The operating system upon which the agents run is attributed as a default tag on agents. You can define custom tags for a running agent or configure the instance name for an agent.

About this task

The Agent.config file is located at <agent_installation directory>\config.

Procedure

Modifying the Agent.config file

Insert the tags that you want to attribute to the agent in the <agentAttributes> section of the Agent.config file.
For example, when you want an agent to run stubs that are in a specific domain, you must define the tags in the Agent Tag field in the Details tab of the domain in Test Virtualization Control Panel. Then, you must enter the same tag as the attribute value in the <agentAttributes> section, as follows:
```
<agentAttributes>
         <attribute value="MyDomain" />
         <attribute value="" />
      </agentAttributes>
```
Where, MyDomain is the name you defined as the Agent Tag in the Domain details.
You must enter the values of different tags in separate value elements in the <agentAttributes> section.

Configuring the instance name

Configure an instance name for each Test Integrations and APIs Agent that is registered with Test Virtualization Control Panel by uncommenting and editing the identifier name setting in the configuration file of the agent and then restart the agent.

Assign a name to identify a specific agent when there are two or more agents of the same type registered with Test Virtualization Control Panel.

Modifying the start-stop-stub.xml file when you are using the Ant client

Specify a comma-separated list of attributes in the attributes property of the <startStub> task element.

The sample start-stop-stub.xml file that is available in the AntClient.zip tool package can be used to set the attributes property. Complete the following steps to set the property:
1. Open the start-stop-stub.xml file for editing and specify the comma-separated list of attributes against the attributes property.
2. 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".

Viewing the stub from the engines section

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.

Procedure

Log in to Test Virtualization Control Panel.

The Test Virtualization Control Panel landing page is displayed.
To view all agents that are registered with the current Test Virtualization Control Panel instance, click the Infrastructure icon or navigation link.

The Infrastructure dashboard is displayed. Any Test Integrations and APIs Agent or proxy registered with visible domains and that is currently running is displayed.
Expand the AGENT.
Expand the Engines tab.

Note: Details about the engine such as Domain, Environment, Identifier, Process ID, Memory Usage, Number of stubs are displayed in sequence, separated by commas in a parenthesis for each engine. You can hover over the item to view the details about the item. You can view these details without having to expand the panel for each engine.
Click the engine running the stub.
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 hostname of the machine that is running the agent or proxy.

Removing an agent

You can remove an agent when Test Virtualization is disconnected that remain in the Disconnected state in the Infrastructure dashboard. You must remove the agents manually as they are not removed automatically.

Procedure

Log in to Test Virtualization Control Panel.

The Test Virtualization Control Panel landing page is displayed.
To view all agents that are registered with the current Test Virtualization Control Panel instance, click the Infrastructure icon or navigation link.

The Infrastructure dashboard is displayed. Any Test Integrations and APIs Agent or proxy registered with visible domains and that is currently running is displayed.
Remove the agents 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.
Note: If any Test Virtualization reconnects without changing its configuration (even after a restart), its status is changed to Connected. That is, a new row is not created on the Infrastructure dashboard and the old row on the Infrastructure dashboard is reused. However, if the configuration of any Test Virtualization was changed before restarting, a new row is created on the Infrastructure dashboard and the old row is also visible on the Infrastructure dashboard with the status of Disconnected.

Stopping an engine running on an agent

You can stop the engine running on an agent from the Infrastructure dashboard when you want to terminate a running test that is using the engine.

Procedure

Log in to Test Virtualization Control Panel.

The Test Virtualization Control Panel landing page is displayed.
To view all agents that are registered with the current Test Virtualization Control Panel instance, click the Infrastructure icon or navigation link on the Test Virtualization Control Panel landing page.

The Infrastructure dashboard is displayed. Any Test Integrations and APIs Agent or proxy registered with visible domains and that is currently running is displayed.
Expand the agent card to display all the attributes defined for the registered agent under the Details section.
Click the Engines section.
Click the engine name to expand the Engines section.
Click Stop.

Note: You must stop all stubs that are running on the engine to prevent the stubs from restarting after the engine is stopped by selecting the Stop the stubs associated with this engine? check box.
Click Stop to stop the engine and the stubs running on the engine.