VMware anomaly detection API - GET configuration

  • Reference
  • Published Aug 28, 2019

Gets the configuration of anomaly detection for VMware.

The request produces an application/json payload.

GETSaaShttps://{your-environment-id}.live.dynatrace.com/api/config/v1/anomalyDetection/vmware
Environment ActiveGatehttps://{your-activegate-domain}:9999/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
droppedPacketsDetectionDroppedPacketsDetectionConfig

The configuration of the high number of dropped packets detection.

esxiHighCpuSaturationEsxiHighCpuSaturationConfig

The configuration of the CPU saturation on ESXi host detection.

esxiHighMemoryDetectionEsxiHighMemoryDetectionConfig

The configuration of the memory saturation on ESXi host detection.

guestCpuLimitReachedGuestCPULimitReachedConfig

The configuration of the guest CPU limit reached configuration detection.

lowDatastoreSpaceDetectionLowDatastoreSpaceDetectionConfig

The configuraiton of the low datastore free space detection.

metadataConfigurationMetadata

Metadata useful for debugging

overloadedStorageDetectionOverloadedStorageDetectionConfig

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

slowPhysicalStorageDetectionSlowPhysicalStorageDetectionConfig

The configuraiton of the physical storage device running slow detection.

undersizedStorageDetectionUndersizedStorageDetectionConfig

Undersized storage device detection cofing

The DroppedPacketsDetectionConfig object

The configuration of the high number of dropped packets detection.

ElementTypeDescription
customThresholdsDroppedPacketsThresholds

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

enabledboolean

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

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 EsxiHighCpuSaturationConfig object

The configuration of the CPU saturation on ESXi host detection.

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

enabledboolean

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

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
cpuPeakPercentageinteger

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

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.

The EsxiHighMemoryDetectionConfig object

The configuration of the memory saturation on ESXi host detection.

ElementTypeDescription
customThresholdsEsxiHighMemoryThresholds

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

enabledboolean

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

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 GuestCPULimitReachedConfig object

The configuration of the guest CPU limit reached configuration detection.

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

enabledboolean

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

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.

vmCpuReadyMaxPercentageinteger

VM CPU ready is higher than X% occurred 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.

The LowDatastoreSpaceDetectionConfig object

The configuraiton of the low datastore free space detection.

ElementTypeDescription
customThresholdsLowDatastoreSpaceThresholds

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

enabledboolean

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

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

The ConfigurationMetadata object

Metadata useful for debugging

ElementTypeDescription
clusterVersionstring

Dynatrace version.

configurationVersionsinteger[]

A sorted list of the version numbers of the configuration.

currentConfigurationVersionsstring[]

A sorted list of version numbers of the configuration.

The OverloadedStorageDetectionConfig object

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

ElementTypeDescription
customThresholdsOverloadedStorageThresholds

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

enabledboolean

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

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 SlowPhysicalStorageDetectionConfig object

The configuraiton of the physical storage device running slow detection.

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

enabledboolean

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

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 UndersizedStorageDetectionConfig object

Undersized storage device detection cofing

ElementTypeDescription
customThresholdsUndersizedStorageThresholds

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

Fulfillment of any condition triggers an alert.

enabledboolean

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

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.

Response body JSON model

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

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

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/vmware

Response 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