Virtual SAN Management

The VMware Virtual SAN API Reference documentation provides information about the methods and data structures available through the Virtual SAN API. Note that the Virtual SAN API is an extension of the regular vSphere API, which is documented elsewhere (see below).

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

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

Virtual SAN API overview

The Virtual SAN API centers around a small set of Managed Objects, which allow you to set up and configure all aspects of Virtual SAN, 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 APIs, operating at a VSAN Cluster level in vCenter Server only; extends the VsanUpgradeSystem APIs
• VsanSpaceReportSystem – VSAN cluster space usage related query APIs, operating at a VSAN Cluster level in vCenter Server only
• VsanObjectSystem – the VSAN object related status query and storage policy setting APIs, operating at both vCenter Service 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

Managed Objects for the vSphere API are serviced with the vSphere SDK service endpoint (Web Services URL ending with "/sdk"), whereas Managed Objects for the Virtual SAN API are serviced with dedicated Web Service endpoints. The dedicated Virtual SAN API service endpoint is at "/vsan" on ESXi hosts, while the Virtual SAN API service endpoint is at "/vsanHealth" on vCenter Server.

Note: The HostVsanSystem and VsanUpgradeSystem managed objects are inherited from previous versions of VSAN, and are serviced as part of the regular vSphere API. You access these two managed objects in the same way you access other managed objects (such as SessionManager) at the service endpoint "/sdk" for the vSphere Web Services API.
Other mananged objects of the Virtual SAN API are serviced under the dedicated endpoints, "/vsan" for ESXi and "/vsanHealth" for vCenter Server, as discussed above.

For more information about the vSphere API, see VMware vSphere Web Services SDK on the VMware API and SDK Documentation landing page.

Navigating the API Reference

The Virtual SAN 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.