Archive

Posts Tagged ‘API Reference’

Simplified vSphere 5.0 API Reference Online

August 27th, 2011 3 comments

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:

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.

Two Important Tips Reading vSphere API Reference

September 29th, 2010 4 comments

Last week I answered a question in VMware Web Services SDK forum about asterisks in vSphere API reference. Underneath these asterisks comes a note saying “May not be present.” What does it really mean?

The asterisks normally show up after properties or sub-properties defined with a managed object. As it says, it’s possible that there is NO value to the property.

How can it be like this?

There are two major causes. First, it reflects the different implementations of ESX, ESXi and vCenter. As a quick example, you can find many of the properties in the “content” (type: ServiceContent) come with asterisks.

On a vCenter server, you will find values to almost all the properties, but not quite so for ESX/ESXi. But we have one API reference document, so it’s natural to mark whatever possible no value as “may not present.”

Secondly, it may be as such depending on the state of a managed object. For instance, a virtual machine can be a bare machine without an OS installed. Therefore, the “guest” property of the virtual machine could have no value at all.

What does it mean to you?