Core\CIM_Job.mof.mof (HTML version)

Return to index
CIM_Job Superclass: CIM_LogicalElement
A Job is a LogicalElement that represents an executing unit of work, such as a script or a print job. A Job is distinct from a Process in that a Job can be scheduled or queued, and its execution is not limited to a single system.
Qualifiers:Abstract Version ( "2.10.0" )
Parameters (local in grey)
Write
ModelCorrespondence { "CIM_Job.RunMonth" , "CIM_Job.RunDay" , "CIM_Job.RunDayOfWeek" , "CIM_Job.RunStartInterval" }
datetime RunStartInterval ;
The time interval after midnight when the Job should be processed. For example,
00000000020000.000000:000
indicates that the Job should be run on or after two o'clock, local time or UTC time (distinguished using the LocalOrUtcTime property.
Values { "-Saturday" , "-Friday" , "-Thursday" , "-Wednesday" , "-Tuesday" , "-Monday" , "-Sunday" , "ExactDayOfMonth" , "Sunday" , "Monday" , "Tuesday" , "Wednesday" , "Thursday" , "Friday" , "Saturday" }
Write
ModelCorrespondence { "CIM_Job.RunMonth" , "CIM_Job.RunDay" , "CIM_Job.RunStartInterval" }
ValueMap { "-7" , "-6" , "-5" , "-4" , "-3" , "-2" , "-1" , "0" , "1" , "2" , "3" , "4" , "5" , "6" , "7" }
sint8 RunDayOfWeek ;
A positive or negative integer used in conjunction with RunDay to indicate the day of the week on which the Job is processed. RunDayOfWeek is set to 0 to indicate an exact day of the month, such as March 1. A positive integer (representing Sunday, Monday, ..., Saturday) means that the day of week is found on or after the specified RunDay. A negative integer (representing -Sunday, -Monday, ..., -Saturday) means that the day of week is found on or BEFORE the RunDay.
Write
string Notify ;
The User who is to be notified upon the Job completion or failure.
ModelCorrespondence { "CIM_Job.RecoveryAction" }
string OtherRecoveryAction ;
A string describing the recovery action when the RecoveryAction property of the instance is 1 ('Other').
Values { "Success" , "Not Supported" , "Unknown" , "Timeout" , "Failed" , "Access Denied" , "Not Found" , "DMTF Reserved" , "Vendor Specific" }
Deprecated { "CIM_ConcreteJob.RequestStateChange()" }
ValueMap { "0" , "1" , "2" , "3" , "4" , "6" , "7" , ".." , "32768..65535" }
uint32KillJob(
Indicates whether or not the Job should be automatically deleted upon termination. This parameter takes precedence over the property, DeleteOnCompletion.
Qualifiers:IN
boolean DeleteOnKill
)
KillJob is being deprecated because there is no distinction made between an orderly shutdown and an immediate kill. CIM_ConcreteJob.RequestStateChange() provides 'Terminate' and 'Kill' options to allow this distinction.
A method to kill this job and any underlying processes, and to remove any 'dangling' associations.
ModelCorrespondence { "CIM_Job.ErrorCode" }
string ErrorDescription ;
A free-form string that contains the vendor error description. Note that this property is also present in the JobProcessingStatistics class. This class is necessary to capture the processing information for recurring Jobs, because only the 'last' run error can be stored in this single-valued property.
MinValue ( 31 )
Write
ModelCorrespondence { "CIM_Job.RunMonth" , "CIM_Job.RunDayOfWeek" , "CIM_Job.RunStartInterval" }
MaxValue ( 31 )
sint8 RunDay ;
The day in the month on which the Job should be processed. There are two different interpretations for this property, depending on the value of DayOfWeek. In one case, RunDay defines the day-in-month on which the Job is processed. This interpretation is used when the DayOfWeek is 0. A positive or negative integer indicates whether the RunDay should be calculated from the beginning or end of the month. For example, 5 indicates the fifth day in the RunMonth and -1 indicates the last day in the RunMonth.

When RunDayOfWeek is not 0, RunDay is the day-in-month on which the Job is processed, defined in conjunction with RunDayOfWeek. For example, if RunDay is 15 and RunDayOfWeek is Saturday, then the Job is processed on the first Saturday on or after the 15th day in the RunMonth (for example, the third Saturday in the month). If RunDay is 20 and RunDayOfWeek is -Saturday, then this indicates the first Saturday on or before the 20th day in the RunMonth. If RunDay is -1 and RunDayOfWeek is -Sunday, then this indicates the last Sunday in the RunMonth.
Values { "January" , "February" , "March" , "April" , "May" , "June" , "July" , "August" , "September" , "October" , "November" , "December" }
Write
ModelCorrespondence { "CIM_Job.RunDay" , "CIM_Job.RunDayOfWeek" , "CIM_Job.RunStartInterval" }
ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , "6" , "7" , "8" , "9" , "10" , "11" }
uint8 RunMonth ;
The month during which the Job should be processed. Specify 0 for January, 1 for February, and so on.
Values { "Unknown" , "Other" , "Do Not Continue" , "Continue With Next Job" , "Re-run Job" , "Run Recovery Job" }
ModelCorrespondence { "CIM_Job.OtherRecoveryAction" }
ValueMap { "0" , "1" , "2" , "3" , "4" , "5" }
uint16 RecoveryAction ;
Describes the recovery action to be taken for an unsuccessfully run Job. The possible values are:
0 = 'Unknown', meaning it is unknown as to what recovery action to take
1 = 'Other', indicating that the recovery action will be specified in the OtherRecoveryAction property
2 = 'Do Not Continue', meaning stop the execution of the job and appropriately update its status
3 = 'Continue With Next Job', meaning continue with the next job in the queue
4 = 'Re-run Job', indicating that the job should be re-run
5 = 'Run Recovery Job', meaning run the Job associated using the RecoveryJob relationship. Note that the recovery Job must already be in the queue from which it will run.
datetime StartTime ;
The time that the Job was actually started. This time can be represented by an actual date and time, or by an interval relative to the time that this property is requested. Note that this property is also present in the JobProcessingStatistics class. This class is necessary to capture the processing information for recurring Jobs, because only the 'last' run time can be stored in this single-valued property.
ModelCorrespondence { "CIM_ManagedSystemElement.OperationalStatus" }
string JobStatus ;
A free-form string that represents the status of the job. The primary status is reflected in the inherited OperationalStatus property. JobStatus provides additional, implementation-specific details.
ModelCorrespondence { "CIM_Job.ErrorDescription" }
uint16 ErrorCode ;
A vendor-specific error code. The value must be set to zero if the Job completed without error. Note that this property is also present in the JobProcessingStatistics class. This class is necessary to capture the processing information for recurring Jobs, because only the 'last' run error can be stored in this single-valued property.
Write
ModelCorrespondence { "CIM_Job.LocalOrUtcTime" }
datetime UntilTime ;
The time after which the Job is invalid or should be stopped. This time can be represented by an actual date and time, or by an interval relative to the time that this property is requested. A value of all nines indicates that the Job can run indefinitely.
Write
Deprecated { "CIM_Job.RunMonth" , "CIM_Job.RunDay" , "CIM_Job.RunDayOfWeek" , "CIM_Job.RunStartInterval" }
datetime ScheduledStartTime ;
The time that the current Job is scheduled to start. This time can be represented by the actual date and time, or an interval relative to the time that this property is requested. A value of all zeroes indicates that the Job is already executing. The property is deprecated in lieu of the more expressive scheduling properties, RunMonth, RunDay, RunDayOfWeek, and RunStartInterval.
datetime TimeSubmitted ;
The time that the Job was submitted to execute. A value of all zeroes indicates that the owning element is not capable of reporting a date and time. Therefore, the ScheduledStartTime and StartTime are reported as intervals relative to the time their values are requested.
MinValue ( 0 )
MaxValue ( 101 )
Units ( "Percent" )
uint16 PercentComplete ;
The percentage of the job that has completed at the time that this value is requested. Note that this property is also present in the JobProcessingStatistics class. This class is necessary to capture the processing information for recurring Jobs, because only the 'last' run data can be stored in this single-valued property.
Note that the value 101 is undefined and will be not be allowed in the next major revision of the specification.
Values { "Local Time" , "UTC Time" }
Write
ValueMap { "1" , "2" }
uint16 LocalOrUtcTime ;
This property indicates whether the times represented in the RunStartInterval and UntilTime properties represent local times or UTC times. Time values are synchronized worldwide by using the enumeration value 2, 'UTC Time'.
datetime ElapsedTime ;
The time interval that the Job has been executing or the total execution time if the Job is complete. Note that this property is also present in the JobProcessingStatistics class. This class is necessary to capture the processing information for recurring Jobs, because only the 'last' run time can be stored in this single-valued property.
Write
uint32 JobRunTimes = 1 ;
The number of times that the Job should be run. A value of 1 indicates that the Job is not recurring, while any non-zero value indicates a limit to the number of times that the Job will recur. Zero indicates that there is no limit to the number of times that the Job can be processed, but that it is terminated either after the UntilTime or by manual intervention. By default, a Job is processed once.
ModelCorrespondence { "CIM_OwningJobElement" }
string Owner ;
The User that submitted the Job, or the Service or method name that caused the job to be created.
Write
boolean DeleteOnCompletion ;
Indicates whether or not the job should be automatically deleted upon completion. Note that the 'completion' of a recurring job is defined by its JobRunTimes or UntilTime properties, or when the Job is terminated by manual intervention. If this property is set to false and the job completes, then the extrinsic method DeleteInstance must be used to delete the job instead of updating this property.
Write
uint32 Priority ;
Indicates the urgency or importance of execution of the Job. The lower the number, the higher the priority. Note that this property is also present in the JobProcessingStatistics class. This class is necessary to capture the setting information that would influence the results of a job.
ModelCorrespondence { "CIM_ManagedSystemElement.OperationalStatus" }
ArrayType ( "Indexed" )
string StatusDescriptions [ ] ;
Strings describing the various OperationalStatus array values. For example, if 'Stopping' is the value assigned to OperationalStatus, then this property may contain an explanation as to why an object is being stopped. Note that entries in this array are correlated with those at the same array index in OperationalStatus.
Values { "Unknown" , "Other" , "OK" , "Degraded" , "Stressed" , "Predictive Failure" , "Error" , "Non-Recoverable Error" , "Starting" , "Stopping" , "Stopped" , "In Service" , "No Contact" , "Lost Communication" , "Aborted" , "Dormant" , "Supporting Entity in Error" , "Completed" , "Power Mode" , "DMTF Reserved" , "Vendor Reserved" }
ModelCorrespondence { "CIM_ManagedSystemElement.StatusDescriptions" }
ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , "6" , "7" , "8" , "9" , "10" , "11" , "12" , "13" , "14" , "15" , "16" , "17" , "18" , ".." , "0x8000.." }
ArrayType ( "Indexed" )
uint16 OperationalStatus [ ] ;
Indicates the current status(es) of the element. Various health and operational statuses are defined. Many of the enumeration's values are self- explanatory. However, a few are not and are described in more detail.
'Stressed' indicates that the element is functioning, but needs attention. Examples of 'Stressed' states are overload, overheated, etc.
'Predictive Failure' indicates that an element is functioning nominally but predicting a failure in the near future.
'In Service' describes an element being configured, maintained, cleaned, or otherwise administered.
'No Contact' indicates that the monitoring system has knowledge of this element, but has never been able to establish communications with it.
'Lost Communication' indicates that the ManagedSystem Element is known to exist and has been contacted successfully in the past, but is currently unreachable.
'Stopped' and 'Aborted' are similar, although the former implies a clean and orderly stop, while the latter implies an abrupt stop where the element's state and configuration may need to be updated.
'Dormant' indicates that the element is inactive or quiesced.
'Supporting Entity in Error' describes that this element may be 'OK' but that another element, on which it is dependent, is in error. An example is a network service or endpoint that cannot function due to lower layer networking problems.
'Completed' indicates the element has completed its operation. This value should be combined with either OK, Error, or Degraded so that a client can till if the complete operation passed (Completed with OK), and failure (Completed with Error). Completed with Degraded would imply the operation finished, but did not complete OK or report an error.
'Power Mode' indicates the element has additional power model information contained in the Associated PowerManagementService association.
OperationalStatus replaces the Status property on ManagedSystemElement to provide a consistent approach to enumerations, to address implementation needs for an array property, and to provide a migration path from today's environment to the future. This change was not made earlier since it required the DEPRECATED qualifier. Due to the widespread use of the existing Status property in management applications, it is strongly RECOMMENDED that providers/instrumentation provide BOTH the Status and OperationalStatus properties. Further, the first value of OperationalStatus SHOULD contain the primary status for the element. When instrumented, Status (since it is single-valued) SHOULD also provide the primary status of the element.
MaxLen ( 1024 )
string Name ;
The Name property defines the label by which the object is known. When subclassed, the Name property can be overridden to be a Key property.
MappingStrings { "MIF.DMTF|ComponentID|001.5" }
datetime InstallDate ;
A datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed.
MaxLen ( 10 )
Deprecated { "CIM_ManagedSystemElement.OperationalStatus" }
ValueMap { "OK" , "Error" , "Degraded" , "Unknown" , "Pred Fail" , "Starting" , "Stopping" , "Service" , "Stressed" , "NonRecover" , "No Contact" , "Lost Comm" , "Stopped" }
string Status ;
A string indicating the current status of the object. Various operational and non-operational statuses are defined. This property is deprecated in lieu of OperationalStatus, which includes the same semantics in its enumeration. This change is made for 3 reasons: 1) Status is more correctly defined as an array. This overcomes the limitation of describing status via a single value, when it is really a multi-valued property (for example, an element may be OK AND Stopped. 2) A MaxLen of 10 is too restrictive and leads to unclear enumerated values. And, 3) The change to a uint16 data type was discussed when CIM V2.0 was defined. However, existing V1.0 implementations used the string property and did not want to modify their code. Therefore, Status was grandfathered into the Schema. Use of the Deprecated qualifier allows the maintenance of the existing property, but also permits an improved definition using OperationalStatus.
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.
string ElementName ;
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.