# Managed Object - VsanClusterHealthSystem(vim.cluster.VsanClusterHealthSystem)

See also
  VsanClusterAdvCfgSyncResult, VsanClusterClomdLivenessResult, VsanClusterCreateVmHealthTestResult, VsanClusterHclInfo, VsanClusterHealthSystemObjectsRepairResult, VsanClusterHealthSystemVersionResult, VsanClusterHostVmknicMapping, VsanClusterLimitHealthResult, VsanClusterNetworkHealthResult, VsanClusterNetworkLoadTestResult, VsanPhysicalDiskHealthSummary, VsanVsanClusterPcapResult
Since
  vSphere API 5.5

## Managed Object Description

The vSAN Cluster Health System exposes the vSAN cluster health service API and serves as an aggregator to collect the result from each of hosts in the vSAN cluster.

Properties

Name | Type | Description
--- | --- | ---
None

Methods

Methods defined in this Managed Object
VsanCheckClusterClomdLiveness, VsanClusterGetHclInfo, VsanQueryClusterAdvCfgSync, VsanQueryClusterCaptureVsanPcap, VsanQueryClusterCheckLimits, VsanQueryClusterCreateVmHealthTest, VsanQueryClusterHealthSystemVersions, VsanQueryClusterNetworkPerfTest, VsanQueryClusterPhysicalDiskHealthSummary, VsanQueryVerifyClusterNetworkSettings, VsanRepairClusterImmediateObjects

# VsanCheckClusterClomdLiveness(checkClusterClomdLiveness)

Queries the CLOM daemon liveness on all of vSAN hosts

Required Privileges
  System.Read

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VsanClusterHealthSystem used to make the method call.
hosts P | xsd:string[] | The vSAN hosts Since vSphere API 5.5
esxRootPassword P | xsd:string | The root password for the host. The password should be the same for all of hosts in the vSAN cluster Since vSphere API 5.5

P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
VsanClusterClomdLivenessResult | The vSAN cluster clomd health 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="VsanCheckClusterClomdLiveness" type="vsan:VsanCheckClusterClomdLivenessRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanCheckClusterClomdLivenessResponse"> <complexType> <sequence> <element name="returnval" type="vsan:VsanClusterClomdLivenessResult"/> </sequence> </complexType> </element>

# VsanClusterGetHclInfo(getClusterHclInfo)

Fetch HCL information about all devices in use by vSAN on all hosts.

Required Privileges
  System.Read

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VsanClusterHealthSystem used to make the method call.
hosts P | xsd:string[] | The vSAN hosts Since vSphere API 5.5
esxRootPassword P | xsd:string | The root password for the host. The password should be the same for all of hosts in the vSAN cluster Since vSphere API 5.5

P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
VsanClusterHclInfo | The vSAN 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.

Events

Type
None

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanClusterGetHclInfo" type="vsan:VsanClusterGetHclInfoRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanClusterGetHclInfoResponse"> <complexType> <sequence> <element name="returnval" type="vsan:VsanClusterHclInfo"/> </sequence> </complexType> </element>

# VsanQueryClusterAdvCfgSync(queryAdvCfgSync)

Queries vSAN advanced configuration and checks if all of the hosts in a vSAN cluster have consistent advanced configuration options

Required Privileges
  System.Read

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VsanClusterHealthSystem used to make the method call.
hosts P | xsd:string[] | The vSAN hosts Since vSphere API 5.5
esxRootPassword P | xsd:string | The root password for the host. The password should be the same for all of hosts in the vSAN cluster Since vSphere API 5.5
options* P | xsd:string[] | list of vsi path for the configuration name Since vSphere API 5.5

*Need not be set P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
VsanClusterAdvCfgSyncResult[] | The vSAN cluster advanced configuration consistent result. If empty, indicates all in sync.

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="VsanQueryClusterAdvCfgSync" type="vsan:VsanQueryClusterAdvCfgSyncRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanQueryClusterAdvCfgSyncResponse"> <complexType> <sequence> <element name="returnval" type="vsan:VsanClusterAdvCfgSyncResult" minOccurs="0" maxOccurs="unbounded"/> </sequence> </complexType> </element>

# VsanQueryClusterCaptureVsanPcap(queryCaptureVsanPcap)

Captures the vSAN cluster multicast network trace to ensure that all of hosts in the cluster can receive multicast packets

Required Privileges
  System.Read

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VsanClusterHealthSystem used to make the method call.
hosts P | xsd:string[] | The vSAN hosts Since vSphere API 5.5
esxRootPassword P | xsd:string | The root password for the host. The password should be the same for all of hosts in the vSAN cluster Since vSphere API 5.5
duration P | xsd:int | Duration to watch for packets in second. 1 minute is recommended Since vSphere API 5.5
vmknic* P | VsanClusterHostVmknicMapping[] | The map for host and the vmknic using for vSAN Since vSphere API 5.5
includeRawPcap* P | xsd:boolean | True to include the raw pcap data in the result. Default is False Since vSphere API 5.5
includeIgmp* P | xsd:boolean | True to include the IGMP network test data. Default is True Since vSphere API 5.5
cmmdsMsgTypeFilter* P | xsd:string[] | The filter for vSAN message type. The network message whose type is not in the filter list will be ignored. All of the supported message types include "MASTER_HEARTBEAT", "MASTER_UPDATE" and "AGENT_HEARTBEAT". Since vSphere API 5.5
cmmdsPorts* P | xsd:int[] | The vSAN multicast ports. Unset will use the default vSAN multicast ports. Since vSphere API 5.5
clusterUuid* P | xsd:string | The vSAN cluster UUID. Since vSphere API 5.5

*Need not be set P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
VsanVsanClusterPcapResult | The vSAN cluster multicast trace 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="VsanQueryClusterCaptureVsanPcap" type="vsan:VsanQueryClusterCaptureVsanPcapRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanQueryClusterCaptureVsanPcapResponse"> <complexType> <sequence> <element name="returnval" type="vsan:VsanVsanClusterPcapResult"/> </sequence> </complexType> </element>

# VsanQueryClusterCheckLimits(queryCheckLimits)

Queries the vSAN cluster component limits, disk space and read cache reservation assuming one host failure

Required Privileges
  System.Read

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VsanClusterHealthSystem used to make the method call.
hosts P | xsd:string[] | The vSAN hosts Since vSphere API 5.5
esxRootPassword P | xsd:string | The root password for the host. The password should be the same for all of hosts in the vSAN cluster Since vSphere API 5.5

P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
VsanClusterLimitHealthResult | The vSAN cluster limit health 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="VsanQueryClusterCheckLimits" type="vsan:VsanQueryClusterCheckLimitsRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanQueryClusterCheckLimitsResponse"> <complexType> <sequence> <element name="returnval" type="vsan:VsanClusterLimitHealthResult"/> </sequence> </complexType> </element>

# VsanQueryClusterCreateVmHealthTest(queryClusterCreateVmHealthTest)

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

Required Privileges
  System.Read

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VsanClusterHealthSystem used to make the method call.
hosts P | xsd:string[] | The vSAN hosts Since vSphere API 5.5
esxRootPassword P | xsd:string | The root password for the host. The password should be the same for all of hosts in the vSAN cluster Since vSphere API 5.5
timeout P | xsd:int | The timeout time for the VM creation test Since vSphere API 5.5

P Required 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="VsanQueryClusterCreateVmHealthTest" type="vsan:VsanQueryClusterCreateVmHealthTestRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanQueryClusterCreateVmHealthTestResponse"> <complexType> <sequence> <element name="returnval" type="vsan:VsanClusterCreateVmHealthTestResult"/> </sequence> </complexType> </element>

# VsanQueryClusterHealthSystemVersions(queryClusterHealthSystemVersions)

Queries vSAN health service version number string for each host and check if all of them are consistent. Mark issueFound flag as True if they are not consistent.

Required Privileges
  System.Read

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VsanClusterHealthSystem used to make the method call.
hosts P | xsd:string[] | The vSAN hosts Since vSphere API 5.5
esxRootPassword P | xsd:string | The root password for the host. The password should be the same for all of hosts in the vSAN cluster Since vSphere API 5.5

P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
VsanClusterHealthSystemVersionResult | The vSAN cluster health service version 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="VsanQueryClusterHealthSystemVersions" type="vsan:VsanQueryClusterHealthSystemVersionsRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanQueryClusterHealthSystemVersionsResponse"> <complexType> <sequence> <element name="returnval" type="vsan:VsanClusterHealthSystemVersionResult"/> </sequence> </complexType> </element>

# VsanQueryClusterNetworkPerfTest(queryClusterNetworkPerfTest)

Queries the vSAN network performance and checks if it meets the bandwidth requirements.

Required Privileges
  System.Read

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VsanClusterHealthSystem used to make the method call.
hosts P | xsd:string[] | The vSAN hosts Since vSphere API 5.5
esxRootPassword P | xsd:string | The root password for the host. The password should be the same for all of hosts in the vSAN 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 time for the Network Performance test. Default is 15 seconds if not set. Since vSphere API 5.5

*Need not be set P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
VsanClusterNetworkLoadTestResult | The vSAN cluster network 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:vsan="urn:vsan" name="VsanQueryClusterNetworkPerfTest" type="vsan:VsanQueryClusterNetworkPerfTestRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanQueryClusterNetworkPerfTestResponse"> <complexType> <sequence> <element name="returnval" type="vsan:VsanClusterNetworkLoadTestResult"/> </sequence> </complexType> </element>

# VsanQueryClusterPhysicalDiskHealthSummary(queryPhysicalDiskHealthSummary)

Queries the vSAN physical disks health on all of vSAN hosts

Required Privileges
  System.Read

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VsanClusterHealthSystem used to make the method call.
hosts P | xsd:string[] | The vSAN hosts Since vSphere API 5.5
esxRootPassword P | xsd:string | The root password for the host. The password should be the same for all of hosts in the vSAN cluster Since vSphere API 5.5

P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
VsanPhysicalDiskHealthSummary[] | The vSAN physical disks health result. If empty, it indicates there is no connected host in 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.

Events

Type
None

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanQueryClusterPhysicalDiskHealthSummary" type="vsan:VsanQueryClusterPhysicalDiskHealthSummaryRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanQueryClusterPhysicalDiskHealthSummaryResponse"> <complexType> <sequence> <element name="returnval" type="vsan:VsanPhysicalDiskHealthSummary" minOccurs="0" maxOccurs="unbounded"/> </sequence> </complexType> </element>

# VsanQueryVerifyClusterNetworkSettings(queryVerifyClusterNetworkSettings)

Queries the vSAN cluster network setting and connectivity health status

Required Privileges
  System.Read

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VsanClusterHealthSystem used to make the method call.
hosts P | xsd:string[] | The vSAN hosts Since vSphere API 5.5
esxRootPassword P | xsd:string | The root password for the host. The password should be the same for all of hosts in the vSAN cluster Since vSphere API 5.5

P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
VsanClusterNetworkHealthResult | The vSAN cluster network health 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="VsanQueryVerifyClusterNetworkSettings" type="vsan:VsanQueryVerifyClusterNetworkSettingsRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanQueryVerifyClusterNetworkSettingsResponse"> <complexType> <sequence> <element name="returnval" type="vsan:VsanClusterNetworkHealthResult"/> </sequence> </complexType> </element>

# VsanRepairClusterImmediateObjects(repairClusterImmediateObjects)

Fix absent and degraded components in object immediately. The result will contain which object have been in queue for repair or failed to be repaired

Required Privileges
  System.Read

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VsanClusterHealthSystem used to make the method call.
hosts P | xsd:string[] | The vSAN hosts Since vSphere API 5.5
esxRootPassword P | xsd:string | The root password for the host. The password should be the same for all of hosts in the vSAN cluster Since vSphere API 5.5
uuids* P | xsd:string[] | The vSAN objects UUID to be repaired. Unset to repair all of reduced objects in the vSAN cluster Since vSphere API 5.5

*Need not be set P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
VsanClusterHealthSystemObjectsRepairResult | The vSAN cluster object repair 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="VsanRepairClusterImmediateObjects" type="vsan:VsanRepairClusterImmediateObjectsRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanRepairClusterImmediateObjectsResponse"> <complexType> <sequence> <element name="returnval" type="vsan:VsanClusterHealthSystemObjectsRepairResult"/> </sequence> </complexType> </element>