WilliamLam.com

  • About
    • About
    • Privacy
  • VMware Cloud Foundation
  • VKS
  • Homelab
    • Resources
    • Nested Virtualization
  • VMware Nostalgia
  • Apple

Quick Tip - Offline viewing of vSphere API & other API docs using Dash

06.06.2014 by William Lam // Leave a Comment

As a frequent consumer of the vSphere API, a must have bookmark for all my systems (work/personal) is the vSphere API Reference document. In my opinion, This is a must have for anyone that is serious about vSphere Automation and having it be an online document, it allows you to quickly search for a specific property or method. The problem with an online document of course is that if you are not connected to the internet, you will not have access to it. VMware does provides an offline version for viewing which is bundled within the vSphere Management SDK.

This morning when I woke up, I was going through the list of sites that I read on a regular basis such as Y Hacker News and the top entry at the moment was "Dash - Beautiful instance offline docs for almost everything". I quickly realized this was not the first time I had heard of this tool, my good friend Timo Sugliani had actually introduced me to Dash a couple months back and he even mentioned it might be possible to view the vSphere API documents. After installing Dash, I did not see the vSphere API docs from what I recall and I just never had time to play with it again. I figure it has been awhile, maybe I should give it another try? I updated Dash this morning to latest version and noticed that the vSphere API documentation is now available and covers vSphere 5.0, 5.1 and 5.5.

dash-documentation-1
Once you have downloaded the specific vSphere API documentation, you can then quickly browse or search through the different class objects, methods, properties and enumeration values. You can see from the screenshot below, it will automatically search through all your documentation include online searches on such as Google and Stack Overflow which I thought was pretty neat.

dash-documentation-2
In addition to being able to easily view the vSphere API documentation offline, but you can also view other types of API documentation. Dash currently supports over 290+ documentation sets and you can even create your own doc sets and contribute them back to Dash. The other neat thing about Dash which I have not tried yet is the plugin integration with popular IDEs like Sublime, Textmate, Eclipse to just name a few. The only downside I see at the moment is that Dash is only for Mac OSX, but it looks like there might be plans to support a Windows version later this year. If you work with a lot of API documentation, Dash might be something you may want to check out. I know I will start leveraging it when I am offline.

Categories // Automation, vSphere Tags // dash, documentation, vSphere, vSphere API

How to finally inject OVF properties into VCSA when deploying directly onto ESXi?

05.27.2014 by William Lam // 40 Comments

One of my biggest pet peeve when it comes to deploying the VCSA (vCenter Server Appliance) and other OVF/OVA directly onto an ESXi host is the lack of OVF property support. If you have deployed the VCSA before, you are probably aware of the different user experience when deploying to a vCenter Server versus deploying directly to an ESXi host. For those of you who are not familiar, the difference is when you deploy an OVF/OVA that contains custom OVF properties such as the VCSA, you have the ability to provide input to these parameters when deploying to a vCenter Server as seen in the screenshot below.

[Read more...]

Categories // Automation, ESXi, OVFTool, VAMI, VCSA, vSphere Tags // ESXi, fusion, injectOvfEnv, ova, ovf, ovftool, VCSA, vcva, workstation

Quick Tip - Enabling HTML5 VM Console in the vSphere Web Client for IE

05.08.2014 by William Lam // 13 Comments

One of the biggest feature that I was most excited for with the initial release of vSphere 5.5, was the full support for Mac OS X with the vSphere Web Client. For many Mac OS X users including myself, this meant you could finally upload OVF/OVA, have support for remote device management such as mounting an ISO or floppy image and the biggest one of them all is having a supported native VM Console (based on HTML5)!

During the early Alpha/Beta release of vSphere 5.5, I started to use the VM Console for Mac OS X quite a bit. One thing that I had noticed was the HTML5 VM console was only used when you are running on a Mac OS X system. If you are on Windows or Linux system, it would still default to VMRC if you did not have the CIP (Client Integration Package) installed which included the VMRC. If you did not have CIP installed, then it would then default to the HTML5 VM Console as an alternative.

Last night, I saw a tweet from Steve Kaplan which seemed to indicate this behavior had changed:

webclient-html5-console-for-internet-explorer-1
I luckily had a Windows system that did not have CIP installed and took a quick look and found the following:

  • On both Chrome and Firefox, the HTML5 VM Console was available, you should see a "Launch Console" under the Virtual Machine summary page
  • On Internet Explorer (9,10 & 11), the HTML5 VM Console was not available and there was no "Launch Console" link

It appears that the behavior did in fact change between Beta and GA of vSphere which was kind of a shame ...

Not being satisfied with the answer, I was still hoping I could help find a solution for my buddy Steve. I think it would still be useful to be able to view the Virtual Machine console w/o having CIP installed, especially if you don't require the functionality of CIP. Thinking about it a for a bit, I had an idea that was worth a shot. I decided to change the User-Agent on the Internet Explorer to make it show up to the vSphere Web Client as Firefox versus Internet Explorer to see what would happen.

webclient-html5-console-for-internet-explorer
To my surprise, as you can see from the screenshot above, it worked! I guess the vSphere Web Client specifically looks for the browser type and if it is Internet Explorer, we only provide the CIP installer versus using the HTML5 VM Console. I'm not exactly sure why that is the case, but at least there is a work around. Here are the instructions if you wish to change the User Agent on IE. I also found that this worked on both IE10 and 11 but not IE9.

Disclaimer: This may not be officially supported by VMware, but you probably already know the drill πŸ˜‰

This is a nice workaround if you are using the vSphere Web Client, but if you do not want to go through this hassle you can ALWAYS access the HTML5 VM Console by generating the URL itself and this will always work on ALL browsers without any workarounds. Here is a nice script that I created which will handle this for you. Web Client 0, Customer 1 πŸ™‚

Categories // Not Supported, VMRC, vSphere, vSphere 5.5, vSphere Web Client Tags // HTML5, internet explorer, vsphere web client

  • « Previous Page
  • 1
  • …
  • 91
  • 92
  • 93
  • 94
  • 95
  • …
  • 109
  • Next Page »

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

 

Loading Comments...