.\" Automatically generated by Podwrapper::Man 1.40.2 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "virt-v2v-copy-to-local 1"
.TH virt-v2v-copy-to-local 1 "2019-02-07" "libguestfs-1.40.2" "Virtualization Support"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
virt\-v2v\-copy\-to\-local \- Copy a remote guest to the local machine
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& virt\-v2v\-copy\-to\-local \-ic LIBVIRT_URI GUEST
\&
\& virt\-v2v\-copy\-to\-local \-ic xen+ssh://root@xen.example.com xen_guest
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\f(CW\*(C`virt\-v2v\-copy\-to\-local\*(C'\fR copies a guest from a remote hypervisor to
the local machine, in preparation for conversion by \fBvirt\-v2v\fR\|(1).
Note this tool alone \fBdoes not\fR do the virt\-v2v conversion.
.SS "When to use this tool"
.IX Subsection "When to use this tool"
This tool is not usually necessary, but there are a few special cases
(see list below) where you might need it.
.PP
If your case does not fit one of these special cases, then ignore this
tool and read \fBvirt\-v2v\fR\|(1) instead.  The virt\-v2v\-copy\-to\-local
process is slower than using virt\-v2v directly, because it has to copy
unused parts of the guest disk.
.IP "\(bu" 4
You have a Xen guest using host block devices.  Virt\-v2v cannot
convert such guests directly.
.Sp
See \fBvirt\-v2v\-input\-xen\fR\|(1).
.SS "How this tool works"
.IX Subsection "How this tool works"
This tool uses libvirt to get the libvirt \s-1XML\s0 (metadata) of the remote
guest, essentially equivalent to running \f(CW\*(C`virsh dumpxml guest\*(C'\fR.
.PP
It then uses the \s-1XML\s0 to locate the remote guest disks, which are
copied over using a hypervisor-specific method.  It uses ssh for
remote Xen hypervisors.
.PP
It then modifies the libvirt \s-1XML\s0 so that it points at the local copies
of the guest disks.
.PP
The libvirt \s-1XML\s0 is output to a file called \fIguest.xml\fR (where
\&\fIguest\fR is the name of the guest).  The disk(s) are output to file(s)
called \fIguest\-disk1\fR, \fIguest\-disk2\fR and so on.
.PP
After copying the guest locally, you can convert it using:
.PP
.Vb 1
\& virt\-v2v \-i libvirtxml guest.xml [\-o options ...]
.Ve
.PP
Virt\-v2v finds the local copies of the disks by looking in the \s-1XML.\s0
.SH "EXAMPLES"
.IX Header "EXAMPLES"
.SS "Copy and convert from Xen hypervisor that uses host block devices"
.IX Subsection "Copy and convert from Xen hypervisor that uses host block devices"
For full instructions, see \fBvirt\-v2v\-input\-xen\fR\|(1).
.PP
.Vb 3
\& virt\-v2v\-copy\-to\-local \-ic xen+ssh://root@xen.example.com xen_guest
\& virt\-v2v \-i libvirtxml xen_guest.xml \-o local \-os /var/tmp
\& rm xen_guest.xml xen_guest\-disk*
.Ve
.SH "OPTIONS"
.IX Header "OPTIONS"
.IP "\fB\-\-help\fR" 4
.IX Item "--help"
Display help.
.IP "\fB\-ic\fR libvirtURI" 4
.IX Item "-ic libvirtURI"
Specify a libvirt connection \s-1URI\s0
.IP "\fB\-ip\fR file" 4
.IX Item "-ip file"
Instead of asking for password(s) interactively, pass the password
through a file.  Note the file should contain the whole password,
\&\fBwithout any trailing newline\fR, and for security the file should have
mode \f(CW0600\fR so that others cannot read it.
.Sp
Currently this option does not have any effect on xen+ssh transfers,
but that is a bug.
.IP "\fB\-q\fR" 4
.IX Item "-q"
.PD 0
.IP "\fB\-\-quiet\fR" 4
.IX Item "--quiet"
.PD
This disables progress bars and other unnecessary output.
.IP "\fB\-v\fR" 4
.IX Item "-v"
.PD 0
.IP "\fB\-\-verbose\fR" 4
.IX Item "--verbose"
.PD
Enable verbose messages for debugging.
.IP "\fB\-V\fR" 4
.IX Item "-V"
.PD 0
.IP "\fB\-\-version\fR" 4
.IX Item "--version"
.PD
Display version number and exit.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBvirt\-v2v\fR\|(1),
\&\fBvirsh\fR\|(1),
http://libguestfs.org/,
https://libvirt.org/uri.html,
https://libvirt.org/remote.html.
.SH "AUTHORS"
.IX Header "AUTHORS"
Richard W.M. Jones http://people.redhat.com/~rjones/
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (C) 2009\-2019 Red Hat Inc.
.SH "LICENSE"
.IX Header "LICENSE"
This program is free software; you can redistribute it and/or modify it
under the terms of the \s-1GNU\s0 General Public License as published by the
Free Software Foundation; either version 2 of the License, or (at your
option) any later version.
.PP
This program is distributed in the hope that it will be useful, but
\&\s-1WITHOUT ANY WARRANTY\s0; without even the implied warranty of
\&\s-1MERCHANTABILITY\s0 or \s-1FITNESS FOR A PARTICULAR PURPOSE.\s0  See the \s-1GNU\s0
General Public License for more details.
.PP
You should have received a copy of the \s-1GNU\s0 General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, \s-1MA 02110\-1301 USA.\s0
.SH "BUGS"
.IX Header "BUGS"
To get a list of bugs against libguestfs, use this link:
https://bugzilla.redhat.com/buglist.cgi?component=libguestfs&product=Virtualization+Tools
.PP
To report a new bug against libguestfs, use this link:
https://bugzilla.redhat.com/enter_bug.cgi?component=libguestfs&product=Virtualization+Tools
.PP
When reporting a bug, please supply:
.IP "\(bu" 4
The version of libguestfs.
.IP "\(bu" 4
Where you got libguestfs (eg. which Linux distro, compiled from source, etc)
.IP "\(bu" 4
Describe the bug accurately and give a way to reproduce it.
.IP "\(bu" 4
Run \fBlibguestfs\-test\-tool\fR\|(1) and paste the \fBcomplete, unedited\fR
output into the bug report.