# Managed Object - VsanDiagnosticsSystem(vim.cluster.VsanDiagnosticsSystem)

See also
  ClusterComputeResource, ComputeResource, HostSystem, Task, VirtualMachineProfileSpec, VsanDiagnosticsThreshold, VsanIODiagnosticsInstance, VsanIODiagnosticsInstanceQuerySpec, VsanIODiagnosticsTarget, VsanIODiagnosticsTargetStats, VsanIOTripAnalyzerConfig, VsanIOTripAnalyzerRecurrence, 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
CreateIOTripAnalyzerRecurrences, EditIOTripAnalyzerRecurrences, GetIOTripAnalyzerSchedulerConfig, QueryIODiagnosticsInstances, QueryIODiagnosticsStats, RemoveIOTripAnalyzerRecurrences, StartIODiagnosticsTask, VsanGetThresholds, VsanQueryNetworkDiagnostics, VsanSetThresholds, VsanSetTraceObjectPolicy

# CreateIOTripAnalyzerRecurrences(createIOTripAnalyzerRecurrences)

Schedule a set of IO trip analyzer recurrences. Currently only 1 recurrence supported for each vSAN cluster.

Required Privileges
  Global.Diagnostics
Since
  vSAN API 8.0.0.2

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 on which the IO trip analyzer scheduler is configured. Since vSAN API 8.0.0.2
recurrences P | VsanIOTripAnalyzerRecurrence[] | The scheduler recurrences configurations. Since vSAN API 8.0.0.2

P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
VsanIOTripAnalyzerRecurrence[] | The list of recurrences that are configured successfully. If the name of the recurrence is not given, it will fill the name with automatically generated name and return it in the list.

Faults

Type | Description
--- | ---
AlreadyExists | Thrown if the recurrence(s) name(s) already exists.
InvalidArgument | Thrown if the recurrence(s) setting(s) are not valid.
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
VsanFault | Thrown if internal vSAN error hit.

Events

Type
None

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="CreateIOTripAnalyzerRecurrences" type="vsan:CreateIOTripAnalyzerRecurrencesRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="CreateIOTripAnalyzerRecurrencesResponse"> <complexType> <sequence> <element name="returnval" type="vsan:VsanIOTripAnalyzerRecurrence" maxOccurs="unbounded"/> </sequence> </complexType> </element>

# EditIOTripAnalyzerRecurrences(editIOTripAnalyzerRecurrences)

Edit the IO trip analyzer recurrences with the given configuration. The name of the recurrence is used to find the recurrence to be updated. It must be provided when editing.

Required Privileges
  Global.Diagnostics
Since
  vSAN API 8.0.0.2

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 on which the IO trip analyzer scheduler is configured. Since vSAN API 8.0.0.2
recurrences P | VsanIOTripAnalyzerRecurrence[] | The updated recurrence(s) configuration. Since vSAN API 8.0.0.2

P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
VsanIOTripAnalyzerRecurrence[] | The list of recurrence(s) that are edited successfully.

Faults

Type | Description
--- | ---
InvalidArgument | Thrown if the recurrence(s) setting(s) are not valid.
NotFound | Thrown if the recurrence(s) name(s) not found.
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
VsanFault | Thrown if internal vSAN error hit.

Events

Type
None

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="EditIOTripAnalyzerRecurrences" type="vsan:EditIOTripAnalyzerRecurrencesRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="EditIOTripAnalyzerRecurrencesResponse"> <complexType> <sequence> <element name="returnval" type="vsan:VsanIOTripAnalyzerRecurrence" maxOccurs="unbounded"/> </sequence> </complexType> </element>

# GetIOTripAnalyzerSchedulerConfig(getIOTripAnalyzerSchedulerConfig)

Get the IO trip analyzer scheduler configurations for the given cluster.

Required Privileges
  System.Read
Since
  vSAN API 8.0.0.2

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 on which the IO trip analyzer scheduler is configured. Since vSAN API 8.0.0.2

P Required privilege: cluster

Return Value

Type | Description
--- | ---
VsanIOTripAnalyzerConfig | The IO trip analyzer scheduler configuration.

Faults

Type | Description
--- | ---
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
VsanFault | Thrown if internal vSAN error hit.

Events

Type
None

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="GetIOTripAnalyzerSchedulerConfig" type="vsan:GetIOTripAnalyzerSchedulerConfigRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="GetIOTripAnalyzerSchedulerConfigResponse"> <complexType> <sequence> <element name="returnval" type="vsan:VsanIOTripAnalyzerConfig" minOccurs="0"/> </sequence> </complexType> </element>

# QueryIODiagnosticsInstances(queryIODiagnosticsInstances)

Query the completed diagnostics instances by the given query spec.

Required Privileges
  None
Since
  vSAN API vSAN 7.0U3

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VsanDiagnosticsSystem used to make the method call.
querySpec P | VsanIODiagnosticsInstanceQuerySpec | The spec for instance query. Since vSAN API vSAN 7.0U3
cluster* P | ManagedObjectReference to a ClusterComputeResource | The cluster where the diagnostics is performed, ignored when calling against ESXi hosts. Since vSAN API vSAN 7.0U3

*Need not be set P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
VsanIODiagnosticsInstance[] | The list of the completed diagnostics instances.

Faults

Type | Description
--- | ---
InvalidArgument | Thrown if the query spec is not valid.
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
VsanFault | Thrown if the caller doesn't have the required privilege or if the vSAN performance service is disabled.

Events

Type
None

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="QueryIODiagnosticsInstances" type="vsan:QueryIODiagnosticsInstancesRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="QueryIODiagnosticsInstancesResponse"> <complexType> <sequence> <element name="returnval" type="vsan:VsanIODiagnosticsInstance" minOccurs="0" maxOccurs="unbounded"/> </sequence> </complexType> </element>

# QueryIODiagnosticsStats(queryIODiagnosticsStats)

Query the IO diagnostics stats according to the given diagnostics instance name.

Required Privileges
  None
Since
  vSAN API vSAN 7.0U3

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VsanDiagnosticsSystem used to make the method call.
instanceName P | xsd:string | The completed diagnostics instance name. Since vSAN API vSAN 7.0U3
cluster* P | ManagedObjectReference to a ClusterComputeResource | The cluster where the diagnostics is performed. Since vSAN API vSAN 7.0U3

*Need not be set P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
VsanIODiagnosticsTargetStats[] | The diagnostics stats.

Faults

Type | Description
--- | ---
InvalidArgument | Thrown if the given diagnostics instance name represent a running instance.
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
VsanFault | Thrown if the caller doesn't have the required privilege or if the vSAN performance service is disabled.

Events

Type
None

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="QueryIODiagnosticsStats" type="vsan:QueryIODiagnosticsStatsRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="QueryIODiagnosticsStatsResponse"> <complexType> <sequence> <element name="returnval" type="vsan:VsanIODiagnosticsTargetStats" minOccurs="0" maxOccurs="unbounded"/> </sequence> </complexType> </element>

# RemoveIOTripAnalyzerRecurrences(removeIOTripAnalyzerRecurrences)

Remove the IO trip analyzer recurrence(s) with the given name(s).

Required Privileges
  Global.Diagnostics
Since
  vSAN API 8.0.0.2

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 on which the IO trip analyzer scheduler is configured. Since vSAN API 8.0.0.2
names P | xsd:string[] | The name(s) of the IO trip analyzer recurrence(s) to be removed. Since vSAN API 8.0.0.2

P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
None

Faults

Type | Description
--- | ---
NotFound | Thrown if the recurrence(s) name(s) not found.
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
VsanFault | Thrown if internal vSAN error hit.

Events

Type
None

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="RemoveIOTripAnalyzerRecurrences" type="vsan:RemoveIOTripAnalyzerRecurrencesRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="RemoveIOTripAnalyzerRecurrencesResponse"> <complexType/> </element>

# StartIODiagnosticsTask(startIODiagnosticsTask)

Start IO diagnostics task against the given targets running on vSAN datastore. It's not supported to run multiple diagnostics tasks at the same time. You need either cancel the running task or wait until it completes before starting a new diagnostics task.

Required Privileges
  None
Since
  vSAN API vSAN 7.0U3

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VsanDiagnosticsSystem used to make the method call.
targets P | VsanIODiagnosticsTarget[] | The targets to run the diagnostics. Since vSAN API vSAN 7.0U3
cluster* P | ManagedObjectReference to a ClusterComputeResource | The cluster where the targets belong to, ignored when calling against ESXi hosts. Since vSAN API vSAN 7.0U3
duration* P | xsd:long | The duration time in seconds to run diagnostics. The valid range is [300, 3600], default is 300. Since vSAN API vSAN 7.0U3

*Need not be set P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
ManagedObjectReference to a Task | The task that runs the diagnostics.

Faults

Type | Description
--- | ---
InvalidArgument | Thrown if the targets are not valid.
NotSupported | Thrown if there's already a running diagnostics task.
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
VsanFault | Thrown if the caller doesn't have the required privilege or if the pre-check tests failed.

Events

Type
None

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="StartIODiagnosticsTask" type="vsan:StartIODiagnosticsTaskRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="StartIODiagnosticsTaskResponse"> <complexType> <sequence> <element name="returnval" type="vsan:ManagedObjectReference"/> </sequence> </complexType> </element>

# 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 P Required 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 P Required 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
  Global.Diagnostics

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 P Required 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>

# VsanSetTraceObjectPolicy(setTraceObjectPolicy)

Set the policy of the vSAN namespace object that hold the vSAN trace files. The cluster parameter is ignored if called on ESXi. Profile can be:
- VirtualMachineDefinedProfileSpec where profileId is an empty string and instead the profileData is set for extensionKey 'com.vmware.vim.sps'. In this case the objectData field can be either the vSAN expression format, or a SPBM XML string.
If no profile is supplied, a default profile with hostFailuresToTolerate setting will be used.

Required Privileges
  None

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VsanDiagnosticsSystem used to make the method call.
cluster* P | ManagedObjectReference to a ComputeResource | vSAN cluster. Ignored if called against host. Since vSAN API vSAN 7.0U2
traceObjectUuid P | xsd:string | Since vSAN API vSAN 7.0U2
profile* P | VirtualMachineProfileSpec | See above description for all possible options. Since vSAN API vSAN 7.0U2

*Need not be set P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
xsd:boolean | True

Faults

Type | Description
--- | ---
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
VsanFault | Thrown if the caller doesn't have the required privilege

Events

Type
None

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanSetTraceObjectPolicy" type="vsan:VsanSetTraceObjectPolicyRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanSetTraceObjectPolicyResponse"> <complexType> <sequence> <element name="returnval" type="xsd:boolean"/> </sequence> </complexType> </element>