On-Premises Upgrade Guide
Each of our new versions provides bug fixes or adds new features. We recommend to regularly upgrading your on-premises environment as it is important to the security and stabilty of your ControlUp environment. Follow this guide to upgrade your ControlUp environment to the latest version.
When to use this guide?
This upgrade manual is relevant only if you currently have ControlUp server 18.104.22.168 or higher installed. If you run a lower version, contact our support team at email@example.com. In this case, do not use this upgrade guide.
You can check the installed COP version by opening the Control Panel on your COP server and check the version under ControlUp Server.
Which components need to be upgraded?
The core infrastructure components that will you need to upgrade are:
- ControlUp On-Premises Server
- Real-Time Consoles
- ControlUp Monitors and Agents
- Insights On-Premises (IOP)
- Solve On-Premises (SOP)
This section shows you how to upgrade your on-premises environment. Make sure you follow the steps carefully, as they are interrelated.
1. Stop all running ControlUp Monitors
Stop all running monitor services. The easiest and most secure way is to stop the monitors from the Real-Time Console.
To stop all ControlUp Monitors:
- Open a Real-Time Console and click Monitoring Status.
- Right-click each ControlUp Monitor and select Stop.
- Wait until all monitors have been stopped and their status has changed to Disconnected.
2. Stop all running IOP Forwarder services
If you run IOP in your environment, you need to stop all IOP Forwarders running on your monitor machines. If your ControlUp Monitors have the ControlUp Agent installed, you can use the Controllers pane to stop the services on all monitor machines at once. If the agent is not installed, identify all running IOP Forwarder services and stop the service by executing the following PowerShell command:
Stop-Service -Name SplunkForwarder
3. Create Backups
The next step is to back up files and folders that contain the configuration of your COP environment. We recommend to save all folders and files to a save location where you can copy the files back after the upgrade has been completed.
ControlUp Server folder
Back up the ControlUp Server folder which you can find under C:\Program Files\ControlUp Inc (if you upgrade from version 8.6) or C:\Program Files\Smart-X (if you upgrade from a lower version than 8.6)
Log in to a console machine with the user domain account that you used to create your ControlUp organization. This user is also known as the organization owner.
Check if a file with the file extension .v4.xml exists in the
%AppData%\Roaming\ControlUp\Configuration folder. This is an encrypted XML that holds the COP configuration.
If the file exists, back up the ControlUp folder as shown in the screenshot below:
If the file does not exist, perform the instructions below.
To save the configuration file manually:
- With a user account from the organization owner group logged in, open the Real-Time Console.
- In the Home ribbon, click Save Configuration. This saves the configuration files to the current user profile directory under
- A popup appears in the right-bottom corner after the configuration files have been successfully saved.
You can now save the
/AppData/Roaming/ControlUp folder to a location that you will be able to access after the upgrade is complete.
COP license file
Back up your on-premises license file. To see where the license file is saved, open the ControlUpServerSettings.xml that is located under
C:\Program Files\Smart-X\ControlUp Server\Server Settings or
C:\Program Files\ControlUp Inc\ControlUp Server\Server Settings
Back up the license file, in our example PrivateCloudLicenseFile.xml.
We highly recommend to make a database backup. You can find more information in the SQL database backup section.
Back up Script-based Actions
Script-based Actions are stored in the ControlUp database. If you created your own script, we recommend to back up the relevant SBA tables in your database. Learn how to back up the tables in the section below.
4. Start the upgrade
Now that you backed up all necessary files, it's time to start the upgrade. Before you continue reading, make sure the servers running the COP components meet all requirements.
Upgrade COP server
First, upgrade the COP server. There are different instructions depending on whether your SQL server is currently configured as Production Mode or Light Mode.
In 8.6.5, you can configure a failover cluster for the COP server. If you want to use this feature, make sure you uninstall the COP server and not upgrade it.
Choose your prefered option below and follow the instructions and follow the instruction in each section:
- My SQL Server instance is installed on a different server and I don't want to use the COP failover feature in the new version
- My SQL Server instance is installed on a different server and I want to use the COP failover feature in the new version.
- SQL Server instance is installed on the COP server (Light-mode installation).
Upgrade Instructions for Production Mode
Production mode means that you currently installed ControlUp version runs on a dedicated SQL server instance and not on your COP server.
To upgrade the COP server in production mode, follow the instructions below
Run the installation file for the new ControlUp Server version as an administrator. Click Upgrade and wait until the installation is complete.
The Upgraded Successfully message indicates that the upgrade was performed successfully.
If the upgrade failed, contact our support team at firstname.lastname@example.org
Upgrade Instructions for Light Mode
Uninstall the currently installed version of the COP server, if you use a
- light-mode SQL deployment
- production mode SQL deployment and you want to use the COP server failover feature.
Uninstall the COP server. To do so, open the Control Panel and run the Programs and Features applet. Right-click ControlUp Server and select Uninstall. Follow the prompts to uninstall.
Uninstall the program by clicking Yes.
Run the installation for the latest COP version as an administrator and follow the installation instructions from the ControlUp On-Premises Server installation guide.
During the installation, you have the option to import Script-based Actions (SBAs). Browse the SQL backup file that you created from your previous COP installation and click Continue to start the import of your SBA backup.
In the Control Panel, verify that the new version was successfully installed once the installation is complete.
Step 2: Upgrade Real-Time Console
After upgrading the COP server, uninstall your old Real-Time Consoles and install the new versions. Follow the instructions in the ControlUp On-Premises Real-Time Console Installation guide.
Step 3: Upgrade ControlUp Monitors
Next, upgrade the ControlUp Monitors that stopped before.
In the Real-Time Console, click Monitoring Status to see all installed monitors in your ControlUp organization.
Right-click a monitor and select Upgrade. Repeat this step for all monitors so that no monitor appears with a version mismatch.
Once the upgrade is finished, check that the monitors started successfully and the Version column shows the updated version.
Step 4: Upgrade ControlUp Agents
We recommend to install the latest ControlUp Agent version on your managed machine to benefit from the latest real-time feature in ControlUp.
Right-click the machine and select Agent Control > Upgrade/Install Remote Agent
If you want to upgrade the agent on multiple machines at the same time, mark those machines, right-click one of them and select Agent Control > Upgrade/Install Remote Agent
ControlUp Agents that were deployed from master images via an MSI installer, need to be upgraded in a different way. Download the latest installation file from our Download Center.
Step 5: Upgrade Insights On-Premises
The next step is to upgrade IOP which is covered in the Insights On-Premises Upgrade article.
Step 6: Upgrade Solve On-Premises
To upgrade SOP, follow the instructions in the Solve On-Premises Upgrade guide.
Back up your ControlUp Database (Optional)
In case the COP upgrade fails, it is highly recommended to back up the ControlUp database. To manually create a DB backup with SSMS, follow the instructions below. If you prefer another backup method, feel free to use it.
To create a database backup:
- Open SSMS and connect to the server instance where the ControlUp database is located.
- Right-click the ControlUpDB > Tasks > Back Up...
- In the Back Up dialog box, accept the selected database. Keep the backup type Full. In the Destination section, specify whether you want to back up to disk or tape.
- Select the options Overwrite all existing backup sets and Verify backup when finished.
- Be sure to keep the backup file created after the backup is complete in case the COP upgrade does not work.
Back up Script-based Actions (Optional)
Creating a backup of your Script-based Actions is recommended if you wrote your own SBAs. If you don't have custom scripts in your ControlUp environment, then skip this section as importing the latest Script-based Actions ensures that you have the latest Community Script available.
In this section, we show how to back up your Script-based Actions with SQL Server Management Studio. Of course, you can use any other SQL management software.
To back up Script-based Actions:
- Open SSMS and connect to the instance on which your ControlUp database is located. For light-mode installations, this is your COP server. For production mode, your dedicated SQL instance.
- Right-click the ControlUp database and select Tasks > Generate Scripts.....
- In the Generate and Publish Script wizard, click Select specific database objects. Expand the Tables tree and mark the following tables:
- In the Set Scripting Options wizard, click Advanced.
- In the Advanced Scripting Options dialog, scroll down the list of options and change the Types of data to script from Schema Only to Data only and click OK.
- In the Set Scripting Options screen, select Save to file and enter the path where you want to save the export file. Click Next to see the summary window.
- Review the export summary and click Next.
- Once the export is complete, click Finish.
- Add the following lines to the top of the export file with a text editor. If you use another database than ControlUpDB, you must change the name of the database accordingly.
TRUNCATE table [dbo].[SBARecord]
TRUNCATE table [dbo].[CloudStore]
TRUNCATE table [dbo].[SBA_EULA]
TRUNCATE table [dbo].[SBAExecutionRecord]
You now prepared the export file for your Script-based Actions which you can later import during the upgrade of your COP server.