CIM_Job class
A logical element that represents a unit of work to execute, such as a script or a print job. A job is distinct from a process because a job can be scheduled or queued, and its execution is not limited to a single system.
The following syntax is simplified from MOF code and includes all inherited properties.
Syntax
[Abstract, Version("2.10.0"), UMLPackagePath("CIM::Core::CoreElements"), AMENDMENT]
class CIM_Job : CIM_LogicalElement
{
string InstanceID;
string Caption;
string Description;
string ElementName;
datetime InstallDate;
string Name;
uint16 OperationalStatus[];
string StatusDescriptions[];
string Status;
uint16 HealthState;
uint16 CommunicationStatus;
uint16 DetailedStatus;
uint16 OperatingStatus;
uint16 PrimaryStatus;
string JobStatus;
datetime TimeSubmitted;
datetime ScheduledStartTime;
datetime StartTime;
datetime ElapsedTime;
uint32 JobRunTimes = 1;
uint8 RunMonth;
sint8 RunDay;
sint8 RunDayOfWeek;
datetime RunStartInterval;
uint16 LocalOrUtcTime;
datetime UntilTime;
string Notify;
string Owner;
uint32 Priority;
uint16 PercentComplete;
boolean DeleteOnCompletion;
uint16 ErrorCode;
string ErrorDescription;
uint16 RecoveryAction;
string OtherRecoveryAction;
};
Members
The CIM_Job class has these types of members:
Methods
The CIM_Job class has these methods.
| Method | Description |
|---|---|
| [KillJob](cim-job-killjob.md) | This method is deprecated. Instead, use the RequestStateChange method.[!Note] |
Properties
The CIM_Job class has these properties.
-
Caption
-
-
Data type: string
-
Access type: Read-only
-
Qualifiers: MaxLen (64)
A short textual description of the object.
This property is inherited from CIM_ManagedElement.
-
-
CommunicationStatus
-
-
Data type: uint16
-
Access type: Read-only
Indicates the ability of the instrumentation to communicate with this element. A NULL value indicates that instrumentation does not support this property.
The possible values are.
-
-
Unknown (0)
-
Indicates that the instrumentation cannot report on the CommunicationStatus property at this time.
-
Not Available (1)
-
Indicates that the instrumentation is capable of reporting this property, but intentionally does not for this element.
-
Communication OK (2)
-
Indicates only that communication is established with the element.
-
Lost Communication (3)
-
Indicates that the element has been contacted in the past, but is currently unreachable.
-
No Contact (4)
-
Indicates that the instrumentation has contact information for this element, but has never been able to communicate with it.
-
DMTF Reserved
-
Reserved.
-
Vendor Reserved
-
Reserved.
This property is inherited from CIM_ManagedSystemElement.
DeleteOnCompletion
-
Data type: boolean
-
Access type: Read/write
True to delete the job upon completion; otherwise, false.
Note
This property will not delete jobs that complete before this property is set to True.
Description
-
Data type: string
-
Access type: Read-only
A textual description of the object.
This property is inherited from CIM_ManagedElement.
DetailedStatus
-
Data type: uint16
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.PrimaryStatus", "CIM_ManagedSystemElement.HealthState")
Indicates additional status details that complement the PrimaryStatus property. A NULL value indicates that the instrumentation does not support this property.
The possible values are.
Not Available (0)
Indicates that the instrumentation is capable of reporting this property, but intentionally does not report it for this element.
No Additional Information (1)
Indicates that no details have to be added to the PrimaryStatus property, for example when the PrimaryStatus is set to OK.
Stressed (2)
Indicates that the element functions, but requires attention. Overload and overheated are examples of Stressed states.
Predictive Failure (3)
Indicates that an element functions nominally, but predicts a failure in the near future.
Non-Recoverable Error (4)
Indicates that this element is in an error condition that requires human intervention.
Supporting Entity in Error (5)
Indicates that an element on which this element depends is in error. This element might be OK but cannot function because of the state of a dependent element. An example is a network service or endpoint that cannot function due to lower-layer networking problems.
DMTF Reserved
Reserved.
Vendor Reserved
Reserved.
This property is inherited from CIM_ManagedSystemElement.
ElapsedTime
-
Data type: datetime
-
Access type: Read-only
The duration for which the job has run.
ElementName
-
Data type: string
-
Access type: Read-only
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.
This property is inherited from CIM_ManagedElement.
ErrorCode
-
Data type: uint16
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_Job.ErrorDescription")
A vendor-specific error code that captures processing information for recurring jobs. The value must be set to zero if the job completed without error.
ErrorDescription
-
Data type: string
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_Job.ErrorCode")
A free-form string that contains a description of the corresponding error code in the ErrorCode property.
HealthState
-
Data type: uint16
-
Access type: Read-only
Indicates the current health of the element. This attribute expresses the health of this element, but not necessarily the health of its subcomponents.
The possible values are.
Unknown (0)
The implementation cannot report on HealthState at this time.
OK (5)
The element is fully functional and operates within normal operational parameters and without error.
Degraded/Warning (10)
The element is in working order, and all functionality is provided. However, the element does not function to the best of its abilities. For example, the element might not operate at optimal performance, or it might report recoverable errors.
Minor failure (15)
All functionality is available, but some functionality might be degraded.
Major failure (20)
The element is failing. It is possible that some or all of the functionality of this component is degraded or does not work.
Critical failure (25)
The element is nonfunctional, and recovery might not be possible.
Non-recoverable error (30)
The element has completely failed, and recovery is not possible. All functionality that this element provides has been lost.
DMTF Reserved
Reserved.
This property is inherited from CIM_ManagedSystemElement.
InstallDate
-
Data type: datetime
-
Access type: Read-only
-
Qualifiers: MappingStrings ("MIF.DMTF|ComponentID|001.5")
Indicates when the object was installed. The lack of a value does not indicate that the object is not installed.
This property is inherited from CIM_ManagedSystemElement.
InstanceID
-
Data type: string
-
Access type: Read-only
Uniquely and opaquely identifies an instance of this class within the scope of the containing namespace.
[!Important]
In order to ensure uniqueness within the namespace, the value of the InstanceID property should be constructed in the following pattern: OrgID:LocalID
OrgID must include a copyrighted, trademarked or otherwise unique name that is owned by the business entity that defines the InstanceID, or be a registered ID that is assigned by a recognized global authority. This pattern is similar to the structure of schema class names. In addition, to ensure uniqueness, the first colon in InstanceID must be between the OrgID andLocalID. Therefore the OrgID must not contain a colon (':').
LocalID is chosen by the business entity and should not be re-used to identify different underlying real-world elements.
If the above pattern is not used, the defining entity must assure that the resultant InstanceID value is not re-used across any InstanceID properties that are produced by this provider or other providers for this namespace.
For Distributed Management Task Force (DMTF) defined instances, the pattern must be used with the OrgID set to CIM.
This property is inherited from CIM_ManagedElement.
JobRunTimes
-
Data type: uint32
-
Access type: Read/write
The number of times to run the job.
The possible values are.
0
Repeat the job until the time specified by the UntilTime property or until it is manually shut down.
(1)
Run the job once. This is the default value.
2 4294967295
Run the job for the specified number of times.
JobStatus
-
Data type: string
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_ManagedSystemElement.OperationalStatus")
A free-form string that represents the status of the job.
LocalOrUtcTime
-
Data type: uint16
-
Access type: Read/write
Indicates whether the times in the RunStartInterval and UntilTime properties represent local times or UTC times.
The possible values are.
Local Time (1)
Local time.
UTC Time (2)
UTC time.
Name
-
Data type: string
-
Access type: Read-only
-
Qualifiers: MaxLen (1024)
The label by which the object is known. When subclassed, the Name property can be overridden to be a key property.
This property is inherited from CIM_ManagedSystemElement.
Notify
-
Data type: string
-
Access type: Read/write
The user to notify when a job completes or fails.
OperatingStatus
-
Data type: uint16
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.EnabledState")
Indicates the current operational condition of the element. This property can be used to provide more detail about the value of the EnabledState property. A NULL value indicates that the instrumentation does not support this property.
The possible values are.
Unknown (0)
Indicates that the instrumentation cannot report on the OperatingStatus property at this time.
Not Available (1)
Indicates that the instrumentation is capable of reporting this property, but intentionally does not report it for this element.
Servicing (2)
Indicates that the element is in process to be configured, maintained, cleaned, or otherwise administered.
Starting (3)
Indicates that the element is being initialized.
Stopping (4)
Indicates that the element is being brought to an orderly stop.
Stopped (5)
Indicates that the element is intentionally stopped.
Aborted (6)
Indicates that the element stopped in an unexpected way.
Dormant (7)
Indicates that the element is inactive.
Completed (8)
Indicates that the element completed its operation. We recommend using a PrimaryStatus property value of OK, Error, or Degraded to indicate success or failure of the operation.
Migrating (9)
Indicates that the element is being moved between host elements.
Emigrating (10)
Indicates that the element is being moved away from the host element.
Immigrating (11)
Indicates that the element is being moved to a new host element.
Snapshotting (12)
Indicates that a snapshot copy of the element is being created.
Shutting Down (13)
Indicates that the element is being brought to an abrupt stop.
In Test (14)
Indicates that the element is performing test functions.
Transitioning (15)
Indicates that the element is between states and is not fully available in either state. Use another value that indicates a more specific transition if one is available.
In Service (16)
Indicates that the element is in service and operational.
DMTF Reserved
Reserved.
Vendor Reserved
Reserved.
This property is inherited from CIM_ManagedSystemElement.
OperationalStatus
-
Data type: uint16 array
-
Access type: Read-only
-
Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_ManagedSystemElement.StatusDescriptions")
Contains indicators of the current status of the element. The first value of the OperationalStatus property should contain the primary status for the element.
Note
The OperationalStatus property replaces the deprecated Status property. Due to the widespread use of the existing Status property in management applications, we strongly recommend that providers or instrumentation provide both the Status and OperationalStatus properties. When instrumented, Status, because it is a single-valued property, should also provide the primary status of the element.
The possible values are.
Unknown (0)
Indicates that the implementation cannot report on the OperationalStatus property at this time.
Other (1)
Indicates an undefined state.
OK (2)
Indicates full functionality without errors.
Degraded (3)
Indicates that the element is in working order and that all functionality is provided. However, the element does not function to the best of its abilities. For example, the element might not operate at optimal performance, or it might report recoverable errors.
Stressed (4)
Indicates that the element functions, but requires attention. Overload and overheated are examples of Stressed states.
Predictive Failure (5)
Indicates that an element functions nominally, but predicts a failure in the near future.
Error (6)
Indicates that an error has occurred.
Non-Recoverable Error (7)
Indicates that a nonrecoverable error has occurred.
Starting (8)
Indicates that the job is starting.
Stopping (9)
Indicates that the job is stopping.
Stopped (10)
Indicates that the element has been intentionally stopped.
In Service (11)
Indicates that the element is in process to be configured, maintained, cleaned, or otherwise administered.
No Contact (12)
Indicates that the monitoring system has information about this element, but has never been able to establish communications with it.
Lost Communication (13)
Indicates that the monitoring system has successfully contacted this element in the past, but it is currently unavailable.
Aborted (14)
Indicates that the job stopped in an unexpected way. The state and configuration of the job might require an update.
Dormant (15)
Indicates that the job is inactive.
Supporting Entity in Error (16)
Indicates that an element on which this job depends is in error. This element might be OK but cannot function because of the state of a dependent element. An example is a network service or endpoint that cannot function due to lower-layer networking problems.
Completed (17)
Indicates that the job has completed its operation. This value should be combined with either OK, Error, or Degraded to indicate to a client whether the complete operation Completed with OK and passed, or completed with Error and failed, or completed with Degraded and finished the operation, but did not complete OK or did not report an error.
Power Mode (18)
Indicates that the element has additional power model information that is contained in the associated power management service.
DMTF Reserved
Reserved.
Vendor Reserved
Reserved.
This property is inherited from CIM_ManagedSystemElement.
OtherRecoveryAction
-
Data type: string
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_Job.RecoveryAction")
A string that describes the recovery action when the RecoveryAction property is Other ("1").
Owner
-
Data type: string
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_OwningJobElement.")
The user that submitted the Job, or the service or method name that requested the job.
PercentComplete
-
Data type: uint16
-
Access type: Read-only
-
Qualifiers: Units ("Percent"), MinValue (0), MaxValue (101), PUnit ("percent")
The percentage of the job that is complete.
Note
The value "101" is undefined and will be not be allowed in the next major revision of the specification.
PrimaryStatus
-
Data type: uint16
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_ManagedSystemElement.DetailedStatus", "CIM_ManagedSystemElement.HealthState")
Indicates a high-level status value.
The possible values are.
Unknown (0)
OK (1)
Degraded (2)
Error (3)
DMTF Reserved
Vendor Reserved
This property is inherited from CIM_ManagedSystemElement.
Priority
-
Data type: uint32
-
Access type: Read/write
The importance of the job. The lower the number, the higher the priority.
RecoveryAction
-
Data type: uint16
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_Job.OtherRecoveryAction")
Describes the recovery action to take when a run job fails.
The possible values are.
Unknown (0)
Unknown.
Other (1)
Take the action specified in the OtherRecoveryAction property.
Do Not Continue (2)
Stop the job and update its status.
Continue With Next Job (3)
Run the next job in the queue.
Re-run Job (4)
Re-run job.
Run Recovery Job (5)
Run the recovery job.
RunDay
-
Data type: sint8
-
Access type: Read/write
-
Qualifiers: MinValue (-31), MaxValue (31), ModelCorrespondence ("CIM_Job.RunMonth", "CIM_Job.RunDayOfWeek", "CIM_Job.RunStartInterval")
An integer that is used on conjunction with the RunDayOfWeek property to indicate the day when the job is processed; or, if RunDayOfWeek is set to zero, RunDay indicates the day of the month when the job is processed. If RunDay is a negative integer, it specifies a day relative to the end of the month, or if RunDay is a positive integer, it specifies a day relative to the beginning of the month.
RunDayOfWeek
-
Data type: sint8
-
Access type: Read/write
-
Qualifiers: ModelCorrespondence ("CIM_Job.RunMonth", "CIM_Job.RunDay", "CIM_Job.RunStartInterval")
An integer that is used on conjunction with the RunDay property to indicate the day when the job is processed; or, if RunDayOfWeek is set to zero, RunDay indicates the day of the month when the job is processed.
The possible values are.
-Saturday (-7)
The job is processed on the last Saturday on or before the day specified by RunDay.
-Friday (-6)
The job is processed on the last Friday on or before the day specified by RunDay.
-Thursday (-5)
The job is processed on the last Thursday on or before the day specified by RunDay.
-Wednesday (-4)
The job is processed on the last Wednesday on or before the day specified by RunDay.
-Tuesday (-3)
The job is processed on the last Tuesday on or before the day specified by RunDay.
-Monday (-2)
The job is processed on the last Monday on or before the day specified by RunDay.
-Sunday (-1)
The job is processed on the last Sunday on or before the day specified by RunDay.
ExactDayOfMonth (0)
RunDay indicates the day of the month when the job is processed.
Sunday (1)
The job is processed on the first Sunday on or after the day specified by RunDay.
Monday (2)
The job is processed on the first Monday on or after the day specified by RunDay.
Tuesday (3)
The job is processed on the first Tuesday on or after the day specified by RunDay.
Wednesday (4)
The job is processed on the first Wednesday on or after the day specified by RunDay.
Thursday (5)
The job is processed on the first Thursday on or after the day specified by RunDay.
Friday (6)
The job is processed on the first Friday on or after the day specified by RunDay.
Saturday (7)
The job is processed on the first Saturday on or after the day specified by RunDay.
RunMonth
-
Data type: uint8
-
Access type: Read/write
-
Qualifiers: ModelCorrespondence ("CIM_Job.RunDay", "CIM_Job.RunDayOfWeek", "CIM_Job.RunStartInterval")
The month when the job is processed.
The possible values are.
January (0)
February (1)
March (2)
April (3)
May (4)
June (5)
July (6)
August (7)
September (8)
October (9)
November (10)
December (11)
RunStartInterval
-
Data type: datetime
-
Access type: Read/write
-
Qualifiers: ModelCorrespondence ("CIM_Job.RunMonth", "CIM_Job.RunDay", "CIM_Job.RunDayOfWeek", "CIM_Job.RunStartInterval")
The time interval after midnight when the job is be processed. For example, "00000000020000.000000:000" indicates that the job is be run on or after two o'clock local time, or UTC time (UTC is specified with the LocalOrUtcTime property).
ScheduledStartTime
-
Data type: datetime
-
Access type: Read/write
-
Qualifiers: Deprecated ("CIM_Job.RunMonth", "CIM_Job.RunDay", "CIM_Job.RunDayOfWeek", "CIM_Job.RunStartInterval")
Note
This property is deprecated. Instead we recommend that you use the RunMonth, RunDay, RunDayOfWeek, and RunStartInterval properties.
The time when the current job is scheduled to start. This time can be represented by a date and time, or an interval relative to the time when the property is requested. A value of all zeroes indicates that the job is already executing.
StartTime
-
Data type: datetime
-
Access type: Read-only
The time when the job started. This time can be represented by a date and time, or by an interval relative to the time when the property is requested.
Status
-
Data type: string
-
Access type: Read-only
-
Qualifiers: Deprecated ("CIM_ManagedSystemElement.OperationalStatus"), MaxLen (10)
Indicates the primary status of the object.
Note
This property is deprecated. It is replaced by the OperationalStatus property. If you choose to use the Status property for backward compatibility, it should be secondary to the OperationalStatus property.
The possible values are.
"OK"
"Error"
"Degraded"
"Unknown"
"Pred Fail"
"Starting"
"Stopping"
"Service"
"Stressed"
"NonRecover"
"No Contact"
"Lost Comm"
"Stopped"
This property is inherited from CIM_ManagedSystemElement.
StatusDescriptions
-
Data type: string array
-
Access type: Read-only
-
Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_ManagedSystemElement.OperationalStatus")
Indicates descriptions of the corresponding values in the OperationalStatus array. For example, if an element in the OperationalStatus property contains the value Stopping, then the element at the same array index in this property might contain an explanation as to why an object is being stopped.
This property is inherited from CIM_ManagedSystemElement.
TimeSubmitted
-
Data type: datetime
-
Access type: Read-only
The time when the job was submitted. A value of all zeroes indicates that the parent element is not capable of reporting a date and time.
UntilTime
-
Data type: datetime
-
Access type: Read/write
-
Qualifiers: ModelCorrespondence ("CIM_Job.LocalOrUtcTime")
The time after which the job becomes invalid or should be stopped. The time can be represented by a date and time, or by an interval relative to the time when this property is requested. A value of all nines indicates that the job can run indefinitely.
Requirements
| Minimum supported client |
None supported |
| Minimum supported server |
Windows Server 2016 |
| Namespace |
Root\HyperVCluster\v2 |
| MOF |
|
| DLL |
|