There are no new features in version 4.1 of the OVF Tool.
You can not use the OVF Tool to deploy a VM to static DVS port group.
To work around this issue:
The OVF Tools supports the following operating systems and software.
Supported Operating Systems include:
The OVF Tool supports the following Windows 32-bit (x86) and 64-bit (x86_64) operating systems:
The OVF Tool supports the following Linux operating systems:
The OVF Tool supports the following Mac OS X 64 bit operating systems:
Version 4.1 of the OVF Tool supports the following VMware software:
OVF support is built into the vSphere Client that installs from, and is compatible with vCenter 5.0 and ESXi 5.0, vCenter 4.0 and ESX 4.0. It is also built into the vSphere Client that installs from and is compatible with VirtualCenter 2.5 and later, and ESX 3.5 and later. The vSphere 5.1 Web Client includes the 3.x version of the VMware OVF Tool as part of the Client Integration Plug-in.
A virtual machine is stored as a set of files on disk. In the VMware runtime format, these files have extensions .vmx, .vmdk, .vmsd, .vmxf, and .nvram. The VMware hypervisor requires these file formats, which are optimized for efficient execution. An ESXi host often uses fully allocated flat disks in a VMFS file system to optimize virtual machine performance.
The OVF standard supports efficient, secure distribution of vApps and virtual machine templates. OVF is optimized for these goals, rather than for efficient runtime execution. OVF does not include specific information on runtime disk format because such information is not required until the virtual machine is deployed. When you package appliances with OVF, you can optimize one vApp for high performance in a production environment, and optimize another for minimal storage space during evaluation.
The following table contrasts a virtual machine in VMware file format with a virtual machine in OVF format. OVF employs a compressed sparse format for VMDK files. Virtual disks in that format cannot be used directly for execution without conversion.
VMware Format | OVF Format | OVA Format | |
---|---|---|---|
Files | |
|
LinuxBasedAppliance.ova |
Total Size | |
132MB | 132MB |
Operating System | Download Filename |
---|---|
Linux 32 bit | VMware-ovftool-4.1.0-10936-lin.i386.bundle |
Linux 64 bit | VMware-ovftool-4.1.0-10936-lin.x86_64.bundle |
Mac OS X 64 bit | VMware-ovftool-4.1.0-10936-mac.x64.dmg |
Windows 32 bit | VMware-ovftool-4.1.0-10936-win.i386.msi |
Windows 64 bit | VMware-ovftool-4.1.0-10936-win.x86_64.msi |
Operating System | Download Filename |
---|---|
Linux 32 bit | Run the shell script as ./VMware-ovftool-4.1.0-10936-lin.i386.bundle |
Linux 64 bit | Run the shell script as ./VMware-ovftool-4.1.0-10936-lin.x86_64.bundle |
Mac OS X 64 bit | Open the .dmg file and double-click the package installer.VMware-ovftool-4.1.0-10936-mac.x64.dmg |
Windows 32 bit | Double-click on the installation file, VMware-ovftool-4.1.0-10936-win.i386.msi |
Windows 64 bit | Double-click on the installation file, VMware-ovftool-4.1.0-10936-win.x86_64.msi |
The following list gives you screen-by-screen instructions for all installations:
After installing the OVF Tool on Windows, you can run the OVF Tool from the Windows command line.
cmd
, which opens the Windows command line console (DOS prompt).If you have the OVF Tool folder in your Path environment variable, you can run the OVF Tool from the command line.
The following instructions are for Windows 7, but the steps are similar on other Windows systems.
The OVF Tool allows you to specify an inventory path for a source or target.
You can specify an inventory path to a specific virtual machine.
The following example shows an inventory path to a virtual machine without any folders:MyDatacenter/vm/MyVM
The following example shows an inventory path with two nested folders: MyDatacenter/vm/Folder 1/Sub Folder/MyVM
The use of the vm tag after the datacenter name specifies that you are locating a virtual machine or vApp in the VM and Template view. Use the host tag after the datacenter name if you are locating a virtual machine or vApp in the Host and Clusters view.
You can specify an inventory path for a host or a resource pool. You can nest resource pools similar to folders.
To specify an inventory path for a host or a resource pool as part of target locators, use the following syntax:/host//Resources/
Using the example above, the following rules apply:
host
is a fixed part of the pathResources
is a fixed part of the path, but is only specified when using a resource pool<resource pool>
can take the value of one or more nested resource pools. If no resource pools are specified, the default resource pool for the host is used.You must specify the /host/
section of an inventory path when using a vi destination locator. If you are specifying the destination of a resource pool, you must include the/Resources/
section of the path.
The following example is of an inventory path without a specified resource pool:vi://username:pass@localhost/my_datacenter/host/esx01.example.com
The following example is of an inventory path with a specified resource pool: vi://username:pass@localhost/my_datacenter/host/esx01.example.com/Resources/my_resourcepool
When using the OVF Tool, it is often not necessary to specify source and target types as long as certain filename conventions are used. It is possible to the ignore locator type and specify the source and target explicitly using the arguments--sourceType=...
and
--targetType=
.
The OVF Tool assumes the locator type based on the following rules:
vcloud://
, OVF Tool assumes vCloud Director type.vi://
, OVF Tool assumes vSphere type..ovf
, OVF Tool assumes OVF type..vmx
, OVF Tool assumes VMX type..ova
, the OVF tool assumes OVA type.Similarly, source and target types can be inferred from folder locators. OVF Tool assumes the type according the following rules:
my-ovf/my-ovf.ovf
.MyVirtualMachines/
, the OVF Tool assumes that the target is a VMX locator. The resulting VMX/VMDK file is added to in a directory with the target name, for example,MyVirtualMachines/MyVM/MyVM.vmx
.OVF Tool supports partial vSphere locators when deploying or exporting. For an incomplete locator path, the tool suggests completions at the command line. The following example shows the command-line dialog when partial locators are used.
Example 1 - Partial VMware Locators on the Command Line
> ovftool LAMP.ovf vi://localhost/ Opening source: LAMP.ovf Opening target: vi://user@localhost/ Error: Found wrong kind of object (Folder) Possible completions are: Datacenter/ Remote Datacenter/ Secondary Datacenter/ > ovftool LAMP.ovf vi://localhost/Datacenter Opening source: LAMP.ovf Opening target: vi://user@localhost/Datacenter Error: Found wrong kind of object (Datacenter) Possible completions are: vm/ host/ > ovftool LAMP.ovf vi://localhost/Datacenter/host Opening source: LAMP.ovf Opening target: vi://user@localhost/Datacenter/host Error: Found wrong kind of object (Folder) Possible completions are: host1.foo.com/ host2.foo.com/ > ovftool LAMP.ovf vi://localhost/Datacenter/vm/host1.foo.com
The OVF Tool supports partial vSphere locators when deploying or exporting. For an incomplete locator path, the tool suggests completions at the command line. Example 2 shows the command-line dialog when partial locators are used. First, the OVF Tool signals that there is more than one virtual datacenter present, then multiple catalogs, then multiple networks. At each attempt, you must select one of the options that the OVF Tool presents.
Example 2 - Partial vCloud Director Locators on the Command Line
ovftool LAMP.ovf vcloud://jd:[email protected]:443/?org=myOrg&vapp=test1 Opening OVF source: LAMP.ovf Warning: No manifest file Opening vCloud target: vcloud://js:[email protected]:443/ Error: Multiple VDCs found. Possible VDC completions are: orgVdc orgVdc2 Completed with errors ovftool LAMP.ovf "vcloud://jd:[email protected]:443/?org=myOrg&vapp=test1&vdc=orgVdc" Opening OVF source: LAMP.ovf Warning: No manifest file Opening vCloud target: vcloud://js:[email protected]:443/ Error: Multiple catalogs found. Possible catalog completions are: catalog catalog2 Completed with errors "vcloud://jd:[email protected]:443/?org=myOrg&vapp=test1&vdc=orgVdc&catalog=catalog" Opening OVF source: LAMP.ovf Warning: No manifest file Opening vCloud target: vcloud://js:[email protected]:443/ Error: Multiple networks found on target. Possible completions are: extNet2 extOrgNet intNet2 intnet Completed with errors ovftool --net:"VM Network=intnet" LAMP.ovf "vcloud://jd:[email protected]:443/ ?org=myOrg&vapp=test1&vdc=orgVdc&catalog=catalog" Opening OVF source: LAMP.ovf Warning: No manifest file Opening vCloud target: vcloud://js:[email protected]:443/ Deploying to vCloud: vcloud://js:[email protected]:443/ Disk Transfer Complete Completed successfully
For more information and examples about partial locators, see the “Partial Locators” section of the OVF Tool User's Guide.
The OVF Tool has many configuration options. You can create a configuration file, so that you don't have to type long configuration entries on the command line. A configuration file uses the following syntax:
option1=value ... #comment optionN=value
The following is an example of a configuration file:
proxy=http://proxy.example.com datastore=storage-test42 # Comment on something locale=dk
You can create local or global configuration files. A local configuration file has the .ovftool suffix and is read in the folder from which you invoke the OVF Tool. A global configuration file is per user.
On Windows, the global configuration file is read from the following location:C:\Documents and Settings\$USERNAME\VMware\ovftool.cfg
On Linux, the global configuration file is read from the following location:$HOME/.ovftool
When using configuration files, globally defined options are overwritten by locally defined and command-line options. Locally defined options are overwritten by command-line options.
You can also use the ovftool --help config command to get information about how to use a configuration file.
See the OVF Tool User's Guide for more information about how to use the OVF Tool.
There are no deprecated features in version 4.1 of the OVF Tool, but support for Windows XP and Windows Server 2003 has been discontinued.