In addition to all the new capabilities and enhancements included in the release of VSAN 6.2 (vSphere 6.0 Update 2) which you can read more about here and here; VSAN 6.2 also introduces a new VSAN Management API which extends the existing vSphere APIs that our customers are quite familiar with.

This new VSAN Management API will allow developers, partners and administrators to automate all aspects of VSAN functionality including: complete lifecycle (install, upgrade, patch), monitoring (including VSAN Observer capabilities), configuration and troubleshooting. There will be two new service endpoints /vsan for an ESXi host and /vsanHealth for vCenter Server respectively which will provide access to the new VSAN Management API interfaces.

UPDATE: (03/17/16) - Check out this article here on how to quickly get started with the new VSAN Management API.

Below are the list of new vSphere Managed Objects that provide the different VSAN capabilities:

Managed Object Functionality ESXi or VC
HostVsanHealthSystem VSAN Health related configuration and query APIs ESXi only
HostVsanSystem VSAN related configuration and query APIs ESXi only
VsanObjectSystem VSAN object related status query and storage policy setting APIs ESXi & VC
VsanPerformanceManager VSAN Performance related configuration and query APIs ESXi & VC
VsanSpaceReportSystem VSAN cluster space usage related query APIs VC only
VsanUpgradeSystem Used to perform and monitor VSAN on-disk format upgrades VC only
VsanUpgradeSystemEx VSAN upgrade and disk format conversion related APIs VC only
VsanVcClusterConfigSystem VSAN cluster configuration setting and query APIs VC only
VsanVcClusterHealthSystem VSAN Health related configuration and query APIs VC only
VsanVcDiskManagementSystem VSAN disks related configuration and query APIs VC only
VsanVcStretchedClusterSystem VSAN Stretched Cluster related configuration and query APIs VC only

Note: There will be a VSAN Management API Reference guide similar to the vSphere API Reference Guide which will be released as part of VSAN 6.2. There, you will find much greater detail on each of the new vSphere Managed Objects and their associated methods and usage.

For customers interested in consuming this new VSAN Management API, there will be initially five language specific bindings also known as an SDK (Software Development Kit) that will be available for download when VSAN 6.2 is generally available:

Additional language bindings are being worked on and if you have any feedback on what you might like to see next, feel free to leave a comment.

4 thoughts on “VSAN 6.2 extends vSphere API to include new VSAN Management APIs

  1. Not sure if this relates to what you posted but in my environment, I have a few monitoring tools (run by other IT folk) that have native integrations capabilities with VMware virtual environments (vSphere API). They’ve made it known that their tools (infovista, netcool, etc.) cannot see all vSAN metrics like IOPs, latency, etc.. We’re running vROPs with the MPSD (storage) solution in place. So vROps natively can see all those metrics but the external tools using the vSphere API inetgrations cannot see all vSAN metrics. Additionally, vROps reports like [Virtual Machine Inventory – Datastore I/O] are able to pull metrics for all non-vSAN datastores but cannot pull all metrics from vSAN. Thoughts?

    • What version of VSAN are you guys running? I only ask as this new VSAN Management API was just released with vSphere 6.0 Update 2 and I’m not sure how many of our partners out there have actually had a chance to consume the new APIs which does provide much more information performance metrics for VSAN which was not available with the vSphere APIs.

      • vSAN version 6u1 (esxi and vcenter) … I guess to better understand the situation, is the issue with reaching the new vSAN metrics stemming from the 3rd party tools needing to update their tools OR is it because we haven’t upgraded to ESXi 6u2 OR is it because vCenter needs to be upgraded to 6u2?

        As much as I would like to fix the problem, at the end of the day, I just need to be able to give higher ups an answer as to why vSAN metrics aren’t visible:

        1. ESXi needs to be updated
        2. vCenter needs to be updated
        3. 3rd party tools need to be updated to see the new/detailed vSAN metrics

        Thank you for taking the time to respond!

      • One last thing I forgot to mention….so using vROps, the Virtual Machine: Datastore IOPs report doesn’t provide much vSAN metrics but vROps does provide all metrics when using the vSAN Solution Management Pack dashboards. Would that have to do with vROps needing to be updated (currently running vROps 6.1) so that the generic vROps reports include vSAN metrics?

Thanks for the comment!