Class Hierarchy
Class Attributes
Class Qualifiers
Properties
Methods
Associations in which the class can participate
Sub Profiling Summary
CIM_SWRIOStatistics --> CIM_SWRStatistics --> CIM_StatisticalData --> CIM_ManagedElement --> [top]
Class Declaration Attributes Name Value SUPERCLASS CIM_SWRStatistics NAME CIM_SWRIOStatistics
Class CIM_SWRIOStatistics Qualifiers Name Type Value From Class Experimental boolean true CIM_SWRIOStatistics Version string 2.8.1000 CIM_SWRIOStatistics Description string The metrics of SWRIOStatistics describe the transfer behavior of the software resource in one particular direction (input or the output). The transfer is basically the amount of data input to or output from the software resource during a sample interval in terms of technical units (e.g., kB) or domain-specific units (e.g., the number of items (e.g., the number of messages if the software resource is of the type ’ queue ’ ). The operational parameters regarding the allocation limits are surfaced also. Further details can be found in the description of the base class SWRStatistics. The metrics found in this statistics are raw values that describe the allocation behavior of the software resource as simple as possible. Thus, the metric values can be used most flexibly (e.g., cumulative, averaged, etc.). The drawback of the flexibility is that the likelyhood of required calculations - subsequent to retrieval of the values - increases in order to result in rates or statistical data needed for monitoring and reporting. CIM_SWRIOStatistics Description string 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. CIM_SWRStatistics 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
Property Qualifiers
Property TransferredQuantity Qualifiers Name Type Value From Class Description string TransferredQuantity describes the quantity transferred to/from the software resource in units corresponding to the type of the statistics (e.g., technical based on Kilobytes). The unit can be found at the CIM_SWRStatistics.Unit. The direction of the transfer can be found at the type of the statistics. The metric accumulates the transfer quantity over the sample interval and is the gross amount of data transferred to/from the software resource. A value of null indicates that no quantity is available. The value is 0 if no transfer happened or all transfers where empty. (Note that this must be true for both the request and the response). The corresponding limits are expected to be a rate. One method to detect limit violations require the division of TransferredQuantity by the sample interval in order to result in rate that then can be compared to the corresponding limit. The initial value is 0. CIM_SWRIOStatistics ModelCorrespondence string CIM_SWRStatistics.Unit
CIM_SWRStatistics.StatisticsTypeCIM_SWRIOStatistics
Property OtherTransferredQuantity Qualifiers Name Type Value From Class Description string OtherTransferredQuantity describes the transfer size of the software resource in complementary units compared to AllocationLevel (e.g., domain-specific units like the number of items: buffered objects or pooled connections). The unit can be found at CIM_SWRStatistics.OtherUnit. The metric accumulates the transfer quantity over the sample interval. A value of null indicates that no quantity is available. The initial value is 0. CIM_SWRIOStatistics ModelCorrespondence string CIM_SWRStatistics.OtherUnit
CIM_SWRIOStatistics.TransferredQuantityCIM_SWRIOStatistics
Property Transfers Qualifiers Name Type Value From Class Description string Transfers is the count of all transfers (sucessful or not) that happened during the sample interval. If the value is null no number can be provided. The initial value is 0. CIM_SWRIOStatistics
Property AverageTransferTime Qualifiers Name Type Value From Class Description string AverageTransferTime is the average time all counted transfers took during the sample interval. If the value is null no average can be provided. The initial value is 0. CIM_SWRIOStatistics
Property SuccessfulTransfers Qualifiers Name Type Value From Class Description string SuccessfulTransfers is the count of all transfers that could be executing fully (i.e., transfer all items requested) during the sample interval. If the value is null no number can be provided. In case of errors, the property can be used to quantify the quality with which the software resource works. The initial value is 0. CIM_SWRIOStatistics
Property SuccessfulQuantity Qualifiers Name Type Value From Class Description string SuccessfulQuantity specifies the successfully transferred amount of data to/from the software resource. It is the net amount in contrast to TransferredQuantity. The unit can be found at the CIM_SWRStatistics.Unit. The direction of the transfer can be found at the type of the statistics. If the value is null no number can be provided. The initial value is 0. CIM_SWRIOStatistics ModelCorrespondence string CIM_SWRStatistics.Unit CIM_SWRIOStatistics
Property CountOfActiveTransfers Qualifiers Name Type Value From Class Description string CountOfActiveTransfers is a point metric and applies to the point in time of the end of the sample interval. It describes the number of in-progress transfers. This also includes pending, suspended, open and asynchronous requests that obviously have not been acknowledged to the requestor of the transfer. If the implementation of the resource is single process, single thread and synchronous (i.e., no internal queue), the number cannot be greater than 1 since no parallel requests can occur. A value of null indicates that no count is available. A value of 0 indicates no active requests. An increasing number indicates that the software resource hangs and a reinitialize() can solve the problem. The initial value is 0. CIM_SWRIOStatistics
Property LastActivity Qualifiers Name Type Value From Class Description string LastActivity is the point in time at which the last transfer ended. The timestamp is 0 if CountOfActiveTransfers is greater than 0, i.e., at least one transfer is still in progress and, thus, the software resource is still active. Even if a transfer is still in progress, LastActivity can be a valid point in time, if the software resource is currently idle due to internal wait states or deadlocks. Thus, activity is defined as the software resource is actively carrying out inputs and outputs. LastActivity may refer to a point in time that is outside the sample interval. This is, the instrumentation internally keeps the timestamp during the lifetime of the software resource. The metric can be used to better quantify what happens at the interfaces of the software resource. The initial value is 0. CIM_SWRIOStatistics
Property LowerLimit Qualifiers Name Type Value From Class Write boolean true CIM_SWRStatistics Description string 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. CIM_SWRStatistics ModelCorrespondence string CIM_SWRLimitSetting.LowerInputLimit
CIM_SWRLimitSetting.LowerOutputLimit
CIM_SWRLimitSetting.LowerAllocationLimitCIM_SWRStatistics
Property UpperLimit Qualifiers Name Type Value From Class Write boolean true CIM_SWRStatistics Description string 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. CIM_SWRStatistics ModelCorrespondence string CIM_SWRLimitSetting.UpperInputLimit
CIM_SWRLimitSetting.UpperOutputLimit
CIM_SWRLimitSetting.UpperAllocationLimitCIM_SWRStatistics
Property Unit Qualifiers Name Type Value From Class Description string 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). CIM_SWRStatistics ModelCorrespondence string CIM_SWRLimitSetting.InputUnit
CIM_SWRLimitSetting.OutputUnit
CIM_SWRLimitSetting.AllocationUnitCIM_SWRStatistics
Property OtherLowerLimit Qualifiers Name Type Value From Class Description string 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. CIM_SWRStatistics
Property OtherUpperLimit Qualifiers Name Type Value From Class Description string 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. CIM_SWRStatistics
Property OtherUnit Qualifiers Name Type Value From Class Description string 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. CIM_SWRStatistics
Property Characteristic Qualifiers Name Type Value From Class Description string 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. CIM_SWRStatistics ValueMap string [See below.] CIM_SWRStatistics Values string Unknown
Allocation
Input
Output
DMTF Reserved
Vendor ReservedCIM_SWRStatistics
Name Value 0 Unknown 2 Allocation 3 Input 4 Output 5..32767 DMTF Reserved 32768..65535 Vendor Reserved
Property StatisticsType Qualifiers Name Type Value From Class Description string 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.. CIM_SWRStatistics ValueMap string [See below.] CIM_SWRStatistics Values string Unknown
Technical
Domain-Specific
DMTF Reserved
Vendor ReservedCIM_SWRStatistics
Name Value 0 Unknown 2 Technical 3 Domain-Specific 4..32767 DMTF Reserved 32768..65535 Vendor Reserved
Property FirstError Qualifiers Name Type Value From Class Description string 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. CIM_SWRStatistics ValueMap string [See below.] CIM_SWRStatistics Values string Unspecified Error
Violate Upper Limit
Violate Lower Limit
Erroneous Transfer
Erroneous Item
Access to Software Resource Denied
DMTF Reserved
Vendor ReservedCIM_SWRStatistics
Name Value 0 Unspecified Error 2 Violate Upper Limit 3 Violate Lower Limit 4 Erroneous Transfer 5 Erroneous Item 6 Access to Software Resource Denied 7..32767 DMTF Reserved 32768..65535 Vendor Reserved
Property FirstErrorTimeStamp Qualifiers Name Type Value From Class Description string FirstErrorTimeStamp is the point in time at which FirstError was detected. CIM_SWRStatistics
Property LastError Qualifiers Name Type Value From Class Description string 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. CIM_SWRStatistics ValueMap string [See below.] CIM_SWRStatistics Values string Unspecified Error
Violate Upper Limit
Violate Lower Limit
Erroneous Transfer
Erroneous Item
Access to Software Resource Denied
DMTF Reserved
Vendor ReservedCIM_SWRStatistics
Name Value 0 Unspecified Error 2 Violate Upper Limit 3 Violate Lower Limit 4 Erroneous Transfer 5 Erroneous Item 6 Access to Software Resource Denied 7..32767 DMTF Reserved 32768..65535 Vendor Reserved
Property LastErrorTimeStamp Qualifiers Name Type Value From Class Description string LastErrorTimeStamp is the point in time at which FirstError was detected. CIM_SWRStatistics
Property ErrorCount Qualifiers Name Type Value From Class Description string ErrorCount is the count of errors that have been detected throughout the sample interval. CIM_SWRStatistics
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