Simplified vSphere 5.0 API Reference Online

After the vSphere 5.0 was released, I checked the vSphere Web Services SDK documentation page. Upon clicking the vSphere API Reference link, I got into the vSphere 5.0 Documentation Center as follows:

Lost VMs or Containers? Too Many Consoles? Too Slow GUI? Time to learn how to "Google" and manage your VMware and clouds in a fast and secure HTML5 App.

It’s a bit surprise to me. First of all, I like the integrated approach where you can find all the information related to vSphere 5.0: from user manual to SDK/CLIs, and even links to communities/blogs. Also, you have nice features like bookmark, search and printing, etc.

At the same time, I found it’s a bit overloaded if I am only interested in the API reference, which I am most of the time. I tried to load the API reference into a separate window or tab, but with no luck. If you know of any trick here, please share it in the comment.

Luckily the API reference is still included in the SDK package. I extracted it out and uploaded it to the open source VI Java API project home. Now if you like simple docs as I do, you can bookmark it here: The link is also available at VI Java API project home with all the previous versions.

This entry was posted in vSphere API and tagged , . Bookmark the permalink. Post a comment or leave a trackback: Trackback URL.


  1. Posted August 27, 2011 at 6:07 am | Permalink

    Hello Steve,

    Maybe I’m missing what you want to do, but wouldn’t the collapse index button which says “hide contents” on the top right of the main panel do what you are after?
    In addition, the page you are linking to also has an “old html interface” link which has the same content as what you are now hosting on sourceforge.

    Hope this helps,


  2. Posted August 27, 2011 at 1:53 pm | Permalink

    HI Wil,

    Yes. The Hide contents button hides the left side navigation tree. I want to have a vSphere API Reference only left side tree. Thanks for the “old html interface” link. I just tried it and found it’s pretty good. But if I search for “VirtualMachine,” it actually shows me results from PowerCLI too. So it’s as clean as the old way. I know I can limit the scope, but it doesn’t seem to work well.

    Overall it’s not a big deal but consistent with old style of API doc online.


  3. Peter
    Posted December 10, 2013 at 10:22 am | Permalink

    This interface is so much nicer than the VMware one.


Post a Comment

Your email is never published nor shared. Required fields are marked *


You may use these HTML tags and attributes <a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code> <del datetime=""> <em> <i> <q cite=""> <s> <strike> <strong>


    My company has created products like vSearch ("Super vCenter"), vijavaNG APIs, EAM APIs, ICE tool. We also help clients with virtualization and cloud computing on customized development, training. Should you, or someone you know, need these products and services, please feel free to contact me: steve __AT__

    Me: Steve Jin, VMware vExpert who authored the VMware VI and vSphere SDK by Prentice Hall, and created the de factor open source vSphere Java API while working at VMware engineering. Companies like Cisco, EMC, NetApp, HP, Dell, VMware, are among the users of the API and other tools I developed for their products, internal IT orchestration, and test automation.