Professional Documents
Culture Documents
Citrix Xenconvert 2.4.1 Guide: Published November 2011 1.0 Edition
Citrix Xenconvert 2.4.1 Guide: Published November 2011 1.0 Edition
1 Guide
1.0 Edition
Legal Notices
XML-RPC.NET
Copyright 2001-2006 Charles Cook.
SharpZipLib
Copyright 2000-2007 IC#Code (webmaster@icsharpcode.net). SharpZipLib is released under the GPL with the
Classpath exception. To learn more about the GPL, please visit http://www.opensource.org/licenses/gpllicense.php.
Open Virtualization Format Schemas
All schemas sourced from schemas.dmtf.org: Copyright 2009 Distributed Management Task Force, Inc.
(DMTF). All rights reserved.
DMTF is a not-for-profit association of industry members dedicated to promoting enterprise and systems
management and interoperability. Members and non-members may reproduce DMTF specifications and
documents for uses consistent with this purpose, provided that correct attribution is given. As DMTF
specifications may be revised from time to time, the particular version and release date should always be noted.
Implementation of certain elements of this standard or proposed standard may be subject to third-party patent
rights, including provisional patent rights (herein "patent rights"). DMTF makes no representations to users of the
standard as to the existence of such rights, and is not responsible to recognize, disclose, or identify any or all such
third party patent right, owners or claimants, nor for any incomplete or inaccurate identification or disclosure of
such rights, owners or claimants. DMTF shall have no liability to any party, in any manner or circumstance, under
any legal theory whatsoever, for failure to recognize, disclose, or identify any such third-party patent rights, or for
such party's reliance on the standard or incorporation thereof in its product, protocols or testing procedures.
DMTF shall have no liability to any party implementing such standard, whether such implementation is
foreseeable or not, nor to any patent owner or claimant, and shall have no liability or responsibility for costs or
losses incurred if a standard is withdrawn or modified after publication, and shall be indemnified and held
harmless by any party implementing the standard from any and all claims of infringement by a patent owner for
such implementations.
Contents
Introduction ........................................................................................................................................................ 1
About This Document .................................................................................................................................. 1
About OVF ..................................................................................................................................................... 1
About VHD Format ...................................................................................................................................... 2
About This Release ........................................................................................................................................ 2
Whats New in 2.4.1 ................................................................................................................................... 2
Whats New in 2.4 ...................................................................................................................................... 2
Known Issues.............................................................................................................................................. 3
Known Limitations .................................................................................................................................... 3
System Requirements..................................................................................................................................... 3
Installing XenConvert ....................................................................................................................................... 5
Configuring XenConvert .................................................................................................................................. 6
Exclude a file from a conversion ................................................................................................................. 6
Change source and destination choices shown in the wizard.................................................................. 6
Align first partition in VHD ......................................................................................................................... 7
Change Windows free space requirement .................................................................................................. 7
Change virtual disk transfer type ................................................................................................................. 7
Using XenConvert ............................................................................................................................................. 9
Starting XenConvert ...................................................................................................................................... 9
Choosing a Conversion ............................................................................................................................... 10
Converting From the Host Machine ......................................................................................................... 10
Preparing the Host Machine ................................................................................................................... 11
Choosing Volumes ................................................................................................................................... 11
Converting the Host Machine to XenServer........................................................................................ 13
Converting the Host Machine to an OVF Package ............................................................................ 14
Converting the Host Machine to a VHD ............................................................................................. 15
Converting the Host Machine to Provisioning Services vDisk ......................................................... 16
Converting a Single Volume ....................................................................................................................... 16
Reviewing the results ................................................................................................................................... 17
Troubleshooting a Conversion ......................................................................................................................18
XenConvert failed to dismount VHD ...................................................................................................... 18
Probable Causes........................................................................................................................................ 18
Solutions .................................................................................................................................................... 18
XenConvert failed to discover volumes ................................................................................................... 19
Probable Causes........................................................................................................................................ 19
Solutions .................................................................................................................................................... 19
PVS Target Device Failed to Boot ............................................................................................................ 20
Solutions .................................................................................................................................................... 20
ii
Introduction
Citrix XenConvert is a physical-to-virtual (P2V) conversion tool that converts a workload from a
server or desktop machine running Windows to a virtual machine in XenServer, virtual appliance,
virtual disk, or virtual disk connected to Provisioning Services. A workload can contain a Windows
operating system, applications, and data.
XenConvert produces a virtual appliance in the Open Virtualization Format (OVF) that XenCenter
can import into XenServer. Refer to the XenCenter and XenServer documentation for information
about importing a virtual appliance into XenServer.
XenConvert produces a virtual disk in the Dynamic Virtual Hard Disk (VHD) format that is
compatible with XenServer and Provisioning Services. Refer to the XenCenter and XenServer
documentation about importing a VHD into XenServer. Refer to the Provisioning Services
documentation for information about importing a virtual disk into Provisioning Services.
About OVF
OVF is an open standard, specified by the Distributed Management Task Force (DMTF), for
packaging and distributing a virtual appliance consisting of one or more virtual machines.
An OVF Package is the set of files that comprise the virtual appliance. It always includes a
descriptor and can include a manifest, signature, disk images, and possibly other files specific to the
service. Storage locations include a simple file system directory, single file archive, or a web server.
An Open Virtual Appliance (OVA) is an OVF Package in a single file archive with the .ova
extension.
The descriptor always specifies the virtual hardware requirements of the service and can include
information such as descriptions of virtual disks, the service itself, and guest operating systems; a
license agreement; instructions to start and stop virtual machines in the appliance; and instructions
to install the service. Its file extension is .ovf.
The manifest allows the verification of the package contents by including the digests of other files.
Its file extension is .mf.
The signature allows the verification of the package author. It is the digest of the manifest signed
with the public key from the X.509 certificate included in the package. Its file extension is .cert.
OVF does not specify a disk image format. XenServer and XenConvert produce disk images in the
Dynamic VHD format. VMware products and Oracle VirtualBox produce virtual disks in the
Stream Optimized VMDK format.
For more information, refer to the Open Virtualization Format Specification.
Known Issues
68589 Japanese and Chinese characters do not render correctly in the field to change the
destination folder.
Known Limitations
Windows Disk Type XenConvert can only convert volumes from primary partitions on a disk
configured as a Windows Basic Disk not a Windows Dynamic Disk.
XenServer Connection XenConvert requires a direct connection to a XenServer to communicate
using HTTP. It cannot communicate through a HTTP proxy server. To work around this limitation,
disable the use of a HTTP proxy server on the XenConvert host.
Firmware Type XenConvert can only convert from a host machine with BIOS firmware not
Extensible Firmware Interface (EFI).
Disk Partition Type XenConvert can only convert a Windows System Volume from a disk with
MBR style partitions not GPT style.
Open Files XenConvert cannot copy a file in use by another application on Windows XP. To
ensure that a conversion includes a file, close that application before converting.
Domain Controller Citrix does not recommend using XenConvert to convert a Domain
Controller.
File System XenConvert only supports converting from a volume formatted with NTFS.
However, XenConvert does not reproduce the following NTFS features from the source volume on
the target volume.
Alternate Data Streams XenConvert can convert only the default data stream of a file and not any
named data streams.
Encryption XenConvert does not reproduce encryption.
System Requirements
Operating Systems
The x86 (32 bit) and x64 (64 bit) types of the following versions of Windows can be a source of a
conversion.
Windows 7
Windows Vista
Windows XP
.Net Framework
XenServer 6.0
XenServer 5.6 SP2
The following versions of XenServer can import an OVF Package created by this version of
XenConvert.
XenServer 6.0
Provisioning Services
The following versions of Provisioning Services can be the destination of a conversion and import a
VHD from this version of XenConvert.
Installing XenConvert
Download the XenConvert installer from the XenServer or Provisioning Services download pages
on www.citrix.com/downloads.
Install XenConvert on the machine that hosts the workload to convert.
1. Remove any other version of XenConvert.
2. Start the appropriate installer.
Open XenConvert_Install on an x86 (32 bit) type of operating system
Open XenConvert_Install_64 on an x64 (64 bit) type of operating system
Click Next.
3. Read the license agreement.
To print the license agreement, click Print.
To accept the license agreement and continue, click I accept the terms in the license
agreement and click Next.
To reject the license agreement and cancel, click I do not accept the terms in the
license agreement and click Cancel.
4. Accept or change the installation folder.
To accept the default installation folder, click Next.
To change the installation folder, click Change.
5. Click Install.
6. Click Finish.
To remove XenConvert from Windows XP and Windows Server 2003:
1. Open the Control Panel.
2. Open Add or Remove Programs.
3. Select Citrix XenConvert.
4. Click Remove.
To remove XenConvert from Windows Vista, Windows Server 2008, Windows 7, and Windows
Server 2008 R2:
1. Open the Control Panel.
2. Open Programs and Features.
3. Select Citrix XenConvert.
4. Click Uninstall.
Configuring XenConvert
Change the default behavior of XenConvert by changing its configuration files XenConvert.ini or
XenConvert.exe.config.
XenConvert.ini
XenConvert.ini resides in the installation folder, has the format of an INI file commonly used in
Windows, and can contain the sections named exclude, mode, and parameters. Start a section by
adding a line with the section name inside square brackets as shown in the examples below.
[exclude]
[parameters]
XenConvert.exe.config
XenConvert.exe.config resides in the installation folder, has the XML format, and contains the
applicationSettings section for XenConvert.
To use iSCSI, change the setting named TransferType to iSCSI as shown in the example below.
<setting name="TransferType" serializeAs="String">
<!-- Default virtual disk transfer method to RawVDI. -->
<value>iSCSI</value>
</setting>
To assign the IP address dynamically, set NetworkSettings to DHCP as shown in the example
below.
<TransferVM>
<add key="NetworkSettings" value="DHCP" />
</TransferVM>
To assign the IP address statically, set NetworkSettings to Manual followed by the static IP
address, network mask, and default gateway as shown in the example below.
<TransferVM>
<add key="NetworkSettings" value="Manual 10.1.1.99
10.1.1.1" />
</TransferVM>
255.255.255.0
Using XenConvert
Using XenConvert involves the following steps.
1. Starting XenConvert
2. Choosing a Conversion
3. Converting
4. Reviewing the results
Starting XenConvert
Log in to an administrator account with the following security privileges.
XenConvert can run in attended mode with a graphical user interface to guide the user through the
conversion steps or in unattended mode with a command line interface.
To start XenConvert in attended mode, open the Windows Start menu and click All Programs,
Citrix, and XenConvert. Note that only one instance of XenConvert can run at once in attended
mode.
To start XenConvert in unattended mode, open a console shell and enter the XenConvert
application name, conversion name, parameters, and any options in the order shown below.
start /b /wait XenConvert <Conversion Name> <Parameters> <Options>
More instructions are available in the help associated with XenConvert. To access the help, enter the
following command line.
XenConvert /?
Even though more than one instance of XenConvert can run at once in unattended mode, it is
impractical because of the use of volume snapshots.
To convert a workload that can stream to either a physical machine or virtual machine, install the
Provisioning Services Target Device software before starting XenConvert.
Choosing a Conversion
A conversion has a source and a destination. Choose the source first because the destination choices
depend on the source. Use the following table as a guide for choosing a source.
Choose
To
This Machine
Volume
The following sections describe the conversions, organized by source, in more detail.
To...
XenServer
OVF Package
VHD
Provisioning
Services vDisk
Converting to any destination other than Provisioning Services vDisk requires sufficient disk space
for a workspace to store intermediate files. For best performance and reliability, choose a local hard
disk that has the fastest interface, does not include the source volumes, and is not a network drive.
All conversions have the following steps in common.
10
Choosing Volumes
Verify adequate free space exists on the destination, which is approximately 101% of used
space of all source volumes.
Remove any network interface teams because it is not applicable to a virtual machine.
Choosing Volumes
Converting from a host machine involves copying selected volumes from the host machine to the
virtual disk that XenConvert creates. A source volume refers to a volume to copy. A destination volume
refers to the copy of the source volume on the virtual disk.
The following table describes the parts of the dialog for selecting a source volume.
Source Volume
Used Space
Free Space
Capacity
File System
The following table describes the parts of the dialog for resizing a destination volume.
Destination
Volume
Used Space
Capacity
File System
The following table describes the parts of the dialog for resizing the virtual disk that XenConvert
creates when the destination is not a Provisioning Services vDisk.
Allocated Space
Unallocated Space
Capacity
The following table describes the parts of the dialog for the virtual disk when the destination is a
Provisioning Services vDisk.
Allocated Space
Unallocated Space
Capacity
12
For each volume that XenConvert creates on a virtual disk, some versions of
Windows display a dialog asking to format the volume. Please cancel this dialog
because XenConvert automatically formats the volume.
Start XenConvert.
2.
3.
To Choose XenServer.
4.
Click Next.
5.
Choose source volumes, resize destination volumes, and resize the virtual disk as
described in Choosing Volumes.
6.
Click Next.
7.
Identify the XenServer to receive the workload and the account to use.
Hostname
User name
Password
Workspace
8.
Click Next.
9.
VM Name Enter a different name to change the name of the virtual machine on
XenServer.
10.
13
11.
Click Next.
12.
Log names of converted files Check this box to log the name of each converted file.
Uncheck this box otherwise.
Note Logging the names of converted files significantly increases the conversion
time.
13.
Click Convert.
The conversion is complete when the progress bar is full and Status contains a message
indicating success or failure.
14.
15.
Click Finish.
Start XenConvert.
2.
3.
4.
Click Next.
5.
Choose source volumes, resize destination volumes, and resize the virtual disk as
described in Choosing Volumes.
6.
Click Next.
7.
Please choose a folder to store the Open Virtualization Format (OVF) Package
Enter the path of the folder or click Browse to navigate to it or create it.
8.
Optionally choose a EULA to include in the OVF Package Enter the path of file
that contains an end user license agreement or click Browse to navigate to it.
Note: The file must be in plain or rich text format.
9.
Create Open Virtual Appliance (OVA) Check this box to store the OVF Package as
a single file. Uncheck this box to store the OVF Package as files in a folder.
10.
Compress Open Virtual Appliance (OVA) Check this box to reduce the size of the
OVA. Uncheck this box to keep the original size of the OVA.
Note Compressing an OVF Package increases the time to create and read it.
11.
Encrypt Check this box to conceal the OVF Package contents. Uncheck this box to
allow anyone to read the OVF Package.
Note Encrypting an OVF Package increases the time to create and read it.
Passphrase Enter a passphrase.
Confirm Enter the same passphrase again.
12.
Sign with certificate Check this box to identify the author of the OVF Package.
Uncheck this box otherwise.
14
File Enter the path of the certificate file or click File to navigate to it.
Passphrase Enter the passphrase for the certificate.
Click View to see the certificate.
13.
Click Next.
14.
VM Name Enter a different name to change the name to assign the workload in
XenServer.
15.
Click Next.
16.
Log names of converted files Check this box to log the name of each converted file.
Uncheck this box otherwise.
Note Logging the names of converted files significantly increases the conversion
time.
17.
Click Convert.
The conversion is complete when the progress bar is full and the Status contains a
message indicating success or failure.
18.
19.
Click Finish.
Start XenConvert.
2.
3.
4.
Click Next.
5.
Choose source volumes, resize destination volumes, and resize the virtual disk as
described in Choosing Volumes.
6.
Click Next.
7.
Please choose a folder to store the XenServer Virtual Hard Disk (VHD) Enter
the path of the folder or click Browse to navigate to it or create it.
8.
Click Next.
9.
VM Name Enter a different name to change the name to assign the workload in
XenServer.
10.
Click Next.
11.
Log names of converted files Check this box to log the name of each converted file.
Uncheck this box otherwise.
Note Logging the names of converted files significantly increases the conversion
time.
12.
Click Convert.
15
The conversion is complete when the progress bar is full and the Status contains a
message indicating success or failure.
13.
14.
Click Finish.
Start XenConvert.
2.
3.
4.
Click Next.
5.
6.
Click Next.
7.
Log names of converted files Check this box to log the name of each converted file.
Uncheck this box otherwise.
Note Logging the names of converted files significantly increases the conversion
time.
8.
Click Convert.
The conversion is complete when the progress bar is full and the Status contains a
message indicating success or failure.
9.
10.
Click Finish.
Start XenConvert.
2.
3.
To Choose Volume.
4.
Click Next.
5.
6.
7.
Click Next.
8.
Log names of converted files Check this box to log the name of each converted file.
Uncheck this box otherwise.
Note Logging the names of converted files significantly increases the conversion
time.
16
9.
Click Convert.
The conversion is complete when the progress bar is full and the Status contains a
message indicating success or failure.
10.
11.
Click Finish.
17
Troubleshooting a Conversion
Some features of Windows and other software can interfere with a conversion.
The following sections identify the most common problems, identify the probable causes, and
suggest solutions. Note that there can be more than one cause of and solution to a problem.
Probable Causes
XenConvert was unable to disable Autoplay automatically and Autoplay opened a file on the
VHD
Solutions
Wait longer for a VHD to dismount
The actual time for a VHD to dismount on the host machine can vary. XenConvert usually waits for
60 seconds for a VHD to dismount before retrying. To wait longer, assign a larger value to
AutoDismountTimeoutAsMs in the parameters section as shown in the example below.
[parameters]
AutoDismountTimeoutAsMs=70000
The OVF Package and VHD are still valid. It is not necessary to repeat the conversion but it is
necessary to dismount the VHD properly as follows.
Close Autoplay and any application that it opened so that the VHD can dismount.
Dismount the VHD manually as follows.
1. Open a command prompt.
2. Change to the XenConvert installation folder (e.g. C:\Program Files\Citrix\XenConvert).
3. Run the following command to dismount all XenConvert VHDs.
cvhdmount u 0
18
If the conversion was to a XenServer VM, the intermediate OVF Package did not import into
XenServer. To import the intermediate OVF Package manually, copy it to a XenCenter 6.0 host, run
the XenCenter 6.0 Import wizard, and choose the OVF Package.
Disable Windows AutoPlay
Prevent Windows AutoPlay from interfering with subsequent conversions by disabling it. Since the
procedure varies by Windows version, please refer to the Microsoft article for details: Article ID:
967715 - Last Review: May 6, 2009 - Revision: 3.0, How to disable the autorun functionality in Windows.
Stop the Anti-Virus Service
Probable Causes
Windows Automount feature was disabled. The Enterprise editions of Windows Server
2003, Windows Server 2008, and Windows Server 2008 R2 disable this feature by default.
Network drive connects to next available drive letter that Windows would assign to the new
volumes on the VHD
Solutions
Wait longer for VHD to come online
The actual time for a VHD to come online on the host machine can vary. XenConvert usually waits
for 10 minutes for a VHD to come online. To wait longer, assign a larger value to
VhdPluginTimeoutAsMs in the parameters section as shown in the example below.
[parameters]
VhdPluginTimeoutAsMs=700000
19
Disconnect the network drive or connect it to another drive letter and retry the conversion.
Solutions
Decrease PartitionOffsetBase
Add the parameter named PartitionOffsetBase to XenConvert.ini or change its value as shown
below.
[parameters]
PartitionOffsetBase=258048
Repeat the conversion.
20