Configuration Files for Helm Migration

This configuration file contains only the basic information necessary to perform the migration:

[GLOBAL]
source-type: helm3
source-servers: helm3, helm3-other-server
target-type: plesk

[plesk]
ip:
os: windows

[helm3]
ip:
windows-username: Administrator
windows-password: password

[helm3-other-server]
ip:

This configuration file contains advanced settings, enabling you to fine-tune many aspects of the migration:

[GLOBAL]
# This section defines global settings and lists the source CP servers.

# [mandatory, non-modifiable] source-type
# Source servers product type.
# The other parameters in this configuration template are listed for this particular type, plesk.
# Rather than changing the source-type here, browse the provided configuration templates
# and pick one that best suits your source type.
source-type: helm3

# [mandatory, non-modifiable] target-type
# Target servers product type.
target-type: plesk

# [mandatory] source-servers
# Comma-separated list of the sections describing source Helm servers.
# An arbitrary number of Helm servers can be listed here.
source-servers: helm3, helm3-other-server

# [optional] external-db-servers
# Comma-separated list of the sections describing external source database servers.
# It is highly recommended to specify external database servers for remote MSSQL.
# Otherwise, there could be issues when copying database content.
# external-db-servers: mssql1

# [optional] session-dir
# A directory for migration tool's temporary files.
# If not specified, temporary files will be put into 'migration-session'.
# session-dir: migration-session

# [optional] zones-ttl
# The time in seconds, which migration tool sets as the SOA minimum TTL
# and refresh interval on a new DNS server.
# If not specified, default value is assumed: 120
# zones-ttl: 120

# [optional] external-dns-server
# An IP v4 address of an external DNS server that allows recursive DNS queries.
# Migration tool uses the specified address to test whether general Internet users
# can obtain the correct DNS records for the transferred domains.
# If nothing is specified, migration tool will use Google DNS server (8.8.8.8).
# If 'none' is specified, migration tool will skip this test.
# external-dns-server: 8.8.8.8

# [optional] mail-messages-delta-limit
# The post-migration mail checks compare the number of messages in the source
# and the target mailboxes.
# If the number of messages differs more than it is specified in 
# "mail-message-count-max-difference", it is considered an error.
# If not specified, default value is assumed: 10
# mail-messages-delta-limit: 10
#
# [optional] website-availability-check-timeout
# Timeout on site response in seconds. When check the availability of site, limit response time.
# If not specified, default value is assumed: 30
# website-availability-check-timeout: 30

# [optional] log-message-context-length
# When logging a multiline output (API request, response), show only top N
# and last N lines. Default value is 0, which means to display full API requests.
# log-message-context-length: 10

# [optional] copy-mssql-content
# Select way to copy MSSQL content: native MSSQL dumps, text dumps or automatic selection (default).
# Possible values: 'native', 'text', 'auto'
# Native backups require direct access of migration tool to all MSSQL servers, so make sure
# that you provided access to all external MSSQL servers in 'external-db-servers' option.
# Native backup is the most reliable way to copy MSSQL database content.
# Text dumps have an advantage that they do not require physical access to the servers.
# Only access by MSSQL protocols is required. But such way may fail in case of complex MSSQL databases
# with stored procedures, triggers, etc.
# If automatic selection is specified, panel migrator will use native backups if we have direct access
# to the servers with MSSQL, and text dumps otherwise.
# copy-mssql-content: auto

[plesk]
# This section defines Plesk-related settings.

# [mandatory] ip
# An IP v4 address of the Plesk node.
# It does not matter whether this IP address is external or internal, as long as migration tool can connect
# to Plesk node at this address.
ip:

# [mandatory] os
# Server's operating system type, 'unix' or 'windows'. Defines which other parameters are required
# in this section.
os: windows

# [optional] panel-username
# Plesk administrator user name. If not specified, 'admin' is used.
# panel-username: admin

# [optional] panel-password
# Plesk administrator password. If not specified, it is automatically detected.
# panel-password: setup

# [optional] windows-session-dir
# A directory for temporary files on Plesk Windows service nodes.
# If not specified, temporary files will be put into C:\migrator
# windows-session-dir: C:\migrator

# [optional] is-local
# Whether migration tools are working on the same server as target Plesk.
# Default is true.
# is-local: true

[helm3]
# This section defines the settings of Helm3 control panel server.

# [mandatory] ip
# An IP v4 address of this Helm CP server.
ip:

# [optional] windows-username
# User name of the privileged system user on this Helm server. Default is 'Administrator'.
# windows-username: Administrator

# [mandatory] windows-password
# Password of the privileged system user on this Helm server.
windows-password: password

# [optional] copy-mail-content
# This parameter specifies what mail content should be copied from the server:
# 'full' to copy all mail content, 'messages' to copy only messages from the Inbox folders
# and 'none' to skip copying.
# Note that if the server does not support IMAP, it is possible to copy only Inbox messages
# using the 'messages' option.
# If not specified, all mail content is copied.
# copy-mail-content: full

# [optional] copy-web-content
# This parameter specifies what web content should be copied from the server:
# 'full' to copy all web content, and 'none' to skip copying.
# If not specified, all web content is copied.
# copy-web-content: full

# [optional] session-dir
# A directory for temporary files. If not specified temporary files are put into C:\migrator.
# session-dir: C:\migrator

[helm3-other-server]
# This section defines the settings of Helm3 remote server.

# [mandatory] ip
# An IP v4 address of this Helm CP server.
ip:

# [optional] windows-username
# User name of the privileged system user on this Helm server.
# Specify if username is different from username on control server.
# windows-username: Administrator

# [optional] windows-password
# Password of the privileged system user on this Helm server.
# Specify if password is different from password on control server.
# windows-password: password

# [optional] session-dir
# A directory for temporary files. If not specified temporary files are put into C:\migrator.
# session-dir: C:\migrator

[mssql1]
# This optional section defines settings of external MSSQL database server 'mssql1'.
# Fill this section's settings and list it in the 'external-db-servers'
# setting of GLOBAL section to get the MSSQL databases copied from this server with native MSSQL backup.
# Remove this section otherwise.

# [mandatory] host
# The address of this database server, exactly as displayed in Plesk Panel (usually it equals
# to database server's IP address).
host:

# [mandatory] type
# Type of the database server, the only allowed value is 'mssql'
type: mssql

# [mandatory] ip
# An IP v4 address of this database server.
ip:

# [optional] windows-username
# User name of the privileged system user on this centralized mail server. Default is 'Administrator'.
# windows-username: Administrator

# [mandatory] windows-password
# Password of the privileged system user on this database server.
windows-password:
 

Leave your feedback on this topic here

If you have questions or need support, please visit the Plesk forum or contact your hosting provider.
The comments below are for feedback on the documentation only. No timely answers or help will be provided.