Upgrade Hybrid Connector: migration steps

  • Last update on February 2nd, 2024

Step 1: API key

First, let’s go to the following section of CoreView Portal: “Settings” > “My Organization” > “On Premises” > “On-Premises Configuration”.

Click on the “Edit” button and take a note of your API key:

You will use that later when configuring the Hybrid Connector 2019.


Step 2: deployment

Now you can deploy Hybrid Connector on your 2019 server. Please refer to the official documentation about Hybrid Connector Deployment.

Once you are on the page where you need to configure your API key, please hold on and go ahead with the next step described below.

Now let’s come back to CoreView portal and close your management session if enabled, we would recommend disabling the “Auto-enable management session” – you will be able to re-enable that at the end of the migration process.

To do that, click on the toggle “Auto-enable management session” and click on “Save changes”. 

Once done, you can turn off your CoreView Management clicking on “Turn off management”:


From the following step, both your management actions and PowerShell run spaces will not be available until the 2019 CV Hybrid Connector version is up and running.


Step 3: stop the CoreView Connector

Once your management action is closed, you should stop the CoreView Connector Windows Service installed on your 2016 server. To avoid a restart, set its status as disabled:


Step 4: custom key settings

Now go to:

 C:\Program Files (x86)\CoreView Agent 

and open the file:


using Notepad.

You must copy and paste all the custom key settings located into the appSettings section to the same file located on your WIndows 2019 Server. In the following screenshot, you can see an example of gMSA custom settings which need to be copied to the new setting file:

<add key="gMSAEnabled" value="true" /> 
<add key="gMSAName" value="CoreViewHybrid" /> 
<add key="gMSAImporterEnabled" value="true" /> 
<add key="gMSAImporterName" value="CoreViewImporter! />

Ensure you check for the presence of a config.json file in the C:\Temp directory. If the file exists, be sure to copy it to the corresponding location on the destination server.

Here is an example of what the file content might look like:

"BackwardCompatibility.SingleForest.ActiveDirectory": "domaincontroller.yourdomain.local",    
"BackwardCompatibility.SingleForest.Exchange": "http://exchangesrv.yourdomain.local/powershell"

Step 4: add the SKU

Once done, it’s time to ask your CoreView Consultant to add the SKU FT:HYBRIDOS2019 to your configuration. That is needed to instruct your new CoreView Hybrid Connector Windows service to download the 2019 docker image from CoreView datacenters.

Without this change, you won’t be able to continue your migration process.


As soon as you get confirmation of the SKU addition, you will be able to paste and apply the API key you previously saved on the configuration page of your new CV Hybrid Connector 2019 host server.

You should get the following confirmation message:


Step 5: verify the configuration

Open your CoreView portal and go to:

“My Organization” > “On Premises”

You should find that your configuration needs to be verified again. Click on the blue verify button and wait until your configuration is complete.

Please note that it will take some time since your 2019 docker image will be downloaded to your on-premises host server for the first time.


If you would like to check for working progress, open the on-premises log files stored on:

 c:\temp directory 

of your 2019 server.

Once you get the following message, your configuration is complete and you will be able to open your management session again.


Step 6: uninstall previous Connector (optional)

If you would, you can uninstall CoreView Hybrid Connector from your Windows 2016 Server where you previously disabled the service.


Step 7: enable management session

Now it’s time to enable your CoreView Management session again. If you got queued some tasks, all of them are managed once the management session is opened.

Finally, you can enable the “Auto-enable management session” feature you previously disabled:


You are now running your CoreView Hybrid Connector on Windows Server 2019!