Vsan Performance Manager APIs
This managed object type provides the service interface for obtaining statistical data about various aspects of vSAN performance, as generated and maintained by the vSAN performance service of the cluster.
It also offers methods to enable/disable, configure and perform other maintenance tasks about the vSAN performance service. It is available on both vCenter as well as ESXi under the vSAN extension endpoint. On both systems a singleton object is registered under the Managed Object ID 'vsan-performance-manager'.
All the vSAN hosts belongs to one of the following two type in performance service perspective.
Stats Master node: see VsanPerfNodeInformation
Agent node: all other nodes except the master node, which collect its performance statistics when receive the request from master then send it back.
Operations
POST
Vsan Performance Manager Vsan Perf Create Stats Object
Create the vSAN object/directory containing the vSAN Perf Stats DB.
POST
Vsan Performance Manager Vsan Perf Create Stats Object Task
The asynchronous API of CreateStatsObject.
POST
Vsan Performance Manager Vsan Perf Delete Stats Object
Delete vSAN object/directory containing the vSAN Perf Stats DB.
POST
Vsan Performance Manager Vsan Perf Delete Stats Object Task
The asynchronous API of DeleteStatsObject.
POST
Vsan Performance Manager Vsan Perf Delete Time Range
Delete saved time range in performance service.
POST
Vsan Performance Manager Vsan Perf Get Aggregated Entity Types
Get supported aggregated entity types for front end data-driven
reporting of diagnostic exceptions which return aggregated data.
POST
Vsan Performance Manager Vsan Perf Get Supported Diagnostic Exceptions
Get supported performance exceptions for front end data-driven
performance exception reporting
POST
Vsan Performance Manager Vsan Perf Get Supported Entity Types
This API is used to build performance graphs in a data-driven and dynamic way.
POST
Vsan Performance Manager Get Vsan Perf Diagnosis Result
Returns the diagnosis result from the in memory cache for the supplied
task.
POST
Vsan Performance Manager Vsan Perf Query Cluster Health
This API shall not be used to query the health status for vSAN performance service.
POST
Vsan Performance Manager Vsan Perf Query Node Information
Query performance service related information about the node(s).
POST
Vsan Performance Manager Query Remote Server Clusters
Query all remote server clusters ever mounted from perf database by the
specified query specification and return their UUIDs.
POST
Vsan Performance Manager Vsan Perf Query Stats Object Information
Get information about the vSAN object/directory containing the vSAN Perf Stats DB.
POST
Vsan Performance Manager Vsan Perf Query Time Ranges
Query saved time ranges in performance service.
POST
Vsan Performance Manager Vsan Perf Query Perf
Retrieves the performance metrics for the specified
vSAN entity (or entities) based on the properties specified in
the VsanPerfQuerySpec data object
The supported entity types are listed as bellow.
- 'cluster-domclient'
- 'cluster-domcompmgr'
- 'host-domclient'
- 'host-domcompmgr'
- 'cache-disk'
- 'capacity-disk'
- 'disk-group'
- 'vscsi'
- 'virtual-machine'
- 'virtual-disk'
- 'vsan-host-net'
- 'vsan-vnic-net'
- 'vsan-pnic-net'
- 'lsom-world-cpu'
- 'dom-world-cpu'
- 'host-cpu'
- 'nic-world-cpu'
- 'vsan-cpu'
- 'vsan-memory'
- 'rdt-net'
The below entity types are used for vSAN ESA related metrics.
POST
Vsan Performance Manager Query Vsan Perf Hotspot Entities
The API is designed to return a list of hotspot entities that are consuming the
most IOPS, throughput or latency according to given start time and end time in
the vSAN cluster.
POST
Vsan Performance Manager Query Vsan Perf Top Entities
The API is designed to return a list of top contributors with either type of
VM or disk group that are consuming the most IOPS, throughput or latency in
the vSAN cluster.
POST
Vsan Performance Manager Vsan Perf Save Time Ranges
Save time ranges in performance service.
POST
Vsan Performance Manager Vsan Perf Set Stats Object Policy
Set the policy of the vSAN object/directory containing the vSAN Perf Stats DB.
POST
Vsan Performance Manager Vsan Perf Toggle Verbose Mode
Toggle vSAN performance service verbose mode.
POST
Vsan Performance Manager Vsan Perf Diagnose Deprecated
API to do performance diagnosis.
POST
Vsan Performance Manager Vsan Perf Diagnose Task
Runs a diagnostic query to determine performance issues in a vSAN
cluster.