Starting and stopping the HTTP/TCP proxy

To route and record HTTP(S) and TCP traffic with HCL Quality Server and HCL OneTest™ API, you must start the HTTP/TCP proxy. If the proxy is installed as a Windows service, you can configure it for an automatic start on start of the system or for a manual start on demand.

Before you begin

Ensure that you have root permissions on non-Windows systems.

About this task

On Windows™ systems, the HTTP/TCP proxy is, by default, configured to be installed as a service, and for automatic startup on boot. If you cleared these selections during the installation, then use the Modify option of IBM® Installation Manager to update the installation.

Note: If you use the SSL mode to connect to the HTTP/TCP proxy and use custom signed certificates to authenticate this connection, you must ensure to use the certificate that is designated as a Certificate Authority (CA) entity and has the attribute set as BasicConstraint CA=true. If you attempt to start the proxy with any certificate that is not designated as a Certificate Authority, then the HTTP/TCP proxy shuts down and logs an error.

Procedure

Start and stop the HTTP/TCP proxy from a Windows™ command line:

Start the proxy from the command line by using a start-up script in C:\Program Files\IBM\RationalTestControlPanel\httptcp. Run the init shell script named startup.bat file from the default location.
Stop the proxy. Close the Terminal window.

Start and stop the HTTT/TCP proxy if the proxy is installed as a Windows™ service:

Start the service from the Start menu. Click (All) Programs > HCL Quality Server > Start HTTP Proxy.

Note: By default, the proxy is configured to start automatically on boot.
Stop the service from the Start menu. Click (All) Programs > HCL Quality Server > Stop HTTP Proxy.

Tip: You can also open the Services window in Control Panel, right-click HCL OneTest™ API HTTP Proxy > Stop.
Follow these steps to modify the Windows™ service from automatic startup to manual startup:
1. Go to Control Panel, and select Administrative Tools > Services.
2. Right-click HCL OneTest™ API HTTP Proxy Windows service.
3. Click Properties and change the startup type from Automatic to Manual. Click OK.
  Tips:
  - You can also use this Control Panel option to start, restart, or stop the service.
  - You can also run editProxyService.bat from an Administrator command prompt and change the startup type, start, restart, or stop the service on the General page.

Start or stop the HTTP/TCP proxy on non-Windows systems. You can use either the init shell script or the systemd script to start or stop the HTTP/TCP proxy. You can find the scripts in the httptcp directory of your HCL Quality Server installation.

Start the proxy on non-Windows systems. Do one of the following steps:
- If you are using the init shell script, run the startup.sh file from the default location or where you installed HCL Quality Server.
- If you are using the systemd script, follow these steps:
  1. Install the file and set permissions:
    sudo cp proxy.service /etc/systemd/system/proxy.service sudo chmod 644 /etc/systemd/system/proxy.service
  2. Start the service:
    sudo systemctl start proxy
    For more information about systemd, see the systemd documentation.
Stop the proxy on non-Windows systems. Do one of the following steps:
- If you are using the init shell script, use ^C in the shell where you ran startup.sh.
- If you are using the systemd script, use sudo systemctl stop proxy.

Configure automatic start on boot on non-Windows systems:

Follow these steps to configure automatic start on boot for the init shell script:
1. Add the startup.sh script to the path /etc/init.d.
2. Create symbolic links to the script in the run-level folders, for example, /etc/rc3.d.
Follow these steps to configure automatic start on boot for the systemd script:
1. Enable automatic startup:
```
sudo systemctl enable proxy
```
2. Check the status:
```
sudo systemctl status proxy 
```