Configuring agents and proxies to use security tokens

If you are an HCL Quality Server system administrator and you want to implement domain-level security, you can assign security tokens to agents and proxies and thus filter which agents and proxies can connect to HCL Quality Server.

About this task

After enabling domain-level security, agents and proxies cannot register with HCL Quality Server unless you assign security tokens to them.

Assigning a security token to each HCL OneTest™ API Agent and proxy also enables you to filter which agents and proxies can connect to HCL Quality Server.

Note: By default, domain-level security is not enabled in HCL Quality Server. In addition, only HCL OneTest™ API, agents and proxies included in HCL Quality Server can be configured to use security tokens for domain-level security.

You must create user accounts and create and assign security tokens for the required agents and proxies before you can configure the agents and proxies to use them.

If an agent or proxy is configured to use a security token but domain-level security is not enabled, the agent or proxy will register with HCL Quality Server. This enables you to configure all required agents and proxies to use security tokens before you enable domain-level security.

Procedure

To configure an HCL OneTest™ API Agent to use a security token, complete the following tasks:
1. Using a text editor, open the Agent.config file, which is located in <Agent installation directory>\config.
2. Modify the HCL Quality Server URL details to include the relevant security token:
```
<rtcpURL value=https://<Host name or IP address>:5443/RTCP security-token="<Copy and paste security token from list table on the Security tab on the Administration page of HCL Quality Server>"/>
```
3. Save and close the Agent.config file.
4. Restart the Agent.exe file, which is located in <Agent installation directory>.
  
  Alternatively, if modifying the HCL OneTest™ API Agent on Microsoft™ Windows™, you can restart the IBM RIT Agent Windows™ service.
To configure a HCL OneTest™ API proxy or the Java™ virtualization agent to use a security token, complete the following tasks:
1. Using a text editor, open the registration.xml file, which is located in <HCL Quality Server installation directory>\<Proxy name>.
  
  Note: For the Java™ virtualization agent, navigate to <HCL Quality Server installation directory>\Java™ virtualization\<Agent name>.
2. Modify the server details to include the relevant security token:
```
<server base-URL value=https://<Host name or IP address>:5443/RTCP security-token="<Copy and paste security token from list table on the Security tab on the Administration page of HCL Quality Server>"/>
```
3. Save and close the registration.xml file.
4. Restart the HCL OneTest™ API proxy or the Java™ virtualization agent.
  
  If modifying the HTTP proxy on Microsoft™ Windows™, you must restart the IBM RIT HTTP Proxy Windows™ service.

Results

The specified agent or proxy registers with HCL Quality Server. Verify this from the Activities tab of the expanded agent card in the Infrastructure Dashboard of HCL Quality Server.