Migrate Virtual Server¶

Supported Versions	Last Updated
1.27.23 & higher	2022/11/14

Note: This API function supports only KVM migration initially.

Action vserver-migrate

Method GET, POST

Variables

vserverid [id of the virtual server]

nodeid [id of the destination node]

compress [0 (default)|1 - compress the data being sent across the network. This variable is optional]

transferspeed [0 (default)-1000 - maximum network speed you want this migration to use, Mbit/s. 0 - unlimited. This variable is optional]

internalnetwork [0 (default)|1 - transfer data over internal network. This variable is optional]

automateonsuccess [0 (default)|1 - Delete the source virtual server and boot on the destination if the migration is successful. It is recommended that you set this to 0 and delete it once you have checked the virtual server has been transfered successfully. This variable is optional]

rdtype [json] For json output specify json or for default output leave blank. This variable is optional

Example Output

JSON

Success:

{
    "status": "success",
    "statusmsg": "Migration of virtual server ID 1093 to node ID 68 has been started"
}

Error:

{
    "status": "error",
    "statusmsg": "ERROR MESSAGE"
}

XML

Success:

<status>success</status>
<statusmsg>Migration of virtual server ID 1093 to node ID 68 has been started</statusmsg>

Error:

<status>error</status>
<statusmsg>ERROR MESSAGE</statusmsg>