Parallels Helm 4.2.0 Upgrade Tool Guide

Contents

  1. Introduction
  2. How to Use the Upgrade Tool
  3. Known Problems and Limitations
  4. Testing Migration
  5. Contact Information

1. Introduction

The Upgrade Tool is a Windows application deployed with Helm 4 that allows the migration of information from one control panel to Helm 4. In the current version, a Helm 3 installation can be upgraded to Helm 4.

This tool will not make changes to your current services enabling it to be run along side an active control panel without affecting customer services. Please note that this tool is not designed to move hosted services from one place to another, but to allow you to upgrade from your current control panel solution to the Helm 4 control system.

The tool supports a number of different information sources:

  1. Helm 3 - This allows an upgrade from version 3.x of the Helm control server family. In order to migrate from Helm 3 you will need to ensure you are running this tool on the Helm 3 control server.
  2. Import Data File - This is a .h4 file that the upgrade tool generates. It is used for exporting settings from one information source in order to install on a different machine. Use this format when needing to migrate a control server from one machine to another. Please note that the new control server MUST be able to communicate with the original host servers in order to complete its task.

2. How to Use the Upgrade Tool

Note: Before performing migration on live servers you might want to test it first. Cloned Helm 3 server is an ideal testing ground - it has all the data from the real server, but doesn't impact users. This guide contains all steps needed to clone and migrate Helm 3 server. See Testing Migration section.

Prerequisites

You need to install Helm 4 on Helm 3 control server and also on each Helm 3 remote server. There are two ways to install Helm 4:

Remote servers need to be configured after installation:

Performing the Upgrade

Upgrade is performed from the control server. Remote servers are upgraded automatically.

  1. On your control server go to the Helm 4 installation folder.
  2. From the "Tools" folder run the Helm4UpgradeTool.exe application.
  3. Go through the wizard following the instructions until you hit the "Import" page.
  4. Select the appropriate information source that you will be upgrading from and click Next. 
  5. The tool will show it importing the information from the selected source.
  6. Once finished click Next. 
  7. You will be asked whether you want to upgrade on the server or export the settings to a file.
  8. Stop Parallels Helm 4 Refresh Service in all Helm 4 servers for the time of migration: 
    net stop Helm4RefreshService
  9. Select "Yes, Upgrade Now!"
  10. Click 'Next', and the tool will show it importing the information in the local Helm 4 control system.
    Please note that import process is a CPU-consuming procedure and can take considerable amount of time depending on number of accounts, plans and domains.
  11. When complete, click 'Next' and you are now upgraded!
  12. Start Parallels Helm 4 Refresh Service: 
    net start Helm4RefreshService

Restarting the Upgrade Tool Process Again

No problem. You can attempt any upgrade as many times as you like. Just drop your Helm 4 database and recreate it using the Helm Configuration Tool and just run through the steps above again.

3. Known Problems and Limitations

  1. UpgradeTool fails with "Can not create service ..." error.

    Workaround: Stop Helm 4 Refresh Service for the time of migration.

  2. Packages can not be imported twice.

  3. Default scripting extensions are not migrated from Helm 3 for ASP, Perl, Python and PHP. Helm 4 default values differ from the ones of Helm 3.

    Workaround: Use Helm 4 control panel interface to configure scripting extensions after migration.

  4. National characters aren't imported in notification text.

4. Testing Migration

Before performing migration on live servers you might want to test it first. Cloned Helm3 server is an ideal testing ground - it has all the data from the real server, but doesn't impact users. This guide contains steps needed to clone and migrate Helm3 server.

Prepare Server

It is advised that the new server will have the same configuration as the existing one.

Copy Services Data

For each service used on server you will need to install corresponding program on new server and copy (or import) all the data (files, databases, etc.). The whole copy process is specific to the service. Here are some examples:

  1. IIS Service
    1. Copy "Domains" folder to the same location on the new server.
    2. Copy settings with the help of iiscnfg.vbs script (use /copy key). See Microsoft technet article.

Install Helm 3

Before installing Helm3 be sure to delete "Helm Control Panel" site from the IIS, because it was copied when you performed IIS migration. Install Helm3 as usual. After the installation you will need to restore copy of source server's Helm3 DB. After that step you will able to login to Helm3 and will observe all your customers and domains. However, you should first change name and address of server (Home > System Settings > Servers) to the new server's ones.

Perform the Upgrade

Follow the instructions from How to Use the Upgrade Tool section.

5. Contact Information

Parallels Holdings, Ltd.
c/o Parallels International GmbH
Vordergasse 59
CH-Schaffhausen
Switzerland
Phone: +41-526320-411
Fax: +41-52672-2010

Web: http://www.parallels.com

E-mail:
For billing information, send e-mail to accounting@parallels.com
For purchasing information, send e-mail to sales@parallels.com
For technical support, use our Parallels Helm Online Support Form.
To report problems with Parallels software, send e-mail to bugreport@parallels.com
For information on career opportunities with Parallels, send e-mail to careers@parallels.com
For press contact information, send e-mail to press@parallels.com
For information about becoming a partner, send e-mail to partners@parallels.com
For information on translating Parallels software into your language, send e-mail to i18n@parallels.com
For general product information, send e-mail to info@parallels.com

Copyright © 1999-2011 Parallels Holdings, Ltd. and its affiliates. All rights reserved.

This product is protected by United States and international copyright laws. The product’s underlying technology, patents, and trademarks are listed at http://www.parallels.com/trademarks.

Microsoft, Windows, Windows Server, Windows NT, Windows Vista, and MS-DOS are registered trademarks of Microsoft Corporation.

All other marks and names mentioned herein may be trademarks of their respective owners.