CIM_AggregationMetricDefinition class
Represents the definition of a metric that is derived from another metric value. A CIM_AggregationMetricDefinition object should be associated with the CIM_ManagedElement objects to which it applies.
The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties.
Syntax
[Abstract, Version("2.22.0"), UMLPackagePath("CIM::Metrics::BaseMetric")]
class CIM_AggregationMetricDefinition : CIM_BaseMetricDefinition
{
string InstanceID;
string Caption;
string Description;
string ElementName;
string Id;
string Name;
uint16 DataType;
uint16 Calculable;
string Units;
string BreakdownDimensions[];
boolean IsContinuous;
uint16 TimeScope;
uint16 GatheringType;
string ProgrammaticUnits;
uint16 ChangeType = 5;
uint16 SimpleFunction;
};
Members
The CIM_AggregationMetricDefinition class has these types of members:
Properties
The CIM_AggregationMetricDefinition class has these properties.
-
BreakdownDimensions
-
-
Data type: string array
-
Access type: Read-only
An array that contains free format strings that can be used to break down queries of CIM_BaseMetricValue objects along a certain dimension. The strings should be meaningful to the end users of the metric data. In addition, the strings should indicate which break down dimensions are supported for the metric definition, by the underlying instrumentation.
An example is a transaction name that allows the break down of the total value for all transactions into a set of values, one for each transaction name. Other examples are an application system, or a user group name.
This property is inherited from CIM_BaseMetricDefinition.
-
-
Calculable
-
-
Data type: uint16
-
Access type: Read-only
The characteristics of the metric used to perform calculations.
This property is inherited from CIM_BaseMetricDefinition.
-
-
Non-calculable (1)
-
The value can not be used to create a sum of values.
-
Summable (2)
-
The value can be used to create a sum of values.
-
Non-summable (3)
-
The value should not be used to create a sum of values.
Caption
-
Data type: string
-
Access type: Read-only
-
Qualifiers: MaxLen (64)
A short textual description of the object.
This property is inherited from CIM_ManagedElement.
ChangeType
-
Data type: uint16
-
Access type: Read-only
-
Qualifiers: Override ("ChangeType"), ModelCorrespondence ("CIM_AggregationMetricDefinition.IsContinuous")
Indicates how the metric value changes using common attributes such as direction change, minimum and maximum values, and wrapping semantics.
Simple Function (5)
The derived metric value is calculated by applying the basic mathematical function identified by the SimpleFunction property to the underlying metric values.
DMTF Reserved
Reserved.
Vendor Reserved
Reserved.
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 textual description of the object.
This property is inherited from CIM_ManagedElement.
ElementName
-
Data type: string
-
Access type: Read-only
A user-friendly name for the object. This property allows each instance to define a user-friendly name in addition to its key properties, identity data, and description information.
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 property is inherited from CIM_BaseMetricDefinition.
Unknown (0)
The gathering type is not known.
OnChange (2)
CIM metric values get updated immediately when the values inside measured resource change. Metric of this gathering type reflect the data of a resource at any time. An example is the number of logged on users that gets updated immediately as users log on and off of a system.
Periodic (3)
CIM metric values get updated periodically. For instance, to a client application, a metric value applying 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 CIM metric value is determined each time a client application reads it. Metrics of this gathering type retrieve data that might only be accurate during the request.
DMTF Reserved
Reserved.
Vendor Reserved
Reserved.
Id
-
Data type: string
-
Access type: Read-only
-
Qualifiers: Key
The unique ID of the metric definition. Open Software Foundation (OSF) UUID/GUIDs are recommended.
This property is inherited from CIM_BaseMetricDefinition.
InstanceID
-
Data type: string
-
Access type: Read-only
Uniquely and opaquely identifies an instance of this class within the scope of the containing namespace.
[!Important]
In order to ensure uniqueness within the namespace, the value of the InstanceID property should be constructed in the following pattern: OrgID:LocalID
OrgID must include a copyrighted, trademarked or otherwise unique name that is owned by the business entity that defines the InstanceID, or be a registered ID that is assigned by a recognized global authority. This pattern is similar to the structure of schema class names. In addition, to ensure uniqueness, the first colon in InstanceID must be between the OrgID andLocalID. Therefore the OrgID must not contain a colon (':').
LocalID is chosen by the business entity and should not be re-used to identify different underlying real-world elements.
If the above pattern is not used, the defining entity must assure that the resultant InstanceID value is not re-used across any InstanceID properties that are produced by this provider or other providers for this namespace.
For Distributed Management Task Force (DMTF) defined instances, the pattern must be used with the OrgID set to CIM.
This property is inherited from CIM_ManagedElement.
IsContinuous
-
Data type: boolean
-
Access type: Read-only
True if the metric value is continuous; otherwise, false.
This property is inherited from CIM_BaseMetricDefinition.
Name
-
Data type: string
-
Access type: Read-only
The name of the metric. This name does not have to be unique, but should be descriptive and may contain blank spaces.
This property is inherited from CIM_BaseMetricDefinition.
ProgrammaticUnits
-
Data type: string
-
Access type: Read-only
The specific units of a value. The value of this property should 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-only
The basic computation performed on an underlying metric to arrive at the value of this derived metric. This property is NULL when the ChangeType property has a value other than "5" (Simple Function).
DMTF Reserved
Reserved.
Minimum (2)
The metric reports the lowest value detected for the associated monitored entity. This is also known as a low watermark.
Maximum (3)
The metric reports the maximum value detected for the associated monitored entity. This is also known as a high watermark.
Average (4)
The metric reports the average value of the underlying metric values.
Median (5)
The metric reports the median value of the underlying metric values.
Mode (6)
The metric reports the modal value of the underlying metric values.
Vendor Reserved
Reserved.
TimeScope
-
Data type: uint16
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_BaseMetricValue.TimeStamp", "CIM_BaseMetricValue.Duration")
The time scope that applies to the metric designer.
This property is inherited from CIM_BaseMetricDefinition.
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. For corresponding CIM_BaseMetricValue instances, the TimeStamp property specifies the point in time, and the Duration property contains "0".
Interval (3)
The metric applies to a time interval. For corresponding CIM_BaseMetricValue instances, the TimeStamp property specifies the end of the time interval, and Duration property specifies the duration of the time interval.
StartupInterval (4)
The metric applies to a time interval that began at the startup of the measured resource, such as a CIM_ManagedElement that is associated with a metric using the CIM_MetricDefForME class.
For corresponding CIM_BaseMetricValue instances, 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 the startup time of the resource and TimeStamp value.
DMTF Reserved
Reserved.
Vendor Reserved
Reserved.
Units
-
Data type: string
-
Access type: Read-only
The units of the metric. Examples are bytes, packets, jobs, files, milliseconds, and amps.
This property is inherited from CIM_BaseMetricDefinition.
Requirements
| Minimum supported client |
None supported |
| Minimum supported server |
Windows Server 2016 |
| Namespace |
Root\HyperVCluster\v2 |
| MOF |
|
| DLL |
|