WilliamLam.com

  • About
    • About
    • Privacy
  • VMware Cloud Foundation
  • VKS
  • Homelab
    • Resources
    • Nested Virtualization
  • VMware Nostalgia
  • Apple
You are here: Home / Automation / VSAN 6.2 extends vSphere API to include new VSAN Management APIs

VSAN 6.2 extends vSphere API to include new VSAN Management APIs

02.26.2016 by William Lam // 7 Comments

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:

  • VSAN Management SDK for Python - Extends pyvmomi (vSphere SDK for Python)
  • VSAN Management SDK for Ruby - Extends rbvmomi (vSphere SDK for Ruby)
  • VSAN Management SDK for Java - Extends vSphere SDK for Java
  • VSAN Management SDK for C# - Extends vSphere SDK for C#
  • VSAN Management SDK for Perl - Extends vSphere SDK for Perl

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.

More from my site

  • Getting started with the new VSAN 6.2 Management API
  • An update on how to retrieve useful information from a vSphere login?
  • Introducing Alexa to a few more VMware APIs
  • How to tell if an ESXi host is a VSAN Witness Virtual Appliance programmatically?
  • Using the vSphere API to remotely generate ESXi performance support bundles

Categories // Automation, ESXi, VSAN, vSphere 6.0 Tags // C#, java, pyVmomi, rbvmomi, Virtual SAN, vSphere 6.0 Update 2, vSphere API

Comments

  1. *protectedaj203355 says

    08/02/2016 at 1:02 pm

    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?

    Reply
    • William Lam says

      08/02/2016 at 4:44 pm

      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.

      Reply
      • *protectedaj203355 says

        08/03/2016 at 1:25 pm

        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!

        Reply
      • *protectedaj203355 says

        08/03/2016 at 3:28 pm

        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?

        Reply
  2. *protectedNaziya Khan says

    11/13/2017 at 10:26 am

    Is VsanVcClusterHealthSystem exposed via govmomi too? If yes, are there any sample references ?

    Reply
  3. *protectedRupasing says

    01/31/2018 at 1:46 am

    Tamilnadu board is going to release tn sslc result 2018 school wise, name wise soon. Tamilnadu 10th result 2018 date is the most awaiting announcement for students.

    Reply
  4. *protectedAmit says

    08/19/2018 at 1:42 am

    Hi William
    is there any way to know from the MOB what is the datastore vSan version ?
    the only why i can think of right now is the look on the related hosts versions , but i am not sure that it is the right way

    Reply

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