Editing Man/vzmigrate.8

== NAME ==

<p style="margin-left:11%; margin-top: 1em">vzmigrate
&minus; migrate a container between two OpenVZ servers</p>

== SYNOPSIS ==

<table width="100%" border="0" rules="none" frame="void"
       cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="14%">

<p style="margin-top: 1em"><b>vzmigrate</b></p></td>
<td width="1%"></td>
<td width="74%">

<p style="margin-top: 1em">[<b>-r</b>|<b>--remove-area&nbsp;yes</b>|<b>no</b>]
[<b>--ssh=</b><i>ssh_options</i>]
[<b>--rsync=</b><i>rsync_options</i>] [<b>--keep-dst</b>]
[<b>--live</b>] [<b>-c</b>|<b>--compact</b>]
[<b>-s</b>|<b>--snapshot</b>]
[<b>--check-only</b>|<b>--dry-run</b>]
[<b>-f</b>|<b>--nodeps</b>[<b>=</b><i>check</i>[<b>,</b><i>check&nbsp;</i>...]]]
[<b>-t</b>|<b>--times</b>] [<b>-v</b>]
<i>destination_address CTID</i></p></td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="14%">

<p><b>vzmigrate</b></p></td>
<td width="1%"></td>
<td width="74%">

<p><b>-h</b>|<b>--help</b>|<b>--usage</b>|<b>-?</b></p></td></tr>
</table>

== DESCRIPTION ==

<p style="margin-left:11%; margin-top: 1em">This utility is
used to migrate a container from one (source) Hardware Node
(HN) to another (destination) HN. The utility can migrate
either stopped or running container. For a stopped
container, simple CT private area transfer is performed
(<b>rsync</b>(1) is used for file transfer). For running
containers, either traditional (with CT stop and start) or
live migration is possible.</p>

<p style="margin-left:11%; margin-top: 1em">This program
uses <b>ssh</b> as a transport layer. You will need to put
ssh public key to destination node and be able to connect to
node without entering password.</p>

== OPTIONS ==

<p style="margin-left:11%; margin-top: 1em"><b>-r</b>,
<b>--remove-area yes</b> | <b>no</b></p>

<p style="margin-left:22%;">Whether to remove a container
area on source HN for the successfully migrated container.
Default is <b>yes</b>.</p>

<p style="margin-left:11%;"><b>--ssh=</b><i>options</i></p>

<p style="margin-left:22%;">Additional <i>options</i> that
will be passed to ssh while establishing connection to
destination HN.</p>

<p style="margin-left:11%;"><b>--rsync=</b><i>options</i></p>

<p style="margin-left:22%;">Additional <i>options</i> that
will be passed to <b>rsync</b>(8). You may add options like
<b>-z</b> to enable data compression if you are migrating
over a slow link.</p>

<p style="margin-left:11%;"><b>--keep-dst</b></p>

<p style="margin-left:22%;">Do not clean synced destination
container private area in case of some error. It makes sense
to use this option on big container migration to avoid
syncing container private area again in case some error (on
container stop for example) occurs during first migration
attempt.</p>

<table width="100%" border="0" rules="none" frame="void"
       cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="9%">

<p><b>--live</b></p></td>
<td width="2%"></td>
<td width="78%">

<p>Perform live migration: instead of restarting a
container, checkpoint and restore are used, so there is no
container downtime or service interruption. Additional steps
are performed to minimize the time when a container is in
suspended state. Option <b>--online</b> can be used as a
backward-compatible alias.</p></td></tr>
</table>

<p style="margin-left:11%;"><b>-c</b>, <b>--compact</b></p>

<p style="margin-left:22%;">Compact a container image (i.e.
run <b>vzctl compact</b>) before migration. Works for ploop
only, ignored otherwise.</p>

<p style="margin-left:11%;"><b>-s</b>,
<b>--snapshot</b></p>

<p style="margin-left:22%;">Create a container snapshot
(i.e. run <b>vzctl snapshot</b>) before migration. Works for
ploop only, ignored otherwise.</p>

<p style="margin-left:11%;"><b>--check-only</b>,
<b>--dry-run</b></p>

<p style="margin-left:22%;">Do not perform actual
migration, stop after preliminary checks. This is used to
check if a CT can possibly be migrated. Combine with
<b>--live</b> to enable more checks for live migration
case.</p>

<p style="margin-left:11%;"><b>-f</b>|<b>--nodeps</b>[<b>=</b><i>check</i>[<b>,</b><i>check&nbsp;</i>...]]</p>

<p style="margin-left:22%;">Continue migration, ignoring
some or all preliminary check failures. Particular checks
can be ignored by providing an argument to <b>--nodeps</b>
option. The following options can be used (comma-separated):
<br>
&bull; <b>cpu</b> &minus; ignore cpu capabilities check;
<br>
&bull; <b>ipv6</b> &minus; ignore ipv6 module check.</p>

<p style="margin-left:11%;"><b>-t</b>, <b>--times</b></p>

<p style="margin-left:22%;">At the end of live migration,
output various timings for migration stages that affect
total suspended CT time. Note that it only makes sense with
<b>--live</b>.</p>

<table width="100%" border="0" rules="none" frame="void"
       cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="3%">

<p><b>-v</b></p></td>
<td width="8%"></td>
<td width="78%">

<p>Verbose mode. Causes <b>vzmigrate</b> to print debugging
messages about its progress. Note that <b>-v</b>
automatically implies <b>-t</b>. Multiple <b>-v</b> options
increase the verbosity.</p></td></tr>
</table>

<p style="margin-left:11%;"><b>-h</b>|<b>--help</b>|<b>--usage</b>|<b>-?</b></p>

<p style="margin-left:22%;">Print usage info and exit.</p>

== EXAMPLES ==

<p style="margin-left:11%; margin-top: 1em">Migration of CT
101 to <b>192.168.1.130</b> with downtime:</p>

<pre style="margin-left:11%; margin-top: 1em">   vzmigrate 192.168.1.130 101</pre>

<p style="margin-left:11%; margin-top: 1em">Online
migration of CT 102 to <b>192.168.1.130</b>:</p>

<pre style="margin-left:11%; margin-top: 1em">   vzmigrate --live 192.168.1.130 102</pre>

== EXIT STATUS ==

<p style="margin-left:11%; margin-top: 1em"><b>0
EXIT_OK</b></p>

<p style="margin-left:22%;">Command completed
successfully.</p>

<p style="margin-left:11%;"><b>1 EXIT_USAGE</b></p>

<p style="margin-left:22%;">Bad command line options.</p>

<p style="margin-left:11%;"><b>2 EXIT_VE_STOPPED</b></p>

<p style="margin-left:22%;">Container is stopped.</p>

<p style="margin-left:11%;"><b>4 EXIT_CONNECT</b></p>

<p style="margin-left:22%;">Can&rsquo;t connect to
destination (source) HN.</p>

<p style="margin-left:11%;"><b>6 EXIT_COPY</b></p>

<p style="margin-left:22%;">Container private area
copying/moving failed.</p>

<p style="margin-left:11%;"><b>7 EXIT_VE_START</b></p>

<p style="margin-left:22%;">Can&rsquo;t start or restore
destination CT.</p>

<p style="margin-left:11%;"><b>8 EXIT_VE_STOP</b></p>

<p style="margin-left:22%;">Can&rsquo;t stop or checkpoint
source CT.</p>

<p style="margin-left:11%;"><b>9 EXIT_EXISTS</b></p>

<p style="margin-left:22%;">Container already exists on
destination HN.</p>

<p style="margin-left:11%;"><b>10 EXIT_NOTEXIST</b></p>

<p style="margin-left:22%;">Container does not exists on
source HN.</p>

<p style="margin-left:11%;"><b>12 EXIT_IP_INUSE</b></p>

<p style="margin-left:22%;">You attempt to migrate CT which
IP address(es) are already in use on the destination
node.</p>

<p style="margin-left:11%;"><b>13 EXIT_QUOTA</b></p>

<p style="margin-left:22%;">Operation with CT quota
failed.</p>

<p style="margin-left:11%;"><b>14
EXIT_OVZ_NOT_RUNNING</b></p>

<p style="margin-left:22%;">OpenVZ is not running, or some
required kernel modules are not loaded.</p>

<p style="margin-left:11%;"><b>15 EXIT_APPLY_CONFIG</b></p>

<p style="margin-left:22%;">Unable to set CT name on
destination node.</p>

<p style="margin-left:11%;"><b>16 EXIT_PLOOP_UNSUP</b></p>

<p style="margin-left:22%;">Ploop is not supported by
destination node.</p>

<p style="margin-left:11%;"><b>17
EXIT_UNSUP_CPT_VER</b></p>

<p style="margin-left:22%;">CPT version incompatibility
with the destination node.</p>

<p style="margin-left:11%;"><b>18 EXIT_UNSUP_CPU</b></p>

<p style="margin-left:22%;">Destination node CPU
incompatibility.</p>

<p style="margin-left:11%;"><b>19
EXIT_CANT_READ_REMOTE_CONFIG</b></p>

<p style="margin-left:22%;">Unable to read remote
vz.conf.</p>

<p style="margin-left:11%;"><b>20 EXIT_LOCKED</b></p>

<p style="margin-left:22%;">Can&rsquo;t lock container
(already locked).</p>

== SEE ALSO ==

<p style="margin-left:11%; margin-top: 1em"><b>rsync</b>(1),
[[Man/vzcptcheck.8|<b>vzcptcheck</b>(8)]].</p>

== COPYRIGHT ==

<p style="margin-left:11%; margin-top: 1em">Copyright (C)
2001-2013, Parallels, Inc. Licensed under GNU GPL.</p>