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.dexp.ae/api/config/v1/anomalyDetection/vmware

Authentication

To execute this request, you need the Read configuration permission assigned to your API token. See the Authentication page to learn how to obtain and use it.

Parameters

The request doesn't provide any configurable parameters.

Response format

Response parameters JSON model

The VMwareAnomalyDetectionConfig object

The configuration of the anomaly detection for VMware.

Element	Type	Description
metadata	ConfigurationMetadata	Metadata useful for debugging.
esxiHighCpuSaturation	EsxiHighCpuSaturationConfig	How to detect CPU saturation on ESXi host.
guestCpuLimitReached	GuestCPULimitReachedConfig	How to detect guest CPU limit reached.
esxiHighMemoryDetection	EsxiHighMemoryDetectionConfig	How to detect memory saturation on ESXi host.
overloadedStorageDetection	OverloadedStorageDetectionConfig	How to detect overloaded storage on physical storage device.
undersizedStorageDetection	UndersizedStorageDetectionConfig	How to detect undersized storage device.
slowPhysicalStorageDetection	SlowPhysicalStorageDetectionConfig	How to detect physical storage device running slow.
droppedPacketsDetection	DroppedPacketsDetectionConfig	How to detect high number of dropped packets.
lowDatastoreSpaceDetection	LowDatastoreSpaceDetectionConfig	How to detect low datastore space.

The LowDatastoreSpaceDetectionConfig object

The configuraiton of the low datastore free space detection.

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

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

The DroppedPacketsDetectionConfig object

The configuration of the high number of dropped packets detection.

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

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

The configuraiton of the physical storage device running slow detection.

Element Type Description

enabled

boolean

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

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.

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

Undersized storage device detection cofing

Element Type Description

enabled

boolean

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

customThresholds

UndersizedStorageThresholds

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.

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

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

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

Element	Type	Description
commandAbortsNumber	integer	Alert if number of command aborts is higher than X 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 (`true`) or disabled (`false`).
customThresholds	EsxiHighMemoryThresholds	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.

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

The configuration of the guest CPU limit reached configuration detection.

Element Type Description

enabled

boolean

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

customThresholds

GuestCPULimitThresholds

Custom thresholds for Guest CPU limit reached. 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.

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

The configuration of the CPU saturation on ESXi host detection.

Element Type Description

enabled

boolean

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

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.

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

Metadata useful for debugging

Element	Type	Description
configurationVersions	integer[]	A Sorted list of the version numbers of the configuration.
clusterVersion	string	DESK server version.

    
{
  "metadata": {
    "configurationVersions": [
      4,
      2
    ],
    "clusterVersion": {
      "major": 0,
      "minor": 0,
      "revision": 0,
      "sourceRevision": "",
      "timestamp": ""
    }
  },
  "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

curl -X GET \
  https://mySampleEnv.live.dexp.ae/api/config/v1/anomalyDetection/vmware \
  -H 'Authorization: Api-token abcdefjhij1234567890'

Request URL

https://mySampleEnv.live.dexp.ae/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