Managed Object - VsanVcClusterHealthSystem(vim.cluster.VsanVcClusterHealthSystem)

See also: ClusterComputeResource, HostSystem, Task, VsanAttachToSrOperation, VsanClusterCreateVmHealthTestResult, VsanClusterFileServiceHealthSummary, VsanClusterHclInfo, VsanClusterHealthCheckInfo, VsanClusterHealthConfigs, VsanClusterHealthSummary, VsanClusterHealthSystemVersionResult, VsanClusterNetworkLoadTestResult, VsanClusterObjectExtAttrs, VsanClusterTelemetryProxyConfig, VsanClusterVmdkLoadTestResult, VsanHclReleaseConstraint, VsanSmartStatsHostSummary, VsanStorageWorkloadType, VsanVmdkLoadTestSpec
Since: vSphere API 5.5

Managed Object Description

This managed object provides access to vSAN Health related configuration and query APIs, operating at a vSAN cluster level. It can be accessed through MOID of 'vsan-cluster-health-system', through vSAN service at vCenter server side.

Properties

Name	Type	Description
None

Methods

Methods defined in this Managed Object
VsanAttachVsanSupportBundleToSr, VsanClusterQueryFileServiceHealthSummary, VsanDownloadAndInstallVendorTool_Task, VsanDownloadHclFile_Task, VsanGetHclConstraints, VsanGetReleaseRecommendation, VsanHealthGetVsanClusterSilentChecks, VsanHealthIsRebalanceRunning, VsanHealthQueryVsanClusterHealthCheckInterval, VsanHealthQueryVsanClusterHealthConfig, VsanHealthQueryVsanProxyConfig, VsanHealthRepairClusterObjectsImmediate, VsanHealthSendVsanTelemetry, VsanHealthSetLogLevel, VsanHealthSetVsanClusterHealthCheckInterval, VsanHealthSetVsanClusterSilentChecks, VsanHealthSetVsanClusterTelemetryConfig, VsanHealthTestVsanClusterTelemetryProxy, VsanPurgeHclFiles, VsanQueryAllSupportedHealthChecks, VsanQueryAttachToSrHistory, VsanQueryVcClusterCreateVmHealthHistoryTest, VsanQueryVcClusterCreateVmHealthTest, VsanQueryVcClusterHealthSummary, VsanQueryVcClusterHealthSummaryTask, VsanQueryVcClusterNetworkPerfHistoryTest, VsanQueryVcClusterNetworkPerfTest, VsanQueryVcClusterObjExtAttrs, VsanQueryVcClusterSmartStatsSummary, VsanQueryVcClusterVmdkLoadHistoryTest, VsanQueryVcClusterVmdkWorkloadTypes, VsanRebalanceCluster, VsanStopRebalanceCluster, VsanVcClusterGetHclInfo, VsanVcClusterQueryVerifyHealthSystemVersions, VsanVcClusterRunVmdkLoadTest, VsanVcUpdateHclDbFromWeb, VsanVcUploadHclDb

Methods defined in this Managed Object

VsanAttachVsanSupportBundleToSr, VsanClusterQueryFileServiceHealthSummary, VsanDownloadAndInstallVendorTool_Task, VsanDownloadHclFile_Task, VsanGetHclConstraints, VsanGetReleaseRecommendation, VsanHealthGetVsanClusterSilentChecks, VsanHealthIsRebalanceRunning, VsanHealthQueryVsanClusterHealthCheckInterval, VsanHealthQueryVsanClusterHealthConfig, VsanHealthQueryVsanProxyConfig, VsanHealthRepairClusterObjectsImmediate, VsanHealthSendVsanTelemetry, VsanHealthSetLogLevel, VsanHealthSetVsanClusterHealthCheckInterval, VsanHealthSetVsanClusterSilentChecks, VsanHealthSetVsanClusterTelemetryConfig, VsanHealthTestVsanClusterTelemetryProxy, VsanPurgeHclFiles, VsanQueryAllSupportedHealthChecks, VsanQueryAttachToSrHistory, VsanQueryVcClusterCreateVmHealthHistoryTest, VsanQueryVcClusterCreateVmHealthTest, VsanQueryVcClusterHealthSummary, VsanQueryVcClusterHealthSummaryTask, VsanQueryVcClusterNetworkPerfHistoryTest, VsanQueryVcClusterNetworkPerfTest, VsanQueryVcClusterObjExtAttrs, VsanQueryVcClusterSmartStatsSummary, VsanQueryVcClusterVmdkLoadHistoryTest, VsanQueryVcClusterVmdkWorkloadTypes, VsanRebalanceCluster, VsanStopRebalanceCluster, VsanVcClusterGetHclInfo, VsanVcClusterQueryVerifyHealthSystemVersions, VsanVcClusterRunVmdkLoadTest, VsanVcUpdateHclDbFromWeb, VsanVcUploadHclDb

VsanAttachVsanSupportBundleToSr(attachVsanSupportBundleToSr)

Collect vSAN and vCenter support bundle and upload to VMware for the given SR (Service Request). The collected support bundles including vSAN health and tracing log bundle, all of ESXi host support bundle and VC support bundle The upload process will be in three stages separately with the order of bundle size to avoid possible time out, which are vCenter bundles, small high importance ESXi/vSAN manifests, vSAN traces and lower priority ESXi manifests. The network proxy for uploading is also supported by calling SetVsanClusterTelemetryConfig() in advance.

Combined Privileges Required (on vSphere ManagedEntity):

Privileges	Required on
Global.Diagnostics	RootFolder

* The RootFolder entity in above table refers to the vCenter server itself in the vCenter UI
* The ClusterComputeResource entity in above table refers to the cluster which is being operated on

* The Required Privileges section below is not used, please ignore.

Required Privileges: Global.Diagnostics

Parameters

Name

Type

Description

_this

ManagedObjectReference

A reference to the VsanVcClusterHealthSystem used to make the method call.

cluster P

ManagedObjectReference
to a ClusterComputeResource

The vCenter cluster

Since vSphere API 5.5

srNumber P

xsd:string

The Customer Service Request number ID

Since vSphere API 5.5

PRequired privilege - see tooltip for details

Return Value

Type	Description
ManagedObjectReference to a Task	task vCenter Task

Faults

Type	Description
NotFound
NotSupported	Thrown if run directly on an ESX Server host.
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
VsanFault

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanAttachVsanSupportBundleToSr" type="vsan:VsanAttachVsanSupportBundleToSrRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanAttachVsanSupportBundleToSrResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vsan:ManagedObjectReference"/>
                     </sequence>
                  </complexType>
               </element>

VsanClusterQueryFileServiceHealthSummary(queryFileServiceHealthSummary)

Query the vSAN file service health on all the hosts in the specified cluster.

Combined Privileges Required (on vSphere ManagedEntity):

Privileges	Required on
System.Read	ClusterComputeResource

* The Required Privileges section below is not used, please ignore.

Required Privileges: None
Since: vSAN API 7.0

Parameters

Name

Type

Description

_this

ManagedObjectReference

A reference to the VsanVcClusterHealthSystem used to make the method call.

cluster P

ManagedObjectReference
to a ClusterComputeResource

The target cluster.

Since vSAN API 7.0

P Required privilege: cluster

Return Value

Type	Description
VsanClusterFileServiceHealthSummary	The file service health summary. Return None if the file service is not enabled.

Faults

Type	Description
InvalidArgument	Exception for invalid input arguments, for example, if the cluster is not found.
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanClusterQueryFileServiceHealthSummary" type="vsan:VsanClusterQueryFileServiceHealthSummaryRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanClusterQueryFileServiceHealthSummaryResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vsan:VsanClusterFileServiceHealthSummary" minOccurs="0"/>
                     </sequence>
                  </complexType>
               </element>

VsanDownloadAndInstallVendorTool_Task(downloadAndInstallVendorTool)

Download and install the vendor tool required for the target cluster. API iterate thru all the update items for the given cluster and download the all the vendor tools required by the cluster. Vendor tool update item is specified by vibSpecType as 'tool'. Download of vendor tool will be skipped if tool is already present on vCenter storage. Check VsanDownloadHclFile_Task for the details about download. After download vendor tools will be installed on the hosts referenced by the vibSpec of vendor tools.

Required Privileges: Global.Settings
Since: vSAN API vSAN 6.7U1

Parameters

Name

Type

Description

_this

ManagedObjectReference

A reference to the VsanVcClusterHealthSystem used to make the method call.

cluster P

ManagedObjectReference
to a ClusterComputeResource

Since vSAN API vSAN 6.7U1

P Required privilege: cluster

Return Value

Type	Description
ManagedObjectReference to a Task

Faults

Type	Description
NotFound
NotSupported	Thrown if run directly on an ESX Server host.
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
VsanFault

Events

Type
None

VsanDownloadHclFile_Task(downloadHclFile)

Download driver/firmware from the URL extracted from HCL database by 'id' and 'md5sum'. The content will be save on the vCenter storage with the auto-generated filename. The checksum of content will be checked after content is saved on the disk.

Required Privileges: Global.Settings
Since: vSAN API 6.6

Parameters

Name

Type

Description

_this

ManagedObjectReference

A reference to the VsanVcClusterHealthSystem used to make the method call.

sha1sums P

xsd:string[]

Since vSAN API 6.6

P Required privilege: sha1sums

Return Value

Type	Description
ManagedObjectReference to a Task

Faults

Type	Description
NotFound
NotSupported	Thrown if run directly on an ESX Server host.
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
VsanFault

Events

Type
None

VsanGetHclConstraints(getClusterHclConstraints)

Get the HCL driver/firmware constraints for PCIe devices used by vSAN in the cluster.

Combined Privileges Required (on vSphere ManagedEntity):

Privileges	Required on
System.Read	ClusterComputeResource

* The Required Privileges section below is not used, please ignore.

Required Privileges: None
Since: vSAN API 7.0

Parameters

Name

Type

Description

_this

ManagedObjectReference

A reference to the VsanVcClusterHealthSystem used to make the method call.

cluster P

ManagedObjectReference
to a ClusterComputeResource

The target vSAN cluster

Since vSAN API 7.0

release P

xsd:string

The target vSphere release

Since vSAN API 7.0

PRequired privilege - see tooltip for details

Return Value

Type	Description
VsanHclReleaseConstraint	The HCL driver constraints for all the PCIe device used by vSAN, and current firmware versions of that device in the cluster.

Faults

Type	Description
NotFound
NotSupported	Thrown if run directly on an ESX Server host.
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
VsanFault	Thrown if unexpected error happened during the query, such as the cluster HCL info is unable to be retrieved, etc.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanGetHclConstraints" type="vsan:VsanGetHclConstraintsRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanGetHclConstraintsResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vsan:VsanHclReleaseConstraint"/>
                     </sequence>
                  </complexType>
               </element>

VsanGetReleaseRecommendation(getClusterReleaseRecommendation)

Get the vSAN recommendation of ESXi releases to update for a cluster, and the associated HCL device constraints to comply for those releases.

Combined Privileges Required (on vSphere ManagedEntity):

Privileges	Required on
System.Read	ClusterComputeResource

* The Required Privileges section below is not used, please ignore.

Required Privileges: None
Since: vSAN API 7.0

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VsanVcClusterHealthSystem used to make the method call.
cluster P	ManagedObjectReference to a ClusterComputeResource	The target vSAN cluster *Since* vSAN API 7.0
minor P	xsd:string[]	A list of minor update releases. E.g., ['ESXi 6.7 U2'] *Since* vSAN API 7.0
major P	xsd:string[]	A list of major update releases. E.g., ['ESXi 6.8', 'ESXi 7.0'] *Since* vSAN API 7.0

PRequired privilege - see tooltip for details

Return Value

Type	Description
VsanHclReleaseConstraint[]	A list of VsanHclReleaseConstraint consists of: Hcl Constraints for one recommended minor release(if applicable) and Hcl Constraints for one recommended major release(if applicable). If none of the minor or major releases are prefered by vSAN, an empty list will be returned.

Faults

Type	Description
NotFound
NotSupported	Thrown if run directly on an ESX Server host.
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
VsanFault	Thrown if unexpected error happened during the query, such as the releases to query is not recognized or supported by vSAN, or vSAN is not able to retrieve the HCL info from the cluster, etc.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanGetReleaseRecommendation" type="vsan:VsanGetReleaseRecommendationRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanGetReleaseRecommendationResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vsan:VsanHclReleaseConstraint" minOccurs="0" maxOccurs="unbounded"/>
                     </sequence>
                  </complexType>
               </element>

VsanHealthGetVsanClusterSilentChecks(getVsanClusterSilentChecks)

Get the user configured silent health check list of the cluster. This API will not return the system configured silent health check items. vSAN will automatically configure the following health check items in the following conditions:

HCL DB auto update in the air gap case.

This API only supported on vCenter.

Combined Privileges Required (on vSphere ManagedEntity):

Privileges	Required on
System.Read	ClusterComputeResource

* The Required Privileges section below is not used, please ignore.

Required Privileges: None
Since: vSAN API 6.6

Parameters

Name

Type

Description

_this

ManagedObjectReference

A reference to the VsanVcClusterHealthSystem used to make the method call.

cluster P

ManagedObjectReference
to a ClusterComputeResource

The target VC cluster

Since vSAN API 6.6

P Required privilege: cluster

Return Value

Type	Description
xsd:string[]	The list of all silent health checks testIds

Faults

Type	Description
NotFound
NotSupported	Thrown if run directly on an ESX Server host.
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
VsanFault

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanHealthGetVsanClusterSilentChecks" type="vsan:VsanHealthGetVsanClusterSilentChecksRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanHealthGetVsanClusterSilentChecksResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="xsd:string" minOccurs="0" maxOccurs="unbounded"/>
                     </sequence>
                  </complexType>
               </element>

VsanHealthIsRebalanceRunning(isRebalanceRunning)

Check whether the proactive rebalance is running or not against the target cluster or the hosts

Combined Privileges Required (on vSphere ManagedEntity):

Privileges	Required on
System.Read	ClusterComputeResource

* The Required Privileges section below is not used, please ignore.

Required Privileges: None

Parameters

Name

Type

Description

_this

ManagedObjectReference

A reference to the VsanVcClusterHealthSystem used to make the method call.

cluster P

ManagedObjectReference
to a ClusterComputeResource

The target vCenter cluster.

Since vSphere API 5.5

targetHosts* P

ManagedObjectReference[]
to a HostSystem[]

Leave this unset

Since vSphere API 5.5

*Need not be set PRequired privilege - see tooltip for details

Return Value

Type	Description
xsd:boolean	True if any of host has running rebalance process

Faults

Type	Description
NotFound
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanHealthIsRebalanceRunning" type="vsan:VsanHealthIsRebalanceRunningRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanHealthIsRebalanceRunningResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="xsd:boolean"/>
                     </sequence>
                  </complexType>
               </element>

VsanHealthQueryVsanClusterHealthCheckInterval(queryVsanClusterHealthCheckInterval)

Get the periodical vSAN health check interval (in minutes) for the cluster. The periodical vSAN health check will perform a full vSAN health check at the fix interval which can be used in refreshing the cache as well as triggering the health event and alarm as the supplement of host event based auto cache refresh mechanism

Combined Privileges Required (on vSphere ManagedEntity):

Privileges	Required on
System.Read	ClusterComputeResource

* The Required Privileges section below is not used, please ignore.

Required Privileges: None

Parameters

Name

Type

Description

_this

ManagedObjectReference

A reference to the VsanVcClusterHealthSystem used to make the method call.

cluster P

ManagedObjectReference
to a ClusterComputeResource

The target vCenter cluster

Since vSphere API 5.5

P Required privilege: cluster

Return Value

Type	Description
xsd:int	The periodical health check interval in minutes. Return 0 indicates the scheduled health check is disabled

Faults

Type	Description
NotFound
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanHealthQueryVsanClusterHealthCheckInterval" type="vsan:VsanHealthQueryVsanClusterHealthCheckIntervalRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanHealthQueryVsanClusterHealthCheckIntervalResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="xsd:int"/>
                     </sequence>
                  </complexType>
               </element>

VsanHealthQueryVsanClusterHealthConfig(queryVsanClusterHealthConfig)

Get the vSAN cluster health system configuration for the cluster Note when the API is called directly from an ESXi host, the configuration options may differ from that of from the vCenter. It returns only ones that may be meaningful to the ESXi host and the health service itself.

Combined Privileges Required (on vSphere ManagedEntity):

Privileges	Required on
System.Read	ClusterComputeResource

* The Required Privileges section below is not used, please ignore.

Required Privileges: None

Parameters

Name

Type

Description

_this

ManagedObjectReference

A reference to the VsanVcClusterHealthSystem used to make the method call.

cluster P

ManagedObjectReference
to a ClusterComputeResource

The target vCenter cluster

Since vSphere API 5.5

P Required privilege: cluster

Return Value

Type	Description
VsanClusterHealthConfigs	The vSAN cluster health service configuration

Faults

Type	Description
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanHealthQueryVsanClusterHealthConfig" type="vsan:VsanHealthQueryVsanClusterHealthConfigRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanHealthQueryVsanClusterHealthConfigResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vsan:VsanClusterHealthConfigs"/>
                     </sequence>
                  </complexType>
               </element>

VsanHealthQueryVsanProxyConfig(queryVsanProxyConfig)

Get the vSAN proxy configuration. Return the proxy configuration for vSAN. The method gets the proxy configured via UI settings or vsan config file. If no proxy is configured, the api tries to check if any system level proxy is set.

Combined Privileges Required (on vSphere ManagedEntity):

Privileges	Required on
System.Read	RootFolder

* The Required Privileges section below is not used, please ignore.

Required Privileges: System.Read
Since: vSAN API 7.0

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VsanVcClusterHealthSystem used to make the method call.

Return Value

Type	Description
VsanClusterTelemetryProxyConfig	The vSAN proxy configuration

Faults

Type	Description
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanHealthQueryVsanProxyConfig" type="vsan:VsanHealthQueryVsanProxyConfigRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanHealthQueryVsanProxyConfigResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vsan:VsanClusterTelemetryProxyConfig"/>
                     </sequence>
                  </complexType>
               </element>

VsanHealthRepairClusterObjectsImmediate(repairClusterObjectsImmediate)

Repair the absent or degraded vSAN object immediately under the cluster. The task triggered by this API will be finished after putting all of the required objects into repairing queue, but it doesn't mean the repair process is done or successful. The completing time for repairing all of objects is unpredictable and depends on vSAN backend.

Combined Privileges Required (on vSphere ManagedEntity):

Privileges	Required on
Host.Config.Storage	ClusterComputeResource

* The Required Privileges section below is not used, please ignore.

Required Privileges: None

Parameters

Name

Type

Description

_this

ManagedObjectReference

A reference to the VsanVcClusterHealthSystem used to make the method call.

cluster P

ManagedObjectReference
to a ClusterComputeResource

The VC cluster.

Since vSphere API 5.5

uuids* P

xsd:string[]

The object UUIDs need to be repaired. Unset to fix all of objects under the cluster

Since vSphere API 5.5

*Need not be set PRequired privilege - see tooltip for details

Return Value

Type	Description
ManagedObjectReference to a Task	task VC Task

Faults

Type	Description
NotFound
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
VsanFault

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanHealthRepairClusterObjectsImmediate" type="vsan:VsanHealthRepairClusterObjectsImmediateRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanHealthRepairClusterObjectsImmediateResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vsan:ManagedObjectReference"/>
                     </sequence>
                  </complexType>
               </element>

VsanHealthSendVsanTelemetry(sendVsanTelemetry)

Collecting vSAN telemetry for the given vCenter cluster and send to VMware phonehome server.

Combined Privileges Required (on vSphere ManagedEntity):

Privileges	Required on
Global.Settings	RootFolder

* The Required Privileges section below is not used, please ignore.

Required Privileges: Global.Settings

Parameters

Name

Type

Description

_this

ManagedObjectReference

A reference to the VsanVcClusterHealthSystem used to make the method call.

cluster P

ManagedObjectReference
to a ClusterComputeResource

The vCenter cluster for collecting vSAN telemetry data

Since vSphere API 5.5

P Required privilege: cluster

Return Value

Type	Description
None

Faults

Type	Description
NotFound
NotSupported	Thrown if run directly on an ESX Server host.
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
VsanFault

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanHealthSendVsanTelemetry" type="vsan:VsanHealthSendVsanTelemetryRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanHealthSendVsanTelemetryResponse">
                  <complexType/>
               </element>

VsanHealthSetLogLevel(setLogLevel)

Set the vSAN health log level which will be taken effect immediately. This setting will be refreshed and reverted to default INFO log level after vCenter system or health service is restarted. Setting the default log level as INFO in production because higher levels lead to too much log volume (reduced performance and too quick log rotation), while lower levels will not have enough information for troubleshooting by VMware support.

Combined Privileges Required (on vSphere ManagedEntity):

Privileges	Required on
Global.Settings	RootFolder

* The Required Privileges section below is not used, please ignore.

Required Privileges: Global.Settings

Parameters

Name

Type

Description

_this

ManagedObjectReference

A reference to the VsanVcClusterHealthSystem used to make the method call.

level* P

xsd:string

The log level to set. Unset will set the log level to the default log level as INFO. See all log levels through VsanVcClusterHealthSystemVsanHealthLogLevelEnum

Since vSphere API 5.5

*Need not be set P Required privilege: level

Return Value

Type	Description
None

Faults

Type	Description
NotFound
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
VsanFault

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanHealthSetLogLevel" type="vsan:VsanHealthSetLogLevelRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanHealthSetLogLevelResponse">
                  <complexType/>
               </element>

VsanHealthSetVsanClusterHealthCheckInterval(setVsanClusterHealthCheckInterval)

Set the periodical vSAN health check interval (in minutes) for the cluster. The periodical vSAN health check will perform a full vSAN health check at the fix interval which can be used in refreshing the cache as well as triggering the health event and alarm as the supplement of host event based auto cache refresh mechanism. Smaller value will perform the vSAN health more frequently to keep the cache to be more up-to-date but will increase the system overhead and vice versa. The default value is 1 hour.

Combined Privileges Required (on vSphere ManagedEntity):

Privileges	Required on
Global.Settings	RootFolder

* The Required Privileges section below is not used, please ignore.

Required Privileges: Global.Settings

Parameters

Name

Type

Description

_this

ManagedObjectReference

A reference to the VsanVcClusterHealthSystem used to make the method call.

cluster P

ManagedObjectReference
to a ClusterComputeResource

The target vCenter cluster

Since vSphere API 5.5

vsanClusterHealthCheckInterval P

xsd:int

The vSAN cluster periodical health check interval in minutes. The value 0 will disable the periodical health check

Since vSphere API 5.5

PRequired privilege - see tooltip for details

Return Value

Type	Description
None

Faults

Type	Description
NotFound
NotSupported	Thrown if run directly on an ESX Server host.
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
VsanFault

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanHealthSetVsanClusterHealthCheckInterval" type="vsan:VsanHealthSetVsanClusterHealthCheckIntervalRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanHealthSetVsanClusterHealthCheckIntervalResponse">
                  <complexType/>
               </element>

VsanHealthSetVsanClusterSilentChecks(setVsanClusterSilentChecks)

Set silent health check list of the cluster. Specify [testId/groupId] for 'addSilentChecks' to add add health checks to silent list. Specify [testId/groupId] for 'removeSilentChecks' to remove health checks from silent list. To restore the whole silent list, set 'removeSilentChecks' = ['all']. After the silent health check list is updated, it is recommended to refresh the vSAN cluster health summary to get the updated result. The health check items in the silent list should be skipped, and labeled with 'skipped' status. Note:

If groupId is added to silent list, all the checks under this group would be silent.
If groupId is removed from silent list, all the checks under this group would back to normal.
If given invalid testId/groupId, it will throw exception.
This method will do add first and then remove. So if the given health check is in both add and remove list, it would NOT be silent in the end.
This API only supported on vCenter.

Combined Privileges Required (on vSphere ManagedEntity):

Privileges	Required on
Global.Settings	RootFolder

* The Required Privileges section below is not used, please ignore.

Required Privileges: Global.Settings
Since: vSAN API 6.6

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VsanVcClusterHealthSystem used to make the method call.
cluster P	ManagedObjectReference to a ClusterComputeResource	The target vCenter cluster *Since* vSAN API 6.6
addSilentChecks* P	xsd:string[]	The health checks/groups to silent. *Since* vSAN API 6.6
removeSilentChecks* P	xsd:string[]	The health checks/groups to restore. *Since* vSAN API 6.6

*Need not be set PRequired privilege - see tooltip for details

Return Value

Type	Description
xsd:boolean	True to indicate the value being set successfully. No return otherwise.

Faults

Type	Description
NotFound
NotSupported	Thrown if run directly on an ESX Server host.
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
VsanFault

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanHealthSetVsanClusterSilentChecks" type="vsan:VsanHealthSetVsanClusterSilentChecksRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanHealthSetVsanClusterSilentChecksResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="xsd:boolean"/>
                     </sequence>
                  </complexType>
               </element>

VsanHealthSetVsanClusterTelemetryConfig(setVsanClusterTelemetryConfig)

Set the vSAN clsuter CEIP (Customer Experience Improvement Program) configuration. The configuration includes the interval time for the periodical CEIP telemetry data collector and the network proxy for sending vSAN telemetry data as well as HCL updating and uploading vSAN support bundle. Notice this proxy will be shared across all of vCenter clusters. The default interval is 1 week.

Combined Privileges Required (on vSphere ManagedEntity):

Privileges	Required on
Global.Settings	RootFolder

* The Required Privileges section below is not used, please ignore.

Required Privileges: Global.Settings

Parameters

Name

Type

Description

_this

ManagedObjectReference

A reference to the VsanVcClusterHealthSystem used to make the method call.

cluster P

ManagedObjectReference
to a ClusterComputeResource

The target vCenter cluster

Since vSphere API 5.5

vsanClusterHealthConfig P

VsanClusterHealthConfigs

The vSAN cluster CEIP configuration

Since vSphere API 5.5

PRequired privilege - see tooltip for details

Return Value

Type	Description
None

Faults

Type	Description
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanHealthSetVsanClusterTelemetryConfig" type="vsan:VsanHealthSetVsanClusterTelemetryConfigRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanHealthSetVsanClusterTelemetryConfigResponse">
                  <complexType/>
               </element>

VsanHealthTestVsanClusterTelemetryProxy(testVsanClusterTelemetryProxy)

Test the vSAN proxy configuration, which is used for downloading, HCL DB, sending vSAN telemetry data and uploading support bundle. Return true if the proxy works fine. This API will take several of seconds to return if given wrong proxy.

Combined Privileges Required (on vSphere ManagedEntity):

Privileges	Required on
Global.Settings	RootFolder

* The Required Privileges section below is not used, please ignore.

Required Privileges: Global.Settings

Parameters

Name

Type

Description

_this

ManagedObjectReference

A reference to the VsanVcClusterHealthSystem used to make the method call.

proxyConfig P

VsanClusterTelemetryProxyConfig

The proxy configuration

Since vSphere API 5.5

P Required privilege: proxyConfig

Return Value

Type	Description
xsd:boolean	True indicates the proxy test is successful

Faults

Type	Description
NotSupported	Thrown if run directly on an ESX Server host.
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
VsanFault

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanHealthTestVsanClusterTelemetryProxy" type="vsan:VsanHealthTestVsanClusterTelemetryProxyRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanHealthTestVsanClusterTelemetryProxyResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="xsd:boolean"/>
                     </sequence>
                  </complexType>
               </element>

VsanPurgeHclFiles(purgeHclFiles)

Purge driver/firmware that was previously put on vCenter (either via download from URL or upload to vCenter).

Required Privileges: Global.Settings
Since: vSAN API 6.6

Parameters

Name

Type

Description

_this

ManagedObjectReference

A reference to the VsanVcClusterHealthSystem used to make the method call.

sha1sums P

xsd:string[]

Since vSAN API 6.6

P Required privilege: sha1sums

Return Value

Type	Description
None

Faults

Type	Description
NotFound
NotSupported	Thrown if run directly on an ESX Server host.
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
VsanFault

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanPurgeHclFiles" type="vsan:VsanPurgeHclFilesRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanPurgeHclFilesResponse">
                  <complexType/>
               </element>

VsanQueryAllSupportedHealthChecks(queryAllSupportedHealthChecks)

Query basic info of all supported health checks

Combined Privileges Required (on vSphere ManagedEntity):

Privileges	Required on
System.Read	RootFolder

* The Required Privileges section below is not used, please ignore.

Required Privileges: System.Read
Since: vSAN API 6.6

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VsanVcClusterHealthSystem used to make the method call.

Return Value

Type	Description
VsanClusterHealthCheckInfo[]	A list of health check info constructed by testId, testName, groupId and groupName

Faults

Type	Description
NotFound
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
VsanFault

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanQueryAllSupportedHealthChecks" type="vsan:VsanQueryAllSupportedHealthChecksRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanQueryAllSupportedHealthChecksResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vsan:VsanClusterHealthCheckInfo" maxOccurs="unbounded"/>
                     </sequence>
                  </complexType>
               </element>

VsanQueryAttachToSrHistory(queryAttachToSrHistory)

Query the historical attach to SR operation result for the vCenter cluster. The historical data is only saved into memory and will disappear after the service is restart or shut down.

Combined Privileges Required (on vSphere ManagedEntity):

Privileges	Required on
System.Read	ClusterComputeResource

* The Required Privileges section below is not used, please ignore.

Required Privileges: None

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VsanVcClusterHealthSystem used to make the method call.
cluster P	ManagedObjectReference to a ClusterComputeResource	The vCenter cluster *Since* vSphere API 5.5
count* P	xsd:int	Collect the last test data for the given number at most. Default to get the latest one historical data. *Since* vSphere API 5.5
taskId* P	xsd:string	The task Id which run the attach to SR operation.Default is None The count parameter will be ignored when the taskId is not None *Since* vSphere API 5.5

*Need not be set PRequired privilege - see tooltip for details

Return Value

Type	Description
VsanAttachToSrOperation[]	The attach to SR operation results

Faults

Type	Description
NotFound
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanQueryAttachToSrHistory" type="vsan:VsanQueryAttachToSrHistoryRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanQueryAttachToSrHistoryResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vsan:VsanAttachToSrOperation" minOccurs="0" maxOccurs="unbounded"/>
                     </sequence>
                  </complexType>
               </element>

VsanQueryVcClusterCreateVmHealthHistoryTest(queryClusterCreateVmHealthHistoryTest)

Query the historical create VM test result for the vCenter cluster. The historical data is only saved into memory and will disappear after the service is restart or shut down.

Combined Privileges Required (on vSphere ManagedEntity):

Privileges	Required on
System.Read	ClusterComputeResource

* The Required Privileges section below is not used, please ignore.

Required Privileges: None

Parameters

Name

Type

Description

_this

ManagedObjectReference

A reference to the VsanVcClusterHealthSystem used to make the method call.

cluster P

ManagedObjectReference
to a ClusterComputeResource

The vCenter cluster

Since vSphere API 5.5

count* P

xsd:int

Collect the last test data for the given number at most. Default to get the latest one historical data

Since vSphere API 5.5

*Need not be set PRequired privilege - see tooltip for details

Return Value

Type	Description
VsanClusterCreateVmHealthTestResult[]	The VM creation test results

Faults

Type	Description
NotFound
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanQueryVcClusterCreateVmHealthHistoryTest" type="vsan:VsanQueryVcClusterCreateVmHealthHistoryTestRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanQueryVcClusterCreateVmHealthHistoryTestResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vsan:VsanClusterCreateVmHealthTestResult" minOccurs="0" maxOccurs="unbounded"/>
                     </sequence>
                  </complexType>
               </element>

VsanQueryVcClusterCreateVmHealthTest(queryClusterCreateVmHealthTest)

Executes VM creation test and checks if a tiny VM can be created on each of host of the vSAN cluster

Combined Privileges Required (on vSphere ManagedEntity):

Privileges	Required on
VirtualMachine.Inventory.Create VirtualMachine.Inventory.Delete	ClusterComputeResource

* The Required Privileges section below is not used, please ignore.

Required Privileges: None

Parameters

Name

Type

Description

_this

ManagedObjectReference

A reference to the VsanVcClusterHealthSystem used to make the method call.

cluster P

ManagedObjectReference
to a ClusterComputeResource

The target cluster

Since vSphere API 5.5

timeout P

xsd:int

The timeout time in second for the VM creation test. The suggested value could be 2 mintues

Since vSphere API 5.5

PRequired privilege - see tooltip for details

Return Value

Type	Description
VsanClusterCreateVmHealthTestResult	The vSAN cluster VM creation test result

Faults

Type	Description
NotFound
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanQueryVcClusterCreateVmHealthTest" type="vsan:VsanQueryVcClusterCreateVmHealthTestRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanQueryVcClusterCreateVmHealthTestResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vsan:VsanClusterCreateVmHealthTestResult"/>
                     </sequence>
                  </complexType>
               </element>

VsanQueryVcClusterHealthSummary(queryClusterHealthSummary)

Perform a cluster wide health check across all types of health checks. It's the primary API for fetching vSAN health status. This API runs a wide variety of health checks in many different categories against the cluster and returns both API-friendly and UI-friendly data. The 'fields' parameter should be used to return what the client is really interested in to limit the big result size for performance consideration. The API can either perform a health check against the up-to-date state of the hosts in the cluster and takes several seconds to return or it can retrieve the latest cached result to return in second. It's encouraged to fetch the cached data to get the quick response unless an update is required. Note: when this API is called directly from an ESXi host, following test groups are not supported: groupId = com.vmware.vsan.health.test.hcl

Querying vSAN cluster requires System.Read privilege on the cluster. If the API is called to have pre-flight health check on a bunch of hosts, System.Read privilege on all these hosts is required.

Required Privileges: None

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VsanVcClusterHealthSystem used to make the method call.
cluster* P	ManagedObjectReference to a ClusterComputeResource	The target cluster *Since* vSphere API 5.5
vmCreateTimeout* P	xsd:int	*Since* vSphere API 5.5
objUuids* P	xsd:string[]	*Since* vSphere API 5.5
includeObjUuids* P	xsd:boolean	Whether to include detailed per-object health in the result. Default to True. Set to false if this value is not of importance to save computing resources. *Since* vSphere API 5.5
fields* P	xsd:string[]	If set, only the properties listed in the array are returned in the result data object. Normally the output of this API can be quite large so this allows clients which are only interested in a subset to save network bandwidth and deserialization effort. The possible value is the field from the VsanClusterHealthSummary class like 'objectHealth', 'networkHealth' etc If unset, following properities are included in the result. 'clusterStatus', 'timestamp', 'clusterVersions', 'objectHealth', 'vmHealth', 'networkHealth', 'limitHealth', 'advCfgSync', 'createVmHealth', 'physicalDisksHealth', 'hclInfo', 'groups', 'overallHealth', 'overallHealthDescription', 'clomdLiveness', 'diskBalance' *Since* vSphere API 5.5
fetchFromCache* P	xsd:boolean	True to return the result from cache directly instead of running the full health check. The cache will be updated and keep the latest vSAN health summary check result either triggering from user on-demand request or the periodical vSAN health check for triggering health event/alarm. Default is False. *Since* vSphere API 5.5
perspective* P	xsd:string	The total amount of health checks is split into multiple different perspectives. This parameter controls which health checks are performed/returned. Please refer to VsanHealthPerspective for all of possible values *Since* vSphere API 5.5
hosts* P	ManagedObjectReference[] to a HostSystem[]	Include the individual host(s) into the health check, with other hosts specified with the cluster parameter. *Since* vSphere API 5.5

*Need not be set PRequired privilege - see tooltip for details

Return Value

Type	Description
VsanClusterHealthSummary	Returns a health summary data object.

Faults

Type	Description
NotFound
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
VsanFault

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanQueryVcClusterHealthSummary" type="vsan:VsanQueryVcClusterHealthSummaryRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanQueryVcClusterHealthSummaryResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vsan:VsanClusterHealthSummary"/>
                     </sequence>
                  </complexType>
               </element>

VsanQueryVcClusterHealthSummaryTask(queryClusterHealthSummaryTask)

An asynchronous API to perform all of cluster wide health checks including the online health checks if CEIP is enabled and returns the task. After the task is finished, all of health check result will be kept in the cache and can be fetched from the synchronous API vim.cluster.VsanVcClusterHealthSystem#QueryClusterHealthSummary by setting the parameter fetchFromCache as True, the perspective as 'defaultView' or unset and the parameter hosts should keep the same while leaving the other parameters as unset.

Combined Privileges Required (on vSphere ManagedEntity):

Privileges	Required on
System.Read	ClusterComputeResource

* The Required Privileges section below is not used, please ignore.

Required Privileges: None
Since: vSAN API vSAN 6.7U1

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VsanVcClusterHealthSystem used to make the method call.
cluster P	ManagedObjectReference to a ClusterComputeResource	The target cluster *Since* vSAN API vSAN 6.7U1
hosts* P	ManagedObjectReference[] to a HostSystem[]	Include the individual host(s) into the health check, with other hosts specified with the cluster parameter *Since* vSAN API vSAN 6.7U1
includeDataProtectionHealth* P	xsd:boolean	This parameter is not used, and no data protection health will be collected. *Since* vSAN API vSAN 6.7U1

*Need not be set PRequired privilege - see tooltip for details

Return Value

Type	Description
ManagedObjectReference to a Task	task VC Task

Faults

Type	Description
NotFound
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanQueryVcClusterHealthSummaryTask" type="vsan:VsanQueryVcClusterHealthSummaryTaskRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanQueryVcClusterHealthSummaryTaskResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vsan:ManagedObjectReference"/>
                     </sequence>
                  </complexType>
               </element>

VsanQueryVcClusterNetworkPerfHistoryTest(queryClusterNetworkPerfHistoryTest)

Query the historical network performance test result for the vCenter cluster. The historical data is only saved into memory and will disappear after the service is restart or shut down.

Combined Privileges Required (on vSphere ManagedEntity):

Privileges	Required on
System.Read	ClusterComputeResource

* The Required Privileges section below is not used, please ignore.

Required Privileges: None

Parameters

Name

Type

Description

_this

ManagedObjectReference

A reference to the VsanVcClusterHealthSystem used to make the method call.

cluster P

ManagedObjectReference
to a ClusterComputeResource

The vCenter cluster

Since vSphere API 5.5

count* P

xsd:int

Collect the last test data for the given number at most. Default to get the latest one historical data.

Since vSphere API 5.5

*Need not be set PRequired privilege - see tooltip for details

Return Value

Type	Description
VsanClusterNetworkLoadTestResult[]	The vSAN cluster network performance test results.

Faults

Type	Description
NotFound
NotSupported
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanQueryVcClusterNetworkPerfHistoryTest" type="vsan:VsanQueryVcClusterNetworkPerfHistoryTestRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanQueryVcClusterNetworkPerfHistoryTestResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vsan:VsanClusterNetworkLoadTestResult" minOccurs="0" maxOccurs="unbounded"/>
                     </sequence>
                  </complexType>
               </element>

VsanQueryVcClusterNetworkPerfTest(queryClusterNetworkPerfTest)

Query the vSAN network performance and checks if it meets the bandwidth requirements. For multicast performance, the test is done by picking one host as the sender, and having all other hosts be receivers. For unicast performance, the test is done by having all hosts form a circular list, and every host in the list will be sending packets to the next host, while receiving packets from the previous host at the same time. For multicast test, the status in test result will be:

red if the speed is less than 20 MB/s
yellow if the speed is between 20MB/s and 50MB/s
green if the speed is larger than 50MB/s

For unicast test, the status in test result will be:

red if the speed is 0 Mb/s
yellow if the speed is less than 850 Mb/s
green if the speed is larger than or equal to 850 Mb/s

Note: Calling this API requires vCenter and all the connected hosts to support the same network performance testing capability(multicast or unicast). As vSAN is moving from multicast to unicast, only the unicast test method is supported since vSphere 6.7 Update 1 release. This API will return "Not Supported" in case the test method is not currently supported by this cluster. User could query VsanGetCapabilities() API to check whether the cluster supports the unicast network performance test. The test is supported if the 'netperftest' capability can be found on the vCenter and all the hosts in this cluster. This API is intended for network bandwidth diagnostics in the environment with no production workloads. It is not designed for network bandwidth monitoring with production workloads as it might impact the actual network utilization during the test.

Combined Privileges Required (on vSphere ManagedEntity):

Privileges	Required on
System.Read	ClusterComputeResource

* The Required Privileges section below is not used, please ignore.

Required Privileges: None

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VsanVcClusterHealthSystem used to make the method call.
cluster P	ManagedObjectReference to a ClusterComputeResource	The target cluster *Since* vSphere API 5.5
multicast P	xsd:boolean	True to test vSAN multicast network performance. False to test vSAN unicast network performance. *Since* vSphere API 5.5
durationSec* P	xsd:int	The duration of the Network Performance test. Default is 15 seconds if not set. *Since* vSphere API 5.5

*Need not be set PRequired privilege - see tooltip for details

Return Value

Type	Description
VsanClusterNetworkLoadTestResult	The vSAN cluster network performance test result

Faults

Type	Description
NotFound
NotSupported
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanQueryVcClusterNetworkPerfTest" type="vsan:VsanQueryVcClusterNetworkPerfTestRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanQueryVcClusterNetworkPerfTestResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vsan:VsanClusterNetworkLoadTestResult"/>
                     </sequence>
                  </complexType>
               </element>

VsanQueryVcClusterObjExtAttrs(queryVsanObjExtAttrs)

Query the extended attributes for vSAN cluster objects.

Combined Privileges Required (on vSphere ManagedEntity):

Privileges	Required on
System.Read	ClusterComputeResource

* The Required Privileges section below is not used, please ignore.

Required Privileges: None
Since: vSAN API 6.7

Parameters

Name

Type

Description

_this

ManagedObjectReference

A reference to the VsanVcClusterHealthSystem used to make the method call.

cluster P

ManagedObjectReference
to a ClusterComputeResource

The target cluster

Since vSAN API 6.7

uuids P

xsd:string[]

List of object UUIDs.

Since vSAN API 6.7

PRequired privilege - see tooltip for details

Return Value

Type	Description
VsanClusterObjectExtAttrs[]	A list of vSAN cluster object extended attributes of given objects

Faults

Type	Description
NotFound
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanQueryVcClusterObjExtAttrs" type="vsan:VsanQueryVcClusterObjExtAttrsRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanQueryVcClusterObjExtAttrsResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vsan:VsanClusterObjectExtAttrs" minOccurs="0" maxOccurs="unbounded"/>
                     </sequence>
                  </complexType>
               </element>

VsanQueryVcClusterSmartStatsSummary(querySmartStatsSummary)

Query vSAN physical disks S.M.A.R.T. stats across all hosts in the target cluster.

Combined Privileges Required (on vSphere ManagedEntity):

Privileges	Required on
System.Read	ClusterComputeResource

* The Required Privileges section below is not used, please ignore.

Required Privileges: None
Since: vSAN API 6.6

Parameters

Name

Type

Description

_this

ManagedObjectReference

A reference to the VsanVcClusterHealthSystem used to make the method call.

cluster P

ManagedObjectReference
to a ClusterComputeResource

The target cluster

Since vSAN API 6.6

P Required privilege: cluster

Return Value

Type	Description
VsanSmartStatsHostSummary[]	The vSAN physical disks S.M.A.R.T. stats

Faults

Type	Description
NotFound
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanQueryVcClusterSmartStatsSummary" type="vsan:VsanQueryVcClusterSmartStatsSummaryRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanQueryVcClusterSmartStatsSummaryResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vsan:VsanSmartStatsHostSummary" maxOccurs="unbounded"/>
                     </sequence>
                  </complexType>
               </element>

VsanQueryVcClusterVmdkLoadHistoryTest(queryClusterVmdkLoadHistoryTest)

Deprecated. As of vSphere API 6.7.

Query the historical vSAN storage test result for the vCenter cluster. The historical data is only saved into memory and will disappear after the service is restart or shut down.

Combined Privileges Required (on vSphere ManagedEntity):

Privileges	Required on
System.Read	ClusterComputeResource

* The Required Privileges section below is not used, please ignore.

Required Privileges: None

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VsanVcClusterHealthSystem used to make the method call.
cluster P	ManagedObjectReference to a ClusterComputeResource	The vCenter cluster *Since* vSphere API 5.5
count* P	xsd:int	Collect the last test data for the given number at most. Default to get the latest one historical data. *Since* vSphere API 5.5
taskId* P	xsd:string	The task Id which run the VMDK performance test. Default is None The count parameter will be ignored when the taskId is not None *Since* vSphere API 5.5

*Need not be set PRequired privilege - see tooltip for details

Return Value

Type	Description
VsanClusterVmdkLoadTestResult[]	The vSAN storage load test results.

Faults

Type	Description
NotFound
NotSupported
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanQueryVcClusterVmdkLoadHistoryTest" type="vsan:VsanQueryVcClusterVmdkLoadHistoryTestRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanQueryVcClusterVmdkLoadHistoryTestResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vsan:VsanClusterVmdkLoadTestResult" minOccurs="0" maxOccurs="unbounded"/>
                     </sequence>
                  </complexType>
               </element>

VsanQueryVcClusterVmdkWorkloadTypes(queryClusterVmdkWorkloadTypes)

Deprecated. As of vSphere API 6.7.

Query the pre-defined workload types for the VMDK performance test.

Combined Privileges Required (on vSphere ManagedEntity):

Privileges	Required on
System.Read	RootFolder

* The Required Privileges section below is not used, please ignore.

Required Privileges: System.Read

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VsanVcClusterHealthSystem used to make the method call.

Return Value

Type	Description
VsanStorageWorkloadType[]	The vSAN cluster VMDK workload type

Faults

Type	Description
NotFound
NotSupported
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanQueryVcClusterVmdkWorkloadTypes" type="vsan:VsanQueryVcClusterVmdkWorkloadTypesRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanQueryVcClusterVmdkWorkloadTypesResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vsan:VsanStorageWorkloadType" maxOccurs="unbounded"/>
                     </sequence>
                  </complexType>
               </element>

VsanRebalanceCluster(rebalanceCluster)

Proactive rebalance the vSAN objects on the cluster hosts based on the vSAN disks usage when the disks are in imbalance status. The typical use case will be adding new host/disk into the vSAN cluster. Users should be aware that rebalancing causes additional background IO requires for data movements

Combined Privileges Required (on vSphere ManagedEntity):

Privileges	Required on
Host.Config.Storage	ClusterComputeResource

* The Required Privileges section below is not used, please ignore.

Required Privileges: None

Parameters

Name

Type

Description

_this

ManagedObjectReference

A reference to the VsanVcClusterHealthSystem used to make the method call.

cluster P

ManagedObjectReference
to a ClusterComputeResource

The vCenter cluster

Since vSphere API 5.5

targetHosts* P

ManagedObjectReference[]
to a HostSystem[]

Leave this unset

Since vSphere API 5.5

*Need not be set PRequired privilege - see tooltip for details

Return Value

Type	Description
ManagedObjectReference to a Task	task vCenter Task to track the rebalance process on the hosts. The task will be completed if all of hosts complete the rebalance

Faults

Type	Description
NotFound
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
VsanFault

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanRebalanceCluster" type="vsan:VsanRebalanceClusterRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanRebalanceClusterResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vsan:ManagedObjectReference"/>
                     </sequence>
                  </complexType>
               </element>

VsanStopRebalanceCluster(stopRebalanceCluster)

Stop proactive rebalance the vSAN objects on the cluster hosts

Combined Privileges Required (on vSphere ManagedEntity):

Privileges	Required on
Host.Config.Storage	ClusterComputeResource

* The Required Privileges section below is not used, please ignore.

Required Privileges: None

Parameters

Name

Type

Description

_this

ManagedObjectReference

A reference to the VsanVcClusterHealthSystem used to make the method call.

cluster P

ManagedObjectReference
to a ClusterComputeResource

The vCenter cluster

Since vSphere API 5.5

targetHosts* P

ManagedObjectReference[]
to a HostSystem[]

Leave this unset

Since vSphere API 5.5

*Need not be set PRequired privilege - see tooltip for details

Return Value

Type	Description
ManagedObjectReference to a Task	task vCenter Task to track the rebalance stop process. The task will be completed if all of hosts have stopped the rebalance

Faults

Type	Description
NotFound
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
VsanFault

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanStopRebalanceCluster" type="vsan:VsanStopRebalanceClusterRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanStopRebalanceClusterResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vsan:ManagedObjectReference"/>
                     </sequence>
                  </complexType>
               </element>

VsanVcClusterGetHclInfo(getClusterHclInfo)

Fetch HCL information including the HCL DB status in general and all devices used by vSAN on all hosts in the cluster(if any).

Combined Privileges Required (on vSphere ManagedEntity):

Privileges	Required on
System.Read	ClusterComputeResource

* The Required Privileges section below is not used, please ignore.

Required Privileges: None

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VsanVcClusterHealthSystem used to make the method call.
cluster* P	ManagedObjectReference to a ClusterComputeResource	The target vCenter cluster. Set to NULL if only intent to get the HCL DB status in general *Since* vSphere API 5.5
includeHostsResult* P	xsd:boolean	True to include the HCL information for each of host in the cluster. Default is True if it's not set. And will be overrided to False if cluster is NULL *Since* vSphere API 5.5
includeVendorInfo* P	xsd:boolean	Include the vendor tool information in the result *Since* vSphere API 5.5
esxRelease* P	xsd:string	The ESXi release version which HCL is computed against *Since* vSphere API 5.5

*Need not be set PRequired privilege - see tooltip for details

Return Value

Type	Description
VsanClusterHclInfo	The HCL information for the cluster

Faults

Type	Description
NotFound
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
VsanFault

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanVcClusterGetHclInfo" type="vsan:VsanVcClusterGetHclInfoRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanVcClusterGetHclInfoResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vsan:VsanClusterHclInfo"/>
                     </sequence>
                  </complexType>
               </element>

VsanVcClusterQueryVerifyHealthSystemVersions(queryVerifyClusterHealthSystemVersions)

Querying version information of vSAN health service installed on all the hosts in the cluster requested and vCenter Server. It will verify the consistency of the version numbers.

Combined Privileges Required (on vSphere ManagedEntity):

Privileges	Required on
System.Read	ClusterComputeResource

* The Required Privileges section below is not used, please ignore.

Required Privileges: None

Parameters

Name

Type

Description

_this

ManagedObjectReference

A reference to the VsanVcClusterHealthSystem used to make the method call.

cluster P

ManagedObjectReference
to a ClusterComputeResource

The target cluster

Since vSphere API 5.5

P Required privilege: cluster

Return Value

Type	Description
VsanClusterHealthSystemVersionResult	The vSAN health service version

Faults

Type	Description
NotFound
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanVcClusterQueryVerifyHealthSystemVersions" type="vsan:VsanVcClusterQueryVerifyHealthSystemVersionsRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanVcClusterQueryVerifyHealthSystemVersionsResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vsan:VsanClusterHealthSystemVersionResult"/>
                     </sequence>
                  </complexType>
               </element>

VsanVcClusterRunVmdkLoadTest(runVmdkLoadTest)

Deprecated. As of vSphere API 6.7.

Run VMDK load test for the given duration second with the IO workload test parameter specifying in spec. The test includes three steps. Firstly, it will create VMDKs on each of cluster host, and then run the IO work test, at last, it will clean up the all of created VMDKs on each of host.Each of step can be run separately by specifying the parameter action. The default action "fullrun" will run all of three steps together Note: if this API is called directly on ESXi host, for any element of specs' vmdkCreateSpec.profile should be either unset or empty as SPBM is not available on ESXi host for profile conversion.

Combined Privileges Required (on vSphere ManagedEntity):

Privileges	Required on
System.Read	ClusterComputeResource

* The Required Privileges section below is not used, please ignore.

Required Privileges: None

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VsanVcClusterHealthSystem used to make the method call.
cluster P	ManagedObjectReference to a ClusterComputeResource	The target vCenter cluster. *Since* vSphere API 5.5
runname P	xsd:string	The name for this test. *Since* vSphere API 5.5
durationSec* P	xsd:int	The duration time for each of VMDK load test. *Since* vSphere API 5.5
specs* P	VsanVmdkLoadTestSpec[]	*Since* vSphere API 5.5
action* P	xsd:string	The possible actions are "prepare", "run" and "cleanup" and "fullrun". Default is "fullrun". *Since* vSphere API 5.5

*Need not be set PRequired privilege - see tooltip for details

Return Value

Type	Description
ManagedObjectReference to a Task	task VC Task.

Faults

Type	Description
NotFound
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanVcClusterRunVmdkLoadTest" type="vsan:VsanVcClusterRunVmdkLoadTestRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanVcClusterRunVmdkLoadTestResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vsan:ManagedObjectReference"/>
                     </sequence>
                  </complexType>
               </element>

VsanVcUpdateHclDbFromWeb(updateHclDbFromWeb)

Downloads the HCL database from the VMware official website http://partnerweb.vmware.com/service/vsan/all.json. The DB will replace any existing DB, even if the existing DB may appear newer. Caller can supply a custom URL. If not provided, DB is downloaded from its standard location on vmware.com.

Combined Privileges Required (on vSphere ManagedEntity):

Privileges	Required on
Global.Settings	RootFolder

* The Required Privileges section below is not used, please ignore.

Required Privileges: Global.Settings

Parameters

Name

Type

Description

_this

ManagedObjectReference

A reference to the VsanVcClusterHealthSystem used to make the method call.

url* P

xsd:string

The URL for downloading the HCL DB. Unset to use the official standard location on vmware.com

Since vSphere API 5.5

*Need not be set P Required privilege: url

Return Value

Type	Description
xsd:boolean	Always return True, or throw exception. False is never returned.

Faults

Type	Description
NotFound
NotSupported	Thrown if run directly on an ESX Server host.
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
VsanFault

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanVcUpdateHclDbFromWeb" type="vsan:VsanVcUpdateHclDbFromWebRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanVcUpdateHclDbFromWebResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="xsd:boolean"/>
                     </sequence>
                  </complexType>
               </element>

VsanVcUploadHclDb(uploadHclDb)

Upload a DB file in JSON format. The DB will replace any existing DB, even if the existing DB may appear newer.

Combined Privileges Required (on vSphere ManagedEntity):

Privileges	Required on
Global.Settings	RootFolder

* The Required Privileges section below is not used, please ignore.

Required Privileges: Global.Settings

Parameters

Name

Type

Description

_this

ManagedObjectReference

A reference to the VsanVcClusterHealthSystem used to make the method call.

db P

xsd:string

The new DB, in base64 encoded, gzipped JSON format

Since vSphere API 5.5

P Required privilege: db

Return Value

Type	Description
xsd:boolean	Always return True, or throw exception. False is never returned.

Faults

Type	Description
NotFound
NotSupported	Thrown if run directly on an ESX Server host.
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
VsanFault

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanVcUploadHclDb" type="vsan:VsanVcUploadHclDbRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanVcUploadHclDbResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="xsd:boolean"/>
                     </sequence>
                  </complexType>
               </element>