vSAN Management API
| Local Methods | ||
Managed Object Types | Data Object Types | All Properties | All Methods |
Managed Object - VsanClusterHealthSystem(vim.cluster.VsanClusterHealthSystem)
- See also
- VsanClusterAdvCfgSyncResult, VsanClusterClomdLivenessResult, VsanClusterCreateVmHealthTestResult, VsanClusterHclInfo, VsanClusterHealthSystemObjectsRepairResult, VsanClusterHealthSystemVersionResult, VsanClusterHostVmknicMapping, VsanClusterLimitHealthResult, VsanClusterNetworkHealthResult, VsanClusterNetworkLoadTestResult, VsanPhysicalDiskHealthSummary, VsanVsanClusterPcapResult
- Since
- vSphere API Release 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
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 | xsd:string[] |
The vSAN hosts
Since vSphere API Release 5.5 |
esxRootPassword | 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 Release 5.5 |
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
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 | xsd:string[] |
The vSAN hosts
Since vSphere API Release 5.5 |
esxRootPassword | 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 Release 5.5 |
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
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 | xsd:string[] |
The vSAN hosts
Since vSphere API Release 5.5 |
esxRootPassword | 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 Release 5.5 |
options* | xsd:string[] |
list of vsi path for the configuration name
Since vSphere API Release 5.5 |
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
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 | xsd:string[] |
The vSAN hosts
Since vSphere API Release 5.5 |
esxRootPassword | 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 Release 5.5 |
duration | xsd:int |
Duration to watch for packets in second. 1 minute is recommended
Since vSphere API Release 5.5 |
vmknic* | VsanClusterHostVmknicMapping[] |
The map for host and the vmknic using for vSAN
Since vSphere API Release 5.5 |
includeRawPcap* | xsd:boolean |
True to include the raw pcap data in the result. Default is False
Since vSphere API Release 5.5 |
includeIgmp* | xsd:boolean |
True to include the IGMP network test data. Default is True
Since vSphere API Release 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 Release 5.5 |
cmmdsPorts* | xsd:int[] |
The vSAN multicast ports. Unset will use the default vSAN
multicast ports.
Since vSphere API Release 5.5 |
clusterUuid* | xsd:string |
The vSAN cluster UUID.
Since vSphere API Release 5.5 |
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
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 | xsd:string[] |
The vSAN hosts
Since vSphere API Release 5.5 |
esxRootPassword | 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 Release 5.5 |
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
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 | xsd:string[] |
The vSAN hosts
Since vSphere API Release 5.5 |
esxRootPassword | 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 Release 5.5 |
timeout | xsd:int |
The timeout time for the VM creation test
Since vSphere API Release 5.5 |
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
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 | xsd:string[] |
The vSAN hosts
Since vSphere API Release 5.5 |
esxRootPassword | 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 Release 5.5 |
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
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 | xsd:string[] |
The vSAN hosts
Since vSphere API Release 5.5 |
esxRootPassword | 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 Release 5.5 |
multicast | xsd:boolean |
True to test vSAN multicast network performance.
False to test vSAN unicast network performance.
Since vSphere API Release 5.5 |
durationSec* | xsd:int |
The duration time for the Network Performance test. Default is 15
seconds if not set.
Since vSphere API Release 5.5 |
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
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 | xsd:string[] |
The vSAN hosts
Since vSphere API Release 5.5 |
esxRootPassword | 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 Release 5.5 |
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
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 | xsd:string[] |
The vSAN hosts
Since vSphere API Release 5.5 |
esxRootPassword | 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 Release 5.5 |
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
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 vSAN hosts
Since vSphere API Release 5.5 |
esxRootPassword | 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 Release 5.5 |
uuids* | xsd:string[] |
The vSAN objects UUID to be repaired. Unset to repair
all of reduced objects in the vSAN cluster
Since vSphere API Release 5.5 |
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
Top of page | Local Methods | ||
Managed Object Types | Data Object Types | All Properties | All Methods |