CIM211 Class Declaration
CIM_BaseMetricDefinition

Table of Contents:
Class Hierarchy
Class Attributes
Class Qualifiers
Properties
Methods
Associations in which the class can participate
Sub Profiling Summary

Class Hierarchy

CIM_BaseMetricDefinition --> CIM_ManagedElement --> [top]

Class Attributes

Class Declaration Attributes
NameValue
SUPERCLASSCIM_ManagedElement
NAMECIM_BaseMetricDefinition

Class Qualifiers

Class CIM_BaseMetricDefinition Qualifiers
NameTypeValueFrom Class
Versionstring2.9.0 CIM_BaseMetricDefinition
DescriptionstringCIM_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. CIM_BaseMetricDefinition
DescriptionstringManagedElement is an abstract class that provides a common superclass (or top of the inheritance tree) for the non-association classes in the CIM Schema. CIM_ManagedElement

Properties

Properties
NameTypeValueQualifiersClassOrigin
Idstring Key
Description
CIM_BaseMetricDefinition
Namestring Description CIM_BaseMetricDefinition
DataTypeuint16 Description
ValueMap
Values
CIM_BaseMetricDefinition
Calculableuint16 Description
ValueMap
Values
CIM_BaseMetricDefinition
Unitsstring Description CIM_BaseMetricDefinition
BreakdownDimensionsstring[] Description CIM_BaseMetricDefinition
IsContinuousboolean Description CIM_BaseMetricDefinition
ChangeTypeuint16 Description
ValueMap
Values
ModelCorrespondence
CIM_BaseMetricDefinition
TimeScopeuint16 Description
ValueMap
Values
ModelCorrespondence
CIM_BaseMetricDefinition
GatheringTypeuint16 Description
ValueMap
Values
CIM_BaseMetricDefinition
Captionstring Description
MaxLen
CIM_ManagedElement
Descriptionstring Description CIM_ManagedElement
ElementNamestring Description CIM_ManagedElement

Property Qualifiers

Property Id Qualifiers
NameTypeValueFrom Class
Keybooleantrue CIM_BaseMetricDefinition
DescriptionstringA string that uniquely identifies the metric definition. The use of OSF UUID/GUIDs is recommended. CIM_BaseMetricDefinition

Property Name Qualifiers
NameTypeValueFrom Class
DescriptionstringThe name of the metric. This name does not have to be unique, but should be descriptive and may contain blanks. CIM_BaseMetricDefinition

Property DataType Qualifiers
NameTypeValueFrom Class
DescriptionstringThe data type of the metric. For example, " boolean " (value=1) or " datetime " (=3) may be specified. These types represent the datatypes defined for CIM. CIM_BaseMetricDefinition
ValueMapstring
[See below.]
CIM_BaseMetricDefinition
Valuesstringboolean
char16
datetime
real32
real64
sint16
sint32
sint64
sint8
string
uint16
uint32
uint64
uint8
CIM_BaseMetricDefinition

NameValue
1boolean
2char16
3datetime
4real32
5real64
6sint16
7sint32
8sint64
9sint8
10string
11uint16
12uint32
13uint64
14uint8
Property Calculable Qualifiers
NameTypeValueFrom Class
DescriptionstringAn 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. CIM_BaseMetricDefinition
ValueMapstring
[See below.]
CIM_BaseMetricDefinition
ValuesstringNon-calculable
Summable
Non-summable
CIM_BaseMetricDefinition

NameValue
1Non-calculable
2Summable
3Non-summable
Property Units Qualifiers
NameTypeValueFrom Class
DescriptionstringIdentifies the specific units of a value. Examples are Bytes, Packets, Jobs, Files, Milliseconds, and Amps. CIM_BaseMetricDefinition

Property BreakdownDimensions Qualifiers
NameTypeValueFrom Class
DescriptionstringDefines 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. CIM_BaseMetricDefinition

Property IsContinuous Qualifiers
NameTypeValueFrom Class
DescriptionstringIsContinuous 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. CIM_BaseMetricDefinition

Property ChangeType Qualifiers
NameTypeValueFrom Class
DescriptionstringChangeType 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. CIM_BaseMetricDefinition
ValueMapstring
[See below.]
CIM_BaseMetricDefinition
ValuesstringUnknown
N/A
Counter
Gauge
DMTF Reserved
Vendor Reserved
CIM_BaseMetricDefinition
ModelCorrespondencestringCIM_BaseMetricDefinition.IsContinuous CIM_BaseMetricDefinition

NameValue
0Unknown
2N/A
3Counter
4Gauge
5..32767DMTF Reserved
32768..65535Vendor Reserved
Property TimeScope Qualifiers
NameTypeValueFrom Class
DescriptionstringTimeScope 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. CIM_BaseMetricDefinition
ValueMapstring
[See below.]
CIM_BaseMetricDefinition
ValuesstringUnknown
Point
Interval
StartupInterval
DMTF Reserved
Vendor Reserved
CIM_BaseMetricDefinition
ModelCorrespondencestringCIM_BaseMetricValue.TimeStamp
CIM_BaseMetricValue.Duration
CIM_BaseMetricDefinition

NameValue
0Unknown
2Point
3Interval
4StartupInterval
5..32767DMTF Reserved
32768..65535Vendor Reserved
Property GatheringType Qualifiers
NameTypeValueFrom Class
DescriptionstringGatheringType 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. CIM_BaseMetricDefinition
ValueMapstring
[See below.]
CIM_BaseMetricDefinition
ValuesstringUnknown
OnChange
Periodic
OnRequest
DMTF Reserved
Vendor Reserved
CIM_BaseMetricDefinition

NameValue
0Unknown
2OnChange
3Periodic
4OnRequest
5..32767DMTF Reserved
32768..65535Vendor Reserved
Property Caption Qualifiers
NameTypeValueFrom Class
DescriptionstringThe Caption property is a short textual description (one- line string) of the object. CIM_ManagedElement
MaxLenuint3264 CIM_ManagedElement

Property Description Qualifiers
NameTypeValueFrom Class
DescriptionstringThe Description property provides a textual description of the object. CIM_ManagedElement

Property ElementName Qualifiers
NameTypeValueFrom Class
DescriptionstringA 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. CIM_ManagedElement

Methods

Method Qualifiers

Parameters

Parameter Qualifiers

Associations this class can participate in

Association
Class
Reference
Class
Role
CIM_MetricDefForMECIM_BaseMetricDefinitionDependent
CIM_MetricInstanceCIM_BaseMetricDefinitionAntecedent
CIM_ComponentCIM_ManagedElementGroupComponent
CIM_ComponentCIM_ManagedElementPartComponent
CIM_ConcreteComponentCIM_ManagedElementGroupComponent
CIM_ConcreteComponentCIM_ManagedElementPartComponent
CIM_CredentialContextCIM_ManagedElementElementProvidingContext
CIM_DefaultElementCapabilitiesCIM_ManagedElementManagedElement
CIM_DependencyCIM_ManagedElementAntecedent
CIM_DependencyCIM_ManagedElementDependent
CIM_HostedDependencyCIM_ManagedElementAntecedent
CIM_HostedDependencyCIM_ManagedElementDependent
CIM_ScopedSettingCIM_ManagedElementAntecedent
CIM_MetricDefForMECIM_ManagedElementAntecedent
CIM_MetricForMECIM_ManagedElementAntecedent
CIM_RelatedElementCausingErrorCIM_ManagedElementDependent
CIM_RelatedElementCausingErrorCIM_ManagedElementAntecedent
CIM_SparedCIM_ManagedElementAntecedent
CIM_SparedCIM_ManagedElementDependent
CIM_ConcreteDependencyCIM_ManagedElementAntecedent
CIM_ConcreteDependencyCIM_ManagedElementDependent
CIM_ElementAsUserCIM_ManagedElementAntecedent
CIM_RecordAppliesToElementCIM_ManagedElementDependent
CIM_AuthenticationTargetCIM_ManagedElementDependent
CIM_AuthorizationSubjectCIM_ManagedElementDependent
CIM_AuthorizationTargetCIM_ManagedElementDependent
CIM_ElementSoftwareIdentityCIM_ManagedElementDependent
CIM_IsSpareCIM_ManagedElementAntecedent
CIM_ProvidesServiceToElementCIM_ManagedElementDependent
CIM_ElementCapabilitiesCIM_ManagedElementManagedElement
CIM_IdentityContextCIM_ManagedElementElementProvidingContext
CIM_LogicalIdentityCIM_ManagedElementSystemElement
CIM_LogicalIdentityCIM_ManagedElementSameElement
CIM_ConcreteIdentityCIM_ManagedElementSystemElement
CIM_ConcreteIdentityCIM_ManagedElementSameElement
CIM_SWRManageableAspectCIM_ManagedElementSystemElement
CIM_MemberOfCollectionCIM_ManagedElementMember
CIM_MemberPrincipalCIM_ManagedElementMember
CIM_ElementInPolicyRoleCollectionCIM_ManagedElementMember
CIM_OwningCollectionElementCIM_ManagedElementOwningElement
CIM_ParametersForMethodCIM_ManagedElementTheMethod
CIM_ParameterValueSourcesCIM_ManagedElementValueSource
CIM_PolicySetAppliesToElementCIM_ManagedElementManagedElement
CIM_AuthorizationRuleAppliesToTargetCIM_ManagedElementManagedElement
CIM_RoleLimitedToTargetCIM_ManagedElementTargetElement
CIM_StatisticsCIM_ManagedElementElement
CIM_SynchronizedCIM_ManagedElementSystemElement
CIM_SynchronizedCIM_ManagedElementSyncedElement
CIM_StorageSynchronizedCIM_ManagedElementSystemElement
CIM_StorageSynchronizedCIM_ManagedElementSyncedElement
CIM_AssignedIdentityCIM_ManagedElementManagedElement
CIM_AuthorizedSubjectCIM_ManagedElementPrivilegedElement
CIM_AuthorizedTargetCIM_ManagedElementTargetElement
CIM_ElementConformsToProfileCIM_ManagedElementManagedElement
CIM_ElementLocationCIM_ManagedElementElement
CIM_ElementProfileCIM_ManagedElementManagedElement
CIM_ElementSecuritySensitivityCIM_ManagedElementManagedElement
CIM_ElementSettingDataCIM_ManagedElementManagedElement
CIM_ElementStatisticalDataCIM_ManagedElementManagedElement
CIM_OwningJobElementCIM_ManagedElementOwningElement
CIM_AffectedJobElementCIM_ManagedElementAffectedElement
CIM_ServiceAffectsElementCIM_ManagedElementAffectedElement
CIM_ServiceAvailableToElementCIM_ManagedElementUserOfService
CIM_SAPAvailableForElementCIM_ManagedElementManagedElement
CIM_ManagementSAPCIM_ManagedElementManagedElement