1
.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
4
.\" ========================================================================
5
.de Sh \" Subsection heading
13
.de Sp \" Vertical space (when we can't use .PP)
17
.de Vb \" Begin verbatim text
22
.de Ve \" End verbatim text
26
.\" Set up some character translations and predefined strings. \*(-- will
27
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
28
.\" double quote, and \*(R" will give a right double quote. | will give a
29
.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
30
.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
31
.\" expand to `' in nroff, nothing in troff, for use with C<>.
33
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
37
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
51
.\" If the F register is turned on, we'll generate index entries on stderr for
52
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
53
.\" entries marked with X<> in POD. Of course, you'll have to process the
54
.\" output yourself in some meaningful fashion.
57
. tm Index:\\$1\t\\n%\t"\\$2"
63
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
64
.\" way too many mistakes in technical documents.
68
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69
.\" Fear. Run. Save yourself. No user-serviceable parts.
70
. \" fudge factors for nroff and troff
79
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
85
. \" simple accents for nroff and troff
95
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
96
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
97
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
98
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
99
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
100
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
102
. \" troff and (daisy-wheel) nroff accents
103
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
104
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
105
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
106
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
107
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
108
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
109
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
110
.ds ae a\h'-(\w'a'u*4/10)'e
111
.ds Ae A\h'-(\w'A'u*4/10)'E
112
. \" corrections for vroff
113
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
114
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
115
. \" for low resolution devices (crt and lpr)
116
.if \n(.H>23 .if \n(.V>19 \
129
.\" ========================================================================
131
.IX Title "VIRT-CLONE 1"
132
.TH VIRT-CLONE 1 "2007-11-20" "perl v5.8.8" "Virtual Machine Install Tools"
134
virt\-clone \- clone existing virtual machine images
136
.IX Header "SYNOPSIS"
137
\&\fBvirt-clone\fR [\s-1OPTION\s0]...
139
.IX Header "DESCRIPTION"
140
\&\fBvirt-clone\fR is a command line tool for cloning existing virtual machine
141
images using the \f(CW\*(C`libvirt\*(C'\fR hypervisor management library. It will copy
142
the disk images of any existing virtual machine, and define a new guest
143
with an identical virtual hardware configuration. Elements which require
144
uniqueness will be updated to avoid a clash between old and new guests.
146
Given suitable command line arguments, \f(CW\*(C`virt\-clone\*(C'\fR is capable of running
147
completely unattended, with the guest 'kickstarting' itself too. This allows
148
for easy automation of guest installs. A companion tool \f(CW\*(C`virt\-clone(1)\*(C'\fR is
149
provided for cloning pre-existing guests if their installation cannot be easily
150
automated from pristine media.
153
Any of the options can be omitted, in which case \f(CW\*(C`virt\-clone\*(C'\fR will run
154
interactively prompting for input as required.
155
.IP "\-h, \-\-help" 4
156
.IX Item "-h, --help"
157
Show the help message and exit
158
.IP "\-o \s-1ORIGINAL_GUEST\s0, \-\-original=ORIGINAL_GUEST" 4
159
.IX Item "-o ORIGINAL_GUEST, --original=ORIGINAL_GUEST"
160
Name or uuid for the original guest to be cloned. This guest must be shut
161
off since it is not possible to safely clone active guests at this time.
162
.IP "\-n \s-1NAME\s0, \-\-name=NAME" 4
163
.IX Item "-n NAME, --name=NAME"
164
Name of the new guest virtual machine instance. This must be unique amongst
165
all guests known to the hypervisor on this machine, including those not
166
currently active. To re-define an existing guest, use the \f(CWvirsh(1)\fR tool
167
to shut it down & delete it prior to running \f(CW\*(C`virt\-clone\*(C'\fR. This parameter
168
will be prompted for if omitted on the command line.
169
.IP "\-u \s-1UUID\s0, \-\-uuid=UUID" 4
170
.IX Item "-u UUID, --uuid=UUID"
171
\&\s-1UUID\s0 for the guest; if none is given a random \s-1UUID\s0 will be generated. If you
172
specify \s-1UUID\s0, you should use a 32\-digit hexadecimal number. \s-1UUID\s0 are intended
173
to be unique across the entire data center, and indeed world. Bear this in
174
mind if manually specifying a \s-1UUID\s0
175
.IP "\-f \s-1DISKFILE\s0, \-\-file=DISKFILE" 4
176
.IX Item "-f DISKFILE, --file=DISKFILE"
177
Path to the file, disk partition, or logical volume to use as the backing store
178
for the guest's virtual disk. If the original guest has multiple disks, this
179
parameter must be repeated multiple times, once per disk in the original virtual
181
.IP "\-m \s-1MAC\s0, \-\-mac=MAC" 4
182
.IX Item "-m MAC, --mac=MAC"
183
Fixed \s-1MAC\s0 address for the guest; If this parameter is omitted, or the value
184
\&\f(CW\*(C`RANDOM\*(C'\fR is specified a suitable address will be randomly generated. For
185
Xen virtual machines it is required that the first 3 pairs in the \s-1MAC\s0 address
186
be the sequence '00:16:3e', while for \s-1QEMU\s0 or \s-1KVM\s0 virtual machines it must
188
.IP "\-\-connect=CONNECT Connect to hypervisor with \s-1URI\s0" 4
189
.IX Item "--connect=CONNECT Connect to hypervisor with URI"
190
Connect to a non-default hypervisor. The default connection is chosen based
191
on the following rules:
195
If running on a host with the Xen kernel (checks against /proc/xen)
196
.IP "qemu:///system" 4
197
.IX Item "qemu:///system"
198
If running on a bare metal kernel as root
199
.IP "qemu:///session" 4
200
.IX Item "qemu:///session"
201
If running on a bare metal kernel as non-root
205
It is only necessary to provide the \f(CW\*(C`\-\-connect\*(C'\fR argument if this default
206
prioritization is incorrect, eg if wanting to use \s-1QEMU\s0 while on a Xen kernel.
208
.IP "\-d, \-\-debug" 4
209
.IX Item "-d, --debug"
210
Print debugging information to the terminal when running the install process.
211
The debugging information is also stored in \f(CW\*(C`$HOME/.virtinst/virt\-clone.log\*(C'\fR
212
even if this parameter is omitted.
214
.IX Header "EXAMPLES"
215
Clone the guest called \f(CW\*(C`demo\*(C'\fR which has a single disk to copy
219
\& --original demo \e
221
\& --file /var/lib/xen/images/newdemo.img
224
Clone a \s-1QEMU\s0 guest with multiple disks
228
\& --connect qemu:///system \e
229
\& --original demo \e
231
\& --file /var/lib/xen/images/newdemo.img \e
232
\& --file /var/lib/xen/images/newdata.img
235
Clone a guest to a physical device which is at least as big as the
236
original guests disks. If the destination device is bigger, the
237
new guest can do a filesystem resize when it boots.
241
\& --connect qemu:///system \e
243
\& --file /dev/HostVG/DemoVM \e
244
\& --mac 54:52:00:34:11:54
248
Written by Kazuki Mizushima, and a team of many other contributors. See the \s-1AUTHORS\s0
249
file in the source distribution for the complete list of credits.
252
Report bugs to the mailing list \f(CW\*(C`http://www.redhat.com/mailman/listinfo/et\-mgmt\-tools\*(C'\fR
253
or directly to BugZilla \f(CW\*(C`http://bugzilla.redhat.com/bugzilla/\*(C'\fR against the
254
\&\f(CW\*(C`Fedora\*(C'\fR product, and the \f(CW\*(C`python\-virtinst\*(C'\fR component.
256
.IX Header "COPYRIGHT"
257
Copyright (C) Fujitsu Limited 2007, and various contributors.
258
This is free software. You may redistribute copies of it under the terms of the \s-1GNU\s0 General
259
Public License \f(CW\*(C`http://www.gnu.org/licenses/gpl.html\*(C'\fR. There is \s-1NO\s0 \s-1WARRANTY\s0, to the extent
262
.IX Header "SEE ALSO"
263
\&\f(CWvirsh(1)\fR, \f(CW\*(C`virt\-install(1)\*(C'\fR, \f(CW\*(C`virt\-manager(1)\*(C'\fR, the project website \f(CW\*(C`http://virt\-manager.org\*(C'\fR
added
removed
man/en/virt-clone.1
