Vstats APIs

Vstats APIs

The com.vmware.vstats file provides API resources and types used in the vStats service.

API Categories
Vstats Acq Specs

The Vstats AcqSpecs resource provides operations to perform acquisition specification related operations. An acquisition specification defines the statistical data that should be collected at desired sampling rates from the underlying providers. It designates the resources and their counters which should be sampled, and a desired sampling rate.

Warning: this resource is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Vstats Counter Metadata

The Vstats CounterMetadata resource provides access to the different historical editions of counters. As computing platforms evolve over time the measurement units for different characteristics of the systems change. As such changes occur, counters will receive different editions reflected in a new metadata record. For example computer memory had changes from kilobytes through megabytes into gigabytes.

Warning: this resource is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Vstats Counter Sets

The Vstats CounterSets resource provides operations for accessing groupings of counters. Counter-sets allow consumers to use groups of counters. The counters may relate to different resource types. When an Vstats AcqSpecs record refers to a counter-set, only the relevant counters apply.

Warning: this resource is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Vstats Counters

The Vstats Counters resource provides operations to perform various Counter related operations. Counter is derived from metric. It applies the metric to a particular class of a resource.

Warning: this resource is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Vstats Data

The Vstats Data resource provides operations to query measurement and statistic data.

Warning: this resource is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Vstats Metrics

The Vstats Metrics resource provides operation to list metrics. A metric is a fundamental concept. It means a measurable aspect or property. For instance, temperature, count, velocity, data size, bandwidth.

Warning: this resource is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Vstats Providers

The Vstats Providers resource manages list of statistical data provider services that are currently used.

Warning: this resource is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Vstats Resource Address Schemas

The Vstats ResourceAddressSchemas resource manages inventory of resource addressing schemas used by Vstats Counters. Each schema consists of a named list of resource identifiers of specific resource type.

Warning: this resource is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Vstats Resource Addresses

The Vstats ResourceAddresses resource provides operations to perform resource addressing queries.

Warning: this resource is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Vstats Resource Types

The Vstats ResourceTypes resource provides list of resource types. Resource refers to any item or concept that could have measurable properties. It is a prerequisite that a resource can be identified.

Example resource types are virtual machine, virtual disk etc.

Warning: this resource is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.