Managed Object - VsanVcClusterHealthSystem(vim.cluster.VsanVcClusterHealthSystem)

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

Managed Object Description

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

Properties

Name	Type	Description
None

Methods

Methods defined in this Managed Object
VsanAttachVsanSupportBundleToSr, VsanHealthIsRebalanceRunning, VsanHealthQueryVsanClusterHealthCheckInterval, VsanHealthQueryVsanClusterHealthConfig, VsanHealthRepairClusterObjectsImmediate, VsanHealthSendVsanTelemetry, VsanHealthSetLogLevel, VsanHealthSetVsanClusterHealthCheckInterval, VsanHealthTestVsanClusterTelemetryProxy, VsanQueryAttachToSrHistory, VsanQueryVcClusterCreateVmHealthHistoryTest, VsanQueryVcClusterCreateVmHealthTest, VsanQueryVcClusterHealthSummary, VsanQueryVcClusterNetworkPerfHistoryTest, VsanQueryVcClusterNetworkPerfTest, VsanQueryVcClusterVmdkLoadHistoryTest, VsanQueryVcClusterVmdkWorkloadTypes, VsanRebalanceCluster, VsanStopRebalanceCluster, VsanVcClusterGetHclInfo, VsanVcClusterQueryVerifyHealthSystemVersions, VsanVcClusterRunVmdkLoadTest, VsanVcUpdateHclDbFromWeb, VsanVcUploadHclDb

Methods defined in this Managed Object

VsanAttachVsanSupportBundleToSr, VsanHealthIsRebalanceRunning, VsanHealthQueryVsanClusterHealthCheckInterval, VsanHealthQueryVsanClusterHealthConfig, VsanHealthRepairClusterObjectsImmediate, VsanHealthSendVsanTelemetry, VsanHealthSetLogLevel, VsanHealthSetVsanClusterHealthCheckInterval, VsanHealthTestVsanClusterTelemetryProxy, VsanQueryAttachToSrHistory, VsanQueryVcClusterCreateVmHealthHistoryTest, VsanQueryVcClusterCreateVmHealthTest, VsanQueryVcClusterHealthSummary, VsanQueryVcClusterNetworkPerfHistoryTest, VsanQueryVcClusterNetworkPerfTest, VsanQueryVcClusterVmdkLoadHistoryTest, VsanQueryVcClusterVmdkWorkloadTypes, VsanRebalanceCluster, VsanStopRebalanceCluster, VsanVcClusterGetHclInfo, VsanVcClusterQueryVerifyHealthSystemVersions, VsanVcClusterRunVmdkLoadTest, VsanVcUpdateHclDbFromWeb, VsanVcUploadHclDb

VsanAttachVsanSupportBundleToSr(attachVsanSupportBundleToSr)

Collect Virtual SAN and VC support bundle and upload to VMWare for the given SR (Service Request). The collected support bundles including Virtual SAN 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 VC bundles, small high importance ESX/Virtual SAN manifests, Virtual SAN traces and lower priority ESX manifests. The network proxy for uploading is also supported by calling SetVsanClusterTelmetryConfig() in advance.

Required Privileges: System.Read

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VsanVcClusterHealthSystem used to make the method call.
cluster	ManagedObjectReference to a ClusterComputeResource	The VC cluster
srNumber	xsd:string	The Customer Service Request number ID

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:vim25="urn:vim25" name="VsanAttachVsanSupportBundleToSr" type="vim25:VsanAttachVsanSupportBundleToSrRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="VsanAttachVsanSupportBundleToSrResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vim25:ManagedObjectReference"/>
               </sequence>
            </complexType>
         </element>

VsanHealthIsRebalanceRunning(isRebalanceRunning)

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

Required Privileges: System.Read

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

cluster

ManagedObjectReference
to a ClusterComputeResource

The target VC cluster.

targetHosts*

ManagedObjectReference[]
to a HostSystem[]

Leave this unset

Since vSphere API 5.5

*Need not be set

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:vim25="urn:vim25" name="VsanHealthIsRebalanceRunning" type="vim25:VsanHealthIsRebalanceRunningRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="VsanHealthIsRebalanceRunningResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="xsd:boolean"/>
               </sequence>
            </complexType>
         </element>

VsanHealthQueryVsanClusterHealthCheckInterval(queryVsanClusterHealthCheckInterval)

Get the periodical Virtual SAN health check interval (in minutes) for the cluster. The periodical Virtual SAN health check will perform a full Virtual SAN 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

Required Privileges: System.Read

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VsanVcClusterHealthSystem used to make the method call.
cluster	ManagedObjectReference to a ClusterComputeResource	The target VC cluster

Return Value

Type	Description
xsd:int	The periodical health check interval in minutes. Return 0 indicates the 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:vim25="urn:vim25" name="VsanHealthQueryVsanClusterHealthCheckInterval" type="vim25:VsanHealthQueryVsanClusterHealthCheckIntervalRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="VsanHealthQueryVsanClusterHealthCheckIntervalResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="xsd:int"/>
               </sequence>
            </complexType>
         </element>

VsanHealthQueryVsanClusterHealthConfig(queryVsanClusterHealthConfig)

Get the Virtual SAN cluster health system configuration for the cluster

Required Privileges: System.Read

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VsanVcClusterHealthSystem used to make the method call.
cluster	ManagedObjectReference to a ClusterComputeResource	The target VC cluster

Return Value

Type	Description
VsanClusterHealthConfigs	The Virtual SAN 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:vim25="urn:vim25" name="VsanHealthQueryVsanClusterHealthConfig" type="vim25:VsanHealthQueryVsanClusterHealthConfigRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="VsanHealthQueryVsanClusterHealthConfigResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vim25:VsanClusterHealthConfigs"/>
               </sequence>
            </complexType>
         </element>

VsanHealthRepairClusterObjectsImmediate(repairClusterObjectsImmediate)

Repair the absent or degraded Virtual SAN object immediately under the cluster. The task triggered by this API will be finished after putting all of the required objects into reparing 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 Virtual SAN backend.

Required Privileges: System.Read

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

cluster

ManagedObjectReference
to a ClusterComputeResource

The VC cluster.

uuids*

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

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:vim25="urn:vim25" name="VsanHealthRepairClusterObjectsImmediate" type="vim25:VsanHealthRepairClusterObjectsImmediateRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="VsanHealthRepairClusterObjectsImmediateResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vim25:ManagedObjectReference"/>
               </sequence>
            </complexType>
         </element>

VsanHealthSendVsanTelemetry(sendVsanTelemetry)

Collecting Virtual SAN telemetry for the given VC cluster and sending to VMWare server for CEIP (Customer Experience Improvement Plan)

Required Privileges: System.Read

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

cluster*

ManagedObjectReference
to a ClusterComputeResource

The VC cluster. Not set will collect the telemetry for all of Virtual SAN cluster

Since vSphere API 5.5

*Need not be set

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:vim25="urn:vim25" name="VsanHealthSendVsanTelemetry" type="vim25:VsanHealthSendVsanTelemetryRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="VsanHealthSendVsanTelemetryResponse">
            <complexType/>
         </element>

VsanHealthSetLogLevel(setLogLevel)

Set the Virtual SAN health log level which will be taken effect immediately. This setting will be refreshed and reverted to default INFO log level after VC system or health serivce 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

Required Privileges: System.Read

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

level*

xsd:string

The log level to set. Unset will set the log level to the default log level as INFO.

Since vSphere API 5.5

*Need not be set

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.

Events

Type
None

Show WSDL type definition

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

VsanHealthSetVsanClusterHealthCheckInterval(setVsanClusterHealthCheckInterval)

Set the periodical Virtual SAN health check interval (in minutes) for the cluster. The periodical Virtual SAN health check will perform a full Virtual SAN 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 Virtual SAN 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 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 Reqruied Privileges section bellow 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.
cluster	ManagedObjectReference to a ClusterComputeResource	The target VC cluster
vsanClusterHealthCheckInterval	xsd:int	The Virtual SAN cluster periodical health check interval in minutes. The value 0 will disable the periodical health check

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:vim25="urn:vim25" name="VsanHealthSetVsanClusterHealthCheckInterval" type="vim25:VsanHealthSetVsanClusterHealthCheckIntervalRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="VsanHealthSetVsanClusterHealthCheckIntervalResponse">
            <complexType/>
         </element>

VsanHealthTestVsanClusterTelemetryProxy(testVsanClusterTelemetryProxy)

Test the Virtual SAN proxy configuration, which is used for downloading, HCL DB, sending Virtual SAN 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

Required Privileges: System.Read

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VsanVcClusterHealthSystem used to make the method call.
proxyConfig	VsanClusterTelemetryProxyConfig	The proxy configuration

Return Value

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

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.
VsanFault

Events

Type
None

Show WSDL type definition

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

VsanQueryAttachToSrHistory(queryAttachToSrHistory)

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

Required Privileges: System.Read

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VsanVcClusterHealthSystem used to make the method call.
cluster	ManagedObjectReference to a ClusterComputeResource	The VC cluster
count*	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*	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

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:vim25="urn:vim25" name="VsanQueryAttachToSrHistory" type="vim25:VsanQueryAttachToSrHistoryRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="VsanQueryAttachToSrHistoryResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vim25:VsanAttachToSrOperation" minOccurs="0" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>

VsanQueryVcClusterCreateVmHealthHistoryTest(queryClusterCreateVmHealthHistoryTest)

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

Required Privileges: System.Read

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

cluster

ManagedObjectReference
to a ClusterComputeResource

The VC cluster

count*

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

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:vim25="urn:vim25" name="VsanQueryVcClusterCreateVmHealthHistoryTest" type="vim25:VsanQueryVcClusterCreateVmHealthHistoryTestRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="VsanQueryVcClusterCreateVmHealthHistoryTestResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vim25: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 Virtual SAN cluster

Required Privileges: System.Read

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VsanVcClusterHealthSystem used to make the method call.
cluster	ManagedObjectReference to a ClusterComputeResource	The target cluster
timeout	xsd:int	The timeout time in second for the VM creation test. The suggested value could be 2 mintues

Return Value

Type	Description
VsanClusterCreateVmHealthTestResult	The Virtual SAN 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:vim25="urn:vim25" name="VsanQueryVcClusterCreateVmHealthTest" type="vim25:VsanQueryVcClusterCreateVmHealthTestRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="VsanQueryVcClusterCreateVmHealthTestResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vim25: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 Virtual SAN 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.

Required Privileges: System.Read

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VsanVcClusterHealthSystem used to make the method call.
cluster	ManagedObjectReference to a ClusterComputeResource	The target cluster
vmCreateTimeout*	xsd:int	*Since* vSphere API 5.5
objUuids*	xsd:string[]	*Since* vSphere API 5.5
includeObjUuids*	xsd:boolean	Whether to include detailed per-object health in the result. *Since* vSphere API 5.5
fields*	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 *Since* vSphere API 5.5
fetchFromCache*	xsd:boolean	True to return the result from cache directly intead of running the full health check. The cache will be updated and keep the latest Virtual SAN health summary check result either triggering from user on-demand request or the periodical Virtual SAN health check for triggering health event/alarm. Default is False *Since* vSphere API 5.5

*Need not be set

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.

Events

Type
None

Show WSDL type definition

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

VsanQueryVcClusterNetworkPerfHistoryTest(queryClusterNetworkPerfHistoryTest)

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

Required Privileges: System.Read

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

cluster

ManagedObjectReference
to a ClusterComputeResource

The VC cluster

count*

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

Return Value

Type	Description
VsanClusterNetworkLoadTestResult[]	The Virtual SAN cluster network performance 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:vim25="urn:vim25" name="VsanQueryVcClusterNetworkPerfHistoryTest" type="vim25:VsanQueryVcClusterNetworkPerfHistoryTestRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="VsanQueryVcClusterNetworkPerfHistoryTestResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vim25:VsanClusterNetworkLoadTestResult" minOccurs="0" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>

VsanQueryVcClusterNetworkPerfTest(queryClusterNetworkPerfTest)

Query the Virtual SAN network multicast performance and checks if it meets the multicast bandwidth requirements of Virtual SAN. The test does so by picking one host as the sender, and having all other hosts be receivers. By virtue of being multicast traffic, any packet that the senders sends should be delivered to all receivers. If the network bandwidth below 20MB/s is too slow, and between 20MB/s and 50MB/s is low but OK, and anything above 50MB/s is within what VMware would expect.

Required Privileges: System.Read

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VsanVcClusterHealthSystem used to make the method call.
cluster	ManagedObjectReference to a ClusterComputeResource	The target cluster
multicast	xsd:boolean	True to test Virtual SAN multicast network performance. Currently, we only support the multicast performance test

Return Value

Type	Description
VsanClusterNetworkLoadTestResult	The Virtual SAN cluster multicast performance 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:vim25="urn:vim25" name="VsanQueryVcClusterNetworkPerfTest" type="vim25:VsanQueryVcClusterNetworkPerfTestRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="VsanQueryVcClusterNetworkPerfTestResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vim25:VsanClusterNetworkLoadTestResult"/>
               </sequence>
            </complexType>
         </element>

VsanQueryVcClusterVmdkLoadHistoryTest(queryClusterVmdkLoadHistoryTest)

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

Required Privileges: System.Read

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VsanVcClusterHealthSystem used to make the method call.
cluster	ManagedObjectReference to a ClusterComputeResource	The VC cluster
count*	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*	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

Return Value

Type	Description
VsanClusterVmdkLoadTestResult[]	The Virtual SAN storage load 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:vim25="urn:vim25" name="VsanQueryVcClusterVmdkLoadHistoryTest" type="vim25:VsanQueryVcClusterVmdkLoadHistoryTestRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="VsanQueryVcClusterVmdkLoadHistoryTestResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vim25:VsanClusterVmdkLoadTestResult" minOccurs="0" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>

VsanQueryVcClusterVmdkWorkloadTypes(queryClusterVmdkWorkloadTypes)

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

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 Virtual SAN cluster VMDK workload type

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:vim25="urn:vim25" name="VsanQueryVcClusterVmdkWorkloadTypes" type="vim25:VsanQueryVcClusterVmdkWorkloadTypesRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="VsanQueryVcClusterVmdkWorkloadTypesResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vim25:VsanStorageWorkloadType" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>

VsanRebalanceCluster(rebalanceCluster)

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

Required Privileges: System.Read

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

cluster

ManagedObjectReference
to a ClusterComputeResource

The VC cluster

targetHosts*

ManagedObjectReference[]
to a HostSystem[]

Leave this unset

Since vSphere API 5.5

*Need not be set

Return Value

Type	Description
ManagedObjectReference to a Task	task VC 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:vim25="urn:vim25" name="VsanRebalanceCluster" type="vim25:VsanRebalanceClusterRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="VsanRebalanceClusterResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vim25:ManagedObjectReference"/>
               </sequence>
            </complexType>
         </element>

VsanStopRebalanceCluster(stopRebalanceCluster)

Stop proactive rebalance the Virtual SAN objects on the cluster hosts

Required Privileges: System.Read

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

cluster

ManagedObjectReference
to a ClusterComputeResource

The VC cluster

targetHosts*

ManagedObjectReference[]
to a HostSystem[]

Leave this unset

Since vSphere API 5.5

*Need not be set

Return Value

Type	Description
ManagedObjectReference to a Task	task VC 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:vim25="urn:vim25" name="VsanStopRebalanceCluster" type="vim25:VsanStopRebalanceClusterRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="VsanStopRebalanceClusterResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vim25:ManagedObjectReference"/>
               </sequence>
            </complexType>
         </element>

VsanVcClusterGetHclInfo(getClusterHclInfo)

Fetch HCL information about all devices in use by Virtual SAN on all hosts in the cluster.

Required Privileges: System.Read

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

cluster

ManagedObjectReference
to a ClusterComputeResource

The target VC cluster

includeHostsResult*

xsd:boolean

True to include the hcl information for each of host in the cluster. Default is True if it's not set

Since vSphere API 5.5

*Need not be set

Return Value

Type	Description
VsanClusterHclInfo	The Virtual SAN cluster HCL information

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:vim25="urn:vim25" name="VsanVcClusterGetHclInfo" type="vim25:VsanVcClusterGetHclInfoRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="VsanVcClusterGetHclInfoResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vim25:VsanClusterHclInfo"/>
               </sequence>
            </complexType>
         </element>

VsanVcClusterQueryVerifyHealthSystemVersions(queryVerifyClusterHealthSystemVersions)

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

Required Privileges: System.Read

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VsanVcClusterHealthSystem used to make the method call.
cluster	ManagedObjectReference to a ClusterComputeResource	The target cluster

Return Value

Type	Description
VsanClusterHealthSystemVersionResult	The Virtual SAN 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:vim25="urn:vim25" name="VsanVcClusterQueryVerifyHealthSystemVersions" type="vim25:VsanVcClusterQueryVerifyHealthSystemVersionsRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="VsanVcClusterQueryVerifyHealthSystemVersionsResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vim25:VsanClusterHealthSystemVersionResult"/>
               </sequence>
            </complexType>
         </element>

VsanVcClusterRunVmdkLoadTest(runVmdkLoadTest)

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

Required Privileges: System.Read

Parameters

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

*Need not be set

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:vim25="urn:vim25" name="VsanVcClusterRunVmdkLoadTest" type="vim25:VsanVcClusterRunVmdkLoadTestRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="VsanVcClusterRunVmdkLoadTestResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vim25:ManagedObjectReference"/>
               </sequence>
            </complexType>
         </element>

VsanVcUpdateHclDbFromWeb(updateHclDbFromWeb)

Downloads the hcl DB 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.

Required Privileges: System.Read

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

url*

xsd:string

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

Since vSphere API 5.5

*Need not be set

Return Value

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

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:vim25="urn:vim25" name="VsanVcUpdateHclDbFromWeb" type="vim25:VsanVcUpdateHclDbFromWebRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" 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.

Required Privileges: System.Read

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VsanVcClusterHealthSystem used to make the method call.
db	xsd:string	The new DB, in base64 encoded, gzipped JSON format

Return Value

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

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:vim25="urn:vim25" name="VsanVcUploadHclDb" type="vim25:VsanVcUploadHclDbRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="VsanVcUploadHclDbResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="xsd:boolean"/>
               </sequence>
            </complexType>
         </element>