| Caption |
string |
CIM_ManagedElement |
|
Description
|
The Caption property is a short textual description (one- line string) of the object. |
|
MaxLen
|
64 |
|
| Description |
string |
CIM_ManagedElement |
|
Description
|
The Description property provides a textual description of the object. |
|
| ElementName |
string |
CIM_ManagedElement |
|
Description
|
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. |
|
| Id |
string |
CIM_BaseMetricDefinition |
|
Key
|
TRUE |
|
Description
|
A string that uniquely identifies the metric definition. The use of OSF UUID/GUIDs is recommended. |
|
| Name |
string |
CIM_BaseMetricDefinition |
|
Description
|
The name of the metric. This name does not have to be unique, but should be descriptive and may contain blanks. |
|
| DataType |
uint16 |
CIM_BaseMetricDefinition |
|
Description
|
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. |
|
ValueMap
|
1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14 |
|
Values
|
"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] |
|
| Calculable |
uint16 |
CIM_BaseMetricDefinition |
|
Description
|
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. |
|
ValueMap
|
1, 2, 3 |
|
Values
|
"Non-calculable" [1]
"Summable" [2]
"Non-summable" [3] |
|
| Units |
string |
CIM_BaseMetricDefinition |
|
Deprecated
|
CIM_BaseMetricDefinition.ProgrammaticUnits |
|
Description
|
Identifies the specific units of a value. Examples are Bytes, Packets, Jobs, Files, Milliseconds, and Amps. |
|
| ProgrammaticUnits |
string |
CIM_BaseMetricDefinition |
|
Experimental
|
TRUE |
|
Description
|
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. |
|
| BreakdownDimensions |
string[] |
CIM_BaseMetricDefinition |
|
Description
|
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. |
|
| IsContinuous |
boolean |
CIM_BaseMetricDefinition |
|
Description
|
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. |
|
| ChangeType |
uint16 |
CIM_BaseMetricDefinition |
|
Override
|
ChangeType |
|
Description
|
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.
5="Simple Function": indicates that the derived metric value is calculated by applying the basic mathematical function identified by the SimpleFunction property to the underlying metric values. |
|
ValueMap
|
5, 6..32767, 32768..65535 |
|
Values
|
"Simple Function" [5]
"DMTF Reserved" [6..32767]
"Vendor Reserved" [32768..65535] |
|
ModelCorrespondence
|
CIM_AggregationMetricDefinition.IsContinuous |
|
| TimeScope |
uint16 |
CIM_BaseMetricDefinition |
|
Description
|
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. |
|
ValueMap
|
0, 2, 3, 4, 5..32767, 32768..65535 |
|
Values
|
"Unknown" [0]
"Point" [2]
"Interval" [3]
"StartupInterval" [4]
"DMTF Reserved" [5..32767]
"Vendor Reserved" [32768..65535] |
|
ModelCorrespondence
|
CIM_BaseMetricValue.TimeStamp, CIM_BaseMetricValue.Duration |
|
| GatheringType |
uint16 |
CIM_BaseMetricDefinition |
|
Description
|
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. |
|
ValueMap
|
0, 2, 3, 4, 5..32767, 32768..65535 |
|
Values
|
"Unknown" [0]
"OnChange" [2]
"Periodic" [3]
"OnRequest" [4]
"DMTF Reserved" [5..32767]
"Vendor Reserved" [32768..65535] |
|
| SampleInterval |
datetime |
CIM_BaseMetricDefinition |
|
Experimental
|
TRUE |
|
Write
|
TRUE |
|
Description
|
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. |
|
ModelCorrespondence
|
CIM_StatisticalData.SampleInterval |
|
| Accuracy |
uint32 |
CIM_BaseMetricDefinition |
|
Experimental
|
TRUE |
|
Description
|
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. |
|
ModelCorrespondence
|
CIM_BaseMetricDefinition.AccuracyUnits |
|
| AccuracyUnits |
string |
CIM_BaseMetricDefinition |
|
Experimental
|
TRUE |
|
Description
|
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. |
|
ModelCorrespondence
|
CIM_BaseMetricDefinition.Accuracy |
|
IsPUnit
|
TRUE |
|
| SimpleFunction |
uint16 |
CIM_AggregationMetricDefinition |
|
Description
|
The SimpleFunction property identifies the basic computation performed on an underlying metric to arrive at the value of this derived metric. This property shall be NULL when the ChangeType property has a value other than 5 "Simple Function".
2="Minimum" indicates that the metric reports the lowest value detected for the associated monitored entity. This is also known as a low watermark.
.3="Maximum" indicates that the metric reports the maximum value detected for the associated monitored entity. This is also known as a high watermark.
4="Average" indicates the metric reports the average value of the underlying metric values.
5="Median" indicates the metric reports the median value of the underlying metric values.
6="Mode" indicates the metric reports the modal value of the underlying metric values. |
|
ValueMap
|
.., 2, 3, 4, 5, 6, 32768..65535 |
|
Values
|
"DMTF Reserved" [..]
"Minimum" [2]
"Maximum" [3]
"Average" [4]
"Median" [5]
"Mode" [6]
"Vendor Reserved" [32768..65535] |
|