System\CIM_JobProcessingStatistics.mof.mof (HTML version)

Return to index
CIM_JobProcessingStatistics Superclass: CIM_StatisticalData
This class records the completion statistics (such as ElapsedTime) and other information for its associated Job. The class will be extended in a future release to include statistics regarding resource utilization. Note that there may be many instances of this class if the Job is recurring (i.e., if its JobRunTimes property is not 1).
Qualifiers:Version ( "2.8.1000" ) Experimental UMLPackagePath ( "CIM::System::Processing" )
Parameters (local in grey)
Counter
Units ( "MilliSeconds" )
ModelCorrespondence { "CIM_BatchJob.MaxCPUTime" }
uint32 CPUTimeUsed ;
Specifies the number of milliseconds of CPU that this job has used in its current (or last) run. When a job is actively running, this number will continue to change until the job has finished its execution, either successfully or unsuccessfully.
MaxValue ( 101 )
MinValue ( 0 )
Units ( "Percent" )
ModelCorrespondence { "CIM_Job.PercentComplete" }
uint16 PercentComplete ;
The percentage of the job that was completed at the time that the Job terminated. Note that this value will be less than 100 if the Job terminated prematurely.
Note that the value 101 is undefined and will be not be allowed in the next major revision of the specification.
ModelCorrespondence { "CIM_Job.ElapsedTime" }
datetime ElapsedTime ;
The total execution time of the Job. This MUST be represented in interval format.
ModelCorrespondence { "CIM_Job.StartTime" }
datetime StartTime ;
The time that this invocation of the Job was started. This SHOULD be represented by an actual date and time, and not in interval format.
ModelCorrespondence { "CIM_Job.Priority" }
uint32 Priority ;
Indicates the urgency or importance of execution of the Job. The lower the number, the higher the priority.
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.)
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.
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.
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'.
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.
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.