Data Object - VsanPerfQuerySpec(vim.cluster.VsanPerfQuerySpec)

Parameter to
VsanPerfQueryPerf
Extends
DynamicData
Since
vSphere API 5.5

Data Object Description

This data object specifies the query parameters, including the reference ID to the target entity for statistics retrieval.

For supported entity types, metric groups, metrics:
See VsanPerfQueryPerf

Properties

Name Type Description
endTime*xsd:dateTime

The endTime is the server time up to which statistics are retrieved. This field will be replaced by current server time if it is later than current server time. This field must be specified and the returned samples include the sample at endTime.
entityRefIdxsd:string

The 'entityRefId' is an entity reference id, which is used to identify the target entity (i.e. clusters, hosts) you want to query. Here an entity reference id consists of an entity type and an UUID of the entity. Its format is <entity-type>:<entity-uuid>. It is possible to pass '*' as the value for entity-uuid in case one wants to query all entities of a certain type. For supported entity types:
See VsanPerfQueryPerf
group*xsd:string

A type of entity (like hosts) may have metrics with same names (i.e. IOPS, Throughput) in different groups/view-points (i.e. DOMClient, DOMCompMgr). Here the 'group' attribute is used to identify which group of metrics is to be queried for an entity. If group is not set, a default group will be used. For supported entity types, metric groups, metrics:
See VsanPerfQueryPerf
interval*xsd:int

The interval, in seconds, for aggregated performance statistics. Please ignore this field. It is not used in this version.
labels*xsd:string[]

The performance metrics (labels) to be retrieved. The label is also used in VsanPerfMetricId of returned metrics data.
startTime*xsd:dateTime

The startTime is the server time from which to obtain counters. This field must be specified, and the returned samples do not include the sample at startTime.
Properties inherited from DynamicData
None
*Need not be set
Show WSDL type definition