VMware anomaly detection API - PUT configuration

Reference
Published Jan 23, 2019

Updates the configuration of anomaly detection for VMware.

The request consumes an application/json payload.

PUT	SaaS	`https://{your-environment-id}.live.dynatrace.com/api/config/v1/anomalyDetection/vmware`
PUT	Environment ActiveGate	`https://{your-activegate-domain}:9999/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

Parameter	Type	Description	In	Required
body	VMwareAnomalyDetectionConfig	JSON body of the request, containing parameters of the VMware anomaly detection configuration.	body	optional

Request body objects

The `VMwareAnomalyDetectionConfig` object

The configuration of the anomaly detection for VMware.

Element	Type	Description	Required
droppedPacketsDetection	DroppedPacketsDetectionConfig	The configuration of the high number of dropped packets detection.	required
esxiHighCpuSaturation	EsxiHighCpuSaturationConfig	The configuration of the CPU saturation on ESXi host detection.	required
esxiHighMemoryDetection	EsxiHighMemoryDetectionConfig	The configuration of the memory saturation on ESXi host detection.	required
guestCpuLimitReached	GuestCPULimitReachedConfig	The configuration of the guest CPU limit reached configuration detection.	optional
lowDatastoreSpaceDetection	LowDatastoreSpaceDetectionConfig	The configuraiton of the low datastore free space detection.	required
metadata	ConfigurationMetadata	Metadata useful for debugging	optional
overloadedStorageDetection	OverloadedStorageDetectionConfig	The cofiguration of the overloaded storage on physical storage device detection.	required
slowPhysicalStorageDetection	SlowPhysicalStorageDetectionConfig	The configuraiton of the physical storage device running slow detection.	required
undersizedStorageDetection	UndersizedStorageDetectionConfig	Undersized storage device detection cofing	required

The `DroppedPacketsDetectionConfig` object

The configuration of the high number of dropped packets detection.

Element	Type	Description	Required
customThresholds	DroppedPacketsThresholds	Custom thresholds for high number of dropped packets. If not set then the automatic mode is used.	optional
enabled	boolean	The detection is enabled (`true`) or disabled (`false`).	required

The `DroppedPacketsThresholds` object

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

Element	Type	Description	Required
droppedPacketsPerSecond	integer	Alert if receive/transmit dropped packets rate on NIC is higher than X packets per second in 3 out of 5 samples.	required

The `EsxiHighCpuSaturationConfig` object

The configuration of the CPU saturation on ESXi host detection.

Element Type Description Required

customThresholds

Element	Type	Description	Required
customThresholds	EsxiHighCpuThresholds	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
enabled	boolean	The detection is enabled (`true`) or disabled (`false`).	required

EsxiHighCpuThresholds

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

enabled

boolean

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

required

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	Required
cpuPeakPercentage	integer	At least one peak higher than X% occurred in 3 out of 5 samples.	required
cpuUsagePercentage	integer	CPU usage is higher than X% in 3 out of 5 samples.	required
vmCpuReadyPercentage	integer	VM CPU ready is higher than X% in 3 out of 5 samples.	required

The `EsxiHighMemoryDetectionConfig` object

The configuration of the memory saturation on ESXi host detection.

Element	Type	Description	Required
customThresholds	EsxiHighMemoryThresholds	Custom thresholds for memory saturation on ESXi host. If not set then the automatic mode is used.	optional
enabled	boolean	The detection is enabled (`true`) or disabled (`false`).	required

The `EsxiHighMemoryThresholds` object

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

Element	Type	Description	Required
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.	required

The `GuestCPULimitReachedConfig` object

The configuration of the guest CPU limit reached configuration detection.

Element Type Description Required

customThresholds

Element	Type	Description	Required
customThresholds	GuestCPULimitThresholds	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
enabled	boolean	The detection is enabled (`true`) or disabled (`false`).	required

GuestCPULimitThresholds

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

enabled

boolean

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

required

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	Required
hostCpuUsageMinPercentage	integer	Hypervisor CPU usage is higher than X% in 3 out of 5 samples.	required
vmCpuReadyMaxPercentage	integer	VM CPU ready is higher than X% occurred in 3 out of 5 samples.	required
vmCpuUsageMaxPercentage	integer	VM CPU usage (VM CPU Usage Mhz / VM CPU limit in Mhz) is higher than X% in 3 out of 5 samples.	required

The `LowDatastoreSpaceDetectionConfig` object

The configuraiton of the low datastore free space detection.

Element	Type	Description	Required
customThresholds	LowDatastoreSpaceThresholds	Custom thresholds for low datastore free space. If not set then the automatic mode is used.	optional
enabled	boolean	The detection is enabled (`true`) or disabled (`false`).	required

The `LowDatastoreSpaceThresholds` object

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

Element	Type	Description	Required
freeSpacePercentage	integer	Alert if datastore free space is lower than X%.	required

The `ConfigurationMetadata` object

Metadata useful for debugging

Element	Type	Description	Required
clusterVersion	string	Dynatrace version.	optional
configurationVersions	integer[]	A sorted list of the version numbers of the configuration.	optional
currentConfigurationVersions	string[]	A sorted list of version numbers of the configuration.	optional

The `OverloadedStorageDetectionConfig` object

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

Element	Type	Description	Required
customThresholds	OverloadedStorageThresholds	Custom thresholds for overloaded storage on physical storage device. If not set then the automatic mode is used.	optional
enabled	boolean	The detection is enabled (`true`) or disabled (`false`).	required

The `OverloadedStorageThresholds` object

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

Element	Type	Description	Required
commandAbortsNumber	integer	Alert if number of command aborts is higher than X in 3 out of 5 samples.	required

The `SlowPhysicalStorageDetectionConfig` object

The configuraiton of the physical storage device running slow detection.

Element Type Description Required

customThresholds

Element	Type	Description	Required
customThresholds	SlowPhysicalStorageThresholds	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
enabled	boolean	The detection is enabled (`true`) or disabled (`false`).	required

SlowPhysicalStorageThresholds

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

enabled

boolean

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

required

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	Required
avgReadWriteLatency	integer	Read/write latency is higher than X milliseconds in 4 out of 5 samples.	required
peakReadWriteLatency	integer	Peak value for read/write latency is higher than X milliseconds in 4 out of 5 samples.	required

The `UndersizedStorageDetectionConfig` object

Undersized storage device detection cofing

Element Type Description Required

customThresholds

Element	Type	Description	Required
customThresholds	UndersizedStorageThresholds	Custom thresholds for undersized storage device. If not set then the automatic mode is used. Fulfillment of any condition triggers an alert.	optional
enabled	boolean	The detection is enabled (`true`) or disabled (`false`).	required

UndersizedStorageThresholds

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

Fulfillment of any condition triggers an alert.

optional

enabled

boolean

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

required

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	Required
averageQueueCommandLatency	integer	Average queue command latency is higher than X milliseconds in 3 out of 5 samples.	required
peakQueueCommandLatency	integer	Peak queue command latency is higher than X milliseconds in 3 out of 5 samples.	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.

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

Response

Response codes

Code	Type	Description
204	-	Success. Configuration has been updated. Response doesn't have a body.
400	ErrorEnvelope	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.

POST	SaaS	`https://{your-environment-id}.live.dynatrace.com/api/config/v1/anomalyDetection/vmware/validator`
POST	Environment ActiveGate	`https://{your-activegate-domain}:9999/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

Code	Type	Description
204	-	Validated. The submitted configuration is valid. Response doesn't have a body.
400	ErrorEnvelope	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

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

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

Request body

{
  "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:

VMware anomaly detection API - PUT configuration

Authentication

Parameters

Request body objects

The VMwareAnomalyDetectionConfig object

The DroppedPacketsDetectionConfig object

The DroppedPacketsThresholds object

The EsxiHighCpuSaturationConfig object

The EsxiHighCpuThresholds object

The EsxiHighMemoryDetectionConfig object

The EsxiHighMemoryThresholds object

The GuestCPULimitReachedConfig object

The GuestCPULimitThresholds object

The LowDatastoreSpaceDetectionConfig object

The LowDatastoreSpaceThresholds object

The ConfigurationMetadata object

The OverloadedStorageDetectionConfig object

The OverloadedStorageThresholds object

The SlowPhysicalStorageDetectionConfig object

The SlowPhysicalStorageThresholds object

The UndersizedStorageDetectionConfig object

The UndersizedStorageThresholds object

Request body JSON model

Response

Response codes

Validate payload

Authentication

Response

Response codes

Example

Curl

Request URL

Request body

Response code

Result

Related topics

The `VMwareAnomalyDetectionConfig` object

The `DroppedPacketsDetectionConfig` object

The `DroppedPacketsThresholds` object

The `EsxiHighCpuSaturationConfig` object

The `EsxiHighCpuThresholds` object

The `EsxiHighMemoryDetectionConfig` object

The `EsxiHighMemoryThresholds` object

The `GuestCPULimitReachedConfig` object

The `GuestCPULimitThresholds` object

The `LowDatastoreSpaceDetectionConfig` object

The `LowDatastoreSpaceThresholds` object

The `ConfigurationMetadata` object

The `OverloadedStorageDetectionConfig` object

The `OverloadedStorageThresholds` object

The `SlowPhysicalStorageDetectionConfig` object

The `SlowPhysicalStorageThresholds` object

The `UndersizedStorageDetectionConfig` object

The `UndersizedStorageThresholds` object