WilliamLam.com

  • About
    • About
    • Privacy
  • VMware Cloud Foundation
  • VKS
  • Homelab
    • Resources
    • Nested Virtualization
  • VMware Nostalgia
  • Apple
You are here: Home / Automation / Quick Tip - Offline viewing of vSphere API & other API docs using Dash

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.

More from my site

  • PowerCLI script to help correlate vCenter, ESXi & vSAN build/versions w/o manual VMware KB lookup
  • How to efficiently transfer files to Datastore in vCenter using the vSphere API?
  • Auditing vMotion Migrations
  • Programmatically accessing the Broadcom Compatibility Guide (BCG)
  • Enhancements to VMware Cloud Foundation (VCF) & vSphere Automated Lab Deployment Scripts

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

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

 

Loading Comments...