vSAN Management API

			Local Methods
Managed Object Types	Data Object Types	All Properties	All Methods

Managed Object - VsanDiagnosticsSystem(vim.cluster.VsanDiagnosticsSystem)

See also

ComputeResource, HostSystem, VsanDiagnosticsThreshold, VsanNetworkDiagnostics

Since

vSAN API vSAN 7.0U2

Managed Object Description

This managed object provides the diagnostics service that operates at cluster level. It runs the periodical diagnostics on the vSAN related statistics, as well as the on-demand diagnostics operation, e.g., the diagnostics of the IOs for a certain virtual machine. The ManagedEntity can be accessed with MOID of 'vsan-cluster-diagnostics-system' through vSAN service at at vCenter side.

Properties

Name	Type	Description
None

Methods

Methods defined in this Managed Object
VsanGetThresholds, VsanQueryNetworkDiagnostics, VsanSetThresholds

VsanGetThresholds(getThresholds)

Get the threshold. If "entityType" is not set, all threshold settings will be returned; If "entityType" is set but "metric" is not set, threshold settings for the specified "entityType" will be returned; If threshold settings doesn't exist for "entityType", empty result ([]) will be returned; If both "entityType" and "metric" are set, threshold settings for the specified "entityType" and "metric" will be returned; If threshold settings doesn't exist for either "entityType" or "metric", empty result ([]) will be returned. If "metric" is set but "entityType" is not set, "metric" will be ignored and all threshold settings will be returned.

Required Privileges

System.Read

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VsanDiagnosticsSystem used to make the method call.
cluster P	ManagedObjectReference to a ComputeResource	The cluster where the threshold is to get from Since vSAN API vSAN 7.0U2
entityType* P	xsd:string	Get threshold only for the specified entity type. Since vSAN API vSAN 7.0U2
metric* P	xsd:string	Get threshold only for the specified metric, "entityType" must also be set if "metric" is set. Since vSAN API vSAN 7.0U2

*Need not be set PRequired privilege - see tooltip for details

Return Value

Type	Description
VsanDiagnosticsThreshold[]	vim.cluster.VsanDiagnosticsThreshold[]

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="VsanGetThresholds" type="vsan:VsanGetThresholdsRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanGetThresholdsResponse"> <complexType> <sequence> <element name="returnval" type="vsan:VsanDiagnosticsThreshold" minOccurs="0" maxOccurs="unbounded"/> </sequence> </complexType> </element>

VsanQueryNetworkDiagnostics(queryNetworkDiagnostics)

Get the latest network events that triggered network alarms.

Required Privileges

System.Read

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VsanDiagnosticsSystem used to make the method call.
cluster P	ManagedObjectReference to a ComputeResource	The cluster where the network diagnostics is performed. Since vSAN API vSAN 7.0U2
host* P	ManagedObjectReference to a HostSystem	Get only for the specified host. Since vSAN API vSAN 7.0U2

*Need not be set PRequired privilege - see tooltip for details

Return Value

Type	Description
VsanNetworkDiagnostics[]	vim.cluster.VsanNetworkDiagnostics[]

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="VsanQueryNetworkDiagnostics" type="vsan:VsanQueryNetworkDiagnosticsRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanQueryNetworkDiagnosticsResponse"> <complexType> <sequence> <element name="returnval" type="vsan:VsanNetworkDiagnostics" minOccurs="0" maxOccurs="unbounded"/> </sequence> </complexType> </element>

VsanSetThresholds(setThresholds)

Set the threshold. The "entityType" and "metric" of the new threshold must be in current supported list (see entityType), or fault "vmodl.fault.InvalidArgument" will be raised. If "yellow" or "red" value is "0" or not set in the new threshold, the existing "yellow" or "red" value of current threshold setting will keep unchanged.

Required Privileges

System.Read

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VsanDiagnosticsSystem used to make the method call.
cluster P	ManagedObjectReference to a ComputeResource	The cluster where the threshold is to set to Since vSAN API vSAN 7.0U2
thresholds* P	VsanDiagnosticsThreshold[]	The new threshold value to set Since vSAN API vSAN 7.0U2

*Need not be set PRequired privilege - see tooltip for details

Return Value

Type	Description
None

Faults

Type	Description
InvalidArgument
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="VsanSetThresholds" type="vsan:VsanSetThresholdsRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanSetThresholdsResponse"> <complexType/> </element>

Top of page			Local Methods
Managed Object Types	Data Object Types	All Properties	All Methods