| Local Properties | ||
Managed Object Types | Data Object Types | All Properties | All Methods |
For ESX systems, a single instance of this data object exists. It cannot be modified. It has these properties:
key | samplingPeriod | length | name | level | enabled |
---|---|---|---|---|---|
1 | 300 | 129600 | PastDay | null | true |
VirtualCenter Server system provides four instances of this data object by default, that apply globally to all system entities.
Example Collection Levels
VirtualCenter Server
uses the specifications configured in its historical intervals to collect metrics
from the ESX systems that it manages. The quantity of data collected depends on
the level settings for the server, and the level associated with a specific counter.
Both factors may change from one version of the products to the next. In general,
the lower the number, the smaller the amount of data collected. For VirtualCenter
Server 2.5, for example, the levels 1 through 4 collected data as follows:
Default properties for the four built-in historical intervals include:
key | samplingPeriod | length | name | level | enabled |
---|---|---|---|---|---|
1 | 300 | 86400 | Past day | 1 | true |
2 | 1800 | 604800 | Past week | 1 | true |
3 | 7200 | 2592000 | Past month | 1 | true |
4 | 86400 | 31536000 | Past year | 1 | true |
All values are in seconds. The default setting for vCenter Server is level 1, which retains sampled statistical data as follows:
Data older than a year is purged from the vCenter Server database.
Prior to version 2.5 of the API, this data object could be used in conjunction with the CreatePerfInterval operation, to define new, custom historical intervals. That operation has been deprecated: Adding and deleting objects of this type is no longer supported. However, the default historical intervals can be enabled or disabled, and can be modified within certain limits (with the UpdatePerfInterval operation).
Properties
Name | Type | Description |
---|---|---|
enabled | xsd:boolean |
Indicates whether the interval is enabled (true) or disabled (false).
Disabling a historical interval prevents vCenter Server from collecting
metrics for that interval and all higher (longer) intervals.
For example, disabling the "Past Month" interval disables both "Past Month" and "Past Year" intervals. The system will aggregate and retain performance data using the "Past Day" and "Past Week" intervals only. Since VI API 2.5 |
key | xsd:int |
A unique identifier for the interval.
Since VI API 2.5 |
length | xsd:int |
Number of seconds that the statistics corresponding to this interval are
kept on the system.
|
level* | xsd:int |
Statistics collection level for this historical interval. vCenter Server
will aggregate only those statistics that match the value of this
property for this historical interval. For ESX, the value of this
property is null. For vCenter Server, the value will be a number from 1
to 4.
Since VI API 2.5 |
name | xsd:string |
The name of the historical interval. A localized string that provides a
name for the interval. Names include:
|
samplingPeriod | xsd:int |
Number of seconds that data is sampled for this interval. The real-time
samplingPeriod is 20 seconds.
|
Properties inherited from DynamicData | ||
None |
Top of page | Local Properties | ||
Managed Object Types | Data Object Types | All Properties | All Methods |