Class CIM_BaseMetricDefinition

extends CIM_ManagedElement
CIM_BaseMetricDefinition represents the definitional aspects of a metric, i.e., a definition template containing meta data about a new metric. Since CIM_BaseMetricDefinition does not capture metric instance information, it does not contain the value of the metric. The associated class CIM_BaseMetricValue holds the metric value and encapsulates its runtime behavior. The purpose of CIM_BaseMetricDefinition is to provide a convenient mechanism for introducing a new metric definition at runtime and capturing its instance values in a separate class. This mechanism is targeted specifically at CIM users who would like to enhance existing CIM schemas by introducing domain-specific metrics that are not captured in the existing CIM schemas. In addition, vendors of managed resources may make use of this mechanism if a small subset of a potentially large and heterogeneous amount of performance-related data needs to be exposed, based on the context in which the data is captured. Additional meta data for a metric can be provided by subclassing from CIM_BaseMetricDefinition. The CIM_BaseMetricDefinition should be associated with the CIM_ManagedElement(s) to which it applies.
Details...
This class is not implemented.

Subclasses

CIM_AggregationMetricDefinition CIM_DiscreteMetricDefinition CIM_MetricDefinition

Class Qualifiers

Name	Data Type	Value	Scope	Flavors
Description	string	CIM_BaseMetricDefinition represents the definitional aspects of a metric, i.e., a definition template containing meta data about a new metric. Since CIM_BaseMetricDefinition does not capture metric instance information, it does not contain the value of the metric. The associated class CIM_BaseMetricValue holds the metric value and encapsulates its runtime behavior. The purpose of CIM_BaseMetricDefinition is to provide a convenient mechanism for introducing a new metric definition at runtime and capturing its instance values in a separate class. This mechanism is targeted specifically at CIM users who would like to enhance existing CIM schemas by introducing domain-specific metrics that are not captured in the existing CIM schemas. In addition, vendors of managed resources may make use of this mechanism if a small subset of a potentially large and heterogeneous amount of performance-related data needs to be exposed, based on the context in which the data is captured. Additional meta data for a metric can be provided by subclassing from CIM_BaseMetricDefinition. The CIM_BaseMetricDefinition should be associated with the CIM_ManagedElement(s) to which it applies.	None	TRANSLATABLE= true
UMLPackagePath	string	CIM::Metrics::BaseMetric	None	None
Version	string	2.16.0	TOSUBCLASS= false	TRANSLATABLE= true

Local Class Properties

Name	Data Type	Qualifiers
Name	Data Type	Name	Data Type	Value	Scope	Flavors
Accuracy	uint32
		Description	string	Indicates the accuracy of the values reported for this metric. The accuracy is expressed as the value of theAccuracy property in the units specified by the AccuracyUnits property.	None	TRANSLATABLE= true
		Experimental	boolean	true	TOSUBCLASS= false	None
		ModelCorrespondence	string	CIM_BaseMetricDefinition.AccuracyUnits	None	None
AccuracyUnits	string
		Description	string	Identifies the specific units in which the accuracy is expressed. The value of this property shall be a legal value of the Programmatic Units qualifier as defined in Appendix C.1 of DSP0004 V2.4.	None	TRANSLATABLE= true
		Experimental	boolean	true	TOSUBCLASS= false	None
		IsPunit	boolean	true	None	None
		ModelCorrespondence	string	CIM_BaseMetricDefinition.Accuracy	None	None
BreakdownDimensions	string
BreakdownDimensions	string	Description	string	Defines one or more strings that can be used to refine (break down) queries against the BaseMetricValues 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.	None	TRANSLATABLE= true
Calculable	uint16
		Description	string	An enumerated value that describes the characteristics of the metric, for purposes of performing calculations. The property can take one of the following values: 1="Non-calculable" -> a string. Arithmetic makes no sense. 2="Summable" -> It is reasonable to sum this value over many instances of e.g., UnitOfWork, such as the number of files processed in a backup job. For example, if each backup job is a UnitOfWork, and each job backs up 27,000 files on average, then it makes sense to say that 100 backup jobs processed 2,700,000 files. 3="Non-summable" -> It does not make sense to sum this value over many instances of UnitOfWork. An example would be a metric that measures the queue length when a job arrives at a server. If each job is a UnitOfWork, 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.	None	TRANSLATABLE= true
		ValueMap	string	1, 2, 3	None	None
		Values	string	Non-calculable, Summable, Non-summable	None	TRANSLATABLE= true
Caption	string
		Description	string	The Caption property is a short textual description (one- line string) of the object.	None	TRANSLATABLE= true
		MaxLen	uint32	64	None	None
ChangeType	uint16
		Description	string	ChangeType 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. 0="Unknown": The metric designer did not qualify the ChangeType. 2="N/A": If the "IsContinuous" property is "false", ChangeType does not make sense and MUST be is set to "N/A". 3="Counter": The metric is a counter metric. These have non-negative integer values which increase monotonically until reaching the maximum representable number and then wrap around and start increasing from 0. Such counters, also known as rollover counters, can be used for instance to count the number of network errors or the number of transactions processed. The only way for a client application to keep track of wrap arounds is to retrieve the value of the counter in appropriately short intervals. 4="Gauge": The metric is a gauge metric. These have integer or float values that can increase and decrease arbitrarily. A gauge MUST NOT wrap when reaching the minimum or maximum representable number, instead, the value "sticks" at that number. Minimum or maximum values inside of the representable value range at which the metric value "sticks", may or may not be defined. Vendors may extend this property in the vendor reserved range.	None	TRANSLATABLE= true
		ModelCorrespondence	string	CIM_BaseMetricDefinition.IsContinuous	None	None
		ValueMap	string	0, 2, 3, 4, 5..32767, 32768..65535	None	None
		Values	string	Unknown, N/A, Counter, Gauge, DMTF Reserved, Vendor Reserved	None	TRANSLATABLE= true
DataType	uint16
		Description	string	The data type of the metric. For example, "boolean" (value=1) or "datetime" (=3) may be specified. These types represent the datatypes defined for CIM.	None	TRANSLATABLE= true
		ValueMap	string	1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14	None	None
		Values	string	boolean, char16, datetime, real32, real64, sint16, sint32, sint64, sint8, string, uint16, uint32, uint64, uint8	None	TRANSLATABLE= true
Description	string
Description	string	Description	string	The Description property provides a textual description of the object.	None	TRANSLATABLE= true
ElementName	string
ElementName	string	Description	string	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. Note that the Name property of ManagedSystemElement is also defined as a user-friendly name. But, it is often subclassed to be a Key. It is not reasonable that the same property can convey both identity and a user-friendly name, without inconsistencies. Where Name exists and is not a Key (such as for instances of LogicalDevice), the same information can be present in both the Name and ElementName properties.	None	TRANSLATABLE= true
GatheringType	uint16
		Description	string	GatheringType indicates how the metric values are gathered by the underlying instrumentation. This allows the client application to choose the right metric for the purpose. 0="Unknown": Indicates that the GatheringType is not known. 2="OnChange": Indicates that the CIM metric values get updated immediately when the values inside of the measured resource change. The values of OnChange metrics truly reflect the current situation within the resource at any time. An example is the number of logged on users that gets updated immediately as users log on and off. 3="Periodic": Indicates that the 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. 4="OnRequest": Indicates that the CIM metric value is determined each time a client application reads it. The values of OnRequest metrics truly return the current situation within the resource if somebody asks for it. However, they do not change "unobserved", and therefore subscribing for value changes of OnRequest metrics is NOT RECOMMENDED.	None	TRANSLATABLE= true
		ValueMap	string	0, 2, 3, 4, 5..32767, 32768..65535	None	None
		Values	string	Unknown, OnChange, Periodic, OnRequest, DMTF Reserved, Vendor Reserved	None	TRANSLATABLE= true
Generation	uint64
		Description	string	Generation is an optional, monotonically increasing property that may be used to identify a particular generation of the resource represented by this class. If Generation is supported by the implementation, its value shall not be null. Except as otherwise specified, a value (including null) of Generation specified at creation time shall be replaced by null if Generation is not supported by the implementation or shall be a, (possibly different), non-null value if the implementation does support Generation. After creation and if supported, Generation shall be updated, at least once per access, whenever the represented resource is modified, regardless of the source of the modification. Note: the Generation value only needs to be updated once between references, even if the resource is updated many times. The key point is to assure that it will be different if there have been updates, not to count each update. Note: unless otherwise specified, the value of Generation within one instance is not required to be coordinated with the value of Generation in any other instance. Note:the semantics of the instance, (as defined by its creation class), define the underlying resource. That underlying resource may be a collection or aggregation of resources. And, in that case, the semantics of the instance further define when updates to constituent resources also require updates to the Generation of the collective resource. Default behavior of composite aggregations should be to update the Generation of the composite whenever the Generation of a component is updated. Subclasses may define additional requirements for updates on some or all of related instances. For a particular instance, the value of Generation may wrap through zero, but the elapsed time between wraps shall be greater than 10's of years. This class does not require Generation to be unique across instances of other classes nor across instances of the same class that have different keys. Generation shall be different across power cycles, resets, or reboots if any of those actions results in an update. Generation may be different across power cycles, resets, or reboots if those actions do not result in an update. If the Generation property of an instance is non-null, and if any attempt to update the instance includes the Generation property, then if it doesn't match the current value, the update shall fail. The usage of this property is intended to be further specified by applicable management profiles. Typically, a client will read the value of this property and then supply that value as input to an operation that modifies the instance in some means. This may be via an explicit parameter in an extrinsic method or via an embedded value in an extrinsic method or intrinsic operation. For example: a profile may require that an intrinsic instance modification supply the Generation property and that it must match for the modification to succeed.	None	TRANSLATABLE= true
		Experimental	boolean	true	TOSUBCLASS= false	None
Id	string
		Description	string	A string that uniquely identifies the metric definition. The use of OSF UUID/GUIDs is recommended.	None	TRANSLATABLE= true
		Key	boolean	true	None	OVERRIDABLE= false
InstanceID	string
InstanceID	string	Description	string	InstanceID is an optional property that may be used to opaquely and uniquely identify an instance of this class within the scope of the instantiating Namespace. Various subclasses of this class may override this property to make it required, or a key. Such subclasses may also modify the preferred algorithms for ensuring uniqueness that are defined below. To ensure uniqueness within the NameSpace, the value of InstanceID should be constructed using the following "preferred" algorithm: <OrgID>:<LocalID> Where <OrgID> and <LocalID> are separated by a colon (:), and where <OrgID> must include a copyrighted, trademarked, or otherwise unique name that is owned by the business entity that is creating or defining the InstanceID or that is a registered ID assigned to the business entity by a recognized global authority. (This requirement is similar to the <Schema Name>_<Class Name> structure of Schema class names.) In addition, to ensure uniqueness, <OrgID> must not contain a colon (:). When using this algorithm, the first colon to appear in InstanceID must appear between <OrgID> and <LocalID>. <LocalID> is chosen by the business entity and should not be reused to identify different underlying (real-world) elements. If not null and the above "preferred" algorithm is not used, the defining entity must assure that the resulting InstanceID is not reused across any InstanceIDs produced by this or other providers for the NameSpace of this instance. If not set to null for DMTF-defined instances, the "preferred" algorithm must be used with the <OrgID> set to CIM.	None	TRANSLATABLE= true
IsContinuous	boolean
IsContinuous	boolean	Description	string	IsContinuous indicates whether or not the metric value is continuous or scalar. Performance metrics are an example of a linear metric. Examples of non-linear metrics include error codes or operational states. Continuous metrics can be compared using the "greater than" relation.	None	TRANSLATABLE= true
Name	string
Name	string	Description	string	The name of the metric. This name does not have to be unique, but should be descriptive and may contain blanks.	None	TRANSLATABLE= true
ProgrammaticUnits	string
		Description	string	Identifies the specific units of a value. The value of this property shall be a legal value of the Programmatic Units qualifier as defined in Appendix C.1 of DSP0004 V2.4 or later.	None	TRANSLATABLE= true
		Experimental	boolean	true	TOSUBCLASS= false	None
SampleInterval	datetime
		Description	string	If metric values are collected at regular intervals, the SampleInterval property indicates the length of the the interval. If non-null, the value of the SampleInterval shall be expressed in interval notation. A value of NULL shall indicate the SampleInterval is unknown. A value of 99990101000000.000000+000 shall indicate the sampling interval is irregular.	None	TRANSLATABLE= true
		Experimental	boolean	true	TOSUBCLASS= false	None
		ModelCorrespondence	string	CIM_StatisticalData.SampleInterval	None	None
		Write	boolean	true	None	None
TimeScope	uint16
		Description	string	TimeScope indicates the time scope to which the metric value applies. 0="Unknown" indicates the time scope was not qualified by the metric designer, or is unknown to the provider. 2="Point" indicates that the metric applies to a point in time. On the corresponding BaseMetricValue instances, TimeStamp specifies the point in time and Duration is always 0. 3="Interval" indicates that the metric applies to a time interval. On the corresponding BaseMetricValue instances, TimeStamp specifies the end of the time interval and Duration specifies its duration. 4="StartupInterval" indicates that the metric applies to a time interval that began at the startup of the measured resource (i.e. the ManagedElement associated by MetricDefForMe). On the corresponding BaseMetricValue instances, TimeStamp specifies the end of the time interval. If Duration is 0, this indicates that the startup time of the measured resource is unknown. Else, Duration specifies the duration between startup of the resource and TimeStamp.	None	TRANSLATABLE= true
		ModelCorrespondence	string	CIM_BaseMetricValue.TimeStamp, CIM_BaseMetricValue.Duration	None	None
		ValueMap	string	0, 2, 3, 4, 5..32767, 32768..65535	None	None
		Values	string	Unknown, Point, Interval, StartupInterval, DMTF Reserved, Vendor Reserved	None	TRANSLATABLE= true
Units	string
		Deprecated	string	CIM_BaseMetricDefinition.ProgrammaticUnits	TOSUBCLASS= false	None
		Description	string	Identifies the specific units of a value. Examples are Bytes, Packets, Jobs, Files, Milliseconds, and Amps.	None	TRANSLATABLE= true