Add static network configuration option and make <Back> work.
[virt-p2v.git] / virt-p2v.1
1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sh \" Subsection heading
6 .br
7 .if t .Sp
8 .ne 5
9 .PP
10 \fB\\$1\fR
11 .PP
12 ..
13 .de Sp \" Vertical space (when we can't use .PP)
14 .if t .sp .5v
15 .if n .sp
16 ..
17 .de Vb \" Begin verbatim text
18 .ft CW
19 .nf
20 .ne \\$1
21 ..
22 .de Ve \" End verbatim text
23 .ft R
24 .fi
25 ..
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<>.
32 .tr \(*W-|\(bv\*(Tr
33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
34 .ie n \{\
35 .    ds -- \(*W-
36 .    ds PI pi
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
39 .    ds L" ""
40 .    ds R" ""
41 .    ds C` ""
42 .    ds C' ""
43 'br\}
44 .el\{\
45 .    ds -- \|\(em\|
46 .    ds PI \(*p
47 .    ds L" ``
48 .    ds R" ''
49 'br\}
50 .\"
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.
55 .if \nF \{\
56 .    de IX
57 .    tm Index:\\$1\t\\n%\t"\\$2"
58 ..
59 .    nr % 0
60 .    rr F
61 .\}
62 .\"
63 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
64 .\" way too many mistakes in technical documents.
65 .hy 0
66 .if n .na
67 .\"
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
71 .if n \{\
72 .    ds #H 0
73 .    ds #V .8m
74 .    ds #F .3m
75 .    ds #[ \f1
76 .    ds #] \fP
77 .\}
78 .if t \{\
79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80 .    ds #V .6m
81 .    ds #F 0
82 .    ds #[ \&
83 .    ds #] \&
84 .\}
85 .    \" simple accents for nroff and troff
86 .if n \{\
87 .    ds ' \&
88 .    ds ` \&
89 .    ds ^ \&
90 .    ds , \&
91 .    ds ~ ~
92 .    ds /
93 .\}
94 .if t \{\
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'
101 .\}
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 \
117 \{\
118 .    ds : e
119 .    ds 8 ss
120 .    ds o a
121 .    ds d- d\h'-1'\(ga
122 .    ds D- D\h'-1'\(hy
123 .    ds th \o'bp'
124 .    ds Th \o'LP'
125 .    ds ae ae
126 .    ds Ae AE
127 .\}
128 .rm #[ #] #H #V #F C
129 .\" ========================================================================
130 .\"
131 .IX Title "VIRT-P2V 1"
132 .TH VIRT-P2V 1 "2008-02-04" "virt-p2v-0.9.1" "Virtualization Support"
133 .SH "NAME"
134 virt\-p2v \- P2V (physical to virtual machine) migration tool
135 .SH "SUMMARY"
136 .IX Header "SUMMARY"
137 virt\-p2v
138 .SH "DESCRIPTION"
139 .IX Header "DESCRIPTION"
140 virt\-p2v is a live \s-1CD\s0 for migrating physical machines to virtual
141 machine guests.
142 .PP
143 In the simplest mode of operation, you take a pre-built live \s-1CD\s0 \s-1ISO\s0
144 from the main website (<http://et.redhat.com/~rjones/virt\-p2v/>) and
145 burn it to a \s-1CD\-R\s0.  Then insert the CD-R into the physical machine
146 which must be migrated, reboot, and follow the on-screen instructions.
147 See \fB\s-1STANDARD\s0 \s-1USAGE\s0\fR section below.
148 .PP
149 You may also build a customized live \s-1CD\s0.  Typically this will contain
150 things like server details specific to your organization, so that the
151 live \s-1CD\s0 can run mostly or completely automatically.  See \fB\s-1BUILDING\s0 A
152 \&\s-1CUSTOM\s0 \s-1LIVE\s0 \s-1CD\s0\fR section below.
153 .PP
154 In both cases, files and disk images are transferred from the physical
155 machine over the network to the virtualization host machine over ssh.
156 Therefore \f(CW\*(C`sshd\*(C'\fR must be running on the virtualization host, and must
157 be accessible to that host.  See \fB\s-1SERVER\s0 \s-1REQUIREMENTS\s0\fR section below.
158 .PP
159 The \f(CW\*(C`virt\-p2v\*(C'\fR script must only be run from the live \s-1CD\s0.  It isn't
160 designed to run outside this environment and could do Bad Things to
161 your machine if you try it.  The script contains some checks to try to
162 stop you from doing this.
163 .PP
164 Virt\-p2v does not modify the physical machine, its disks,
165 configuration etc.
166 .SH "STANDARD USAGE"
167 .IX Header "STANDARD USAGE"
168 After booting the live \s-1CD\-R\s0, you are presented with a series of
169 questions.  This section explains each question.
170 .IP "Remote host" 4
171 .IX Item "Remote host"
172 Enter the name or \s-1IP\s0 address of the virtualization host.  This is the
173 host running Xen (or any other virtualization system supported by
174 libvirt, eg. \s-1QEMU\s0).  This host should be accessible on the network and
175 running an \s-1SSH\s0 daemon (\f(CW\*(C`sshd\*(C'\fR).
176 .IP "Remote port" 4
177 .IX Item "Remote port"
178 This is the port name or number of the \s-1SSH\s0 server on the remote host.
179 The default is \f(CW22\fR which is the standard \s-1SSH\s0 port.
180 .IP "Remote directory" 4
181 .IX Item "Remote directory"
182 Enter the directory on the remote host where disk image(s) and
183 configuration file(s) must reside.
184 .Sp
185 Note that if the remote host is running SELinux then you may not be
186 able to start a Xen guest unless its disk image(s) are located in the
187 default directory, \f(CW\*(C`/var/lib/xen/images\*(C'\fR.
188 .IP "Remote username" 4
189 .IX Item "Remote username"
190 Enter the remote \s-1SSH\s0 username to use to log in to the remote host.
191 .Sp
192 If you use the default username of \f(CW\*(C`root\*(C'\fR then you should ensure that
193 remote root logins are enabled on the remote host
194 (ie. \f(CW\*(C`PermitRootLogin yes\*(C'\fR in \f(CW\*(C`/etc/ssh/sshd_config\*(C'\fR).
195 .IP "Network configuration" 4
196 .IX Item "Network configuration"
197 Choose the way that the live \s-1CD\s0 configures network access.  The
198 current options are:
199 .RS 4
200 .IP "Automatic configuration" 4
201 .IX Item "Automatic configuration"
202 In this mode, the live \s-1CD\s0 attempts to reuse the network configuration
203 from the physical machine's root filesystem.  You should probably try
204 this method even though occasionally it does not work.
205 .IP "Configure from the shell" 4
206 .IX Item "Configure from the shell"
207 In this mode you will be dropped into a command shell and you will
208 need to issue the correct sequence of \f(CW\*(C`/sbin/ifconfig\*(C'\fR commands in
209 order to configure the network interface.
210 .Sp
211 A typical sequence of commands which should bring up the network
212 interface would be:
213 .Sp
214 .Vb 2
215 \& /sbin/ifconfig eth0 AA.BB.CC.DD
216 \& /sbin/route add default gw GG.HH.II.JJ eth0
217 .Ve
218 .Sp
219 where \f(CW\*(C`AA.BB.CC.DD\*(C'\fR is the \s-1IP\s0 address and \f(CW\*(C`GG.HH.II.JJ\*(C'\fR is the
220 gateway.
221 .RE
222 .RS 4
223 .RE
224 .IP "Devices" 4
225 .IX Item "Devices"
226 This question lists out all local block devices (hard disk drives and
227 similar) and asks you to choose which will be sent to the remote host.
228 You must send at least one block device.
229 .IP "Root device" 4
230 .IX Item "Root device"
231 This question lists out possible root filesystems and asks you to
232 choose the right one.  Choose the filesystem which would normally be
233 mounted as \f(CW\*(C`/\*(C'\fR on the system.
234 .Sp
235 Virt\-p2v performs some autodetection and is in most cases able to work
236 out which filesystems are possible root filesystems.  It displays what
237 it thinks is on each filesystem, but leaves it up to the user to make
238 a final decision.
239 .Sp
240 The root filesystem is critical because it contains \f(CW\*(C`/etc/fstab\*(C'\fR.
241 This is used during P2V both to determine how other filesystems are
242 normally mounted on the machine, and because this file and others
243 under \f(CW\*(C`/etc\*(C'\fR may need to be modified during P2V conversion.
244 .Sp
245 If the machine has more than one root filesystem (typically because
246 the machine is dual-booted with another operating system), then you
247 must choose only one of them to perform the P2V conversion on.
248 .IP "Hypervisor" 4
249 .IX Item "Hypervisor"
250 This question asks you to choose the hypervisor / virtualization
251 system in use on the remote host.
252 .Sp
253 If you select \fIXen\fR, \fI\s-1QEMU\s0\fR or \fI\s-1KVM\s0\fR then virt\-p2v will produce a
254 configuration file which is customized for the selected system.  If
255 you select \fIOther\fR then virt\-p2v will produce a generic configuration
256 file which will probably require hand-modification to work.
257 .Sp
258 See also <http://libvirt.org/format.html>.
259 .IP "Machine architecture" 4
260 .IX Item "Machine architecture"
261 This question asks you to choose the machine architecture.  Virt\-p2v
262 can normally detect this, so you should leave it as \fIAuto-detect\fR.
263 .IP "Memory" 4
264 .IX Item "Memory"
265 This question asks you to choose the amount of memory (\s-1RAM\s0) in
266 megabytes assigned to the virtual machine.
267 .Sp
268 If the entry is left blank, then virt\-p2v will try to autodetect how
269 much \s-1RAM\s0 is present in the physical machine and use that, and this is
270 probably a good choice for most simple migrations.
271 .IP "Virtual CPUs" 4
272 .IX Item "Virtual CPUs"
273 This question asks you to choose the number of virtual CPUs assigned
274 to the virtual machine.  Choosing \f(CW1\fR causes the virtual machine to
275 be uniprocessor, and choosing some number greater than 1 causes the
276 virtual machine to be \s-1SMP\s0.
277 .Sp
278 If the entry is left blank, then virt\-p2v will try to autodetect how
279 many \s-1CPU\s0 cores are present in the physical machine and use that, and
280 this is probably a good choice for most simple migrations.
281 .IP "\s-1MAC\s0 address" 4
282 .IX Item "MAC address"
283 Here you should enter a \s-1MAC\s0 address for the virtual machine's emulated
284 network card.  \s-1MAC\s0 addresses are written as \f(CW\*(C`aa:bb:cc:dd:ee:ff\*(C'\fR where
285 \&\f(CW\*(C`aa\*(C'\fR, \f(CW\*(C`bb\*(C'\fR etc are hexadecimal octets.
286 .Sp
287 Leaving it blank will cause virt\-p2v to choose a random \s-1MAC\s0 address
288 within the \f(CW\*(C`00:16:3e:..\*(C'\fR space reserved for Xen guests.  These \s-1MAC\s0
289 addresses are not tested for uniqueness so there is a very small
290 chance that they could coincide, which would leave a guest unable to
291 access the virtual network.
292 .IP "Verify and proceed" 4
293 .IX Item "Verify and proceed"
294 In this step you are asked to verify the settings above.  If any are
295 incorrect, use the \fIBack\fR button to navigate back to the setting.  If
296 all settings are correct, use the \fI\s-1OK\s0\fR button to begin the P2V
297 conversion.
298 .IP "Network autoconfiguration" 4
299 .IX Item "Network autoconfiguration"
300 If you selected network autoconfiguration above then virt\-p2v tries to
301 autoconfigure the network and ping the remote host.  It then asks
302 \&\fIDid automatic network configuration work?\fR
303 .Sp
304 You should answer \f(CW\*(C`y\*(C'\fR here if it worked.
305 .Sp
306 Answering \f(CW\*(C`n\*(C'\fR will drop you into a command shell.
307 .Sp
308 You can also switch to another virtual console if you need to perform
309 additional tests.  See section \fB\s-1GETTING\s0 A \s-1SHELL\s0\fR below.
310 .IP "\s-1SSH\s0 connection" 4
311 .IX Item "SSH connection"
312 Unless you have set up an \s-1SSH\s0 key, or the \s-1SSH\s0 server on the remote
313 host allows passwordless logins, then for each file that has to be
314 transferred to the remote host you will need to confirm the identity
315 of the remote host and/or enter a password.
316 .Sp
317 To understand more about this, please see the \fIssh\fR\|(1) manual page.
318 .Sh "\s-1BOOTING\s0 P2V \s-1GUEST\s0 \s-1ON\s0 \s-1VIRTUALIZATION\s0 \s-1HOST\s0"
319 .IX Subsection "BOOTING P2V GUEST ON VIRTUALIZATION HOST"
320 Once the P2V conversion has been completed, and assuming it was
321 successful, you will find a configuration file and one or more disk
322 images on the remote host.
323 .PP
324 The files will be located in the directory selected, usually
325 \&\f(CW\*(C`/var/lib/xen/images\*(C'\fR.  The names of the files are made up of:
326 .PP
327 \&\f(CW\*(C`p2v\-\f(CIhostname\f(CW\-\f(CI\s-1YYYYMMDDHHMM\s0\f(CW.conf\*(C'\fR or
328 \&\f(CW\*(C`p2v\-\f(CIhostname\f(CW\-\f(CI\s-1YYYYMMDDHHMM\s0\f(CW\-hd\f(CIX\f(CW.img\*(C'\fR
329 .PP
330 To simply start up the guest, use the following commands as root:
331 .PP
332 .Vb 2
333 \& virsh define p2v-foo-2008MMDDHHMM.conf
334 \& virsh start foo
335 .Ve
336 .PP
337 For \s-1QEMU/KVM\s0 do:
338 .PP
339 .Vb 2
340 \& virsh -c qemu:///system define p2v-foo-2008MMDDHHMM.conf
341 \& virsh -c qemu:///system start foo
342 .Ve
343 .PP
344 For other hypervisors you will need to edit the configuration file and
345 read <http://libvirt.org/uri.html>.
346 .SH "GETTING A SHELL"
347 .IX Header "GETTING A SHELL"
348 During all stages of P2V questions and conversion you can get a root
349 shell on the physical machine.  Use \fI\s-1ALT\s0\fR \fIF2\fR keys to switch to the
350 second virtual console, then log in as \fIroot\fR with no password.
351 .Sh "\s-1LOG\s0 \s-1FILE\s0"
352 .IX Subsection "LOG FILE"
353 Virt\-p2v writes a detailed log file to \f(CW\*(C`/tmp/virt\-p2v.log\*(C'\fR.  (Note
354 that this \f(CW\*(C`/tmp\*(C'\fR directory is a ramdisk on the live \s-1CD\s0, not the same
355 as the \f(CW\*(C`/tmp\*(C'\fR directory of the physical machine, and more importantly
356 it disappears when the machine is rebooted).
357 .PP
358 If you are reporting a bug, please always supply this file.
359 .SH "SERVER REQUIREMENTS"
360 .IX Header "SERVER REQUIREMENTS"
361 The virtualization host (remote host) must be running an \s-1SSH\s0 daemon
362 (\f(CW\*(C`sshd\*(C'\fR), accessible from the physical machine which is being
363 migrated.
364 .PP
365 Previous versions of virt\-p2v could use a special virt\-p2v server.
366 However this capability has been removed since there was practically
367 no benefit.
368 .SH "BUILDING A CUSTOM LIVE CD"
369 .IX Header "BUILDING A CUSTOM LIVE CD"
370 To build a custom live \s-1CD\s0 you must download the source for virt\-p2v
371 from <http://et.redhat.com/~rjones/virt\-p2v/> or from the Mercurial
372 source repository (see website for details).
373 .PP
374 Please read the \f(CW\*(C`README\*(C'\fR file to find the dependencies which are all
375 in Fedora &gt; 8 or \s-1EPEL\s0 &gt; 5.
376 .PP
377 The steps to creating a custom live \s-1CD\s0 are:
378 .ie n .IP "1. Edit ""virt\-p2v"" and adjust defaults" 4
379 .el .IP "1. Edit \f(CWvirt\-p2v\fR and adjust defaults" 4
380 .IX Item "1. Edit virt-p2v and adjust defaults"
381 Find the section \*(L"\s-1TO\s0 \s-1MAKE\s0 A \s-1CUSTOM\s0 virt\-p2v \s-1SCRIPT\s0 ...\*(R" which is near
382 to the top of this file.  Edit the defaults in this section as
383 detailed below.
384 .ie n .IP "2. ""virt\-p2v \-\-test"" to verify your changes" 4
385 .el .IP "2. \f(CWvirt\-p2v \-\-test\fR to verify your changes" 4
386 .IX Item "2. virt-p2v --test to verify your changes"
387 This command should not print anything at all.  If it prints any
388 message, then you will need to fix the error by going back to the
389 first step.
390 .ie n .IP "3. ""make build""\fR or \f(CW""make update"" to build a custom live \s-1CD\s0" 4
391 .el .IP "3. \f(CWmake build\fR or \f(CWmake update\fR to build a custom live \s-1CD\s0" 4
392 .IX Item "3. make build or make update to build a custom live CD"
393 \&\f(CW\*(C`make build\*(C'\fR will create a complete \s-1ISO\s0 from scratch.  \f(CW\*(C`make update\*(C'\fR
394 can be used to build a \*(L"quick\*(R" developer \s-1ISO\s0 by updating an existing
395 \&\s-1ISO\s0 image.  See section \fB\s-1ISO\s0 \s-1ATTACHMENTS\s0\fR below for more details.
396 .IP "4. Burn the \s-1ISO\s0 to a CD-R and test" 4
397 .IX Item "4. Burn the ISO to a CD-R and test"
398 .ie n .Sh "\s-1EDITING\s0 \s-1DEFAULTS\s0 \s-1IN\s0 \s-1THE\s0 ""virt\-p2v"" \s-1SCRIPT\s0"
399 .el .Sh "\s-1EDITING\s0 \s-1DEFAULTS\s0 \s-1IN\s0 \s-1THE\s0 \f(CWvirt\-p2v\fP \s-1SCRIPT\s0"
400 .IX Subsection "EDITING DEFAULTS IN THE virt-p2v SCRIPT"
401 For each default, setting it to \f(CW\*(C`None\*(C'\fR will ask the user.  All of the
402 defaults are set to \f(CW\*(C`None\*(C'\fR in the standard, uncustomized virt\-p2v
403 script, and so the standard script asks all the questions.
404 .PP
405 You may edit \f(CW\*(C`virt\-p2v\*(C'\fR and change the defaults, in which case the
406 user will not be questioned.  In this way you can make the script
407 partially or fully automated.
408 .PP
409 \&\fINote about OCaml code:\fR  \f(CW\*(C`None\*(C'\fR and \f(CW\*(C`Some foo\*(C'\fR are similar to the
410 concept of a \s-1NULL\s0 pointer versus non-NULL pointer in other languages.
411 This a variant type defined as:
412 .PP
413 type α option = None | Some of α
414 .ie n .IP """greeting""" 4
415 .el .IP "\f(CWgreeting\fR" 4
416 .IX Item "greeting"
417 If this is \f(CW\*(C`true\*(C'\fR then we wait for a keypress after boot and at a
418 couple of other stages.  If set to \f(CW\*(C`false\*(C'\fR then we try not to wait
419 for any keypresses (so more automated live CDs are possible).
420 .ie n .IP """remote_host""" 4
421 .el .IP "\f(CWremote_host\fR" 4
422 .IX Item "remote_host"
423 Set this to \f(CW\*(C`Some "hostname"\*(C'\fR or \f(CW\*(C`Some "IP\-address"\*(C'\fR to
424 provide the name of the remote host.
425 .ie n .IP """remote_port""" 4
426 .el .IP "\f(CWremote_port\fR" 4
427 .IX Item "remote_port"
428 Set this to \f(CW\*(C`Some port\*(C'\fR (eg. \f(CW\*(C`Some 22\*(C'\fR) to provide the port number
429 of the remote host's \s-1SSH\s0 daemon.
430 .ie n .IP """remote_directory""" 4
431 .el .IP "\f(CWremote_directory\fR" 4
432 .IX Item "remote_directory"
433 Set this to \f(CW\*(C`Some "path"\*(C'\fR (eg. \f(CW\*(C`Some "/var/lib/xen/images"\*(C'\fR) to
434 provide the directory where we update P2V converted images and
435 configuration files.
436 .ie n .IP """remote_username""" 4
437 .el .IP "\f(CWremote_username\fR" 4
438 .IX Item "remote_username"
439 Set this to \f(CW\*(C`Some "username"\*(C'\fR (eg. \f(CW\*(C`Some "root"\*(C'\fR) to provide the \s-1SSH\s0
440 username to use on the remote system.
441 .ie n .IP """devices_to_send""" 4
442 .el .IP "\f(CWdevices_to_send\fR" 4
443 .IX Item "devices_to_send"
444 Set this to a list of block devices to send to the remote system.
445 For example, \f(CW\*(C`Some ["sda"; "sdb"]\*(C'\fR.
446 .ie n .IP """root_filesystem""" 4
447 .el .IP "\f(CWroot_filesystem\fR" 4
448 .IX Item "root_filesystem"
449 Set this to the name of the root filesystem.
450 .Sp
451 For a disk partition (eg. \f(CW\*(C`/dev/sda1\*(C'\fR), use:
452 .Sp
453 .Vb 1
454 \& Some (Part ("sda", "1"))
455 .Ve
456 .Sp
457 For a logical volume (eg. \f(CW\*(C`/dev/VolGroup00/LogVol00\*(C'\fR), use:
458 .Sp
459 .Vb 1
460 \& Some (LV ("VolGroup00", "LogVol00"))
461 .Ve
462 .ie n .IP """network""" 4
463 .el .IP "\f(CWnetwork\fR" 4
464 .IX Item "network"
465 Set this to the choice for network setup.  Use either \f(CW\*(C`Some Auto\*(C'\fR or
466 \&\f(CW\*(C`Some Shell\*(C'\fR for auto-configuration or shell (manual) configuration
467 respectively.
468 .ie n .IP """hypervisor""" 4
469 .el .IP "\f(CWhypervisor\fR" 4
470 .IX Item "hypervisor"
471 Set this to the choice of hypervisor or virtualization system.  The
472 choices are: \f(CW\*(C`Some Xen\*(C'\fR, \f(CW\*(C`Some QEMU\*(C'\fR or \f(CW\*(C`Some KVM\*(C'\fR.
473 .ie n .IP """architecture""" 4
474 .el .IP "\f(CWarchitecture\fR" 4
475 .IX Item "architecture"
476 Set this to the architecture.  The choices are:
477 \&\f(CW\*(C`Some I386\*(C'\fR (i386 and up, 32 bit),
478 \&\f(CW\*(C`Some X86_64\*(C'\fR (\s-1AMD\s0 and Intel x86\-64, 64 bit),
479 \&\f(CW\*(C`Some IA64\*(C'\fR (Intel \s-1IA64\s0),
480 \&\f(CW\*(C`Some PPC\*(C'\fR (PowerPC, 32 bit),
481 \&\f(CW\*(C`Some PPC64\*(C'\fR (PowerPC, 64 bit),
482 \&\f(CW\*(C`Some SPARC\*(C'\fR (Sun \s-1SPARC\s0, 32 bit),
483 \&\f(CW\*(C`Some SPARC64\*(C'\fR (Sun \s-1SPARC\s0, 64 bit),
484 \&\f(CW\*(C`OtherArch "foo"\*(C'\fR (a hypothetical architecture called \fIfoo\fR), or
485 \&\f(CW\*(C`UnknownArch\*(C'\fR to auto-detect the architecture.
486 .ie n .IP """memory""" 4
487 .el .IP "\f(CWmemory\fR" 4
488 .IX Item "memory"
489 Set this to the size of memory in megabytes, eg. \f(CW\*(C`Some 256\*(C'\fR.  If you
490 set this to \f(CW\*(C`Some 0\*(C'\fR then virt\-p2v will try to autodetect the amount
491 of \s-1RAM\s0 installed on the physical machine.
492 .ie n .IP """vcpus""" 4
493 .el .IP "\f(CWvcpus\fR" 4
494 .IX Item "vcpus"
495 Set this to the number of virtual CPUs, eg. \f(CW\*(C`Some 1\*(C'\fR.  If you set
496 this to \f(CW\*(C`Some 0\*(C'\fR then virt\-p2v will try to autodetect the number of
497 \&\s-1CPU\s0 cores on the physical machine.
498 .ie n .IP """mac_address""" 4
499 .el .IP "\f(CWmac_address\fR" 4
500 .IX Item "mac_address"
501 Set this to the \s-1MAC\s0 address for the virtual network card, eg. \f(CW\*(C`Some
502 "aa:bb:cc:dd:ee:ff"\*(C'\fR.  If you set this to \f(CW\*(C`Some ""\*(C'\fR then virt\-p2v
503 will choose a random \s-1MAC\s0 address within the \f(CW\*(C`00:16:3e:..\*(C'\fR space
504 reserved for Xen guests.  These \s-1MAC\s0 addresses are not tested for
505 uniqueness so there is a very small chance that they could coincide,
506 which would leave a guest unable to access the virtual network.
507 .Sh "\s-1ISO\s0 \s-1ATTACHMENTS\s0"
508 .IX Subsection "ISO ATTACHMENTS"
509 Rebuilding a custom \s-1ISO\s0 is time\-consuming.  You can make a \*(L"quick\*(R"
510 developer \s-1ISO\s0 by updating an existing \s-1ISO\s0 image with a new custom
511 \&\f(CW\*(C`virt\-p2v\*(C'\fR script.  This is useful for testing purposes.
512 .PP
513 From the source directory, assuming that you have downloaded or
514 built an existing \f(CW\*(C`virt\-p2v\-*.iso\*(C'\fR, you can just do:
515 .PP
516 .Vb 1
517 \& make update
518 .Ve
519 .PP
520 or the equivalent manual command:
521 .PP
522 .Vb 1
523 \& ./iso-attach virt-p2v-VERSION.iso virt-p2v
524 .Ve
525 .SH "BOOTING FROM A USB KEY INSTEAD OF A CD"
526 .IX Header "BOOTING FROM A USB KEY INSTEAD OF A CD"
527 If you wish to boot from a \s-1USB\s0 keydrive, use the livecd-iso-to-disk
528 tool:
529 .PP
530 .Vb 1
531 \& livecd-iso-to-disk virt-p2v-$VERSION.iso /dev/sdX1
532 .Ve
533 .PP
534 (Replace /dev/sdX1 with the actual \s-1USB\s0 device).
535 .PP
536 In my experience I also had to set up a suitable \s-1MBR:\s0
537 .PP
538 .Vb 1
539 \& cat /usr/lib/syslinux/mbr.bin > /dev/sdX
540 .Ve
541 .SH "TESTING AN ISO UNDER QEMU OR KVM"
542 .IX Header "TESTING AN ISO UNDER QEMU OR KVM"
543 If you have a virtual guest running under \s-1QEMU\s0 or \s-1KVM\s0 then
544 you can test the P2V conversion process on the guest.
545 .PP
546 (Technically this is a V2V \*(-- virtual to virtual \*(-- conversion).
547 .PP
548 From the source directory do:
549 .PP
550 .Vb 1
551 \& make boot HDA=qemuimage.img
552 .Ve
553 .PP
554 where \f(CW\*(C`qemuimage.img\*(C'\fR is the name of the \s-1QEMU/KVM\s0 image.
555 .PP
556 You can also supply an \f(CW\*(C`HDB\*(C'\fR parameter to specify a second disk.
557 .SH "MAILING LIST"
558 .IX Header "MAILING LIST"
559 Please direct questions to the et-mgmt-tools mailing list
560 <http://www.redhat.com/mailman/listinfo/et\-mgmt\-tools>
561 <et\-mgmt\-tools @ redhat . com>
562 .SH "SEE ALSO"
563 .IX Header "SEE ALSO"
564 \&\fIvirsh\fR\|(1),
565 <http://www.libvirt.org/ocaml/>,
566 <http://www.libvirt.org/>,
567 <http://et.redhat.com/~rjones/>,
568 <http://caml.inria.fr/>
569 .SH "AUTHORS"
570 .IX Header "AUTHORS"
571 Richard W.M. Jones <rjones @ redhat . com>
572 .SH "COPYRIGHT"
573 .IX Header "COPYRIGHT"
574 (C) Copyright 2007\-2008 Red Hat Inc., Richard W.M. Jones
575 http://libvirt.org/
576 .PP
577 This program is free software; you can redistribute it and/or modify
578 it under the terms of the \s-1GNU\s0 General Public License as published by
579 the Free Software Foundation; either version 2 of the License, or
580 (at your option) any later version.
581 .PP
582 This program is distributed in the hope that it will be useful,
583 but \s-1WITHOUT\s0 \s-1ANY\s0 \s-1WARRANTY\s0; without even the implied warranty of
584 \&\s-1MERCHANTABILITY\s0 or \s-1FITNESS\s0 \s-1FOR\s0 A \s-1PARTICULAR\s0 \s-1PURPOSE\s0.  See the
585 \&\s-1GNU\s0 General Public License for more details.
586 .PP
587 You should have received a copy of the \s-1GNU\s0 General Public License
588 along with this program; if not, write to the Free Software
589 Foundation, Inc., 675 Mass Ave, Cambridge, \s-1MA\s0 02139, \s-1USA\s0.
590 .SH "REPORTING BUGS"
591 .IX Header "REPORTING BUGS"
592 Bugs can be viewed on the Red Hat Bugzilla page:
593 <https://bugzilla.redhat.com/>.
594 .PP
595 If you find a bug in virt\-p2v, please follow these steps to report it:
596 .IP "1. Check for existing bug reports" 4
597 .IX Item "1. Check for existing bug reports"
598 Go to <https://bugzilla.redhat.com/> and search for similar bugs.
599 Someone may already have reported the same bug, and they may even
600 have fixed it.
601 .IP "2. Capture debug and error messages" 4
602 .IX Item "2. Capture debug and error messages"
603 At the point where you get the error or unexpected behaviour,
604 go to the second virtual console (\fI\s-1ALT\s0\fR \fIF2\fR) and look at
605 the logfile \f(CW\*(C`/tmp/virt\-p2v.log\*(C'\fR.  Please make sure that
606 this file is attached to your bug report.
607 .IP "3. Get version of virt\-p2v" 4
608 .IX Item "3. Get version of virt-p2v"
609 The version is in the name of the \s-1ISO\s0.  If you have built a custom
610 virt\-p2v \s-1ISO\s0, please describe any changes that you have made.
611 .IP "4. Submit a bug report." 4
612 .IX Item "4. Submit a bug report."
613 Go to <https://bugzilla.redhat.com/> and enter a new bug.
614 Please describe the problem in as much detail as possible.
615 .Sp
616 Remember to include the version number (step 3) and to
617 attach the log file (step 2).
618 .IP "5. Assign the bug to rjones @ redhat.com" 4
619 .IX Item "5. Assign the bug to rjones @ redhat.com"
620 Assign or reassign the bug to \fBrjones @ redhat.com\fR (without the
621 spaces).  You can also send me an email with the bug number if you
622 want a faster response.