Msvm_AggregationMetricDefinition class
Represents the definition aspects of a metric that is derived from another metric value. The Msvm_AggregationMetricDefinition object should be associated with the managed elements to which it applies.
The following syntax is simplified Managed Object Format (MOF) code, and it includes all of the inherited properties.
Syntax
[Dynamic, Provider("VmmsWmiInstanceAndMethodProvider"), AMENDMENT]
class Msvm_AggregationMetricDefinition : CIM_AggregationMetricDefinition
{
string InstanceID;
string Caption;
string Description;
string ElementName;
string Id;
string Name;
uint16 DataType;
uint16 Calculable;
string Units;
string BreakdownDimensions[];
boolean IsContinuous;
uint16 ChangeType;
uint16 TimeScope;
uint16 GatheringType;
string ProgrammaticUnits;
uint16 SimpleFunction;
};
Members
The Msvm_AggregationMetricDefinition class has these types of members:
Properties
The Msvm_AggregationMetricDefinition class has these properties.
-
BreakdownDimensions
-
-
Data type: string array
-
Access type: Read-only
Defines one or more strings that can be used to refine (break down) queries against the metric values along a certain dimension. An example is a transaction name, allowing the break down of the total value for all transactions into a set of values, one for each transaction name. Other examples might be application system or user group name. The strings are free format and should be meaningful to the end users of the metric data. The strings indicate which break down dimensions are supported for this metric definition by the underlying instrumentation. This property is inherited from CIM_BaseMetricDefinition.
-
-
Calculable
-
-
Data type: uint16
-
Access type: Read-only
Describes the characteristics of the metric for purposes of performing calculations. This property is inherited from CIM_BaseMetricDefinition. This may be Null or one of the following values.
Value Meaning - Non-calculable
- 1
The value cannot be calculated. For example, a string. - Summable
- 2
The value can be summed over many instances. For example, if each backup job is a unit of work, and each job backs up 27,000 files on average, then 100 backup jobs processed 2,700,000 files. - Non-summable
- 3
This value cannot be summed over many instances. An example would be a metric that measures the queue length when a job arrives at a server. If each job is a unit of work, and the average queue length when each job arrives is 33, it does not make sense to say that the queue length for 100 jobs is 3300. It does make sense to say that the mean is 33. -
-
Caption
-
-
Data type: string
-
Access type: Read-only
A short description of the object. This property is inherited from CIM_ManagedElement.
-
-
ChangeType
-
-
Data type: uint16
-
Access type: Read-only
Indicates how the metric value changes, in the form of typical combinations of finer grain attributes such as direction change, minimum and maximum values, and wrapping semantics. This property is inherited from CIM_BaseMetricDefinition.
Value Meaning - Unknown
- 0
The metric designer did not qualify the ChangeType. - N/A
- 2
If the IsContinuous property is "false", ChangeType does not make sense and must be set to "N/A". - Counter
- 3
The metric is a counter metric. These have nonnegative integer values that increase until reaching the maximum representable number and then wrap around and start increasing from 0. - Gauge
- 4
The metric is a gauge metric. These have integer or float values that can increase and decrease arbitrarily. - DMTF Reserved
- 5..32767
- Vendor Reserved
- 32768..65535
Vendors may extend the ChangeType property in the vendor reserved range. -
-
DataType
-
-
Data type: uint16
-
Access type: Read-only
The data type of the metric. This property is inherited from CIM_BaseMetricDefinition.
-
boolean (1)
-
char16 (2)
-
datetime (3)
-
real32 (4)
-
real64 (5)
-
sint16 (6)
-
sint32 (7)
-
sint64 (8)
-
sint8 (9)
-
string (10)
-
uint16 (11)
-
uint32 (12)
-
uint64 (13)
-
uint8 (14 )
-
-
Description
-
-
Data type: string
-
Access type: Read-only
A description of the object. This property is inherited from CIM_ManagedElement.
-
-
ElementName
-
-
Data type: string
-
Access type: Read-only
A display name for the object. This property is inherited from CIM_ManagedElement.
-
-
GatheringType
-
-
Data type: uint16
-
Access type: Read-only
Indicates how the metric values are gathered by the underlying instrumentation. This allows the client application to choose the right metric for the purpose. This property is inherited from CIM_BaseMetricDefinition. This may be Null or one of the following values.
Value Meaning - Unknown
- 0
The gathering type is not known. - OnChange
- 2
The metric values get updated immediately when the values inside of the measured resource change. - Periodic
- 3
The metric values get updated periodically. For instance, to a client application, a metric value that applies to the current time will appear constant during each gathering interval, and then jumps to the new value at the end of each gathering interval. - OnRequest
- 4
The metric value is determined each time a client application reads it. - DMTF Reserved
- 5..32767
- Vendor Reserved
- 32768..65535
-
-
Id
-
-
Data type: string
-
Access type: Read-only
-
Qualifiers: Key
A string that uniquely identifies the metric definition. This property is inherited from CIM_BaseMetricDefinition.
-
-
InstanceID
-
-
Data type: string
-
Access type: Read-only
-
Qualifiers: Key
A string that uniquely identifies an instance of this class. This property is inherited from CIM_ManagedElement.
-
-
IsContinuous
-
-
Data type: boolean
-
Access type: Read-only
Indicates whether the metric value is continuous or scalar. Performance metrics are an example of a continuous metric. Examples of scalar metrics include error codes or operational states. Continuous metrics can be compared by using the "greater than" relation. This property is inherited from CIM_BaseMetricDefinition.
-
-
Name
-
-
Data type: string
-
Access type: Read-only
The name of the metric. This property is inherited from CIM_BaseMetricDefinition.
-
-
ProgrammaticUnits
-
-
Data type: string
-
Access type: Read-only
Identifies the specific units of a value. The value of this property will be a legal value of the Programmatic Units qualifier as defined in Appendix C.1 of DSP0004 V2.4 or later. This property is inherited from CIM_BaseMetricDefinition.
-
-
SimpleFunction
-
-
Data type: uint16
-
Access type: Read/write
Identifies the basic computation performed on an underlying metric to arrive at the value of this derived metric. This property is inherited from CIM_AggregationMetricDefinition and will be one of the following values.
-
Minimum (2)
-
Maximum (3)
-
Average (4)
-
Median (5)
-
Mode (6)
-
-
TimeScope
-
-
Data type: uint16
-
Access type: Read-only
Indicates the time scope to which the metric value applies. This property is inherited from CIM_BaseMetricDefinition.
Value Meaning - Unknown
- 0
The time scope was not qualified by the metric designer, or is unknown to the provider. - Point
- 2
The metric applies to a point in time. On the corresponding Msvm_BaseMetricValue instances, the TimeStamp property specifies the point in time, and the Duration property is always 0. - Interval
- 3
The metric applies to a time interval. On the corresponding Msvm_BaseMetricValue instances, the TimeStamp property specifies the end of the time interval, and the Duration property specifies its duration. - StartupInterval
- 4
The metric applies to a time interval that began at the startup of the measured resource (that is, the ManagedElement associated by MetricDefForMe). On the corresponding Msvm_BaseMetricValue instances, the TimeStamp property specifies the end of the time interval. If the Duration property is 0, this indicates that the startup time of the measured resource is unknown. Otherwise, Duration specifies the duration between startup of the resource and TimeStamp. - DMTF Reserved
- 5..32767
- Vendor Reserved
- 32768..65535
-
-
Units
-
-
Data type: string
-
Access type: Read-only
Identifies the units of a value, for example, "megabytes". This property is inherited from CIM_BaseMetricDefinition.
-
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client |
Windows 8 [desktop apps only] |
| Minimum supported server |
Windows Server 2012 [desktop apps only] |
| Namespace |
Root\Virtualization\V2 |
| MOF |
|
| DLL |
|
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for