Usage: ovftool [options] <source> [<target>]

where

<source>: Source URL locator to an OVF package, VMX file, or virtual machine in vCenter or on ESX Server.

<target>: Destination URL locator which specifies either a file location, or a location in the vCenter inventory or on an ESX Server.

If <target> is not specified, information about the source is displayed to the console.

Options:

–acceptAllEulas : Accept all end-user licenses agreements without being prompted.

–authdPortSource : Use this to override default vmware authd port (902) when using a host as source.

–authdPortTarget : Use this to override default vmware authd port (902) when using a host as target.

–chunkSize : Specifies the chunk size to use for files in a generated OVF package. The default is not to chunk. The chunk size without unit is assumed to be in megabytesAccepted units are b, kb, mb, gb; e.g., 2gb or 100kb.

–compress : Compress the disks in an OVF package. Value must be between 1 and 9. 1 is the fastest, but gives the worst compression, whereas 9 is the slowest, but gives the best compression.

-ds/–datastore : Target datastore name for a VI locator.

–deploymentOption : Selects what deployment option to use (if the source OVF package supports multiple options.)

–disableVerification : Skip validation of signature and certificate.

-dm/–diskMode : Select target disk format. Supported formats are: monolithicSparse, monolithicFlat, twoGbMaxExtentSparse, twoGbMaxExtentFlat, streamOptimized, thin (VI target) and thick (VI target)

–eula : EULA to be inserted in the first virtual system or virtual system collection in the OVF. If the

EULA is in a file, use the option

–eula@=filename instead.

-h /–help : Prints this message.

–hideEula : In OVF probe mode, hides the EULA.

–ipAllocationPolicy : IP allocation policy for a deployed OVF package. Supported values are fixed, transient and dhcp.

–ipProtocol : Select what IP protocol to use (IPv4, IPv6).

–lax : Relax OVF specification conformance and virtual hardware compliance checks. Use only if you know what you are doing.

–locale : Selects locale for target.

–machineOutput : Output OVF Tool messages in a machine friendly manner.

–makeDeltaDisks : Build delta disk hierarchy from the given source locator.

-n /–name : Specifies target name (defaults to source name).

–net : Set a network assignment in the deployed OVF package. A network assignment is set using thesyntax

–net:<OVF name>=<target name>.

-nw/–network : Target network for a VI deployment.

–noDisks : Disable disk conversion.

–noImageFiles : Do not include image files in destination.

-o /–overwrite : Force overwrites of existing files.

–powerOffSource : Ensures a VM/vApp is powered off before

importing from a VI source.

–powerOffTarget : Ensures a VM/vApp is powered off before overwriting a VI target.

–powerOn : Powers on a VM/vApp deployed on a VI target.

–privateKey : Sign OVF package with the given private key (.pem file). The file must contain a private key and a certificate.

–privateKeyPassword : Password for the private key. Should be used in conjunction with privateKey if the private key requires password authentication. If required and not specified, the tool will prompt for the password.

–prop : Set a property in the deployed OVF package. A property is set using the syntax

–prop:<key>=<value>.

–proxy : Proxy used for HTTP[S] access.

-q /–quiet : No output to screen except errors.

–schemaValidate : Validate OVF descriptor against OVF schema.

–skipManifestCheck : Skip validation of OVF package manifest.

–skipManifestGeneration : Skip generation of OVF package manifest.

-st/–sourceType : Explicitly express that source is OVF, OVA, VMX, VI, vApprun

-tt/–targetType : Explicitly express that target is OVF, OVA, VMX, VI, vApprun

–verifyOnly : Do not upload the source but only verify it against the target host. Applies to VI 4

targets only.

-v /–version : Prints the version of this tool.

-vf/–vmFolder : Target VM folder in VI inventory (relative to datacenter).

For more help, type: –help <topic>, where topics are:

locators : For detailed source and destination locator syntax

examples : For examples of use

config : For syntax of configuration files

integration : For a list of options primarily used when ovftool is exec’ed

from another tool or shellscript.

C:\Program Files\VMware\VMware OVF Tool>ovftool –help examples

Source Locator Examples:

c:\ovfs\my_vapp.ovf

c:\vms\my_vm.vmx

c:\my_vApprun_workspace\MyVm

my_vms_folder/my_vm_name

Destination Locator Examples:

c:\ovfs\my_vapp.ovf

c:\vms\my_vm.vmx

c:\my_vApprun_workspace\MyVM

esx01.example.com

esx01.example.com/Resources/my_resourcepool

Note: the /host/ and /Resources/ part of the above inventory path are fixed and must be specified when using a vi destination locator. The /Resources/ part is only used when specifying a resource

pool.

Examples:

ovftool -tt=vmx c:\ovfs\my_vapp.ovf c:\vms\(.ovf file to .vmx file. Result files will be: c:\vms\my_vapp\my_vapp.[vmx|vmdk])

ovftool c:\vms\my_vm.vmx c:\ovfs\my_vapp.ovf (.vmx file to .ovf file. Result files will be c:\ovfs\my_vapp.[ovf|vmdk])

ovftool http://my_ovf_server/ovfs/my_vapp.ova c:\vms\my_vm.vmx (.ova file to .vmx file)

ovftool c:\ovfs\my_vapp.ovf vi://username:pass@my_esx_host (.ovf file to ESX host using default mappings)

ovftool c:\ovfs\my_vm.vmx vi://username:pass@my_esx_host (.vmx file to ESX host using default mappings)

(.ovf file from a web server to ESX host using defaults)

ovftool c:\ovfs\my_vapp.ovf \

(.ovf file to vCenter server using managed ESX host ip address)

ovftool “vi://username:pass@my_vc_server/my_datacenter?ds=\

[Storage1] foo/foo.vmx” c:\ovfs\

(VM on ESX/vCenter server to OVF using datastore location query)

ovftool c:\ovfs\my_vapp.ovf \

(.ovf file to vCenter server using vCenter inventory path)

c:\ovfs\my_vapp.ovf

(VC/ESX vm to .ovf file)

ovftool c:\VirtualMachines\MyVM.vmx \

c:\My_vApprun_Workspace\

(Imports a .vmx file into a vApprun workspace using default name)

(shows summary information about the OVF package [probe mode])


Tags: ,