vSAN Management

The VMware vSAN API Reference documentation provides information about the methods and data structures available through the vSAN API. Note that the vSAN APIs are an extension of the regular vSphere APIs, and as such this API reference includes all types of the vSphere API for reference as well.

• Managed objects
• Data objects
• Properties
• Methods
• Enumerations
• Faults

The vSAN API is exposed as a Web service, running on both the VMware vCenter server systems as well as the VMware ESXi systems. The API provides access to the methods that you can use to manage vSAN.

vSAN API overview

The vSAN API centers around a small set of Managed Objects, which allow to set up and configure all aspects of vSAN, as well as query runtime state.

• VsanVcDiskManagementSystem – VSAN disks related configuration and query APIs, operating at a VSAN Cluster level in vCenter Server only
• VsanVcStretchedClusterSystem – VSAN Stretched Cluster related configuration and query APIs, operating at a VSAN Cluster level in vCenter Server only
• VsanVcClusterConfigSystem – VSAN cluster configuration setting and query APIs, operating at a VSAN Cluster level in vCenter Server only
• VsanVcClusterHealthSystem – VSAN Health related configuration and query APIs, operating at a VSAN Cluster level in vCenter Server only
• VsanPerformanceManager – VSAN Performance related configuration and query APIs, operating at both vCenter Server and ESXi Host sides
• HostVsanHealthSystem – VSAN Health related configuration and query APIs, operating at a single ESXi Host level
• VsanUpgradeSystemEx – VSAN upgrade and disk format conversion related APIs, operating at a VSAN Cluster level in vCenter Server only. This MO extends the APIs of VsanUpgradeSystem
• VsanSpaceReportSystem – VSAN cluster space usage related query APIs, operating at a VSAN Cluster level in vCenter Server side only
• VsanObjectSystem – the VSAN object related status query and storage policy setting APIs, operating at both vCenter Server and ESXi host sides
• HostVsanSystem – VSAN Health related configuration and query APIs, operating at a single ESXi Host level
• VsanUpgradeSystem – Used to perform and monitor VSAN on-disk format upgrades, operating at a VSAN Cluster level in vCenter Server only
• VsanIscsiTargetSystem – vSAN iSCSI target service related configuration and management APIs, operating at both vCenter Server and ESXi hosts
• VsanVcsaDeployerSystem – Virtual Center Service Appliance deployment APIs onto VSAN datastore, operating at both vCenter Server and ESXi host sides
• VsanSystemEx – vSAN system extended management APIs, operating at a single ESXi Host level
• 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
• VsanVumSystem – vSAN VUM integration related API, operating at a vSAN Cluster level in vCenter Server only

Managed Objects for vSphere Management API/SDK are serviced with the vSphere SDK service endpoint(the Web Service URL - '/sdk').
While the Managed Objects for vSAN API are serviced with dedicated Web Service endpoints.
At ESXi side, the dedicated vSAN API service endpoint is '/vsan'. At VC side, the dedicated vSAN API service endpoint is '/vsanHealth'.

Note:
The HostVsanSystem and VsanUpgradeSystem are inherited MOs from previous version of VSAN. They are serviced as part of the vSphere Management API. So you access these two MOs in the same way of accessing the MOs (i.e. SessionManager) of vSphere APIs with the service endpoint - '/sdk'.
Other Mananged MOs of Vritual VSAN API are serviced under the dedicated endpoints - '/vsan' (for ESXi) and '/vsanHealth' (for VC).

For more information about the vSphere Management API, see vSphere API/SDK Documentation from VMware vSphere Documentation Center.

Navigating the API Reference

The vSAN API Reference is an HTML frameset. Click an entry in the left-hand pane to display information in the right-hand pane. To find the description of a specific object type, click the appropriate category name and then refine your search by entering the object name in the search text field.

To quickly find an entry, start typing its name in the Quick Index field.

The most recent published versions of this guide is available at:

http://www.vmware.com/support/developer/vc-sdk