Upgrading Bomgar Software Quick Guide
Please visit the Product Change Log to get the details of each release of Bomgar remote support software.
Note: This condensed upgrade guide is intended as a quick reference for your upgrade process. For full details on upgrading one or more Bomgar Appliances, please refer to the Upgrade Guide for Bomgar Software.
If you have two Bomgar Appliances in a failover configuration, please refer to Upgrade Two Bomgar Appliances in a Failover Configuration
- Prior to upgrading, always create a backup of your settings and configuration from /login > Management > Software Management.
(See Management for more details.)As a best practice, also export a copy of your SSL certificates and private key, and save them locally to ensure continuity in case of a failure on the upgrade. (See steps 1-3 of Replicate the SSL Certificate on Failover and Atlas Appliances for more details.)
- For major software releases, customers with current maintenance contracts are placed into a rollout schedule. Once your upgrade is ready, Bomgar alerts you via email to begin this upgrade procedure.
- If your appliance is many months or years out of date, it is unlikely to be able to upgrade directly to the latest version of Bomgar in a single installation. In this case, some upgrade packages may be grayed out in the updates list and require another package to be installed first. Select Install This Update on the available package to enable the dependent one.
- If uncertain which updates to install or in which order, contact Bomgar Technical Support at help.bomgar.com with a screenshot of your /appliance > Status > Basics page to determine the specific updates needed for your appliance.
- In cases where intermediate Bomgar updates must be installed before the latest version, Bomgar software clients are not expected to auto-update successfully unless they are allowed time to retrieve the intermediate updates. Therefore, Bomgar recommends that you wait at least 24 hours after installing each package prefixed by "Bomgar".
- Base updates do not require a waiting period, but they are typically prerequisite to "Bomgar" packages. As such, Base updates are normally installed immediately prior to "Bomgar" packages.
- If it is impossible to allow 24 hours for automatic client upgrades to complete, the alternative to automated updating is first to remove all existing client software, including representative consoles, Jump Clients, Jumpoints, Bomgar Buttons, connection agents, etc. Install each "Bomgar" and Base upgrade in sequence until the latest version is reached. Then, manually reinstall all client software.
- Installation usually takes between 15 minutes to an hour. However, if you are storing a large amount of data on your appliance (e.g., session recordings), the installation could take significantly longer.
- Bomgar recommends performing upgrades during scheduled maintenance windows. Your Bomgar site will be temporarily unavailable during the upgrade. All logged in users and active sessions will be terminated.
- Bomgar also recommends testing the update in a controlled environment prior to deploying into production. Testing can best be performed when you have two appliances in a failover relationship and when you update asynchronously. (See Verify and Test).
- If you experience any issues during the Base update, do not restart the Bomgar Appliance. Please contact Bomgar Technical Support.
- If you have two appliances set up in a failover configuration, consider whether you want to update synchronously or asynchronously.
- With synchronous updating, the primary appliance is updated first and maintains its role as primary. This method does involve some downtime; it is recommended for simple deployments and scenarios that will not suffer from being offline during the update.
- 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 fail over to the backup appliance.
Only certain upgrades require client software to update. Base software updates and license add-ons do not require client software updates. Site version updates do require client updates, however. Most client updates occur automatically, but the expected update procedure for each type of client is reviewed below.
- Your installed representative consoles will need to be upgraded after the site upgrades. Typically, this occurs automatically the next time the representative run the representative console.
- 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 consoles will not come online until their appliance is updated. It is not necessary to uninstall the original 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 installations after the appliance is updated should this removal prove necessary. The new MSI is unable to do so.
- After an upgrade, deployed Jump Clients automatically update.
- If large numbers of Jump Clients attempt to update simultaneously, they may flood the appliance, severely crippling performance both on the appliance and the network, depending on the available bandwidth and hardware. To regulate the amount of bandwidth and resources consumed by Jump Client updates, go to /login > Jump > Jump Clients and set a lower value for Maximum Number of Concurrent Jump Client Upgrades and/or Maximum bandwidth of concurrent Jump Client upgrades.
Active and passive Jump Clients update upon their first check-in with the appliance subsequent to the appliance's update.These check-in events occur at regular intervals outbound from the Jump Client host over TCP port 443 to the appliance. Active Jump Clients check in immediately after an upgrade is complete on the appliance. Passive Jump Clients check in upon boot up, upon having a connection made from the representative console, upon being told to check in from the system tray icon, and at least once every 24 hours.
- If your Bomgar Appliance is out of date, multiple release versions may need to be installed to reach the current version. In this case, Bomgar recommends allowing at least 24 hours between updates to allow Jump Clients to upgrade. Passive Jump Clients may take longer than this depending on how long their host systems remain offline.
- Once a Jump Client appears as online in the representative console or the /login > Status > Information page, it has updated successfully. An effective means of confirming that all Jump Clients have updated is to log into the representative console as an administrative user with permission to modify all Jump Clients in the system. Export the list of Jump Clients. In the resulting report, sort the Jump Clients by Status Details and confirm that all the dates listed are more recent than the date of the last Bomgar Appliance upgrade.
- If too many release versions are installed back-to-back without first allowing Jump Clients to upgrade, Jump Clients may require manual redeployment.
- After an upgrade, Bomgar Buttons update automatically upon being used for the first time subsequent to an upgrade.
- After an upgrade, deployed Jumpoints should automatically update.
- Bomgar Connection Agents update automatically after the site upgrades.
- Bomgar Integration Clients do not automatically update after the site upgrades. Integration Clients must be re-installed manually. Integration Client installers are available from the Downloads page of help.bomgar.com.
- Upon upgrading, it is necessary to regenerate any installer packages previously created for Bomgar Buttons, Jump Clients, and representative consoles. The clients themselves update as described above. However, the installer files for them invalidate once the appliance which generated them is upgraded.
In most cases, Bomgar customers can download and install updates with no assistance from Bomgar Technical Support. To see if an upgrade is available, log in to your Bomgar Appliance (/appliance). On the Updates page, click on Check for updates.
If a software update is available, it will appear under Available Updates. Once you click Install This Update, the appliance will download and automatically install the new version of the Bomgar software.
Note: Some packages require another package to be installed first. Install 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 https://help.bomgar.com/ssc/SolutionFAQ.aspx?id=377.
If you are unable to use automatic updates (e.g., if your appliance exists on a restricted network), you may perform manual updates.
Log into your Bomgar Appliance and go to the Updates page. 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 update.bomgar.com. 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 the Updates page, 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: Be prepared to install software updates directly after download. Once an update has been downloaded, it no longer appears in your list of available updates. Should you need to re-download an update, contact Bomgar Technical Support.
Note: If you receive an error, please make sure the time listed on the /appliance > Status > Basics page is correct. Many functions of the Bomgar Appliance, including the Appliance Download Key, rely on this time being correct. If the time is not correct, please check the NTP setting on the Networking > IP Configuration page.