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

Combined Privileges Required (on vSphere ManagedEntity):
Privileges Required on
System.Read RootFolder
* The RootFolder entity in above table refers to the vCenter server itself in the vCenter UI
* The ClusterComputeResource entity in above table refers to the cluster which is being operated on

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

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VsanClusterHealthSystem used to make the method call.
hostsxsd:string[]

The vSAN hosts
esxRootPasswordxsd:string

The root password for the host. The password should be the same for all of hosts in the vSAN cluster

Return Value

Type Description
VsanClusterClomdLivenessResultThe vSAN cluster clomd health result

Faults

Type Description
NotFound
RuntimeFaultThrown 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



VsanClusterGetHclInfo(getClusterHclInfo)

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

Combined Privileges Required (on vSphere ManagedEntity):
Privileges Required on
System.Read RootFolder
* The RootFolder entity in above table refers to the vCenter server itself in the vCenter UI
* The ClusterComputeResource entity in above table refers to the cluster which is being operated on

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

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VsanClusterHealthSystem used to make the method call.
hostsxsd:string[]

The vSAN hosts
esxRootPasswordxsd:string

The root password for the host. The password should be the same for all of hosts in the vSAN cluster

Return Value

Type Description
VsanClusterHclInfoThe vSAN cluster HCL information

Faults

Type Description
NotFound
RuntimeFaultThrown 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



VsanQueryClusterAdvCfgSync(queryAdvCfgSync)

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

Combined Privileges Required (on vSphere ManagedEntity):
Privileges Required on
System.Read RootFolder
* The RootFolder entity in above table refers to the vCenter server itself in the vCenter UI
* The ClusterComputeResource entity in above table refers to the cluster which is being operated on

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

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VsanClusterHealthSystem used to make the method call.
hostsxsd:string[]

The vSAN hosts
esxRootPasswordxsd:string

The root password for the host. The password should be the same for all of hosts in the vSAN cluster
options*xsd:string[]

list of vsi path for the configuration name

Since vSAN API 6.6
*Need not be set

Return Value

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

Faults

Type Description
NotFound
RuntimeFaultThrown 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



VsanQueryClusterCaptureVsanPcap(queryCaptureVsanPcap)

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

Combined Privileges Required (on vSphere ManagedEntity):
Privileges Required on
System.Read RootFolder
* The RootFolder entity in above table refers to the vCenter server itself in the vCenter UI
* The ClusterComputeResource entity in above table refers to the cluster which is being operated on

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

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VsanClusterHealthSystem used to make the method call.
hostsxsd:string[]

The vSAN hosts
esxRootPasswordxsd:string

The root password for the host. The password should be the same for all of hosts in the vSAN cluster
durationxsd:int

Duration to watch for packets in second. 1 minute is recommended
vmknic*VsanClusterHostVmknicMapping[]

The map for host and the vmknic using for vSAN

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 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*xsd:int[]

The vSAN multicast ports. Unset will use the default vSAN multicast ports.

Since vSphere API 5.5
clusterUuid*xsd:string

The vSAN cluster UUID.

Since vSphere API 5.5
*Need not be set

Return Value

Type Description
VsanVsanClusterPcapResultThe vSAN cluster multicast trace result

Faults

Type Description
NotFound
RuntimeFaultThrown 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



VsanQueryClusterCheckLimits(queryCheckLimits)

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

Combined Privileges Required (on vSphere ManagedEntity):
Privileges Required on
System.Read RootFolder
* The RootFolder entity in above table refers to the vCenter server itself in the vCenter UI
* The ClusterComputeResource entity in above table refers to the cluster which is being operated on

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

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VsanClusterHealthSystem used to make the method call.
hostsxsd:string[]

The vSAN hosts
esxRootPasswordxsd:string

The root password for the host. The password should be the same for all of hosts in the vSAN cluster

Return Value

Type Description
VsanClusterLimitHealthResultThe vSAN cluster limit health result

Faults

Type Description
NotFound
RuntimeFaultThrown 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



VsanQueryClusterCreateVmHealthTest(queryClusterCreateVmHealthTest)

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

Combined Privileges Required (on vSphere ManagedEntity):
Privileges Required on
System.Read RootFolder
* The RootFolder entity in above table refers to the vCenter server itself in the vCenter UI
* The ClusterComputeResource entity in above table refers to the cluster which is being operated on

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

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VsanClusterHealthSystem used to make the method call.
hostsxsd:string[]

The vSAN hosts
esxRootPasswordxsd:string

The root password for the host. The password should be the same for all of hosts in the vSAN cluster
timeoutxsd:int

The timeout time for the VM creation test

Return Value

Type Description
VsanClusterCreateVmHealthTestResultThe vSAN cluster VM creation test result

Faults

Type Description
NotFound
RuntimeFaultThrown 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



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.

Combined Privileges Required (on vSphere ManagedEntity):
Privileges Required on
System.Read RootFolder
* The RootFolder entity in above table refers to the vCenter server itself in the vCenter UI
* The ClusterComputeResource entity in above table refers to the cluster which is being operated on

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

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VsanClusterHealthSystem used to make the method call.
hostsxsd:string[]

The vSAN hosts
esxRootPasswordxsd:string

The root password for the host. The password should be the same for all of hosts in the vSAN cluster

Return Value

Type Description
VsanClusterHealthSystemVersionResultThe vSAN cluster health service version result

Faults

Type Description
NotFound
RuntimeFaultThrown 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



VsanQueryClusterNetworkPerfTest(queryClusterNetworkPerfTest)

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

Combined Privileges Required (on vSphere ManagedEntity):
Privileges Required on
System.Read RootFolder
* The RootFolder entity in above table refers to the vCenter server itself in the vCenter UI
* The ClusterComputeResource entity in above table refers to the cluster which is being operated on

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

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VsanClusterHealthSystem used to make the method call.
hostsxsd:string[]

The vSAN hosts
esxRootPasswordxsd:string

The root password for the host. The password should be the same for all of hosts in the vSAN cluster
multicastxsd:boolean

True to test vSAN multicast network performance. False to test vSAN unicast network performance.
durationSec*xsd:int

The duration time for the Network Performance test. Default is 15 seconds if not set.

Since vSAN API vSAN 6.7U1
*Need not be set

Return Value

Type Description
VsanClusterNetworkLoadTestResultThe vSAN cluster network performance test result

Faults

Type Description
NotFound
RuntimeFaultThrown 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



VsanQueryClusterPhysicalDiskHealthSummary(queryPhysicalDiskHealthSummary)

Queries the vSAN physical disks health on all of vSAN hosts

Combined Privileges Required (on vSphere ManagedEntity):
Privileges Required on
System.Read RootFolder
* The RootFolder entity in above table refers to the vCenter server itself in the vCenter UI
* The ClusterComputeResource entity in above table refers to the cluster which is being operated on

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

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VsanClusterHealthSystem used to make the method call.
hostsxsd:string[]

The vSAN hosts
esxRootPasswordxsd:string

The root password for the host. The password should be the same for all of hosts in the vSAN cluster

Return Value

Type Description
VsanPhysicalDiskHealthSummary[]The vSAN physical disks health result

Faults

Type Description
NotFound
RuntimeFaultThrown 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



VsanQueryVerifyClusterNetworkSettings(queryVerifyClusterNetworkSettings)

Queries the vSAN cluster network setting and connectivity health status

Combined Privileges Required (on vSphere ManagedEntity):
Privileges Required on
System.Read RootFolder
* The RootFolder entity in above table refers to the vCenter server itself in the vCenter UI
* The ClusterComputeResource entity in above table refers to the cluster which is being operated on

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

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VsanClusterHealthSystem used to make the method call.
hostsxsd:string[]

The vSAN hosts
esxRootPasswordxsd:string

The root password for the host. The password should be the same for all of hosts in the vSAN cluster

Return Value

Type Description
VsanClusterNetworkHealthResultThe vSAN cluster network health result

Faults

Type Description
NotFound
RuntimeFaultThrown 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



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

Combined Privileges Required (on vSphere ManagedEntity):
Privileges Required on
System.Read RootFolder
* The RootFolder entity in above table refers to the vCenter server itself in the vCenter UI
* The ClusterComputeResource entity in above table refers to the cluster which is being operated on

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

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VsanClusterHealthSystem used to make the method call.
hostsxsd:string[]

The vSAN hosts
esxRootPasswordxsd:string

The root password for the host. The password should be the same for all of hosts in the vSAN cluster
uuids*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

Return Value

Type Description
VsanClusterHealthSystemObjectsRepairResultThe vSAN cluster object repair result

Faults

Type Description
NotFound
RuntimeFaultThrown 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