| Local Methods | ||
Managed Object Types | Data Object Types | All Properties | All Methods |
Properties
Name | Type | Description |
---|---|---|
None |
Methods
Methods defined in this Managed Object |
---|
QueryIODiagnosticsInstances, QueryIODiagnosticsStats, StartIODiagnosticsTask, VsanGetThresholds, VsanQueryNetworkDiagnostics, VsanSetThresholds |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
Top of page | Local Methods | ||
Managed Object Types | Data Object Types | All Properties | All Methods |