Application\CIM_SWRStatistics.mof.mof (HTML version)

Return to index
CIM_SWRStatistics Superclass: CIM_StatisticalData
This is base class for the software resource statistics. Depending on the implementation it can be of six types that identify the unit type (technical or domain-specific) and the behavioral characteristic of the software resource (allocation, input or output). The statistics is also the place at which the corresponding operational settings of the software resource appear. These parameters are changeable on-the-fly (i.e., they are writable). They bear the same constraints regarding their interdependencies between technical and domain-specific units as SWRLimitSettings.
Point metrics apply to the point in time of end of the sample, interval metrics apply to the sample interval. It is up to the implementation of the statistcs whether the sample interval ends at the point in time of the request of the instance of this class (working with internal ring buffers) or whether the underlying instrumentation autonomously determines the beginning and the end of the sample interval.
SWRStatistics is associated to SoftwareResource via ElementStatisticalData. In general, one software resource is expected to have three statistics. The statistics type covers each behavior characteristics at most once. I.e., the software resource has at most one allocation statistcs, one input statistics and one output statistics. Nevertheless, the implementation of the software resource may exhibit more statistics SWRStatistics instances that cover more context-specific behavior characteristics.
Qualifiers:Experimental Version ( "2.8.1000" )
Parameters (local in grey)
datetime LastErrorTimeStamp ;
LastErrorTimeStamp is the point in time at which FirstError was detected.
ModelCorrespondence { "CIM_SWRLimitSetting.InputUnit" , "CIM_SWRLimitSetting.OutputUnit" , "CIM_SWRLimitSetting.AllocationUnit" }
string Unit = "kB" ;
This is the unit of the numeric metrics and the set of upper and lower limits of the software resource. The property should always have a value, null should not appear.The property value is read-only and assumed to correspond to the implementation of the software resource to which the operational parameters and metrics apply. The default value is of the technical domain (Kilobytes).
uint32 OtherUpperLimit ;
This property is not null, if the operational upper limit parameter of the software resource can be calculated from the property UpperLimit. If UpperLimit is described by technical units (i.e., InputUnit applies to the technical domain), OtherUpperLimit is described by domain-specific units.
datetime FirstErrorTimeStamp ;
FirstErrorTimeStamp is the point in time at which FirstError was detected.
Values { "Unspecified Error" , "Violate Upper Limit" , "Violate Lower Limit" , "Erroneous Transfer" , "Erroneous Item" , "Access to Software Resource Denied" , "DMTF Reserved" , "Vendor Reserved" }
ValueMap { "0" , "2" , "3" , "4" , "5" , "6" , "7..32767" , "32768..65535" }
uint16 FirstError ;
This is the error code of the first error that occurs during the sample interval. It is assumed that the first error, detected throughout the sample interval, is the first symptom of the root cause and therefore closer than the last error. Unrelated, subsequent errors during the sample interval of the statistics do not show up. Such a behavior is tolerable compared to the relatively short length of the sample interval.
Values:
Unspecified Error: No error code can be determined.
Violate Upper Limit: The upper limit of the behavior characteristic (allocation, input, output) was exceeded.
Violate Lower Limit: The lower limit was underrun.
Erroneous Transfer: The transfer had to be aborted. This message does not overlap with 'Erroneous Item'.
Erroneous Item: The handling of at least one item was problematic and the item had to be dropped, suspended or rejected.
Access to Software Resource Denied: The access control of software resource refused the use of the it.
Write
ModelCorrespondence { "CIM_SWRLimitSetting.LowerInputLimit" , "CIM_SWRLimitSetting.LowerOutputLimit" , "CIM_SWRLimitSetting.LowerAllocationLimit" }
uint32 LowerLimit ;
This is an operational lower limit parameter of the software resource. The limit applies to input, output or allocation according to the statistics type. The corresponding unit is found at the property Unit. A null value indicates that no lower limit exists. The property value can be modified. Whether changes are persisted on saving the modification depends on the implementation of the software resource. The default behavior is no persistence.
uint32 ErrorCount ;
ErrorCount is the count of errors that have been detected throughout the sample interval.
Values { "Unspecified Error" , "Violate Upper Limit" , "Violate Lower Limit" , "Erroneous Transfer" , "Erroneous Item" , "Access to Software Resource Denied" , "DMTF Reserved" , "Vendor Reserved" }
ValueMap { "0" , "2" , "3" , "4" , "5" , "6" , "7..32767" , "32768..65535" }
uint16 LastError ;
This is the error code of the last error that occured. The value of LastError remains from one sample interval to the next even if a sample interval is error-free.
Values:
Unspecified Error: No error code can be determined.
Violate Upper Limit: The upper limit of the behavior characteristic (allocation, input, output) was exceeded.
Violate Lower Limit: The lower limit was underrun.
Erroneous Transfer: The transfer had to be aborted. This message does not overlap with 'Erroneous Item'.
Erroneous Item: The handling of at least one item was problematic and the item had to be dropped, suspended or rejected.
Access to Software Resource Denied: The access control of software resource refused the use of the it.
uint32 OtherLowerLimit ;
This property is not null, if the operational lower limit parameter of the software resource can be calculated from the property LowerLimit. If LowerLimit is described by technical units (i.e., InputUnit applies to the technical domain), OtherLowerLimit is described by domain-specific units.
string OtherUnit ;
This is the complementary unit of the operational limit parameters. If Unit is a unit of the technical domain, OtherUnit is a domain-specific unit.
Values { "Unknown" , "Technical" , "Domain-Specific" , "DMTF Reserved" , "Vendor Reserved" }
ValueMap { "0" , "2" , "3" , "4..32767" , "32768..65535" }
uint16 StatisticsType = 2 ;
StatisticsType describes whether the statistics is specified in terms of technical units or domain-specific units. Domain-specific is meant to be the items unit or 'business' unit of the usage the software resource. It may range from objects or tables (in a buffer) to orders in a queue. It depends on the implementation and usage context of the software resource. The default is the technical domain.
Values:
Technical: The writable operational parameters and the affected metrics are assigned a technical unit e.g Kilobytes.
Domain-Specific: The writable operational parameters and the affected metrics are assigned a business-like, item-oriented unit e.g messages, objects, orders, etc..
Write
ModelCorrespondence { "CIM_SWRLimitSetting.UpperInputLimit" , "CIM_SWRLimitSetting.UpperOutputLimit" , "CIM_SWRLimitSetting.UpperAllocationLimit" }
uint32 UpperLimit ;
This is an operational upper limit parameter of the software resource. The limit applies to input, output or allocation according to the statistics type. The corresponding unit is found at the property Unit. A null value indicates that no upper limit exists. The property value can be modified. Whether changes are persisted on saving the modification depends on the implementation of the software resource. The default behavior is no persistence.
Values { "Unknown" , "Allocation" , "Input" , "Output" , "DMTF Reserved" , "Vendor Reserved" }
ValueMap { "0" , "2" , "3" , "4" , "5..32767" , "32768..65535" }
uint16 Characteristic ;
Characteristic allows for the distinction of the software resource behavior characteristics. This is either the allocation, input and output.
Values:
Allocation: Statistics about the size of the software resource.
Input: Statistics about the data transfer into the software resource.
Output: Statistics about the data transfer from the software resource.
datetime StartStatisticTime ;
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.
datetime StatisticTime ;
The time the most recent measurement was taken, relative to the managed element where the statistic was collected.
datetime SampleInterval = "00000000000000.000000:000" ;
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.
uint32ResetSelectedStats(
Array of strings indicating which statistics to reset.
Qualifiers:IN
string SelectedStatistics [ ]
)
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.
Required
Override ( "ElementName" )
string ElementName ;
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.)
Key
string InstanceID ;
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'.
MaxLen ( 64 )
string Caption ;
The Caption property is a short textual description (one- line string) of the object.
string Description ;
The Description property provides a textual description of the object.