| Local Methods | ||
Managed Object Types | Data Object Types | All Properties | All Methods |
Properties
Name | Type | Description |
---|---|---|
None |
Methods
Privileges | Required on |
---|---|
System.Read | RootFolder |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VsanClusterHealthSystem used to make the method call. |
hosts | xsd:string[] |
The vSAN hosts
|
esxRootPassword | xsd: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 |
---|---|
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 |
Privileges | Required on |
---|---|
System.Read | RootFolder |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VsanClusterHealthSystem used to make the method call. |
hosts | xsd:string[] |
The vSAN hosts
|
esxRootPassword | xsd: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 |
---|---|
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 |
Privileges | Required on |
---|---|
System.Read | RootFolder |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VsanClusterHealthSystem used to make the method call. |
hosts | xsd:string[] |
The vSAN hosts
|
esxRootPassword | xsd: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 |
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 |
Privileges | Required on |
---|---|
System.Read | RootFolder |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VsanClusterHealthSystem used to make the method call. |
hosts | xsd:string[] |
The vSAN hosts
|
esxRootPassword | xsd:string |
The root password for the host. The password should
be the same for all of hosts in the vSAN cluster
|
duration | xsd: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 |
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 |
Privileges | Required on |
---|---|
System.Read | RootFolder |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VsanClusterHealthSystem used to make the method call. |
hosts | xsd:string[] |
The vSAN hosts
|
esxRootPassword | xsd: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 |
---|---|
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 |
Privileges | Required on |
---|---|
System.Read | RootFolder |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VsanClusterHealthSystem used to make the method call. |
hosts | xsd:string[] |
The vSAN hosts
|
esxRootPassword | xsd:string |
The root password for the host. The password should
be the same for all of hosts in the vSAN cluster
|
timeout | xsd:int |
The timeout time for the VM creation test
|
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 |
Privileges | Required on |
---|---|
System.Read | RootFolder |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VsanClusterHealthSystem used to make the method call. |
hosts | xsd:string[] |
The vSAN hosts
|
esxRootPassword | xsd: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 |
---|---|
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 |
Privileges | Required on |
---|---|
System.Read | RootFolder |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VsanClusterHealthSystem used to make the method call. |
hosts | xsd:string[] |
The vSAN hosts
|
esxRootPassword | xsd:string |
The root password for the host. The password should
be the same for all of hosts in the vSAN cluster
|
multicast | xsd: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 |
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 |
Privileges | Required on |
---|---|
System.Read | RootFolder |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VsanClusterHealthSystem used to make the method call. |
hosts | xsd:string[] |
The vSAN hosts
|
esxRootPassword | xsd: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 | |
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 |
Privileges | Required on |
---|---|
System.Read | RootFolder |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VsanClusterHealthSystem used to make the method call. |
hosts | xsd:string[] |
The vSAN hosts
|
esxRootPassword | xsd: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 |
---|---|
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 |
Privileges | Required on |
---|---|
System.Read | RootFolder |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VsanClusterHealthSystem used to make the method call. |
hosts | xsd:string[] |
The vSAN hosts
|
esxRootPassword | xsd: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 |
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 |
Top of page | Local Methods | ||
Managed Object Types | Data Object Types | All Properties | All Methods |