How to Upgrade High-Volume Agent

First, download a new version of HVA from the Downloads page of your Fivetran dashboard. Then, follow the instructions below based on your operating system.

Upgrading HVA on Linux

Expand for instructions

This section describes the requirements and step-by-step instructions for upgrading HVA on Linux.

Requirements

HVA installation file
Before upgrading HVA, it is recommended to take a full backup of theHVR_HOME directory.

Upgrade steps

Pause the connector from the Fivetran dashboard. On the connector dashboard, set the connector status toggle to PAUSED, ensuring that a sync is not taking place.
Stop the Agent Listener service:
- If you configured the agent using agentListener.service, stop the service.
```
sudo systemctl stop agentListener.service
```
- If you configured the agent to run as a daemon process, stop the service using command hvragentlistener.
```
hvragentlistener -k <agent_port_number>
```
Install the new version of HVA; uncompress the HVA installation file into the HVR_HOME directory.
```
cd $HVR_HOME
tar -zxzf <hva_installation_file>.tar.gz
```
Start the Agent Listener service:
- If you configured the agent using agentListener.service, start the service.
```
sudo systemctl start agentListener.service
```
- If you configured the agent to run as a daemon process, start the service using command hvragentlistener.
```
hvragentlistener -d <agent_port_number>
```

Upgrading HVA on Windows

Expand for instructions

This section describes the requirements and step-by-step instructions for upgrading HVA on Windows.

Requirements

HVA installation file
Before upgrading HVA, it is recommended to take a full backup of the HVR_HOME directory.

Upgrade steps

Pause the connector from the Fivetran dashboard. On the connector dashboard, set the connector status toggle to PAUSED, ensuring that a sync is not taking place.
Stop the Agent Listener service (refer to Microsoft Windows documentation for steps to configure services).
Install the new version of the agent using either of the following methods:
Install HVA on Windows using EXE file
Perform the following steps as the user that runs the HVA. We recommend running the HVA as an Administrator user or a user that has permissions to access the .ldf and .mdf files generated by your SQL Server database.
NOTE: The HVA installation file for Windows is available in the .exe and .zip formats. The compressed file (.zip) distribution is normally used as an alternative for the Windows executable based (.exe) distribution. The steps to install the HVA are also different for both formats.
1. Run the downloaded .exe file (for example, hvr-6.1.0_10-hub_and_agent-windows-x64-64bit_ga_patch-setup.exe).
2. In the setup wizard dialog, click Next.
3. Read the License Agreement, select I accept the agreement and then click Next.
4. Specify the HVA installation directories and click Next.
5. Click Next to create a program folder for the HVA.
6. Select High-Volume Agent (HVA) and click Next.
7. Enter a value for Agent Listener Port and click Next.
8. Select the user account to run the HVA service.
  - If you select Specified user, enter the values for User, Password, Confirm Password and click Next.
    NOTE: For user with Windows authentication (if applicable), specify your Active Directory domain and username in the format <domain>\<username>.
  - If you select Local System account, click Next.
9. Select Add HVR_HOME, HVR_CONFIG, and HVR_TMP (if required) and click Next.
  This is to set the environment variables HVR_HOME, HVR_CONFIG, and HVR_TMP in your operating system. These variables point to the corresponding directories created in step 4 above.
10. Click Next to initiate the installation.
11. Click Finish to start the HVA service.
  Once the installation is complete, the HVA and all required components are installed into the $HVR_HOME directory (C:\hvr\hvr_home).
Install HVA on Windows using ZIP file
Uncompress (unzip) the HVA installation file into the HVR_HOME directory.
Start the Agent Listener service (refer to Microsoft Windows documentation for steps to configure services).

Upgrading HVA on Unix

Expand for instructions

This section describes the requirements and step-by-step instructions for upgrading HVA on Unix (Solaris, AIX, HP-UX).

Requirements

HVA installation file
Before upgrading HVA, it is recommended to take a full backup of the HVR_HOME directory.

Upgrade steps

Pause the connector from the Fivetran dashboard. On the connector dashboard, set the connector status toggle to PAUSED, ensuring that a sync is not taking place.
Stop the Agent Listener service:
- If you configured the agent using inetd, stop the inetd service (refer to the OS instructions).
NOTE: If you are on Solaris and used Service Management Facility (SMF), run the following command to refresh the service:
```
svcadm refresh inetd
```
- If you configured the agent to run as a daemon process, stop the service using command hvragentlistener.
```
hvragentlistener -k <agent_port_number>
```
Install the new version of HVA; uncompress the HVA installation file into the HVR_HOME directory.
```
cd $HVR_HOME
gzip -dc <hva_installation_file>.tar.gz | tar xf -
```
Start the Agent Listener service:
- If you configured the agent using inetd, reload the inetd service to apply the changes (refer to the OS instructions).
- If you configured the agent to run as a daemon process, start the service using command hvragentlistener.
```
hvragentlistener -d <agent_port_number>
```