Class Hierarchy
Class Attributes
Class Qualifiers
Properties
Methods
Associations in which the class can participate
Sub Profiling Summary
CIM_CIMOMStatisticalData --> CIM_StatisticalData --> CIM_ManagedElement --> [top]
Class Declaration Attributes Name Value SUPERCLASS CIM_StatisticalData NAME CIM_CIMOMStatisticalData
Class CIM_CIMOMStatisticalData Qualifiers Name Type Value From Class Version string 2.7.0 CIM_CIMOMStatisticalData Description string CIM_CIMOMStatisticalData provides statistical data about the performance of the CIM Object Manager. Each object of this class provides elapsed time and size data for a particular type of CIM operation. All operations of that type, regardless of the CIM operations protocol being used, are accumulated in one object and covers the CIM operations issued by all clients of the Object Manager scoping the instance. Batched CIM operations are accumulated into a separate operation type for " Batched " . The counters in this class SHOULD be implemented such that they always increment and naturally wrap around when their numerical limit is exceeded. A client that calculates the difference of two snapshots of a counter at the beginning and end of a measurement interval should get the correct result, even if there was a wrap-around in between obtaining the two snapshots. (Two or more wrap arounds will result in wrong data being calculated.) The gathering of the data can be controlled through the property, CIM_ObjectManager.GatherStatisticalData. The time interval to which the statistical data applies, ends at the current time and therefore includes the most current CIM operations. The interval starts when the statistical data gathering was last turned on for the Object Manager. CIM_CIMOMStatisticalData Description string CIM_StatisticalData is a root class for any arbitrary collection of statistical data and/or metrics applicable to one or more ManagedElements. These statistics MUST represent the most recent observations and MUST NOT be provided if irrelevant or stale. Note that this class uses a simplified naming/identity algorithm as compared to CIM_StatisticalInformation. CIM_StatisticalData Description string ManagedElement 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 Name Type Value Qualifiers ClassOrigin InstanceID string Override
Description
KeyCIM_CIMOMStatisticalData OperationType uint16 Required
Description
ValueMap
Values
ModelCorrespondenceCIM_CIMOMStatisticalData OtherOperationType string Description
MaxLen
ModelCorrespondenceCIM_CIMOMStatisticalData NumberOfOperations uint64 Required
Description
CounterCIM_CIMOMStatisticalData CimomElapsedTime datetime Required
DescriptionCIM_CIMOMStatisticalData ProviderElapsedTime datetime Required
DescriptionCIM_CIMOMStatisticalData RequestSize uint64 Description
Units
CounterCIM_CIMOMStatisticalData ResponseSize uint64 Description
Units
CounterCIM_CIMOMStatisticalData ElementName string Required
Override
DescriptionCIM_StatisticalData StartStatisticTime datetime Description CIM_StatisticalData StatisticTime datetime Description CIM_StatisticalData SampleInterval datetime 00000000000000.000000:000 Description CIM_StatisticalData Caption string Description
MaxLenCIM_ManagedElement Description string Description CIM_ManagedElement Property Qualifiers
Property InstanceID Qualifiers Name Type Value From Class Override string InstanceID CIM_CIMOMStatisticalData Description string The InstanceID property opaquely identifies a unique instance of CIMOMStatisticalData and MUST be unique within a namespace. In order to ensure uniqueness, the value of InstanceID MUST be constructed in the following manner: CIM < ID > The < ID > MUST include a CIM Object Manager specified unique identifier. CIM_CIMOMStatisticalData Key boolean true CIM_CIMOMStatisticalData
Property OperationType Qualifiers Name Type Value From Class Required boolean true CIM_CIMOMStatisticalData Description string The OperationType property identifies the type of CIM operation for which data is reported in this instance. Batched CIM operations (consisting of multiple simple CIM operations) are reported against the " Batched " type only. CIM_CIMOMStatisticalData ValueMap string [See below.] CIM_CIMOMStatisticalData Values string Unknown
Other
Batched
GetClass
GetInstance
DeleteClass
DeleteInstance
CreateClass
CreateInstance
ModifyClass
ModifyInstance
EnumerateClasses
EnumerateClassNames
EnumerateInstances
EnumerateInstanceNames
ExecQuery
Associators
AssociatorNames
References
ReferenceNames
GetProperty
SetProperty
GetQualifier
SetQualifier
DeleteQualifier
EnumerateQualifiers
IndicationDeliveryCIM_CIMOMStatisticalData ModelCorrespondence string CIM_CIMOMStatisticalData.OtherOperationType CIM_CIMOMStatisticalData
Name Value 0 Unknown 1 Other 2 Batched 3 GetClass 4 GetInstance 5 DeleteClass 6 DeleteInstance 7 CreateClass 8 CreateInstance 9 ModifyClass 10 ModifyInstance 11 EnumerateClasses 12 EnumerateClassNames 13 EnumerateInstances 14 EnumerateInstanceNames 15 ExecQuery 16 Associators 17 AssociatorNames 18 References 19 ReferenceNames 20 GetProperty 21 SetProperty 22 GetQualifier 23 SetQualifier 24 DeleteQualifier 25 EnumerateQualifiers 26 IndicationDelivery
Property OtherOperationType Qualifiers Name Type Value From Class Description string The OtherOperationType property identifies the operation if the OperationType property has a value of 1 ( " Other " ). For all other values of OperationType, the property is NULL. CIM_CIMOMStatisticalData MaxLen uint32 64 CIM_CIMOMStatisticalData ModelCorrespondence string CIM_CIMOMStatisticalData.OperationType CIM_CIMOMStatisticalData
Property NumberOfOperations Qualifiers Name Type Value From Class Required boolean true CIM_CIMOMStatisticalData Description string The NumberOfOperations property contains the number of CIM operations of the specified type. This property can be used to calculate average values per CIM operation. CIM_CIMOMStatisticalData Counter boolean true CIM_CIMOMStatisticalData
Property CimomElapsedTime Qualifiers Name Type Value From Class Required boolean true CIM_CIMOMStatisticalData Description string The CimomElapsedTime property contains the elapsed time spent in the CIM Object Manager for this operation type, not counting the elapsed time spent in providers and the underlying instrumentation. The measurement points for this property SHOULD be at the transport layer interface on the network side, and at the provider interface on the instrumentation side of the CIM Object Manager. CIM_CIMOMStatisticalData
Property ProviderElapsedTime Qualifiers Name Type Value From Class Required boolean true CIM_CIMOMStatisticalData Description string The ProviderElapsedTime property contains the elapsed time spent in all providers involved with this operation type, including the underlying instrumentation. The measurement point for this property SHOULD be from the provider interface of the CIM Object Manager. CIM_CIMOMStatisticalData
Property RequestSize Qualifiers Name Type Value From Class Description string The RequestSize property contains the size of the operation requests sent to the CIM Object Manager. Any overhead of protocols above the transport protocol SHOULD be included in the count. For example, for the HTTP protocol, the size would include the size of the HTTP payload and the size of the HTTP headers. CIM_CIMOMStatisticalData Units string Bytes CIM_CIMOMStatisticalData Counter boolean true CIM_CIMOMStatisticalData
Property ResponseSize Qualifiers Name Type Value From Class Description string The ResponseSize property contains the size of the operation responses sent back from the CIM Object Manager. Any overhead of protocols above the transport protocol SHOULD be included in the count. For example, for the HTTP protocol, the size would include the size of the HTTP payload and the size of the HTTP headers. CIM_CIMOMStatisticalData Units string Bytes CIM_CIMOMStatisticalData Counter boolean true CIM_CIMOMStatisticalData
Property InstanceID Qualifiers Name Type Value From Class Key boolean true CIM_StatisticalData Description string Within the scope of the instantiating Namespace, InstanceID opaquely and uniquely identifies an instance of this class. In order 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 creating/defining the InstanceID, or is a registered ID that is assigned to the business entity by a recognized global authority (This 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 re-used to identify different underlying (real-world) elements. If the above ’ preferred ’ algorithm is not used, the defining entity MUST assure that the resultant InstanceID is not re-used across any InstanceIDs produced by this or other providers for this instance ’ s NameSpace. For DMTF defined instances, the ’ preferred ’ algorithm MUST be used with the < OrgID > set to ’ CIM ’ . CIM_StatisticalData
Property ElementName Qualifiers Name Type Value From Class Required boolean true CIM_StatisticalData Override string ElementName CIM_StatisticalData Description string The user friendly name for this instance of StatisticalData. In addition, the user friendly name can be used as a index property for a search of query. (Note: Name does not have to be unique within a namespace.) CIM_StatisticalData
Property StartStatisticTime Qualifiers Name Type Value From Class Description string The time, relative to managed element where the statistic was collected, when the first measurement was taken. If the statistic is reset, the StartStatisticTime is the time when the reset was performed. CIM_StatisticalData
Property StatisticTime Qualifiers Name Type Value From Class Description string The time the most recent measurement was taken, relative to the managed element where the statistic was collected. CIM_StatisticalData
Property SampleInterval Qualifiers Name Type Value From Class Description string Some statistics are sampled at consistent time intervals. This property provides the sample interval so that client applications can determine the minimum time that new statistics should be pulled. If the statistics are not sampled at consistent time intervals, this property must be set to a zero time interval. CIM_StatisticalData
Property Caption Qualifiers Name Type Value From Class Description string The Caption property is a short textual description (one- line string) of the object. CIM_ManagedElement MaxLen uint32 64 CIM_ManagedElement
Property Description Qualifiers Name Type Value From Class Description string The Description property provides a textual description of the object. CIM_ManagedElement
Property ElementName Qualifiers Name Type Value From Class 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. CIM_ManagedElement
Name Type Value Qualifiers Parameters ClassOrigin ResetSelectedStats uint32 Description SelectedStatistics CIM_StatisticalData Method Qualifiers
Method ResetSelectedStats Qualifiers Name Type Value From Class Description string Method to reset one or more of the instance ’ s statistics. The method takes one parameter as input - an array of strings indicating which statistics to reset. If all the statistics in the instance should be reset, the first element of the array MUST be set to " All " or " ALL " . If one or more individual statistics should be reset, the corresponding property names are entered into the elements of the array. The method returns 0 if successful, 1 if not supported, and any other value if an error occurred. A method is specified so that the StatisticalInformation ’ s provider/ instrumentation, which calculates the statistics, can reset its internal processing, counters, etc. In a subclass, the set of possible return codes could be specified, using a ValueMap qualifier on the method. The strings to which the ValueMap contents are ’ translated ’ may also be specified in the subclass as a Values array qualifier. CIM_StatisticalData Parameters
Method ResetSelectedStats Parameters Name Type Qualifiers SelectedStatistics string IN
DescriptionParameter Qualifiers
Parameter SelectedStatistics Qualifiers Name Type Value From Class IN boolean true CIM_StatisticalData Description string Array of strings indicating which statistics to reset. CIM_StatisticalData