| Name | Data Type | Qualifiers |
| Name | Data Type | Value | Scope | Flavors |
| AverageTransferTime | datetime |
| 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. | None | TRANSLATABLE= true |
| Caption | string |
| Description | string | The Caption property is a short textual description (one- line string) of the object. | None | TRANSLATABLE= true |
| MaxLen | uint32 | 64 | None | None |
| Characteristic | uint16 |
| 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. | None | TRANSLATABLE= true |
| ValueMap | string | 0, 2, 3, 4, 5..32767, 32768..65535 | None | None |
| Values | string | Unknown, Allocation, Input, Output, DMTF Reserved, Vendor Reserved | None | TRANSLATABLE= true |
| CountOfActiveTransfers | uint32 |
| 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. | None | TRANSLATABLE= true |
| Description | string |
| Description | string | The Description property provides a textual description of the object. | None | TRANSLATABLE= true |
| ElementName | string |
| 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.) | None | TRANSLATABLE= true |
| Override | string | ElementName | TOSUBCLASS= false | None |
| Required | boolean | true | None | OVERRIDABLE= false
|
| ErrorCount | uint32 |
| Description | string | ErrorCount is the count of errors that have been detected throughout the sample interval. | None | TRANSLATABLE= true |
| FirstError | uint16 |
| 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. | None | TRANSLATABLE= true |
| ValueMap | string | 0, 2, 3, 4, 5, 6, 7..32767, 32768..65535 | None | None |
| Values | string | Unspecified Error, Violate Upper Limit, Violate Lower Limit, Erroneous Transfer, Erroneous Item, Access to Software Resource Denied, DMTF Reserved, Vendor Reserved | None | TRANSLATABLE= true |
| FirstErrorTimeStamp | datetime |
| Description | string | FirstErrorTimeStamp is the point in time at which FirstError was detected. | None | TRANSLATABLE= true |
| Generation | uint64 |
| Description | string | Generation is an optional, monotonically increasing property that may be used to identify a particular generation of the resource represented by this class.
If Generation is supported by the implementation, its value shall not be null.
Except as otherwise specified, a value (including null) of Generation specified at creation time shall be replaced by null if Generation is not supported by the implementation or shall be a, (possibly different), non-null value if the implementation does support Generation.
After creation and if supported, Generation shall be updated, at least once per access, whenever the represented resource is modified, regardless of the source of the modification.
Note: the Generation value only needs to be updated once between references, even if the resource is updated many times. The key point is to assure that it will be different if there have been updates, not to count each update.
Note: unless otherwise specified, the value of Generation within one instance is not required to be coordinated with the value of Generation in any other instance.
Note:the semantics of the instance, (as defined by its creation class), define the underlying resource. That underlying resource may be a collection or aggregation of resources. And, in that case, the semantics of the instance further define when updates to constituent resources also require updates to the Generation of the collective resource. Default behavior of composite aggregations should be to update the Generation of the composite whenever the Generation of a component is updated.
Subclasses may define additional requirements for updates on some or all of related instances.
For a particular instance, the value of Generation may wrap through zero, but the elapsed time between wraps shall be greater than 10's of years.
This class does not require Generation to be unique across instances of other classes nor across instances of the same class that have different keys. Generation shall be different across power cycles, resets, or reboots if any of those actions results in an update. Generation may be different across power cycles, resets, or reboots if those actions do not result in an update. If the Generation property of an instance is non-null, and if any attempt to update the instance includes the Generation property, then if it doesn't match the current value, the update shall fail.
The usage of this property is intended to be further specified by applicable management profiles.
Typically, a client will read the value of this property and then supply that value as input to an operation that modifies the instance in some means. This may be via an explicit parameter in an extrinsic method or via an embedded value in an extrinsic method or intrinsic operation.
For example: a profile may require that an intrinsic instance modification supply the Generation property and that it must match for the modification to succeed. | None | TRANSLATABLE= true |
| Experimental | boolean | true | TOSUBCLASS= false | None |
| InstanceID | string |
| 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'. | None | TRANSLATABLE= true |
| Key | boolean | true | None | OVERRIDABLE= false
|
| Override | string | InstanceID | TOSUBCLASS= false | None |
| LastActivity | datetime |
| 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. | None | TRANSLATABLE= true |
| LastError | uint16 |
| 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. | None | TRANSLATABLE= true |
| ValueMap | string | 0, 2, 3, 4, 5, 6, 7..32767, 32768..65535 | None | None |
| Values | string | Unspecified Error, Violate Upper Limit, Violate Lower Limit, Erroneous Transfer, Erroneous Item, Access to Software Resource Denied, DMTF Reserved, Vendor Reserved | None | TRANSLATABLE= true |
| LastErrorTimeStamp | datetime |
| Description | string | LastErrorTimeStamp is the point in time at which FirstError was detected. | None | TRANSLATABLE= true |
| LowerLimit | uint32 |
| 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. | None | TRANSLATABLE= true |
| ModelCorrespondence | string | CIM_SWRLimitSetting.LowerInputLimit, CIM_SWRLimitSetting.LowerOutputLimit, CIM_SWRLimitSetting.LowerAllocationLimit | None | None |
| Write | boolean | true | None | None |
| OtherLowerLimit | uint32 |
| 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. | None | TRANSLATABLE= true |
| OtherTransferredQuantity | uint32 |
| 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. | None | TRANSLATABLE= true |
| ModelCorrespondence | string | CIM_SWRStatistics.OtherUnit, CIM_SWRIOStatistics.TransferredQuantity | None | None |
| OtherUnit | string |
| 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. | None | TRANSLATABLE= true |
| OtherUpperLimit | uint32 |
| 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. | None | TRANSLATABLE= true |
| SampleInterval | datetime |
| 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. | None | TRANSLATABLE= true |
| StartStatisticTime | datetime |
| 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. | None | TRANSLATABLE= true |
| StatisticsType | uint16 |
| 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.. | None | TRANSLATABLE= true |
| ValueMap | string | 0, 2, 3, 4..32767, 32768..65535 | None | None |
| Values | string | Unknown, Technical, Domain-Specific, DMTF Reserved, Vendor Reserved | None | TRANSLATABLE= true |
| StatisticTime | datetime |
| Description | string | The time the most recent measurement was taken, relative to the managed element where the statistic was collected. | None | TRANSLATABLE= true |
| SuccessfulQuantity | uint32 |
| 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. | None | TRANSLATABLE= true |
| ModelCorrespondence | string | CIM_SWRStatistics.Unit | None | None |
| SuccessfulTransfers | uint32 |
| 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. | None | TRANSLATABLE= true |
| TransferredQuantity | uint32 |
| 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. | None | TRANSLATABLE= true |
| ModelCorrespondence | string | CIM_SWRStatistics.Unit, CIM_SWRStatistics.StatisticsType | None | None |
| Transfers | uint32 |
| 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. | None | TRANSLATABLE= true |
| Unit | string |
| 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). | None | TRANSLATABLE= true |
| ModelCorrespondence | string | CIM_SWRLimitSetting.InputUnit, CIM_SWRLimitSetting.OutputUnit, CIM_SWRLimitSetting.AllocationUnit | None | None |
| UpperLimit | uint32 |
| 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. | None | TRANSLATABLE= true |
| ModelCorrespondence | string | CIM_SWRLimitSetting.UpperInputLimit, CIM_SWRLimitSetting.UpperOutputLimit, CIM_SWRLimitSetting.UpperAllocationLimit | None | None |
| Write | boolean | true | None | None |
Copyright © 2008-2010 VMware, Inc. All rights reserved.