# Managed Object - HostVsanHealthSystem(vim.host.VsanHealthSystem)

See also
  OptionValue, Task, VsanEncryptionHealthSummary, VsanFileServiceHealthSummary, VsanHclFirmwareUpdateSpec, VsanHealthQuerySpec, VsanHostCreateVmHealthTestResult, VsanHostEMMSummary, VsanHostHclInfo, VsanHostQueryCheckLimitsSpec, VsanIperfClientSpec, VsanLimitHealthResult, VsanNetworkDiagnosticsHealthInfo, VsanNetworkHealthResult, VsanNetworkLoadTestResult, VsanObjectOverallHealth, VsanPhysicalDiskHealthSummary, VsanProactiveRebalanceInfoEx, VsanQueryResultHostInfo, VsanRepairObjectsResult, VsanSmartStatsHostSummary, VsanVmdkLoadTestResult, VsanVmdkLoadTestSpec
Since
  vSphere API 5.5

## Managed Object Description

This managed object consolidates vSAN Health APIs that operate on a single ESXi host, i.e., the APIs in this Managed Object do not correlate health among multiple nodes in a vSAN cluster. Typically this level is not very useful for direct user consumption, and the cluster level APIs should be used instead. The cluster level APIs build upon the APIs in this Managed Object. All information retrieved is as seen by this host, which under network partitions is not the global view.
The ManagedEntity can be accessed with MOID of 'ha-vsan-health-system', through vSAN service at at ESXi host side.

Properties

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

Methods

Methods defined in this Managed Object
VsanFlashScsiControllerFirmware_Task, VsanGetHclInfo, VsanGetNetworkDiagnosticsHealthInfo, VsanGetProactiveRebalanceInfo, VsanHostCleanupVmdkLoadTest, VsanHostClomdLiveness, VsanHostCreateVmHealthTest, VsanHostPrepareVmdkLoadTest, VsanHostQueryAdvCfg, VsanHostQueryCheckLimits, VsanHostQueryEncryptionHealthSummary, VsanHostQueryFileServiceHealthSummary, VsanHostQueryHealthSystemVersion, VsanHostQueryHostInfoByUuids, VsanHostQueryObjectHealthSummary, VsanHostQueryPhysicalDiskHealthSummary, VsanHostQueryRunIperfClient, VsanHostQueryRunIperfServer, VsanHostQuerySmartStats, VsanHostQueryVerifyNetworkSettings, VsanHostRepairImmediateObjects, VsanHostRunVmdkLoadTest, VsanQueryHostEMMState, VsanStartProactiveRebalance, VsanStopProactiveRebalance, VsanWaitForVsanHealthGenerationIdChange

# VsanFlashScsiControllerFirmware_Task(flashScsiControllerFirmware)

Perform a SCSI controller firmware upgrade. Pre-requisites:

- Host must be in maintenance mode to ensure vSAN is in a stable quiesced state
- The vendor tools required to perform the firmware upgrade must have been installed

Required Privileges
  Host.Config.Storage
Since
  vSAN API 6.6

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostVsanHealthSystem used to make the method call.
spec P | VsanHclFirmwareUpdateSpec | Firmware update specification. Since vSAN API 6.6

P Required privilege: spec

Return Value

Type | Description
--- | ---
ManagedObjectReference to a 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

# VsanGetHclInfo(getHclInfo)

Fetch HCL information about all devices in use by vSAN. Currently covers SCSI controllers.

Required Privileges
  System.Read

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostVsanHealthSystem used to make the method call.
includeVendorInfo* P | xsd:boolean | Include vendor tool controller raw info in the result Since vSphere API 5.5

*Need not be set P Required privilege: includeVendorInfo

Return Value

Type | Description
--- | ---
VsanHostHclInfo |

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="VsanGetHclInfo" type="vsan:VsanGetHclInfoRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanGetHclInfoResponse"> <complexType> <sequence> <element name="returnval" type="vsan:VsanHostHclInfo"/> </sequence> </complexType> </element>

# VsanGetNetworkDiagnosticsHealthInfo(getNetworkDiagnosticsHealthInfo)

Query the network related information of the host for health check.

Required Privileges
  System.Read
Since
  vSAN API vSAN 7.0U3

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostVsanHealthSystem used to make the method call.

Return Value

Type | Description
--- | ---
VsanNetworkDiagnosticsHealthInfo | The network diagnostics information.

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:vsan="urn:vsan" name="VsanGetNetworkDiagnosticsHealthInfo" type="vsan:VsanGetNetworkDiagnosticsHealthInfoRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanGetNetworkDiagnosticsHealthInfoResponse"> <complexType> <sequence> <element name="returnval" type="vsan:VsanNetworkDiagnosticsHealthInfo"/> </sequence> </complexType> </element>

# VsanGetProactiveRebalanceInfo(getProactiveRebalanceInfo)

Retrieve information of proactive rebalance on this host

Required Privileges
  System.Read

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostVsanHealthSystem used to make the method call.

Return Value

Type | Description
--- | ---
VsanProactiveRebalanceInfoEx | The current proactive rebalance information

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:vsan="urn:vsan" name="VsanGetProactiveRebalanceInfo" type="vsan:VsanGetProactiveRebalanceInfoRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanGetProactiveRebalanceInfoResponse"> <complexType> <sequence> <element name="returnval" type="vsan:VsanProactiveRebalanceInfoEx"/> </sequence> </complexType> </element>

# VsanHostCleanupVmdkLoadTest(cleanupVmdkLoadTest)

Deprecated. As of vSphere API 6.7.

Cleanup the VMDK load test. It will delete the created test VMDKs during this test.

Required Privileges
  System.Read

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostVsanHealthSystem used to make the method call.
runname P | xsd:string | The name for this VMDK load test Since vSphere API 5.5
specs* P | VsanVmdkLoadTestSpec[] | The VMDK load test spec list each of which includes the VMDK creation spec and IO load test spec. Since vSphere API 5.5

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

Return Value

Type | Description
--- | ---
xsd:string |

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="VsanHostCleanupVmdkLoadTest" type="vsan:VsanHostCleanupVmdkLoadTestRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanHostCleanupVmdkLoadTestResponse"> <complexType> <sequence> <element name="returnval" type="xsd:string"/> </sequence> </complexType> </element>

# VsanHostClomdLiveness(checkClomdLiveness)

Check CLOMD liveness on vSAN host. It returns True only if CLOMD is alive, otherwise it throws VsanFault. It never returns False.

Required Privileges
  System.Read

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostVsanHealthSystem used to make the method call.

Return Value

Type | Description
--- | ---
xsd:boolean |

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 | when CLOMD is not alive.

Events

Type
None

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanHostClomdLiveness" type="vsan:VsanHostClomdLivenessRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanHostClomdLivenessResponse"> <complexType> <sequence> <element name="returnval" type="xsd:boolean"/> </sequence> </complexType> </element>

# VsanHostCreateVmHealthTest(createVmHealthTest)

Perform VM creation test on localhost.

Required Privileges
  System.Read
Since
  vSAN API 6.6

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostVsanHealthSystem used to make the method call.
timeout P | xsd:int | time out for the creation of VM Since vSAN API 6.6

P Required privilege: timeout

Return Value

Type | Description
--- | ---
VsanHostCreateVmHealthTestResult | summarized creation vm test result on the host

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:vsan="urn:vsan" name="VsanHostCreateVmHealthTest" type="vsan:VsanHostCreateVmHealthTestRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanHostCreateVmHealthTestResponse"> <complexType> <sequence> <element name="returnval" type="vsan:VsanHostCreateVmHealthTestResult"/> </sequence> </complexType> </element>

# VsanHostPrepareVmdkLoadTest(prepareVmdkLoadTest)

Deprecated. As of vSphere API 6.7.

Prepare the VMDK load test. It will create VMDKs on the host according to the VMDK creation spec given in the specs parameter.

Required Privileges
  System.Read

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostVsanHealthSystem used to make the method call.
runname P | xsd:string | The name for this VMDK load test Since vSphere API 5.5
specs P | VsanVmdkLoadTestSpec[] | The VMDK load test spec list each of which includes the VMDK creation spec and IO load test spec Since vSphere API 5.5

P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
xsd:string |

Faults

Type | Description
--- | ---
FileFault |
InvalidDatastorePath |
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.
VsanFault |

Events

Type
None

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanHostPrepareVmdkLoadTest" type="vsan:VsanHostPrepareVmdkLoadTestRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanHostPrepareVmdkLoadTestResponse"> <complexType> <sequence> <element name="returnval" type="xsd:string"/> </sequence> </complexType> </element>

# VsanHostQueryAdvCfg(queryAdvCfg)

Query advanced configuration on host

Required Privileges
  System.Read

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostVsanHealthSystem used to make the method call.
options P | xsd:string[] | list of path for the configuration name for example: [VSAN.VsanSparseCacheThreshold, VSAN.ClomRepairDelay, VSAN.ClomRebalanceThreshold, VSAN.DomLongOpTraceMS...] Since vSphere API 5.5
includeAllAdvOptions* P | xsd:boolean | Flag to check for all possible config options. If set to True the options parameter is ignored. Since vSphere API 5.5
nonDefaultOnly* P | xsd:boolean | Flag to return only options with non-default values. Since vSphere API 5.5

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

Return Value

Type | Description
--- | ---
OptionValue[] | list of key value pair of the querying options for example:<'VSAN.VsanSparseCacheThreshold':1>, <'VSAN.ClomRepairDelay':60>... Allow to return empty list.

Faults

Type | Description
--- | ---
NotFound | the path 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="VsanHostQueryAdvCfg" type="vsan:VsanHostQueryAdvCfgRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanHostQueryAdvCfgResponse"> <complexType> <sequence> <element name="returnval" type="vsan:OptionValue" minOccurs="0" maxOccurs="unbounded"/> </sequence> </complexType> </element>

# VsanHostQueryCheckLimits(queryCheckLimits)

Determines limit health, i.e. if any system resources (free disk space, vSAN component counts, etc.) are exhausted, or would be exhausted after simulated failures. All information is as seen by this host, which under network partitions is not the global view.

Required Privileges
  System.Read

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostVsanHealthSystem used to make the method call.
spec* P | VsanHostQueryCheckLimitsSpec | Please refer to VsanHostQueryCheckLimitsSpec for more details. Since vSphere API 5.5

*Need not be set P Required privilege: spec

Return Value

Type | Description
--- | ---
VsanLimitHealthResult | Summarized limit health as seen by this host

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="VsanHostQueryCheckLimits" type="vsan:VsanHostQueryCheckLimitsRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanHostQueryCheckLimitsResponse"> <complexType> <sequence> <element name="returnval" type="vsan:VsanLimitHealthResult"/> </sequence> </complexType> </element>

# VsanHostQueryEncryptionHealthSummary(queryEncryptionHealthSummary)

Query the encryption health summary on the host.

Required Privileges
  System.Read
Since
  vSAN API 6.6

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostVsanHealthSystem used to make the method call.

Return Value

Type | Description
--- | ---
VsanEncryptionHealthSummary | The encryption health summary 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="VsanHostQueryEncryptionHealthSummary" type="vsan:VsanHostQueryEncryptionHealthSummaryRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanHostQueryEncryptionHealthSummaryResponse"> <complexType> <sequence> <element name="returnval" type="vsan:VsanEncryptionHealthSummary"/> </sequence> </complexType> </element>

# VsanHostQueryFileServiceHealthSummary(queryFileServiceHealthSummary)

Query the file service health summary on the host.

Required Privileges
  System.Read
Since
  vSAN API 7.0

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostVsanHealthSystem used to make the method call.

Return Value

Type | Description
--- | ---
VsanFileServiceHealthSummary | The file service health summary 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="VsanHostQueryFileServiceHealthSummary" type="vsan:VsanHostQueryFileServiceHealthSummaryRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanHostQueryFileServiceHealthSummaryResponse"> <complexType> <sequence> <element name="returnval" type="vsan:VsanFileServiceHealthSummary"/> </sequence> </complexType> </element>

# VsanHostQueryHealthSystemVersion(queryVersion)

Return a string which represents vSAN version number for the querying host. for example: vSphere 6.0u2 host will return '6.2.0.0'

Required Privileges
  System.Read

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostVsanHealthSystem used to make the method call.
displayVersion* P | xsd:boolean | True to return vSAN display version instead of internal version. Default is False. Since vSphere API 5.5

*Need not be set P Required privilege: displayVersion

Return Value

Type | Description
--- | ---
xsd:string | The vSAN 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="VsanHostQueryHealthSystemVersion" type="vsan:VsanHostQueryHealthSystemVersionRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanHostQueryHealthSystemVersionResponse"> <complexType> <sequence> <element name="returnval" type="xsd:string"/> </sequence> </complexType> </element>

# VsanHostQueryHostInfoByUuids(queryHostInfoByUuids)

Query host info by host uuid. Multiple vSAN Host UUIDs may be passed in. If a uuid can't be resolved, it is still included in the result set, but without any additional information given.

Required Privileges
  System.Read

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostVsanHealthSystem used to make the method call.
uuids P | xsd:string[] | List of vSAN Host/Node UUIDs Since vSphere API 5.5

P Required privilege: uuids

Return Value

Type | Description
--- | ---
VsanQueryResultHostInfo[] | The hosts information for the given vSAN host/node UUIDs

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="VsanHostQueryHostInfoByUuids" type="vsan:VsanHostQueryHostInfoByUuidsRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanHostQueryHostInfoByUuidsResponse"> <complexType> <sequence> <element name="returnval" type="vsan:VsanQueryResultHostInfo" maxOccurs="unbounded"/> </sequence> </complexType> </element>

# VsanHostQueryObjectHealthSummary(queryObjectHealthSummary)

Query the object health status

Required Privileges
  System.Read

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostVsanHealthSystem used to make the method call.
objUuids* P | xsd:string[] | The DOM object UUID list to be queried. None to query all of objects Since vSphere API 5.5
includeObjUuids* P | xsd:boolean | True to include the object UUID list in the returned list and default is False Since vSphere API 5.5
localHostOnly* P | xsd:boolean | True to only query the objects owned by the host and default is False Since vSphere API 5.5
includeNonComplianceObjDetail* P | xsd:boolean | True to include all of non-compliant objects detail information. The default is False Since vSphere API 5.5
spec* P | VsanHealthQuerySpec | The additional query spec for object health. If the object health version is v2 vim.host.VsanObjectHealthVersion, it will try to convert v1 to v2 if not all of host can support the new object health version. If the object health version is unknown, it will always try to return the v2 object health version if all hosts support or return v1 if it doesn't Since vSphere API 5.5

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

Return Value

Type | Description
--- | ---
VsanObjectOverallHealth | The object health status query 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="VsanHostQueryObjectHealthSummary" type="vsan:VsanHostQueryObjectHealthSummaryRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanHostQueryObjectHealthSummaryResponse"> <complexType> <sequence> <element name="returnval" type="vsan:VsanObjectOverallHealth"/> </sequence> </complexType> </element>

# VsanHostQueryPhysicalDiskHealthSummary(queryPhysicalDiskHealthSummary)

Query the physical disks health summary on the host

Required Privileges
  System.Read

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostVsanHealthSystem used to make the method call.

Return Value

Type | Description
--- | ---
VsanPhysicalDiskHealthSummary | The physical disks health summary 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="VsanHostQueryPhysicalDiskHealthSummary" type="vsan:VsanHostQueryPhysicalDiskHealthSummaryRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanHostQueryPhysicalDiskHealthSummaryResponse"> <complexType> <sequence> <element name="returnval" type="vsan:VsanPhysicalDiskHealthSummary"/> </sequence> </complexType> </element>

# VsanHostQueryRunIperfClient(queryRunIperfClient)

Run the network performance test client side program to act as the sender to send the packet to each of receiver.

Required Privileges
  System.Read

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostVsanHealthSystem used to make the method call.
multicast P | xsd:boolean | True to test mutlicast network performance. False to test unicast network performance. Since vSphere API 5.5
serverIp P | xsd:string | The server IP binding to in the test 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
spec* P | VsanIperfClientSpec | The additional query spec for iperf client. Since vSphere API 5.5

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

Return Value

Type | Description
--- | ---
VsanNetworkLoadTestResult | The 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="VsanHostQueryRunIperfClient" type="vsan:VsanHostQueryRunIperfClientRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanHostQueryRunIperfClientResponse"> <complexType> <sequence> <element name="returnval" type="vsan:VsanNetworkLoadTestResult"/> </sequence> </complexType> </element>

# VsanHostQueryRunIperfServer(queryRunIperfServer)

Run the network performance test server side program to act as the receiver to receive the packet from sender.

Required Privileges
  System.Read

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostVsanHealthSystem used to make the method call.
multicast P | xsd:boolean | True to test mutlicast network performance. False to test unicast network performance. Since vSphere API 5.5
serverIp* P | xsd:string | The server IP binding to in the test 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 P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
VsanNetworkLoadTestResult | The 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="VsanHostQueryRunIperfServer" type="vsan:VsanHostQueryRunIperfServerRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanHostQueryRunIperfServerResponse"> <complexType> <sequence> <element name="returnval" type="vsan:VsanNetworkLoadTestResult"/> </sequence> </complexType> </element>

# VsanHostQuerySmartStats(querySmartStats)

Query the physical disks S.M.A.R.T. stats on the host

Required Privileges
  System.Read
Since
  vSAN API 6.6

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostVsanHealthSystem used to make the method call.
disks* P | xsd:string[] | Since vSAN API 6.6
includeAllDisks* P | xsd:boolean | Since vSAN API 6.6

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

Return Value

Type | Description
--- | ---
VsanSmartStatsHostSummary | The 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="VsanHostQuerySmartStats" type="vsan:VsanHostQuerySmartStatsRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanHostQuerySmartStatsResponse"> <complexType> <sequence> <element name="returnval" type="vsan:VsanSmartStatsHostSummary"/> </sequence> </complexType> </element>

# VsanHostQueryVerifyNetworkSettings(queryVerifyNetworkSettings)

Queries all network settings required to perform a cluster wide network health check. In addition, for all specified peers connectivity checks are performed, providing network health from the perspective of this ESXi host.

Required Privileges
  System.Read

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostVsanHealthSystem used to make the method call.
peers* P | xsd:string[] | List of IP addresses of other hosts in the vSAN cluster. Used to perform connectivity checks. Since vSphere API 5.5
ROBOStretchedClusterWitnesses* P | xsd:string[] | List of ROBO witness IPs. Used to info host that during the network connectivity check, the time out threshold should be different. Since vSphere API 5.5
vMotionPeers* P | xsd:string[] | List of IP addresses of vMotion traffic enabled NICs excludes this host. Used to perform vMotion connectivity checks. Since vSphere API 5.5
spec* P | VsanHealthQuerySpec | Since vSphere API 5.5

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

Return Value

Type | Description
--- | ---
VsanNetworkHealthResult | Summarized network health related information from the perspective of this host.

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="VsanHostQueryVerifyNetworkSettings" type="vsan:VsanHostQueryVerifyNetworkSettingsRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanHostQueryVerifyNetworkSettingsResponse"> <complexType> <sequence> <element name="returnval" type="vsan:VsanNetworkHealthResult"/> </sequence> </complexType> </element>

# VsanHostRepairImmediateObjects(repairImmediateObjects)

When the health check for vSAN object health test detects issues, this API can be used to repair the objects immediately. the result would return objects in three lists the queuing repairing list: contains objects which are queuing for repairing the failed repaired list: contains objects which fails to repaired the not in queue list: contains objects which are not in repairing queue due to out of slot even though the objects are in the queuing repairing list, it does not mean the repair process is done. The completing time for repairing all of objects is unpredictable and depends on vSAN backend.

Required Privileges
  Host.Config.Storage

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostVsanHealthSystem used to make the method call.
uuids* P | xsd:string[] | UUID list of the objects to be fixed Since vSphere API 5.5
repairType* P | xsd:string | Type of repair, can be 'fix-object-immediate' (default) or 'crawler' Since vSphere API 5.5

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

Return Value

Type | Description
--- | ---
VsanRepairObjectsResult |

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="VsanHostRepairImmediateObjects" type="vsan:VsanHostRepairImmediateObjectsRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanHostRepairImmediateObjectsResponse"> <complexType> <sequence> <element name="returnval" type="vsan:VsanRepairObjectsResult"/> </sequence> </complexType> </element>

# VsanHostRunVmdkLoadTest(runVmdkLoadTest)

Deprecated. As of vSphere API 6.7.

Run the VMDK load test according to the IO load test spec. It cannot be run before the test VMDK is created by invoking QueryPrepareVmdkLoadTest() API.

Required Privileges
  System.Read

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostVsanHealthSystem used to make the method call.
runname P | xsd:string | The name for this VMDK load 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[] | The VMDK load test spec list each of which includes the VMDK creation spec and IO load test spec Since vSphere API 5.5

P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
VsanVmdkLoadTestResult[] |

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="VsanHostRunVmdkLoadTest" type="vsan:VsanHostRunVmdkLoadTestRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanHostRunVmdkLoadTestResponse"> <complexType> <sequence> <element name="returnval" type="vsan:VsanVmdkLoadTestResult" maxOccurs="unbounded"/> </sequence> </complexType> </element>

# VsanQueryHostEMMState(queryHostEMMState)

Query the host's maintenance mode and vSAN node decommission state.

Required Privileges
  System.Read
Since
  vSAN API 6.7

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostVsanHealthSystem used to make the method call.

Return Value

Type | Description
--- | ---
VsanHostEMMSummary | The summary including if host is in MM and node decommission state on this host.

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:vsan="urn:vsan" name="VsanQueryHostEMMState" type="vsan:VsanQueryHostEMMStateRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanQueryHostEMMStateResponse"> <complexType> <sequence> <element name="returnval" type="vsan:VsanHostEMMSummary"/> </sequence> </complexType> </element>

# VsanStartProactiveRebalance(startProactiveRebalance)

Initiate proactive rebalance on target host

Required Privileges
  Host.Config.Storage

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostVsanHealthSystem used to make the method call.
timeSpan* P | xsd:int | Determines how long this proactive rebalance operation lasts in seconds, default 86400. Since vSphere API 5.5
varianceThreshold* P | xsd:float | Only if the disk's fullness (defined as used_capacity/disk_capacity) is above mean fullness and exceeds the lowest-usage disk in the cluster than this threshold, this disk is qualified for proactive rebalancing, default 0.3. Since vSphere API 5.5
timeThreshold* P | xsd:int | Only if the variance threshold has been continuously exceeded for this amount of time (in sec), the proactive rebalance operation will be applied to this disk, default 1800. Since vSphere API 5.5
rateThreshold* P | xsd:int | Determines how many bytes CLOMD on this node can move out per hour (MB/hr) for proactive rebalancing, default 51200. Since vSphere API 5.5

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

Return Value

Type | Description
--- | ---
xsd:boolean | True if the proactive rebalance has been triggered successfully but doesn't mean the proactive rebalance has been finished

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:vsan="urn:vsan" name="VsanStartProactiveRebalance" type="vsan:VsanStartProactiveRebalanceRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanStartProactiveRebalanceResponse"> <complexType> <sequence> <element name="returnval" type="xsd:boolean"/> </sequence> </complexType> </element>

# VsanStopProactiveRebalance(stopProactiveRebalance)

Stop proactive rebalance on target host

Required Privileges
  Host.Config.Storage

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostVsanHealthSystem used to make the method call.

Return Value

Type | Description
--- | ---
xsd:boolean | True if triggering stopping proactive rebalance successfully but doesn't mean the proactive rebalance has been stopped

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:vsan="urn:vsan" name="VsanStopProactiveRebalance" type="vsan:VsanStopProactiveRebalanceRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanStopProactiveRebalanceResponse"> <complexType> <sequence> <element name="returnval" type="xsd:boolean"/> </sequence> </complexType> </element>

# VsanWaitForVsanHealthGenerationIdChange(waitForVsanHealthGenerationIdChange)

Waiting until the change of current vSAN health generation ID or timed out. The change of generation ID indicates there are potential vSAN health status changes in the host

Required Privileges
  System.Read

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostVsanHealthSystem used to make the method call.
timeout P | xsd:int | The timeout in seconds. The recommended timeout is 10s Since vSphere API 5.5

P Required privilege: timeout

Return Value

Type | Description
--- | ---
xsd:boolean | True indicates there is generation ID change

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="VsanWaitForVsanHealthGenerationIdChange" type="vsan:VsanWaitForVsanHealthGenerationIdChangeRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanWaitForVsanHealthGenerationIdChangeResponse"> <complexType> <sequence> <element name="returnval" type="xsd:boolean"/> </sequence> </complexType> </element>