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

VMware anomaly detection API - PUT configuration

Updates the configuration of anomaly detection for VMware.

The request consumes an application/json payload.

PUTManagedDynatrace 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 WriteConfig scope.

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

Parameters

ParameterTypeDescriptionInRequired
bodyVMwareAnomalyDetectionConfig

JSON body of the request, containing parameters of the VMware anomaly detection configuration.

bodyoptional

Request body objects

The VMwareAnomalyDetectionConfig object

The configuration of the anomaly detection for VMware.

ElementTypeDescriptionRequired
metadataConfigurationMetadata

Metadata useful for debugging

optional
esxiHighCpuSaturationEsxiHighCpuSaturationConfig

The configuration of the CPU saturation on ESXi host detection.

required
guestCpuLimitReachedGuestCPULimitReachedConfig

The configuration of the guest CPU limit reached configuration detection.

optional
esxiHighMemoryDetectionEsxiHighMemoryDetectionConfig

The configuration of the memory saturation on ESXi host detection.

required
overloadedStorageDetectionOverloadedStorageDetectionConfig

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

required
undersizedStorageDetectionUndersizedStorageDetectionConfig

Undersized storage device detection cofing

required
slowPhysicalStorageDetectionSlowPhysicalStorageDetectionConfig

The configuraiton of the physical storage device running slow detection.

required
droppedPacketsDetectionDroppedPacketsDetectionConfig

The configuration of the high number of dropped packets detection.

required
lowDatastoreSpaceDetectionLowDatastoreSpaceDetectionConfig

The configuraiton of the low datastore free space detection.

required

The ConfigurationMetadata object

Metadata useful for debugging

ElementTypeDescriptionRequired
configurationVersionsinteger[]

A sorted list of the version numbers of the configuration.

optional
currentConfigurationVersionsstring[]

A sorted list of version numbers of the configuration.

optional
clusterVersionstring

Dynatrace version.

optional

The EsxiHighCpuSaturationConfig object

The configuration of the CPU saturation on ESXi host detection.

ElementTypeDescriptionRequired
enabledboolean

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

required
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.

optional

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.

ElementTypeDescriptionRequired
cpuUsagePercentageinteger

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

required
vmCpuReadyPercentageinteger

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

required
cpuPeakPercentageinteger

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

required

The GuestCPULimitReachedConfig object

The configuration of the guest CPU limit reached configuration detection.

ElementTypeDescriptionRequired
enabledboolean

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

required
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.

optional

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.

ElementTypeDescriptionRequired
hostCpuUsageMinPercentageinteger

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

required
vmCpuUsageMaxPercentageinteger

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

required
vmCpuReadyMaxPercentageinteger

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

required

The EsxiHighMemoryDetectionConfig object

The configuration of the memory saturation on ESXi host detection.

ElementTypeDescriptionRequired
enabledboolean

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

required
customThresholdsEsxiHighMemoryThresholds

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

optional

The EsxiHighMemoryThresholds object

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

ElementTypeDescriptionRequired
compressionDecompressionRatenumber

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

required

The OverloadedStorageDetectionConfig object

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

ElementTypeDescriptionRequired
enabledboolean

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

required
customThresholdsOverloadedStorageThresholds

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

optional

The OverloadedStorageThresholds object

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

ElementTypeDescriptionRequired
commandAbortsNumberinteger

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

required

The UndersizedStorageDetectionConfig object

Undersized storage device detection cofing

ElementTypeDescriptionRequired
enabledboolean

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

required
customThresholdsUndersizedStorageThresholds

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

Fulfillment of any condition triggers an alert.

optional

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.

ElementTypeDescriptionRequired
averageQueueCommandLatencyinteger

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

required
peakQueueCommandLatencyinteger

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

required

The SlowPhysicalStorageDetectionConfig object

The configuraiton of the physical storage device running slow detection.

ElementTypeDescriptionRequired
enabledboolean

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

required
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.

optional

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.

ElementTypeDescriptionRequired
avgReadWriteLatencyinteger

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

required
peakReadWriteLatencyinteger

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

required

The DroppedPacketsDetectionConfig object

The configuration of the high number of dropped packets detection.

ElementTypeDescriptionRequired
enabledboolean

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

required
customThresholdsDroppedPacketsThresholds

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

optional

The DroppedPacketsThresholds object

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

ElementTypeDescriptionRequired
droppedPacketsPerSecondinteger

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

required

The LowDatastoreSpaceDetectionConfig object

The configuraiton of the low datastore free space detection.

ElementTypeDescriptionRequired
enabledboolean

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

required
customThresholdsLowDatastoreSpaceThresholds

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

optional

The LowDatastoreSpaceThresholds object

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

ElementTypeDescriptionRequired
freeSpacePercentageinteger

Alert if datastore free space is lower than X%.

required

Request body JSON model

This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.

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 } } }

Response

Response codes

CodeTypeDescription
204

Success. Configuration has been updated. Response doesn't have a body.

400ErrorEnvelope

Failed. The input is invalid.

Validate payload

We recommend that you validate the payload before submitting it with an actual request. A response code of 204 indicates a valid payload.

The request consumes an application/json payload.

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

Authentication

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

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

Response

Response codes

CodeTypeDescription
204

Validated. The submitted configuration is valid. Response doesn't have a body.

400ErrorEnvelope

Failed. The input is invalid.

Example

In this example, the request updates the configuration of anomaly detection for VMware from the GET request example. It changes Detect CPU saturation ESXi host mode to based on custom thresholds and sets the following thresholds:

  • Alert if CPU usage is higher than 90%
  • AND VM CPU ready is higher than 12%
  • AND at least one peak higher than 98% occurred in 3 out of 5 samples.

The API token is passed in the Authorization header.

You can download or copy the example request body to try it out on your own. Be sure to create a backup copy of your current configuration with the GET VMware anomaly detection configuration call.

Curl

bash
curl -X PUT \ https://mySampleEnv.live.dynatrace.com/api/config/v1/anomalyDetection/vmware \ -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \ -H 'Content-Type: application/json' \ -d '{ "esxiHighCpuSaturation": { "enabled": true, "customThresholds": { "cpuUsagePercentage": 90, "vmCpuReadyPercentage": 12, "cpuPeakPercentage": 98 } }, "esxiHighMemoryDetection": { "enabled": true }, "overloadedStorageDetection": { "enabled": true }, "undersizedStorageDetection": { "enabled": true }, "slowPhysicalStorageDetection": { "enabled": true }, "droppedPacketsDetection": { "enabled": true }, "lowDatastoreSpaceDetection": { "enabled": true } } '

Request URL

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

Request body

json
{ "esxiHighCpuSaturation": { "enabled": true, "customThresholds": { "cpuUsagePercentage": 90, "vmCpuReadyPercentage": 12, "cpuPeakPercentage": 98 } }, "esxiHighMemoryDetection": { "enabled": true }, "overloadedStorageDetection": { "enabled": true }, "undersizedStorageDetection": { "enabled": true }, "slowPhysicalStorageDetection": { "enabled": true }, "droppedPacketsDetection": { "enabled": true }, "lowDatastoreSpaceDetection": { "enabled": true } }

Response code

204

Result

The updated configuration has the following parameters:

Anomaly detection config - vmware - updated

Related topics
  • Adjust the sensitivity of anomaly detection for infrastructure

    Adjust problem detection sensitivity for infrastructure.

  • Davis® AI

    Get familiar with the capabilities of Davis AI.