CIM211 Class Declaration
CIM_CIMOMStatisticalData

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

Class Hierarchy

CIM_CIMOMStatisticalData --> CIM_StatisticalData --> CIM_ManagedElement --> [top]

Class Attributes

Class Declaration Attributes
NameValue
SUPERCLASSCIM_StatisticalData
NAMECIM_CIMOMStatisticalData

Class Qualifiers

Class CIM_CIMOMStatisticalData Qualifiers
NameTypeValueFrom Class
Versionstring2.7.0 CIM_CIMOMStatisticalData
DescriptionstringCIM_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
DescriptionstringCIM_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
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
InstanceIDstring Override
Description
Key
CIM_CIMOMStatisticalData
OperationTypeuint16 Required
Description
ValueMap
Values
ModelCorrespondence
CIM_CIMOMStatisticalData
OtherOperationTypestring Description
MaxLen
ModelCorrespondence
CIM_CIMOMStatisticalData
NumberOfOperationsuint64 Required
Description
Counter
CIM_CIMOMStatisticalData
CimomElapsedTimedatetime Required
Description
CIM_CIMOMStatisticalData
ProviderElapsedTimedatetime Required
Description
CIM_CIMOMStatisticalData
RequestSizeuint64 Description
Units
Counter
CIM_CIMOMStatisticalData
ResponseSizeuint64 Description
Units
Counter
CIM_CIMOMStatisticalData
ElementNamestring Required
Override
Description
CIM_StatisticalData
StartStatisticTimedatetime Description CIM_StatisticalData
StatisticTimedatetime Description CIM_StatisticalData
SampleIntervaldatetime00000000000000.000000:000 Description CIM_StatisticalData
Captionstring Description
MaxLen
CIM_ManagedElement
Descriptionstring Description CIM_ManagedElement

Property Qualifiers

Property InstanceID Qualifiers
NameTypeValueFrom Class
OverridestringInstanceID CIM_CIMOMStatisticalData
DescriptionstringThe 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
Keybooleantrue CIM_CIMOMStatisticalData

Property OperationType Qualifiers
NameTypeValueFrom Class
Requiredbooleantrue CIM_CIMOMStatisticalData
DescriptionstringThe 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
ValueMapstring
[See below.]
CIM_CIMOMStatisticalData
ValuesstringUnknown
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
IndicationDelivery
CIM_CIMOMStatisticalData
ModelCorrespondencestringCIM_CIMOMStatisticalData.OtherOperationType CIM_CIMOMStatisticalData

NameValue
0Unknown
1Other
2Batched
3GetClass
4GetInstance
5DeleteClass
6DeleteInstance
7CreateClass
8CreateInstance
9ModifyClass
10ModifyInstance
11EnumerateClasses
12EnumerateClassNames
13EnumerateInstances
14EnumerateInstanceNames
15ExecQuery
16Associators
17AssociatorNames
18References
19ReferenceNames
20GetProperty
21SetProperty
22GetQualifier
23SetQualifier
24DeleteQualifier
25EnumerateQualifiers
26IndicationDelivery
Property OtherOperationType Qualifiers
NameTypeValueFrom Class
DescriptionstringThe 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
MaxLenuint3264 CIM_CIMOMStatisticalData
ModelCorrespondencestringCIM_CIMOMStatisticalData.OperationType CIM_CIMOMStatisticalData

Property NumberOfOperations Qualifiers
NameTypeValueFrom Class
Requiredbooleantrue CIM_CIMOMStatisticalData
DescriptionstringThe 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
Counterbooleantrue CIM_CIMOMStatisticalData

Property CimomElapsedTime Qualifiers
NameTypeValueFrom Class
Requiredbooleantrue CIM_CIMOMStatisticalData
DescriptionstringThe 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
NameTypeValueFrom Class
Requiredbooleantrue CIM_CIMOMStatisticalData
DescriptionstringThe 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
NameTypeValueFrom Class
DescriptionstringThe 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
UnitsstringBytes CIM_CIMOMStatisticalData
Counterbooleantrue CIM_CIMOMStatisticalData

Property ResponseSize Qualifiers
NameTypeValueFrom Class
DescriptionstringThe 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
UnitsstringBytes CIM_CIMOMStatisticalData
Counterbooleantrue CIM_CIMOMStatisticalData

Property InstanceID Qualifiers
NameTypeValueFrom Class
Keybooleantrue CIM_StatisticalData
DescriptionstringWithin 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
NameTypeValueFrom Class
Requiredbooleantrue CIM_StatisticalData
OverridestringElementName CIM_StatisticalData
DescriptionstringThe 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
NameTypeValueFrom Class
DescriptionstringThe 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
NameTypeValueFrom Class
DescriptionstringThe time the most recent measurement was taken, relative to the managed element where the statistic was collected. CIM_StatisticalData

Property SampleInterval Qualifiers
NameTypeValueFrom Class
DescriptionstringSome 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
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

NameTypeValueQualifiersParametersClassOrigin
ResetSelectedStatsuint32 Description SelectedStatisticsCIM_StatisticalData

Method Qualifiers

Method ResetSelectedStats Qualifiers
NameTypeValueFrom Class
DescriptionstringMethod 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
NameTypeQualifiers
SelectedStatisticsstringIN
Description

Parameter Qualifiers

Parameter SelectedStatistics Qualifiers
NameTypeValueFrom Class
INbooleantrue CIM_StatisticalData
DescriptionstringArray of strings indicating which statistics to reset. CIM_StatisticalData

Associations this class can participate in

Association
Class
Reference
Class
Role
CIM_ElementStatisticalDataCIM_StatisticalDataStats
CIM_RelatedStatisticalDataCIM_StatisticalDataStats
CIM_RelatedStatisticalDataCIM_StatisticalDataRelatedStats
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