VMware anomaly detection API - GET configuration
Gets the configuration of anomaly detection for VMware.
The request produces an application/json payload.
| GET | Managed | https://{your-domain}/e/{your-environment-id}/api/config/v1/anomalyDetection/vmware |
| SaaS | https://{your-environment-id}.live.dynatrace.com/api/config/v1/anomalyDetection/vmware | |
| Environment ActiveGate | https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/anomalyDetection/vmware |
Authentication
To execute this request, you need an access token with Read configuration (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
| Code | Type | Description |
|---|---|---|
| 200 | V | Success |
Response body objects
The VMwareAnomalyDetectionConfig object
The configuration of the anomaly detection for VMware.
| Element | Type | Description |
|---|---|---|
| metadata | Configuration | Metadata useful for debugging Can be |
| esxiHighCpuSaturation | Esxi | The configuration of the CPU saturation on ESXi host detection. |
| guestCpuLimitReached | Guest | The configuration of the guest CPU limit reached configuration detection. Can be |
| esxiHighMemoryDetection | Esxi | The configuration of the memory saturation on ESXi host detection. |
| overloadedStorageDetection | Overloaded | The cofiguration of the overloaded storage on physical storage device detection. |
| undersizedStorageDetection | Undersized | Undersized storage device detection cofing |
| slowPhysicalStorageDetection | Slow | The configuraiton of the physical storage device running slow detection. |
| droppedPacketsDetection | Dropped | The configuration of the high number of dropped packets detection. |
| lowDatastoreSpaceDetection | Low | The configuraiton of the low datastore free space detection. |
The ConfigurationMetadata object
Metadata useful for debugging
| Element | Type | Description |
|---|---|---|
| configurationVersions | integer[] | A sorted list of the version numbers of the configuration. Can be |
| currentConfigurationVersions | string[] | A sorted list of version numbers of the configuration. Can be |
| clusterVersion | string | Dynatrace version. Can be |
The EsxiHighCpuSaturationConfig object
The configuration of the CPU saturation on ESXi host detection.
| Element | Type | Description |
|---|---|---|
| enabled | boolean | The detection is enabled ( |
| customThresholds | Esxi | 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. Can be |
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.
| Element | Type | Description |
|---|---|---|
| cpuUsagePercentage | integer | CPU usage is higher than X% in 3 out of 5 samples. |
| vmCpuReadyPercentage | integer | VM CPU ready is higher than X% in 3 out of 5 samples. |
| cpuPeakPercentage | integer | 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.
| Element | Type | Description |
|---|---|---|
| enabled | boolean | The detection is enabled ( |
| customThresholds | Guest | 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. Can be |
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.
| Element | Type | Description |
|---|---|---|
| hostCpuUsageMinPercentage | integer | Hypervisor CPU usage is higher than X% in 3 out of 5 samples. |
| vmCpuUsageMaxPercentage | integer | VM CPU usage (VM CPU Usage Mhz / VM CPU limit in Mhz) is higher than X% in 3 out of 5 samples. |
| vmCpuReadyMaxPercentage | integer | 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.
| Element | Type | Description |
|---|---|---|
| enabled | boolean | The detection is enabled ( |
| customThresholds | Esxi | Custom thresholds for memory saturation on ESXi host. If not set then the automatic mode is used. Can be |
The EsxiHighMemoryThresholds object
Custom thresholds for memory saturation on ESXi host. If not set then the automatic mode is used.
| Element | Type | Description |
|---|---|---|
| compressionDecompressionRate | number | 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.
| Element | Type | Description |
|---|---|---|
| enabled | boolean | The detection is enabled ( |
| customThresholds | Overloaded | Custom thresholds for overloaded storage on physical storage device. If not set then the automatic mode is used. Can be |
The OverloadedStorageThresholds object
Custom thresholds for overloaded storage on physical storage device. If not set then the automatic mode is used.
| Element | Type | Description |
|---|---|---|
| commandAbortsNumber | integer | Alert if number of command aborts is higher than X in 3 out of 5 samples. |
The UndersizedStorageDetectionConfig object
Undersized storage device detection cofing
| Element | Type | Description |
|---|---|---|
| enabled | boolean | The detection is enabled ( |
| customThresholds | Undersized | Custom thresholds for undersized storage device. If not set then the automatic mode is used. Fulfillment of any condition triggers an alert. Can be |
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.
| Element | Type | Description |
|---|---|---|
| averageQueueCommandLatency | integer | Average queue command latency is higher than X milliseconds in 3 out of 5 samples. |
| peakQueueCommandLatency | integer | 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.
| Element | Type | Description |
|---|---|---|
| enabled | boolean | The detection is enabled ( |
| customThresholds | Slow | Custom thresholds for slow running physical storage device. If not set then the automatic mode is used. Fulfillment of any condition triggers an alert. Can be |
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.
| Element | Type | Description |
|---|---|---|
| avgReadWriteLatency | integer | Read/write latency is higher than X milliseconds in 4 out of 5 samples. |
| peakReadWriteLatency | integer | 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.
| Element | Type | Description |
|---|---|---|
| enabled | boolean | The detection is enabled ( |
| customThresholds | Dropped | Custom thresholds for high number of dropped packets. If not set then the automatic mode is used. Can be |
The DroppedPacketsThresholds object
Custom thresholds for high number of dropped packets. If not set then the automatic mode is used.
| Element | Type | Description |
|---|---|---|
| droppedPacketsPerSecond | integer | 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.
| Element | Type | Description |
|---|---|---|
| enabled | boolean | The detection is enabled ( |
| customThresholds | Low | Custom thresholds for low datastore free space. If not set then the automatic mode is used. Can be |
The LowDatastoreSpaceThresholds object
Custom thresholds for low datastore free space. If not set then the automatic mode is used.
| Element | Type | Description |
|---|---|---|
| freeSpacePercentage | integer | Alert if datastore free space is lower than X%. |
Response body JSON model
{
"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:
Curl
curl -X GET \
https://mySampleEnv.live.dynatrace.com/api/config/v1/anomalyDetection/vmware \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'Request URL
https://mySampleEnv.live.dynatrace.com/api/config/v1/anomalyDetection/vmwareResponse body
{
"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