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>--online</b>] [<b>-v</b>] <i>destination_address
CTID</i></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, migration may be offline (default) or
online.</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>

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

<p style="margin-left:22%;">Perform online (zero-downtime)
migration: during the migration the container hangs for a
while and after the migration it continues working as though
nothing has happened.</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. Multiple <b>-v</b> options
increase the verbosity. The maximum is 3.</p></td></tr>
</table>

== 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 --online 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>

== SEE ALSO ==

<p style="margin-left:11%; margin-top: 1em"><b>rsync</b>(1).</p>

== COPYRIGHT ==

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