With all the new awesome capabilities that have been introduced in vSAN 6.6, there is just as much Automation goodness that will be available for our customers to consume to help them easily mange and operate at scale.

vSAN Management 6.6 API

Below are all the new Managed Objects that have been introduced in the new vSAN Management 6.6 API. This does not even cover all the new methods or object types. For the complete list of vSAN 6.6 APIs, be sure to check out the vSAN Management 6.6 API Reference Guide here.

  • VsanVcsaDeployerSystem – Virtual Center Service Appliance deployment APIs onto vSAN datastore, operating at both vCenter Server and ESXi Host sides
  • VsanVdsSystem – vSAN system optimized VDS related operations, especially migrations from VSS to VDS
  • VsanUpdateManager – VIB installation engine operating at vSAN cluster level (optimized for vSAN clusters)
  • VsanCapabilitySystem – APIs to query vSAN capability, available on both vCenter and ESXi
  • VsanMassCollector – vSAN system management query API's to access data and managed object properties, operating at a vSAN Cluster level in vCenter Server only
  • VsanPhoneHomeSystem – vSAN online health related query API, operating at a vSAN Cluster level in vCenter Server only

vSAN Management 6.6 Quick Reference

The vSAN Management API Reference Guide is definitely the go to place to not only see what vSAN APIs are available but also on how to use them. However, if you are new to vSAN API, it can be daunting at first to figure out where things are at and how to access them. When vSAN 6.2 was released, I thought it would be useful to create a "Quick Reference" which provides a flatten view of the vSAN API which has come in pretty handy for myself and others as well. I have also taken the time to update it to now reflect all the new vSAN 6.5 and vSAN 6.6 APIs which you can access by going to the following URL below:

http://vmwa.re/vsanapi

Here is a screenshot of what vSAN Management 6.6 API Quick Reference looks like:


vSAN Management 6.6 SDKs

Simliar to previous releases of vSAN, there are new vSAN Management SDKs that are available across a variety of development and scripting languages that customers can take advantage of to consume all the new vSAN 6.6 functionality.

ESXCLI for vSAN 6.6

vSAN Customers have really enjoyed and benefited from the extensive vSAN Health Checks that have been built into the vCenter Server UI. In vSAN 6.6, these vSAN Health Checks are now also available directly on an ESXi host when connecting to the Embedded Host Client UI. In addition to the vSAN Health Checks being available in both VC/ESXi which can also be consumed programmatically using the vSAN Management APIs, they are also available using ESXCLI (locally or remotely).

The following two ESXCLI commands have been added to support vSAN Health Checks on an individual ESXi host:

  • vsan.health.cluster get
  • vsan.health.cluster list

To get a summary view of all vSAN Health Checks, you can run the following command:

esxcli vsan health cluster list


To retrieve a specific vSAN health Check, you can pass in the name of a specific Health Check from the previous command as shown in the following command:

esxcli vsan health cluster get -t [NAME-OF-CHECK]


Here is a complete list of all the new vSAN specific ESXCLI commands that have been added in vSAN 6.6:

  • vsan.cluster.unicastagent clear
  • vsan.debug.controller list
  • vsan.debug.disk list
  • vsan.debug.disk.summary get
  • vsan.debug.limit get
  • vsan.debug.object.health.summary get
  • vsan.debug.object list
  • vsan.debug.resync list
  • vsan.debug.resync.summary get
  • vsan.debug.vmdk list
  • vsan.resync.bandwidth get
  • vsan.resync.throttle get
  • vsan.resync.throttle set

PowerCLI for vSAN 6.6 (UPDATED 04/20/17)

With the PowerCLI 6.5.1 release, a new Get-VSANView cmdlet is now available that will exposes the complete vSAN Management API using PowerCLI. Since the vSAN Management API has been around since vSphere 6.0 Update 2, you will be able to use this new cmdlet against vSAN 6.2, vSAN 6.5 and vSAN 6.6 environment! You simply just need to update your PowerCLI installation which you should always do to get the latest fixes and enhancements.

When you connect to either a vCenter Server and/or ESXi host, you will be able to view all available vSAN Managed Objects for the system by simply running the cmdlet without any arguments as shown in the screenshot below.

One thought on “New vSAN Management 6.6 API / SDKs / CLIs

Thanks for the comment!