Starting Migration

To start a migration, send a request XML packet containing the start operational node to the destination Plesk server. You can start migration of either subscription or customer, or reseller account(s) with one start operation.

A request XML packet starting a migration includes the start operation node:

<packet>
<migration>
   <start>
   ...
   </start>
</migration>
</packet>

 

The start node is presented by type MigrationArguments (plesk_migration.xsd), and its graphical representation is as follows:

MigrationArguments

  • The host node is required. It specifies name or IP address of the source server. Data type: string.
  • The login node is required. It specifies the login of Administrator/Power user on the source server. Data type: string.
  • The password node is required. It specifies the password of Administrator/Power user on the source server. Data type: string.

    Important:The login and password nodes contain credentials of administrator/power user on the server, in all XML API versions.

  • The destination-host-directory node is required. It specifies path to the directory on the destination server file system, where the dump of objects being migrated will be stored before deploying them to Plesk. Data type: string.

    Note: The node can be used with empty value. In such case, dump will be placed to a default location, which is C:\temp\ on Windows, and PRODUCT_ROOT_D/PMM/var/ on Linux/Unix.

  • The system-type node is required in Plesk for Windows. It specifies the type of operating system running on source server. Data type: string. Allowed values: unix | windows.
  • The content-transport node (for Linux only) is optional. It specifies the transport protocol that should be used to transfer data during the migration: whether a dump is archived, passed to source server, unpacked and then deployed, or the migration data is transferred using rsync. In the archive case, a significant amount of disk space is consumed by temporary migration files. Data type: string. Allowed values: archive | rsync. Default value: archive.
  • The only-hosting node is optional. It specifies if only Web site hosting data (configuration and content) of the selected objects should be migrated. Data type: none.
  • The only-mail node is optional. It specifies if only mail data (configuration and content) of the selected objects should be migrated. Data type: none.
  • The selected-objects node is required. It defines which accounts will be transferred with the migration.

    The node is presented with data type SelectedObjects (plesk_migration.xsd) and is structured as follows:

    SelectedObjects

    Either a migrate-resellers or migrate-customers node, or migrate-webspaces nodes are required.

    • The migrate-resellers node defines that reseller accounts migration will be started, and wraps the collection of data defining what reseller accounts should be migrated and the migration options. For the detailed information on this node structure, refer to the Starting Reseller Migration section. Data type: SelectedResellers (plesk_migration.xsd).
    • The migrate-customers node is optional. It defines that the customer accounts migration will be started, and wraps the collection of data defining what customer accounts should be migrated and the migration options. For the detailed information on this node structure, refer to the Starting Customer Migration section. Data type: SelectedClients (plesk_migration.xsd).
    • The migrate-webspaces node is optional. It defines that the subscription migration will be started, and wraps the collection of data defining what subscription should be migrated and the migration options. For the detailed information on this node structure, refer to the Starting Subscription Migration section. Data type: SelectedDomains (plesk_migration.xsd).

 

Note: With one START operation, you can migrate either reseller or customer or subscription accounts from one Plesk server . However, you can always migrate different customer and subscription accounts located on the same or different Plesk servers with one request packet, just use as many start nodes as you want.

 

Important: When creating request packets, put nodes and elements in the order they follow in the packet structure.

Next in this section:

Starting Reseller Migration

Starting Customer Migration

Starting Subscription Migration

Response Packet Structure

Response Samples

 

Leave your comments on this page

Leave your feedback or question on this documentation topic below. For technical assistance, contact your hosting service provider or submit a request to Plesk support. Suggest new features for Plesk here. Discuss general questions on the Plesk forum. All offtopic comments will be removed.