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-07" "virt-p2v-0.9.3" "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 "Ask for fixed \s-1IP\s0 address and gateway" 4
 206 .IX Item "Ask for fixed IP address and gateway"
 207 In this mode the live \s-1CD\s0 will ask you for a fixed \s-1IP\s0 address and
 208 gateway address, and will configure your chosen interface with these.
 209 .IP "Configure from the shell" 4
 210 .IX Item "Configure from the shell"
 211 In this mode you will be dropped into a command shell and you will
 212 need to issue the correct sequence of \f(CW\*(C`/sbin/ifconfig\*(C'\fR commands in
 213 order to configure the network interface.
 214 .Sp
 215 A typical sequence of commands which should bring up the network
 216 interface would be:
 217 .Sp
 218 .Vb 2
 219 \& /sbin/ifconfig eth0 AA.BB.CC.DD
 220 \& /sbin/route add default gw GG.HH.II.JJ eth0
 221 .Ve
 222 .Sp
 223 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
 224 gateway.
 225 .IP "\s-1QEMU\s0 user network" 4
 226 .IX Item "QEMU user network"
 227 This option configures the network for use inside a \s-1QEMU\s0 user network
 228 (<http://fabrice.bellard.free.fr/qemu/qemu\-doc.html#SEC30>).  It
 229 should only be used by developers.
 230 .RE
 231 .RS 4
 232 .RE
 233 .IP "Devices" 4
 234 .IX Item "Devices"
 235 This question lists out all local block devices (hard disk drives and
 236 similar) and asks you to choose which will be sent to the remote host.
 237 You must send at least one block device.
 238 .IP "Root device" 4
 239 .IX Item "Root device"
 240 This question lists out possible root filesystems and asks you to
 241 choose the right one.  Choose the filesystem which would normally be
 242 mounted as \f(CW\*(C`/\*(C'\fR on the system.
 243 .Sp
 244 Virt\-p2v performs some autodetection and is in most cases able to work
 245 out which filesystems are possible root filesystems.  It displays what
 246 it thinks is on each filesystem, but leaves it up to the user to make
 247 a final decision.
 248 .Sp
 249 The root filesystem is critical because it contains \f(CW\*(C`/etc/fstab\*(C'\fR.
 250 This is used during P2V both to determine how other filesystems are
 251 normally mounted on the machine, and because this file and others
 252 under \f(CW\*(C`/etc\*(C'\fR may need to be modified during P2V conversion.
 253 .Sp
 254 If the machine has more than one root filesystem (typically because
 255 the machine is dual-booted with another operating system), then you
 256 must choose only one of them to perform the P2V conversion on.
 257 .IP "Hypervisor" 4
 258 .IX Item "Hypervisor"
 259 This question asks you to choose the hypervisor / virtualization
 260 system in use on the remote host.
 261 .Sp
 262 If you select \fIXen\fR, \fI\s-1QEMU\s0\fR or \fI\s-1KVM\s0\fR then virt\-p2v will produce a
 263 configuration file which is customized for the selected system.  If
 264 you select \fIOther\fR then virt\-p2v will produce a generic configuration
 265 file which will probably require hand-modification to work.
 266 .Sp
 267 See also <http://libvirt.org/format.html>.
 268 .IP "Machine architecture" 4
 269 .IX Item "Machine architecture"
 270 This question asks you to choose the machine architecture.  Virt\-p2v
 271 can normally detect this, so you should leave it as \fIAuto-detect\fR.
 272 .IP "Memory" 4
 273 .IX Item "Memory"
 274 This question asks you to choose the amount of memory (\s-1RAM\s0) in
 275 megabytes assigned to the virtual machine.
 276 .Sp
 277 If the entry is left blank, then virt\-p2v will try to autodetect how
 278 much \s-1RAM\s0 is present in the physical machine and use that, and this is
 279 probably a good choice for most simple migrations.
 280 .IP "Virtual CPUs" 4
 281 .IX Item "Virtual CPUs"
 282 This question asks you to choose the number of virtual CPUs assigned
 283 to the virtual machine.  Choosing \f(CW1\fR causes the virtual machine to
 284 be uniprocessor, and choosing some number greater than 1 causes the
 285 virtual machine to be \s-1SMP\s0.
 286 .Sp
 287 If the entry is left blank, then virt\-p2v will try to autodetect how
 288 many \s-1CPU\s0 cores are present in the physical machine and use that, and
 289 this is probably a good choice for most simple migrations.
 290 .IP "\s-1MAC\s0 address" 4
 291 .IX Item "MAC address"
 292 Here you should enter a \s-1MAC\s0 address for the virtual machine's emulated
 293 network card.  \s-1MAC\s0 addresses are written as \f(CW\*(C`aa:bb:cc:dd:ee:ff\*(C'\fR where
 294 \&\f(CW\*(C`aa\*(C'\fR, \f(CW\*(C`bb\*(C'\fR etc are hexadecimal octets.
 295 .Sp
 296 Leaving it blank will cause virt\-p2v to choose a random \s-1MAC\s0 address
 297 within the \f(CW\*(C`00:16:3e:..\*(C'\fR space reserved for Xen guests.  These \s-1MAC\s0
 298 addresses are not tested for uniqueness so there is a very small
 299 chance that they could coincide, which would leave a guest unable to
 300 access the virtual network.
 301 .IP "Compression" 4
 302 .IX Item "Compression"
 303 Choose whether to enable or disable compression on disk images as they
 304 are copied across the network.
 305 .Sp
 306 If enabled, the \f(CW\*(C`\-C\*(C'\fR option is passed to \fIssh\fR\|(1).  On fast networks
 307 this can sometimes be slower.
 308 .Sp
 309 \&\s-1NB:\s0 The disk image is still stored uncompressed on the remote host
 310 however this option is set.
 311 .IP "Verify and proceed" 4
 312 .IX Item "Verify and proceed"
 313 In this step you are asked to verify the settings above.  If any are
 314 incorrect, use the \fIBack\fR button to navigate back to the setting.  If
 315 all settings are correct, use the \fI\s-1OK\s0\fR button to begin the P2V
 316 conversion.
 317 .IP "Network autoconfiguration" 4
 318 .IX Item "Network autoconfiguration"
 319 If you selected network autoconfiguration above then virt\-p2v tries to
 320 autoconfigure the network and ping the remote host.  It then asks
 321 \&\fIDid automatic network configuration work?\fR
 322 .Sp
 323 You should answer \f(CW\*(C`y\*(C'\fR here if it worked.
 324 .Sp
 325 Answering \f(CW\*(C`n\*(C'\fR will drop you into a command shell.
 326 .Sp
 327 You can also switch to another virtual console if you need to perform
 328 additional tests.  See section \fB\s-1GETTING\s0 A \s-1SHELL\s0\fR below.
 329 .IP "\s-1SSH\s0 connection" 4
 330 .IX Item "SSH connection"
 331 Unless you have set up an \s-1SSH\s0 key, or the \s-1SSH\s0 server on the remote
 332 host allows passwordless logins, then for each file that has to be
 333 transferred to the remote host you will need to confirm the identity
 334 of the remote host and/or enter a password.
 335 .Sp
 336 To understand more about this, please see the \fIssh\fR\|(1) manual page.
 337 .Sh "\s-1BOOTING\s0 P2V \s-1GUEST\s0 \s-1ON\s0 \s-1VIRTUALIZATION\s0 \s-1HOST\s0"
 338 .IX Subsection "BOOTING P2V GUEST ON VIRTUALIZATION HOST"
 339 Once the P2V conversion has been completed, and assuming it was
 340 successful, you will find a configuration file and one or more disk
 341 images on the remote host.
 342 .PP
 343 The files will be located in the directory selected, usually
 344 \&\f(CW\*(C`/var/lib/xen/images\*(C'\fR.  The names of the files are made up of:
 345 .PP
 346 \&\f(CW\*(C`p2v\-\f(CIhostname\f(CW\-\f(CI\s-1YYYYMMDDHHMM\s0\f(CW.conf\*(C'\fR or
 347 \&\f(CW\*(C`p2v\-\f(CIhostname\f(CW\-\f(CI\s-1YYYYMMDDHHMM\s0\f(CW\-hd\f(CIX\f(CW.img\*(C'\fR
 348 .PP
 349 To simply start up the guest, use the following commands as root:
 350 .PP
 351 .Vb 2
 352 \& virsh define p2v-foo-2008MMDDHHMM.conf
 353 \& virsh start foo
 354 .Ve
 355 .PP
 356 For \s-1QEMU/KVM\s0 do:
 357 .PP
 358 .Vb 2
 359 \& virsh -c qemu:///system define p2v-foo-2008MMDDHHMM.conf
 360 \& virsh -c qemu:///system start foo
 361 .Ve
 362 .PP
 363 For other hypervisors you will need to edit the configuration file and
 364 read <http://libvirt.org/uri.html>.
 365 .SH "GETTING A SHELL"
 366 .IX Header "GETTING A SHELL"
 367 During all stages of P2V questions and conversion you can get a root
 368 shell on the physical machine.  Use \fI\s-1ALT\s0\fR \fIF2\fR keys to switch to the
 369 second virtual console, then log in as \fIroot\fR with no password.
 370 .Sh "\s-1LOG\s0 \s-1FILE\s0"
 371 .IX Subsection "LOG FILE"
 372 Virt\-p2v writes a detailed log file to \f(CW\*(C`/tmp/virt\-p2v.log\*(C'\fR.  (Note
 373 that this \f(CW\*(C`/tmp\*(C'\fR directory is a ramdisk on the live \s-1CD\s0, not the same
 374 as the \f(CW\*(C`/tmp\*(C'\fR directory of the physical machine, and more importantly
 375 it disappears when the machine is rebooted).
 376 .PP
 377 If you are reporting a bug, please always supply this file.
 378 .SH "SERVER REQUIREMENTS"
 379 .IX Header "SERVER REQUIREMENTS"
 380 The virtualization host (remote host) must be running an \s-1SSH\s0 daemon
 381 (\f(CW\*(C`sshd\*(C'\fR), accessible from the physical machine which is being
 382 migrated.
 383 .PP
 384 Previous versions of virt\-p2v could use a special virt\-p2v server.
 385 However this capability has been removed since there was practically
 386 no benefit.
 387 .SH "BUILDING A CUSTOM LIVE CD"
 388 .IX Header "BUILDING A CUSTOM LIVE CD"
 389 To build a custom live \s-1CD\s0 you must download the source for virt\-p2v
 390 from <http://et.redhat.com/~rjones/virt\-p2v/> or from the Mercurial
 391 source repository (see website for details).
 392 .PP
 393 Please read the \f(CW\*(C`README\*(C'\fR file to find the dependencies which are all
 394 in Fedora &gt; 8 or \s-1EPEL\s0 &gt; 5.
 395 .PP
 396 The steps to creating a custom live \s-1CD\s0 are:
 397 .ie n .IP "1. Edit ""virt\-p2v"" and adjust defaults" 4
 398 .el .IP "1. Edit \f(CWvirt\-p2v\fR and adjust defaults" 4
 399 .IX Item "1. Edit virt-p2v and adjust defaults"
 400 Find the section \*(L"\s-1TO\s0 \s-1MAKE\s0 A \s-1CUSTOM\s0 virt\-p2v \s-1SCRIPT\s0 ...\*(R" which is near
 401 to the top of this file.  Edit the defaults in this section as
 402 detailed below.
 403 .ie n .IP "2. ""virt\-p2v \-\-test"" to verify your changes" 4
 404 .el .IP "2. \f(CWvirt\-p2v \-\-test\fR to verify your changes" 4
 405 .IX Item "2. virt-p2v --test to verify your changes"
 406 This command should not print anything at all.  If it prints any
 407 message, then you will need to fix the error by going back to the
 408 first step.
 409 .ie n .IP "3. ""make build""\fR or \f(CW""make update"" to build a custom live \s-1CD\s0" 4
 410 .el .IP "3. \f(CWmake build\fR or \f(CWmake update\fR to build a custom live \s-1CD\s0" 4
 411 .IX Item "3. make build or make update to build a custom live CD"
 412 \&\f(CW\*(C`make build\*(C'\fR will create a complete \s-1ISO\s0 from scratch.  \f(CW\*(C`make update\*(C'\fR
 413 can be used to build a \*(L"quick\*(R" developer \s-1ISO\s0 by updating an existing
 414 \&\s-1ISO\s0 image.  See section \fB\s-1ISO\s0 \s-1ATTACHMENTS\s0\fR below for more details.
 415 .IP "4. Burn the \s-1ISO\s0 to a CD-R and test" 4
 416 .IX Item "4. Burn the ISO to a CD-R and test"
 417 .ie n .Sh "\s-1EDITING\s0 \s-1DEFAULTS\s0 \s-1IN\s0 \s-1THE\s0 ""virt\-p2v"" \s-1SCRIPT\s0"
 418 .el .Sh "\s-1EDITING\s0 \s-1DEFAULTS\s0 \s-1IN\s0 \s-1THE\s0 \f(CWvirt\-p2v\fP \s-1SCRIPT\s0"
 419 .IX Subsection "EDITING DEFAULTS IN THE virt-p2v SCRIPT"
 420 For each default, setting it to \f(CW\*(C`None\*(C'\fR will ask the user.  All of the
 421 defaults are set to \f(CW\*(C`None\*(C'\fR in the standard, uncustomized virt\-p2v
 422 script, and so the standard script asks all the questions.
 423 .PP
 424 You may edit \f(CW\*(C`virt\-p2v\*(C'\fR and change the defaults, in which case the
 425 user will not be questioned.  In this way you can make the script
 426 partially or fully automated.
 427 .PP
 428 \&\fINote about OCaml code:\fR  \f(CW\*(C`None\*(C'\fR and \f(CW\*(C`Some foo\*(C'\fR are similar to the
 429 concept of a \s-1NULL\s0 pointer versus non-NULL pointer in other languages.
 430 This a variant type defined as:
 431 .PP
 432 type α option = None | Some of α
 433 .ie n .IP """greeting""" 4
 434 .el .IP "\f(CWgreeting\fR" 4
 435 .IX Item "greeting"
 436 If this is \f(CW\*(C`true\*(C'\fR then we wait for a keypress after boot and at a
 437 couple of other stages.  If set to \f(CW\*(C`false\*(C'\fR then we try not to wait
 438 for any keypresses (so more automated live CDs are possible).
 439 .ie n .IP """remote_host""" 4
 440 .el .IP "\f(CWremote_host\fR" 4
 441 .IX Item "remote_host"
 442 Set this to \f(CW\*(C`Some "hostname"\*(C'\fR or \f(CW\*(C`Some "IP\-address"\*(C'\fR to
 443 provide the name of the remote host.
 444 .ie n .IP """remote_port""" 4
 445 .el .IP "\f(CWremote_port\fR" 4
 446 .IX Item "remote_port"
 447 Set this to \f(CW\*(C`Some port\*(C'\fR (eg. \f(CW\*(C`Some 22\*(C'\fR) to provide the port number
 448 of the remote host's \s-1SSH\s0 daemon.
 449 .ie n .IP """remote_directory""" 4
 450 .el .IP "\f(CWremote_directory\fR" 4
 451 .IX Item "remote_directory"
 452 Set this to \f(CW\*(C`Some "path"\*(C'\fR (eg. \f(CW\*(C`Some "/var/lib/xen/images"\*(C'\fR) to
 453 provide the directory where we update P2V converted images and
 454 configuration files.
 455 .ie n .IP """remote_username""" 4
 456 .el .IP "\f(CWremote_username\fR" 4
 457 .IX Item "remote_username"
 458 Set this to \f(CW\*(C`Some "username"\*(C'\fR (eg. \f(CW\*(C`Some "root"\*(C'\fR) to provide the \s-1SSH\s0
 459 username to use on the remote system.
 460 .ie n .IP """devices_to_send""" 4
 461 .el .IP "\f(CWdevices_to_send\fR" 4
 462 .IX Item "devices_to_send"
 463 Set this to a list of block devices to send to the remote system.
 464 For example, \f(CW\*(C`Some ["sda"; "sdb"]\*(C'\fR.
 465 .ie n .IP """root_filesystem""" 4
 466 .el .IP "\f(CWroot_filesystem\fR" 4
 467 .IX Item "root_filesystem"
 468 Set this to the name of the root filesystem.
 469 .Sp
 470 For a disk partition (eg. \f(CW\*(C`/dev/sda1\*(C'\fR), use:
 471 .Sp
 472 .Vb 1
 473 \& Some (Part ("sda", "1"))
 474 .Ve
 475 .Sp
 476 For a logical volume (eg. \f(CW\*(C`/dev/VolGroup00/LogVol00\*(C'\fR), use:
 477 .Sp
 478 .Vb 1
 479 \& Some (LV ("VolGroup00", "LogVol00"))
 480 .Ve
 481 .ie n .IP """network""" 4
 482 .el .IP "\f(CWnetwork\fR" 4
 483 .IX Item "network"
 484 Set this to the choice for network setup.  Use one of:
 485 .RS 4
 486 .ie n .IP """Some Auto""" 4
 487 .el .IP "\f(CWSome Auto\fR" 4
 488 .IX Item "Some Auto"
 489 for auto-configuration
 490 .ie n .IP """Some Static""" 4
 491 .el .IP "\f(CWSome Static\fR" 4
 492 .IX Item "Some Static"
 493 to specify the interface, address, netmask and gateway statically
 494 .ie n .IP """Some Shell""" 4
 495 .el .IP "\f(CWSome Shell\fR" 4
 496 .IX Item "Some Shell"
 497 to launch a shell
 498 .ie n .IP """Some QEMUUserNet""" 4
 499 .el .IP "\f(CWSome QEMUUserNet\fR" 4
 500 .IX Item "Some QEMUUserNet"
 501 to use a \s-1QEMU\s0 user network (developers only)
 502 .RE
 503 .RS 4
 504 .RE
 505 .ie n .IP """static_network_config""" 4
 506 .el .IP "\f(CWstatic_network_config\fR" 4
 507 .IX Item "static_network_config"
 508 This setting only applies if \f(CW\*(C`network\*(C'\fR is set to \f(CW\*(C`Some Static\*(C'\fR,
 509 in which case you should set this to the static network settings,
 510 a tuple of (interface, address, netmask, gateway, nameserver):
 511 .Sp
 512 .Vb 1
 513 \& Some ("eth0", "192.168.2.5", "255.255.255.0", "192.168.2.1", "192.168.2.1")
 514 .Ve
 515 .ie n .IP """hypervisor""" 4
 516 .el .IP "\f(CWhypervisor\fR" 4
 517 .IX Item "hypervisor"
 518 Set this to the choice of hypervisor or virtualization system.  The
 519 choices are: \f(CW\*(C`Some Xen\*(C'\fR, \f(CW\*(C`Some QEMU\*(C'\fR or \f(CW\*(C`Some KVM\*(C'\fR.
 520 .ie n .IP """architecture""" 4
 521 .el .IP "\f(CWarchitecture\fR" 4
 522 .IX Item "architecture"
 523 Set this to the architecture.  The choices are:
 524 \&\f(CW\*(C`Some I386\*(C'\fR (i386 and up, 32 bit),
 525 \&\f(CW\*(C`Some X86_64\*(C'\fR (\s-1AMD\s0 and Intel x86\-64, 64 bit),
 526 \&\f(CW\*(C`Some IA64\*(C'\fR (Intel \s-1IA64\s0),
 527 \&\f(CW\*(C`Some PPC\*(C'\fR (PowerPC, 32 bit),
 528 \&\f(CW\*(C`Some PPC64\*(C'\fR (PowerPC, 64 bit),
 529 \&\f(CW\*(C`Some SPARC\*(C'\fR (Sun \s-1SPARC\s0, 32 bit),
 530 \&\f(CW\*(C`Some SPARC64\*(C'\fR (Sun \s-1SPARC\s0, 64 bit),
 531 \&\f(CW\*(C`OtherArch "foo"\*(C'\fR (a hypothetical architecture called \fIfoo\fR), or
 532 \&\f(CW\*(C`UnknownArch\*(C'\fR to auto-detect the architecture.
 533 .ie n .IP """memory""" 4
 534 .el .IP "\f(CWmemory\fR" 4
 535 .IX Item "memory"
 536 Set this to the size of memory in megabytes, eg. \f(CW\*(C`Some 256\*(C'\fR.  If you
 537 set this to \f(CW\*(C`Some 0\*(C'\fR then virt\-p2v will try to autodetect the amount
 538 of \s-1RAM\s0 installed on the physical machine.
 539 .ie n .IP """vcpus""" 4
 540 .el .IP "\f(CWvcpus\fR" 4
 541 .IX Item "vcpus"
 542 Set this to the number of virtual CPUs, eg. \f(CW\*(C`Some 1\*(C'\fR.  If you set
 543 this to \f(CW\*(C`Some 0\*(C'\fR then virt\-p2v will try to autodetect the number of
 544 \&\s-1CPU\s0 cores on the physical machine.
 545 .ie n .IP """mac_address""" 4
 546 .el .IP "\f(CWmac_address\fR" 4
 547 .IX Item "mac_address"
 548 Set this to the \s-1MAC\s0 address for the virtual network card, eg. \f(CW\*(C`Some
 549 "aa:bb:cc:dd:ee:ff"\*(C'\fR.  If you set this to \f(CW\*(C`Some ""\*(C'\fR then virt\-p2v
 550 will choose a random \s-1MAC\s0 address within the \f(CW\*(C`00:16:3e:..\*(C'\fR space
 551 reserved for Xen guests.  These \s-1MAC\s0 addresses are not tested for
 552 uniqueness so there is a very small chance that they could coincide,
 553 which would leave a guest unable to access the virtual network.
 554 .ie n .IP """compression""" 4
 555 .el .IP "\f(CWcompression\fR" 4
 556 .IX Item "compression"
 557 Set this to \f(CW\*(C`Some false\*(C'\fR to disable compression, or \f(CW\*(C`Some true\*(C'\fR to
 558 enable compression, or \f(CW\*(C`None\*(C'\fR to ask the user.
 559 .Sh "\s-1ISO\s0 \s-1ATTACHMENTS\s0"
 560 .IX Subsection "ISO ATTACHMENTS"
 561 Rebuilding a custom \s-1ISO\s0 is time\-consuming.  You can make a \*(L"quick\*(R"
 562 developer \s-1ISO\s0 by updating an existing \s-1ISO\s0 image with a new custom
 563 \&\f(CW\*(C`virt\-p2v\*(C'\fR script.  This is useful for testing purposes.
 564 .PP
 565 From the source directory, assuming that you have downloaded or
 566 built an existing \f(CW\*(C`virt\-p2v\-*.iso\*(C'\fR, you can just do:
 567 .PP
 568 .Vb 1
 569 \& make update
 570 .Ve
 571 .PP
 572 or the equivalent manual command:
 573 .PP
 574 .Vb 1
 575 \& ./iso-attach virt-p2v-VERSION.iso virt-p2v
 576 .Ve
 577 .SH "BOOTING FROM A USB KEY INSTEAD OF A CD"
 578 .IX Header "BOOTING FROM A USB KEY INSTEAD OF A CD"
 579 If you wish to boot from a \s-1USB\s0 keydrive, use the livecd-iso-to-disk
 580 tool:
 581 .PP
 582 .Vb 1
 583 \& livecd-iso-to-disk virt-p2v-$VERSION.iso /dev/sdX1
 584 .Ve
 585 .PP
 586 (Replace /dev/sdX1 with the actual \s-1USB\s0 device).
 587 .PP
 588 In my experience I also had to set up a suitable \s-1MBR:\s0
 589 .PP
 590 .Vb 1
 591 \& cat /usr/lib/syslinux/mbr.bin > /dev/sdX
 592 .Ve
 593 .SH "TESTING AN ISO UNDER QEMU OR KVM"
 594 .IX Header "TESTING AN ISO UNDER QEMU OR KVM"
 595 If you have a virtual guest running under \s-1QEMU\s0 or \s-1KVM\s0 then
 596 you can test the P2V conversion process on the guest.
 597 .PP
 598 (Technically this is a V2V \*(-- virtual to virtual \*(-- conversion).
 599 .PP
 600 From the source directory do:
 601 .PP
 602 .Vb 1
 603 \& make boot HDA=qemuimage.img
 604 .Ve
 605 .PP
 606 where \f(CW\*(C`qemuimage.img\*(C'\fR is the name of the \s-1QEMU/KVM\s0 image.
 607 .PP
 608 You can also supply an \f(CW\*(C`HDB\*(C'\fR parameter to specify a second disk.
 609 .SH "MAILING LIST"
 610 .IX Header "MAILING LIST"
 611 Please direct questions to the et-mgmt-tools mailing list
 612 <http://www.redhat.com/mailman/listinfo/et\-mgmt\-tools>
 613 <et\-mgmt\-tools @ redhat . com>
 614 .SH "SEE ALSO"
 615 .IX Header "SEE ALSO"
 616 \&\fIvirsh\fR\|(1),
 617 <http://www.libvirt.org/ocaml/>,
 618 <http://www.libvirt.org/>,
 619 <http://et.redhat.com/~rjones/>,
 620 <http://caml.inria.fr/>
 621 .SH "AUTHORS"
 622 .IX Header "AUTHORS"
 623 Richard W.M. Jones <rjones @ redhat . com>
 624 .SH "COPYRIGHT"
 625 .IX Header "COPYRIGHT"
 626 (C) Copyright 2007\-2008 Red Hat Inc., Richard W.M. Jones
 627 http://libvirt.org/
 628 .PP
 629 This program is free software; you can redistribute it and/or modify
 630 it under the terms of the \s-1GNU\s0 General Public License as published by
 631 the Free Software Foundation; either version 2 of the License, or
 632 (at your option) any later version.
 633 .PP
 634 This program is distributed in the hope that it will be useful,
 635 but \s-1WITHOUT\s0 \s-1ANY\s0 \s-1WARRANTY\s0; without even the implied warranty of
 636 \&\s-1MERCHANTABILITY\s0 or \s-1FITNESS\s0 \s-1FOR\s0 A \s-1PARTICULAR\s0 \s-1PURPOSE\s0.  See the
 637 \&\s-1GNU\s0 General Public License for more details.
 638 .PP
 639 You should have received a copy of the \s-1GNU\s0 General Public License
 640 along with this program; if not, write to the Free Software
 641 Foundation, Inc., 675 Mass Ave, Cambridge, \s-1MA\s0 02139, \s-1USA\s0.
 642 .SH "REPORTING BUGS"
 643 .IX Header "REPORTING BUGS"
 644 Bugs can be viewed on the Red Hat Bugzilla page:
 645 <https://bugzilla.redhat.com/>.
 646 .PP
 647 If you find a bug in virt\-p2v, please follow these steps to report it:
 648 .IP "1. Check for existing bug reports" 4
 649 .IX Item "1. Check for existing bug reports"
 650 Go to <https://bugzilla.redhat.com/> and search for similar bugs.
 651 Someone may already have reported the same bug, and they may even
 652 have fixed it.
 653 .IP "2. Capture debug and error messages" 4
 654 .IX Item "2. Capture debug and error messages"
 655 At the point where you get the error or unexpected behaviour,
 656 go to the second virtual console (\fI\s-1ALT\s0\fR \fIF2\fR) and look at
 657 the logfile \f(CW\*(C`/tmp/virt\-p2v.log\*(C'\fR.  Please make sure that
 658 this file is attached to your bug report.
 659 .IP "3. Get version of virt\-p2v" 4
 660 .IX Item "3. Get version of virt-p2v"
 661 The version is in the name of the \s-1ISO\s0.  If you have built a custom
 662 virt\-p2v \s-1ISO\s0, please describe any changes that you have made.
 663 .IP "4. Submit a bug report." 4
 664 .IX Item "4. Submit a bug report."
 665 Go to <https://bugzilla.redhat.com/> and enter a new bug.
 666 Please describe the problem in as much detail as possible.
 667 .Sp
 668 Remember to include the version number (step 3) and to
 669 attach the log file (step 2).
 670 .IP "5. Assign the bug to rjones @ redhat.com" 4
 671 .IX Item "5. Assign the bug to rjones @ redhat.com"
 672 Assign or reassign the bug to \fBrjones @ redhat.com\fR (without the
 673 spaces).  You can also send me an email with the bug number if you
 674 want a faster response.