Stopping Migration

To stop migration running at the moment, use the FINISH operation. If the operation is successful, the migration is immediately stopped, and all the data related to the migration (that is, dumps on source and destination servers, migration log file) is deleted. If the FINISH operation is performed at the moment when some of the migrated objects have already been deployed to the destination Plesk, the migration will be stopped, migration dumps and log files will be deleted, but the objects already deployed will remain in Plesk.

Request Packet Structure

A request XML packet stopping the migration includes the finish operation node:

<packet version="1.6.0.2">
<migration>
  <finish>
  ...
  </finish>
</migration>
</packet>

The finish node is presented by complex type MigrationId (plesk_migration.xsd), and its graphical representation is as follows:

• The migration_id node is required. It holds the unique identifier of the migration. Data type: none.

With one finish operation, you can stop only a single migration. To stop multiple migrations with one packet, use the required number of the finish nodes in your request packet.

Response Packet Structure

The finish node of the response packet is structured as follows:

• The result node is required. It wraps the operation result. Data type: resultType.
• The status node is required. It returns the execution status of the finish operation. Data type: string. Allowed values: ok | error.
• The errcode node is optional. It returns the error code when the finish operation fails. Data type: unsignedInt.
• The errtext node is optional. It returns the error message if the finish operation fails. Data type: string.

Samples

Stopping a single migration

This packet stops the migration with ID 28955.

<packet version="1.6.0.2">
  <migration>
    <finish>
      <migration_id>28955</migration_id>
    </finish>
  </migration>
</packet>

Response:

<packet version="1.6.0.2">
<migration>
<finish>
   <result>
      <status>ok</status>
   </result>
</finish>
</migration>
</packet>

Stopping multiple migrations

This packet stops migrations with IDs 24175 and 24176.

<packet version="1.6.0.2">
<migration>
   <finish>
      <migration_id>24175</migration_id>
   </finish>
   <finish>
      <migration_id>24176</migration_id>
   </finish>
</migration>
</packet>

Response:

<packet version="1.6.0.2">
<migration>
<finish>
   <result>
      <status>ok</status>
   </result>
</finish>
<finish>
   <result>
      <status>ok</status>
   </result>
</finish>
</migration>
</packet>