Asynchronous Upgrade of Two Appliances in a Failover Relationship

With asynchronous updating, the backup appliance is updated first and then assumes the role of primary. This method has minimal downtime; it is recommended for larger deployments and scenarios that rely on maintaining solid uptime. Some complexity is involved, as the network may have to be modified in order to failover to the backup appliance.

Bomgar recommends performing upgrades during scheduled maintenance windows. Your Bomgar site will be temporarily unavailable during the upgrade. All logged in representatives and active sessions will be terminated. You will need to schedule two separate maintenance windows in which to complete the upgrade. Installation usually takes between 15 minutes to an hour. However, if you are storing a large amount of data on your appliance (e.g., support session recordings), the installation could take significantly longer. Plan an interim period between the two maintenance windows adequate enough to confirm the new software version in your production environment but brief enough to minimize the exposure of temporarily not having a failover configuration. Bomgar also recommends testing the update in a controlled environment prior to deploying into production. If you experience any issues during the Base update, do not restart the Bomgar Appliance. Please contact Bomgar Technical Support.

In these instructions, Appliance A is the primary appliance (i.e., the appliance to which the primary hostname resolves), while Appliance B is the backup appliance.

Backup and Sync

Prior to upgrading, make a backup of your current Bomgar software settings. On Appliance A, go to /login > Management > Software Management.

Management > Software Management

Software :: Backup Settings

Click the Download Backup button, and save the backup file to a secure location.


On Appliance B, go to /login > Management > Failover.

Management > Failover

Failover :: Backup Site Instance Status

Click Sync Now. Once synchronization is complete, click Break Failover Relationships.


Update Appliance B

Update Appliance B using either the automatic or the manual update method.


In most cases, Bomgar customers can download and install updates with no assistance from Bomgar Technical Support. To see if an upgrade is available, go to /appliance > Support > Updates.

Support > Updates

Updates :: Check

Click on Check for updates.


Updates :: Check

If a software upgrade is available, it will appear under Available Updates. Once you select Install This Update, the appliance will download and automatically install the new version of the Bomgar software.

Note: Some packages may be grayed out and require another package to be installed first. Select Install This Update on the available package to enable the dependent one.

If automatic updates fail when expected to work, please review the Check for Updates troubleshooting FAQ at


If you are unable to use automatic updates (for example, if your Bomgar Appliance exists on a restricted network), you may perform manual updates.

Go to /appliance > Support > Updates.

Support > Updates

Updates :: Manual Installation

Updates :: Appliance Download Key

Starting with Base 3.3.2, click the Appliance Download Key link to generate a unique appliance key; prior to Base 3.3.2, you must contact Bomgar Technical Support to request this key. From a non-restricted system, submit this key to Bomgar's update server at Download any available updates to a removable storage device and then transfer those updates to a system from which you can manage your appliance.

From Support > Updates, browse to the file from the Manual Installation section and then click the Update Software button to complete the installation. The appliance will install the new version of the Bomgar software.

Note: Please be prepared to install software updates directly after download. Once an update has been downloaded, it will no longer appear in your list of available updates. Should you need to re-download a software update, contact Bomgar Technical Support.


Verify and Test

After completing the upgrade process, verify that the update completed successfully and that your software is working as expected.

On a minimum of two local machines that can access Appliance B, edit the hosts file so that your support site hostname resolves to the IP address of Appliance B. On one computer, run the representative console. Your installed representative consoles will need to be upgraded after the site upgrades. Typically, this occurs automatically the next time representatives run the representative console. To check the software build a representative console is running, log into the representative console and then click Help > About.

Note: Representative consoles previously deployed on locked-down computers using MSI may need to be re-deployed once the upgrade is complete. If the extractable representative console feature has been enabled for your site by Bomgar Technical Support, then you can download an MSI installer to update representative consoles prior to upgrading the appliance. To do this, check for the new update either manually or automatically. Click the Rep Console Installers link to download the MSI for distribution. Note that the updated representative consoles will not come online until their appliance is updated. It is not necessary to uninstall the original representative console prior to deploying the new one, as the new one should automatically replace the original installation. It is a best practice, however, to keep a copy of the old MSI to remove the outdated representative installations after the appliance is updated should this removal prove necessary. The new MSI is unable to do so.

From the other computer, request a support session and, when prompted, run the customer client to be sure that a connection can be made. You may also wish to test that this computer can be accessed via a Jump Client installed prior to upgrade.

Make Appliance B the Primary Appliance

Set Appliance B to the primary role following the steps previously determined in your failover plan: shared IP switch, DNS swing, or NAT swing.

Note: If you are using the Bomgar Integration Client and have configured it based on IP address rather than hostname, be sure to verify that it can extract data from Appliance B after redefining Appliance B as the primary appliance.

Note: For Bomgar versions 10.6 and later, data from remote support sessions completed on either appliance while failover is not enabled will automatically sync once the failover relationship has been re-established. For versions of Bomgar prior to 10.6, upgrading appliances asynchronously may create a gap in support session data. In order to ensure all session data is retained and available when asynchronously upgrading appliances running versions of Bomgar prior 10.6, be sure to use the Integration Client or API to extract any session data from Appliance A immediately before making Appliance B the primary appliance.

Shared IP Switch

On Appliance A, go to /appliance > Networking > IP Configuration.

Networking > IP Configuration

Click on the shared IP address to edit it, and uncheck the Enabled box. Then click Save Changes.

Immediately, go to /appliance > Networking > IP Configuration on Appliance B. It is helpful to have this page already open in a separate browser tab.

Click on the shared IP address to edit it, and check the Enabled box. Then click Save Changes.

As soon as the switch is made, you can resume normal support activity. All requests to your support site will be served by Appliance B.

DNS Swing

Access the DNS controller and locate the DNS entry for your support site. Edit the entry to point to the IP address for Appliance B. Once the DNS entry has propagated, you can resume normal support activity. All requests to your support site will be served by Appliance B.

NAT Swing

Access the NAT controller and locate the NAT entry for your support site. Edit the entry to point to the IP address for Appliance B. As soon as the change is made, you can resume normal support activity. All requests to your support site will be served by Appliance B.

Update Appliance A

Update Appliance A using either the automatic or the manual update method as defined above. Then verify and test that the update completed successfully.

Reestablish Failover Relationship

From Appliance B, go to /login > Management > Failover.

Management > Failover

Note: To configure a valid connection, both appliances must have identical Inter-Appliance keys. See the /login > Management > Security page to verify the key for each appliance.

Failover :: Configuration

Reestablish the failover relationship with the backup appliance, using Appliance A as the backup and Appliance B as the primary. Establishing the relationship between the two appliances occurs on the Failover page of the appliance intended to be the primary appliance. The addresses that are entered here will establish the relationship and allow either appliance to connect to each other at any time. The fields on this page called New Backup Site Connection Details tell the primary appliance how to connect to the appliance that will become the backup appliance. The fields called Reverse Connection Details to this Primary Site will be given to the backup appliance and tell it how to connect back to this primary appliance. You must use a valid hostname or IP address and the TLS port number for these fields. When all of these fields are set, click the Establish Relationship button to attempt to establish the relationship. Note: Whenever possible, Bomgar recommends using the unique IP address of each appliance when configuring these settings.

Once the relationship has been established, extraneous tabs will be removed from the backup site. It takes about 60 seconds for the first data synchronization to initiate, but you may also click the Sync Now button to force synchronization and pull the most current information from the primary appliance into the memory of the backup appliance. Synchronization itself may take anywhere from a few seconds to a few hours, depending on the amount of data that needs to be synchronized. The Failover page will list the last date and time of data synchronization when synchronization is completed.