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 Virtual SAN Cluster Health System exposes the Virtual SAN cluster health service API and serves as an aggregator to collect the result from each of hosts in the Virtual SAN 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 Virtual SAN hosts

Required Privileges: System.Read

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VsanClusterHealthSystem used to make the method call.
hosts	xsd:string[]	The Virtual SAN hosts
esxRootPassword	xsd:string	The root password for the host. The password should be the same for all of hosts in the Virtual SAN cluster

Return Value

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

VsanClusterGetHclInfo(getClusterHclInfo)

Fetch HCL information about all devices in use by Virtual SAN 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	xsd:string[]	The Virtual SAN hosts
esxRootPassword	xsd:string	The root password for the host. The password should be the same for all of hosts in the Virtual SAN cluster

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.

Events

Type
None

Show WSDL type definition

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

VsanQueryClusterAdvCfgSync(queryAdvCfgSync)

Queries Virtual SAN advanced configuration and checks if all of the hosts in a Virtual SAN 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	xsd:string[]	The Virtual SAN hosts
esxRootPassword	xsd:string	The root password for the host. The password should be the same for all of hosts in the Virtual SAN cluster

Return Value

Type	Description
VsanClusterAdvCfgSyncResult[]	The Virtual SAN cluster advanced configuration consistent 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="VsanQueryClusterAdvCfgSync" type="vim25:VsanQueryClusterAdvCfgSyncRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="VsanQueryClusterAdvCfgSyncResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vim25:VsanClusterAdvCfgSyncResult" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>

VsanQueryClusterCaptureVsanPcap(queryCaptureVsanPcap)

Captures the Virtual SAN 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	xsd:string[]	The Virtual SAN hosts
esxRootPassword	xsd:string	The root password for the host. The password should be the same for all of hosts in the Virtual SAN cluster
duration	xsd:int	Duration to watch for packets in second. 1 minute is recommended
vmknic*	VsanClusterHostVmknicMapping[]	The map for host and the VM keneral nic using for Virtual SAN *Since* vSphere API 5.5
includeRawPcap*	xsd:boolean	True to include the raw pcap data in the result. Default is False *Since* vSphere API 5.5
includeIgmp*	xsd:boolean	True to include the IGMP network test data. Default is True *Since* vSphere API 5.5
cmmdsMsgTypeFilter*	xsd:string[]	The filter for Virtual SAN 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*	xsd:int[]	The Virtual SAN multicast ports. Unset will use the default Virtual SAN multicast ports. *Since* vSphere API 5.5
clusterUuid*	xsd:string	The Virtual SAN cluster UUID. *Since* vSphere API 5.5

*Need not be set

Return Value

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

VsanQueryClusterCheckLimits(queryCheckLimits)

Queries the Virtual SAN 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	xsd:string[]	The Virtual SAN hosts
esxRootPassword	xsd:string	The root password for the host. The password should be the same for all of hosts in the Virtual SAN cluster

Return Value

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

Required Privileges: System.Read

Parameters

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

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

VsanQueryClusterHealthSystemVersions(queryClusterHealthSystemVersions)

Queries Virtual SAN 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	xsd:string[]	The Virtual SAN hosts
esxRootPassword	xsd:string	The root password for the host. The password should be the same for all of hosts in the Virtual SAN cluster

Return Value

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

VsanQueryClusterNetworkPerfTest(queryClusterNetworkPerfTest)

Queries the Virtual SAN network multicast performance and checks if it meets the multicast bandwidth requirements of Virtual SAN

Required Privileges: System.Read

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VsanClusterHealthSystem used to make the method call.
hosts	xsd:string[]	The Virtual SAN hosts
esxRootPassword	xsd:string	The root password for the host. The password should be the same for all of hosts in the Virtual SAN 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="VsanQueryClusterNetworkPerfTest" type="vim25:VsanQueryClusterNetworkPerfTestRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="VsanQueryClusterNetworkPerfTestResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vim25:VsanClusterNetworkLoadTestResult"/>
               </sequence>
            </complexType>
         </element>

VsanQueryClusterPhysicalDiskHealthSummary(queryPhysicalDiskHealthSummary)

Queries the Virtual SAN physical disks health on all of Virtual SAN hosts

Required Privileges: System.Read

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VsanClusterHealthSystem used to make the method call.
hosts	xsd:string[]	The Virtual SAN hosts
esxRootPassword	xsd:string	The root password for the host. The password should be the same for all of hosts in the Virtual SAN cluster

Return Value

Type	Description
VsanPhysicalDiskHealthSummary[]	The Virtual SAN physical disks 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:vim25="urn:vim25" name="VsanQueryClusterPhysicalDiskHealthSummary" type="vim25:VsanQueryClusterPhysicalDiskHealthSummaryRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="VsanQueryClusterPhysicalDiskHealthSummaryResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vim25:VsanPhysicalDiskHealthSummary" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>

VsanQueryVerifyClusterNetworkSettings(queryVerifyClusterNetworkSettings)

Queries the Virtual SAN 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	xsd:string[]	The Virtual SAN hosts
esxRootPassword	xsd:string	The root password for the host. The password should be the same for all of hosts in the Virtual SAN cluster

Return Value

Type	Description
VsanClusterNetworkHealthResult	The Virtual SAN 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:vim25="urn:vim25" name="VsanQueryVerifyClusterNetworkSettings" type="vim25:VsanQueryVerifyClusterNetworkSettingsRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="VsanQueryVerifyClusterNetworkSettingsResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vim25: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	xsd:string[]	The Virtual SAN hosts
esxRootPassword	xsd:string	The root password for the host. The password should be the same for all of hosts in the Virtual SAN cluster
uuids*	xsd:string[]	The Virtual SAN objects UUID to be repaired. Unset to repair all of reduced objects in the Virtual SAN cluster *Since* vSphere API 5.5

*Need not be set

Return Value

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