• Home
  • Dynatrace API
  • Configuration
  • Anomaly detection
  • VMware
  • GET configuration

VMware anomaly detection API - GET configuration

Gets the configuration of anomaly detection for VMware.

The request produces an application/json payload.

GETManagedDynatrace for Governmenthttps://{your-domain}/e/{your-environment-id}/api/config/v1/anomalyDetection/vmware
SaaShttps://{your-environment-id}.live.dynatrace.com/api/config/v1/anomalyDetection/vmware
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/anomalyDetection/vmware

Authentication

To execute this request, you need an access token with ReadConfig scope.

To learn how to obtain and use it, see Tokens and authentication.

Parameters

The request doesn't provide any configurable parameters.

Response

Response codes

CodeTypeDescription
200VMwareAnomalyDetectionConfig

Success

Response body objects

The VMwareAnomalyDetectionConfig object

The configuration of the anomaly detection for VMware.

ElementTypeDescription
metadataConfigurationMetadata

Metadata useful for debugging

esxiHighCpuSaturationEsxiHighCpuSaturationConfig

The configuration of the CPU saturation on ESXi host detection.

guestCpuLimitReachedGuestCPULimitReachedConfig

The configuration of the guest CPU limit reached configuration detection.

esxiHighMemoryDetectionEsxiHighMemoryDetectionConfig

The configuration of the memory saturation on ESXi host detection.

overloadedStorageDetectionOverloadedStorageDetectionConfig

The cofiguration of the overloaded storage on physical storage device detection.

undersizedStorageDetectionUndersizedStorageDetectionConfig

Undersized storage device detection cofing

slowPhysicalStorageDetectionSlowPhysicalStorageDetectionConfig

The configuraiton of the physical storage device running slow detection.

droppedPacketsDetectionDroppedPacketsDetectionConfig

The configuration of the high number of dropped packets detection.

lowDatastoreSpaceDetectionLowDatastoreSpaceDetectionConfig

The configuraiton of the low datastore free space detection.

The ConfigurationMetadata object

Metadata useful for debugging

ElementTypeDescription
configurationVersionsinteger[]

A sorted list of the version numbers of the configuration.

currentConfigurationVersionsstring[]

A sorted list of version numbers of the configuration.

clusterVersionstring

Dynatrace version.

The EsxiHighCpuSaturationConfig object

The configuration of the CPU saturation on ESXi host detection.

ElementTypeDescription
enabledboolean

The detection is enabled (true) or disabled (false).

customThresholdsEsxiHighCpuThresholds

Custom thresholds for CPU saturation detection on ESXi. If not set then the automatic mode is used.

All conditions must be fulfilled to trigger an alert.

The EsxiHighCpuThresholds object

Custom thresholds for CPU saturation detection on ESXi. If not set then the automatic mode is used.

All conditions must be fulfilled to trigger an alert.

ElementTypeDescription
cpuUsagePercentageinteger

CPU usage is higher than X% in 3 out of 5 samples.

vmCpuReadyPercentageinteger

VM CPU ready is higher than X% in 3 out of 5 samples.

cpuPeakPercentageinteger

At least one peak higher than X% occurred in 3 out of 5 samples.

The GuestCPULimitReachedConfig object

The configuration of the guest CPU limit reached configuration detection.

ElementTypeDescription
enabledboolean

The detection is enabled (true) or disabled (false).

customThresholdsGuestCPULimitThresholds

Custom thresholds for guest CPU limit detection. If not set then the automatic mode is used.

All conditions must be fulfilled to trigger an alert.

The GuestCPULimitThresholds object

Custom thresholds for guest CPU limit detection. If not set then the automatic mode is used.

All conditions must be fulfilled to trigger an alert.

ElementTypeDescription
hostCpuUsageMinPercentageinteger

Hypervisor CPU usage is higher than X% in 3 out of 5 samples.

vmCpuUsageMaxPercentageinteger

VM CPU usage (VM CPU Usage Mhz / VM CPU limit in Mhz) is higher than X% in 3 out of 5 samples.

vmCpuReadyMaxPercentageinteger

VM CPU ready is higher than X% occurred in 3 out of 5 samples.

The EsxiHighMemoryDetectionConfig object

The configuration of the memory saturation on ESXi host detection.

ElementTypeDescription
enabledboolean

The detection is enabled (true) or disabled (false).

customThresholdsEsxiHighMemoryThresholds

Custom thresholds for memory saturation on ESXi host. If not set then the automatic mode is used.

The EsxiHighMemoryThresholds object

Custom thresholds for memory saturation on ESXi host. If not set then the automatic mode is used.

ElementTypeDescription
compressionDecompressionRatenumber

Alert if ESXi host swap IN/OUT or compression/decompression rate is higher X kilobytes per second in 3 out of 5 samples.

The OverloadedStorageDetectionConfig object

The cofiguration of the overloaded storage on physical storage device detection.

ElementTypeDescription
enabledboolean

The detection is enabled (true) or disabled (false).

customThresholdsOverloadedStorageThresholds

Custom thresholds for overloaded storage on physical storage device. If not set then the automatic mode is used.

The OverloadedStorageThresholds object

Custom thresholds for overloaded storage on physical storage device. If not set then the automatic mode is used.

ElementTypeDescription
commandAbortsNumberinteger

Alert if number of command aborts is higher than X in 3 out of 5 samples.

The UndersizedStorageDetectionConfig object

Undersized storage device detection cofing

ElementTypeDescription
enabledboolean

The detection is enabled (true) or disabled (false).

customThresholdsUndersizedStorageThresholds

Custom thresholds for undersized storage device. If not set then the automatic mode is used.

Fulfillment of any condition triggers an alert.

The UndersizedStorageThresholds object

Custom thresholds for undersized storage device. If not set then the automatic mode is used.

Fulfillment of any condition triggers an alert.

ElementTypeDescription
averageQueueCommandLatencyinteger

Average queue command latency is higher than X milliseconds in 3 out of 5 samples.

peakQueueCommandLatencyinteger

Peak queue command latency is higher than X milliseconds in 3 out of 5 samples.

The SlowPhysicalStorageDetectionConfig object

The configuraiton of the physical storage device running slow detection.

ElementTypeDescription
enabledboolean

The detection is enabled (true) or disabled (false).

customThresholdsSlowPhysicalStorageThresholds

Custom thresholds for slow running physical storage device. If not set then the automatic mode is used.

Fulfillment of any condition triggers an alert.

The SlowPhysicalStorageThresholds object

Custom thresholds for slow running physical storage device. If not set then the automatic mode is used.

Fulfillment of any condition triggers an alert.

ElementTypeDescription
avgReadWriteLatencyinteger

Read/write latency is higher than X milliseconds in 4 out of 5 samples.

peakReadWriteLatencyinteger

Peak value for read/write latency is higher than X milliseconds in 4 out of 5 samples.

The DroppedPacketsDetectionConfig object

The configuration of the high number of dropped packets detection.

ElementTypeDescription
enabledboolean

The detection is enabled (true) or disabled (false).

customThresholdsDroppedPacketsThresholds

Custom thresholds for high number of dropped packets. If not set then the automatic mode is used.

The DroppedPacketsThresholds object

Custom thresholds for high number of dropped packets. If not set then the automatic mode is used.

ElementTypeDescription
droppedPacketsPerSecondinteger

Alert if receive/transmit dropped packets rate on NIC is higher than X packets per second in 3 out of 5 samples.

The LowDatastoreSpaceDetectionConfig object

The configuraiton of the low datastore free space detection.

ElementTypeDescription
enabledboolean

The detection is enabled (true) or disabled (false).

customThresholdsLowDatastoreSpaceThresholds

Custom thresholds for low datastore free space. If not set then the automatic mode is used.

The LowDatastoreSpaceThresholds object

Custom thresholds for low datastore free space. If not set then the automatic mode is used.

ElementTypeDescription
freeSpacePercentageinteger

Alert if datastore free space is lower than X%.

Response body JSON model

json
{ "metadata": { "configurationVersions": [ 4, 2 ], "clusterVersion": "Mock version" }, "esxiHighCpuSaturation": { "enabled": true, "customThresholds": { "cpuUsagePercentage": 80, "vmCpuReadyPercentage": 10, "cpuPeakPercentage": 90 } }, "esxiHighMemoryDetection": { "enabled": true, "customThresholds": { "compressionDecompressionRate": 120 } }, "overloadedStorageDetection": { "enabled": true, "customThresholds": { "commandAbortsNumber": 1 } }, "undersizedStorageDetection": { "enabled": true, "customThresholds": { "averageQueueCommandLatency": 15, "peakQueueCommandLatency": 160 } }, "slowPhysicalStorageDetection": { "enabled": true, "customThresholds": { "avgReadWriteLatency": 150, "peakReadWriteLatency": 400 } }, "droppedPacketsDetection": { "enabled": true, "customThresholds": { "droppedPacketsPerSecond": 4 } }, "lowDatastoreSpaceDetection": { "enabled": true, "customThresholds": { "freeSpacePercentage": 5 } } }

Example

In this example, the request lists the current configuration of anomaly detection for VMware.

The API token is passed in the Authorization header.

The configuration has the following settings:

Anomaly detection config - vmware

Curl

bash
curl -X GET \ https://mySampleEnv.live.dynatrace.com/api/config/v1/anomalyDetection/vmware \ -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

Request URL

plaintext
https://mySampleEnv.live.dynatrace.com/api/config/v1/anomalyDetection/vmware

Response body

json
{ "metadata": { "clusterVersion": "1.164.0.20190204-124711", "configurationVersions": [ 1 ] }, "esxiHighCpuSaturation": { "enabled": true }, "esxiHighMemoryDetection": { "enabled": true }, "overloadedStorageDetection": { "enabled": true }, "undersizedStorageDetection": { "enabled": true }, "slowPhysicalStorageDetection": { "enabled": true }, "droppedPacketsDetection": { "enabled": true }, "lowDatastoreSpaceDetection": { "enabled": true } }

Response code

200

Related topics
  • Adjust the sensitivity of anomaly detection for infrastructure

    Adjust problem detection sensitivity for infrastructure.

  • Problem detection and analysis

    Understand the basic concepts related to how Dynatrace detects and raises alerts for problems detected in your environment.