WilliamLam.com

  • About
    • About
    • Privacy
  • VMware Cloud Foundation
  • VKS
  • Homelab
    • Resources
    • Nested Virtualization
  • VMware Nostalgia
  • Apple
You are here: Home / Automation / Quick Tip - Useful ovftool debugging options

Quick Tip - Useful ovftool debugging options

08.16.2013 by William Lam // 7 Comments

This morning I needed perform several OVF uploads using ovftool and provide that information to engineering to investigate some performance issues. I tend to error on the side of providing more information than requested. The ovftool provides some really useful debugging options that are really handy in these situations but are un-documented. I can never seem to remember the exact syntax and hence I am documenting them here. I will also file a documentation bug to ensure these get added 🙂

UPDATE (08/19/13) - Thanks to one of the OVF engineers, it turns out you can see all the debug options and their definitions by running ovftool --help debug

The two options that I am referring to are:

--X:logFile=
--X:logLevel=

The first option allows you to log the entire ovftool session to a file which you can then send off to someone and the second option allows you to control the verbosity of the logs which I normally set to use verbose.

Here is an example of how you would use these ovftool options:

/Applications/VMware\ OVF\ Tool/ovftool --X:logFile=upload.log --X:logLevel=verbose -ds=mini-local-datastore-2 '--net:Network 1=VM Network' VMware-vCenter-Server-Appliance-5.1.0.10200-1235310_OVF10.ova vi://root@mini

Once the ovftool has completed its operation, you can take a look at the log and you will see quite a bit of information including some additional ovftool options that can be specified on the command-line which start with /X:

--> /X:httpTimeout = "0"
--> /X:imageReadSize = "262144"
--> /X:logFile = "upload.log"
--> /X:logLevel = "verbose"
--> /X:maxNumberOfTermSignals = "5"
--> /X:maxRedirects = "256"
--> /X:maximalDeltaConfSize = "8"
--> /X:maximalDeltaTreeSize = "6"
--> /X:progressSmoothing = "60"
--> /X:useMacNaming = "true"
--> /X:vCloudEnableGuestCustomization = "false"
--> /X:vCloudKeepTemplate = "true"
--> /X:vCloudTimeout = "3600"
--> /X:vimSessionTimeout = "600"

Note: I would not recommend tweaking the other options as the defaults should be sufficient, but logging to a file or upping the verbosity can be useful for troubleshooting

More from my site

  • Quick Tip - Import OVF/OVA as VM Template using OVFTool 4.3 Update 1
  • Native OVF support for Fusion/Workstation 2017 Tech Preview 
  • Default hashing algorithm changed in OVFTool 4.2 preventing OVF/OVA import using vSphere C# Client
  • Heads Up: OVF/OVA always deployed as Thick on VSAN when using vSphere Web Client
  • Caveat when deploying Photon Controller Installer (v0.8) OVA to vCenter Server

Categories // Automation, OVFTool Tags // debug, log, ovf, ovftool

Comments

  1. *protectedAnders Madsen says

    08/19/2013 at 6:06 am

    You can see many of these debug option in OVF Tool by invoking the --help option with a debug argument

    $ ovftool --help debug

    Reply
    • *protectedWilliam Lam says

      08/19/2013 at 2:48 pm

      Thanks for the comment Anders. I guess we should also document the "debug" option in help 🙂

      Reply
  2. *protectedRichard Sillito says

    11/04/2014 at 9:02 pm

    Hi William,

    I ran the following command, using ovftool version: VMware ovftool 4.0.0 (build-2189843)

    Against a standalone host running ESXi-5.5.0-20141004001-standard

    C:\Program Files\VMware\VMware OVF Tool>".\ovftool.exe" --X:injectOvfEnv --powerOn --X:logFile=upload.log --X:logLevel=verbose --prop:vami.DNS.VMware_vCent
    er_Server_Appliance=10.4.5.20 --prop:vami.gateway.VMware_vCenter_Server_Appliance=10.4.0.1 --prop:vami.hostname=srvvcnt02 --prop:vami.ip0.VMware_vCenter
    _Server_Appliance=10.4.3.21 --prop:vami.netmask0.VMware_vCenter_Server_Appliance=255.255.0.0 --prop:vm.vmname=test-VMware_vCenter_Server_Appliance --nam
    e=vcsa --datastore=iSCSI-VMs-NAS02 --diskMode=thin --network="VM Network" --acceptAllEulas G:\Software\VMWare\Products\vSphere\vSphere55U2\VMware-vCenter-S
    erver-Appliance-5.5.0.20200-2183109_OVF10.ova vi://root:[email protected]/
    Opening OVA source: G:\Software\VMWare\Products\vSphere\vSphere55U2\VMware-vCenter-Server-Appliance-5.5.0.20200-2183109_OVF10.ova
    The manifest validates
    Source is signed and the certificate validates
    Opening VI target: vi://[email protected]:443/
    Deploying to VI: vi://[email protected]:443/
    Transfer Completed
    Powering on VM: vcsa
    Task Completed
    Completed successfully

    However I still get the message "No networking detected. Please log in and run the command...."

    Not sure what I am doing wrong. Let me know if you see anything I missed.

    Reply
    • *protectedRichard Sillito says

      11/04/2014 at 10:55 pm

      Sorry William, I realized that I reply to the wrong post. Too many browser tabs open 🙂 I meant for this to be on the post regarding -X:injectOvfEnv. All the same assistance would be greatly appreciated.

      Reply
      • William Lam says

        11/05/2014 at 2:32 am

        I've seen this error before, usually indicates that the portgroup the VCSA is connected to isn't connected to a network, either the vNIC has been disconnected or it can't obtain an IP Address. I would double check your network and possibly even perform a manual deployment just to make sure network is functional for the IP you're specifying

        Reply
  3. *protectedRichard Sillito says

    11/06/2014 at 4:56 am

    Hi William,

    It turned out to the --prop:vm.vmname setting that was causing the problem. The first command works fine the second one fails. In the second command I put "test-" in front of the vmname setting. Possibly I exceeded a variable size??

    C:\Program Files\VMware\VMware OVF Tool>.\ovftool.exe --X:injectOvfEnv --powerOn --prop:vami.ip0.VMware_vCenter_Server_Appliance=10.4.3.21 --prop:vami.netm
    ask0.VMware_vCenter_Server_Appliance=255.255.0.0 --datastore=iSCSI-VMs-NAS02 --prop:vami.DNS.VMware_vCenter_Server_Appliance=10.4.5.20 --prop:vami.gateway.
    VMware_vCenter_Server_Appliance=10.4.0.1 --prop:vami.hostname=srvvcnt02.provider.priv --prop:vm.vmname=VMware_vCenter_Server_Appliance --name=vcsa --diskMo
    de=thin --network="VM Network" --acceptAllEulas G:\Software\VMWare\Products\vSphere\vSphere55U2\VMware-vCenter-Server-Appliance-5.5.0.20200-2183109_OVF10.o
    va vi://root:[email protected]/
    Opening OVA source: G:\Software\VMWare\Products\vSphere\vSphere55U2\VMware-vCenter-Server-Appliance-5.5.0.20200-2183109_OVF10.ova
    The manifest validates
    Source is signed and the certificate validates
    Opening VI target: vi://[email protected]:443/
    Deploying to VI: vi://[email protected]:443/
    Transfer Completed
    Powering on VM: vcsa
    Task Completed
    Completed successfully

    C:\Program Files\VMware\VMware OVF Tool>.\ovftool.exe --X:injectOvfEnv --powerOn --prop:vami.ip0.VMware_vCenter_Server_Appliance=10.4.3.21 --prop:vami.netm
    ask0.VMware_vCenter_Server_Appliance=255.255.0.0 --datastore=iSCSI-VMs-NAS02 --prop:vami.DNS.VMware_vCenter_Server_Appliance=10.4.5.20 --prop:vami.gateway.
    VMware_vCenter_Server_Appliance=10.4.0.1 --prop:vami.hostname=srvvcnt02.provider.priv --prop:vm.vmname=test-VMware_vCenter_Server_Appliance --name=vcsa --d
    iskMode=thin --network="VM Network" --acceptAllEulas G:\Software\VMWare\Products\vSphere\vSphere55U2\VMware-vCenter-Server-Appliance-5.5.0.20200-2183109_OV
    F10.ova vi://root:[email protected]/
    Opening OVA source: G:\Software\VMWare\Products\vSphere\vSphere55U2\VMware-vCenter-Server-Appliance-5.5.0.20200-2183109_OVF10.ova
    The manifest validates
    Source is signed and the certificate validates
    Opening VI target: vi://[email protected]:443/
    Deploying to VI: vi://[email protected]:443/
    Transfer Completed
    Powering on VM: vcsa
    Task Completed
    Completed successfully

    Reply

Trackbacks

  1. My failed attempt at installing Azure Stack in vCloud Air – VirtualizedGeek says:
    02/11/2016 at 6:48 pm

    […] The upload would start and fail between 1 and 5 percent completion. William Lam had directions for logging errors, but the tool didn't generate a log file. After attempting to upload the OVF about ten […]

    Reply

Thanks for the comment!Cancel reply

This site uses Akismet to reduce spam. Learn how your comment data is processed.

Search

Thank Author

Author

William is Distinguished Platform Engineering Architect in the VMware Cloud Foundation (VCF) Division at Broadcom. His primary focus is helping customers and partners build, run and operate a modern Private Cloud using the VMware Cloud Foundation (VCF) platform.

Connect

  • Bluesky
  • Email
  • GitHub
  • LinkedIn
  • Mastodon
  • Reddit
  • RSS
  • Twitter
  • Vimeo

Recent

  • Programmatically accessing the Broadcom Compatibility Guide (BCG) 05/06/2025
  • Quick Tip - Validating Broadcom Download Token  05/01/2025
  • Supported chipsets for the USB Network Native Driver for ESXi Fling 04/23/2025
  • vCenter Identity Federation with Authelia 04/16/2025
  • vCenter Server Identity Federation with Kanidm 04/10/2025

Advertisment

Privacy & Cookies: This site uses cookies. By continuing to use this website, you agree to their use.
To find out more, including how to control cookies, see here: Cookie Policy

Copyright WilliamLam.com © 2025