CIM_Job class

Article
05/31/2018

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.

The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties.

Syntax

[UMLPackagePath("CIM::Core::CoreElements"), Abstract, Version("2.10.0"), 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
Properties

Methods

The CIM_Job class has these methods.

Method	Description
KillJob	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.

Properties

The CIM_Job class has these properties.

Caption

Data type: string
Access type: Read-only
Qualifiers: MaxLen (64)

The Caption property is a short textual description (one- line string) of the object.

This property is inherited from CIM_ManagedElement.

CommunicationStatus

Data type: uint16
Access type: Read-only

CommunicationStatus indicates the ability of the instrumentation to communicate with the underlying ManagedElement.

A Null return indicates the implementation (provider) does not implement this property.

This property is inherited from CIM_ManagedSystemElement.

Unknown (0)

Unknown - indicates the implementation is in general capable of returning this property, but is unable to do so at this time.

Not Available (1)

Not Available - indicates that the implementation (provider) is capable of returning a value for this property, but not ever for this particular piece of hardware/software or the property is intentionally not used because it adds no meaningful information (as in the case of a property that is intended to add additional info to another property).

Communication OK (2)

Communication OK - indicates communication is established with the element, but does not convey any quality of service.

Lost Communication (3)

Lost Communication - indicates that the Managed Element is known to exist and has been contacted successfully in the past, but is currently unreachable.

No Contact (4)

No Contact - indicates that the monitoring system has knowledge of this element, but has never been able to establish communications with it.

DMTF Reserved

Vendor Reserved

DeleteOnCompletion

Data type: boolean
Access type: Read/write

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.

Description

Data type: string
Access type: Read-only

The Description property provides 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")

Compliments PrimaryStatus with additional status detail. This property is used to expand upon the PrimaryStatus of the element.

A Null return indicates the implementation (provider) does not implement this property.

This property is inherited from CIM_ManagedSystemElement.

Not Available (0)

Not Available - indicates that the implementation (provider) is capable of returning a value for this property, but not ever for this particular piece of hardware/software or the property is intentionally not used because it adds no meaningful information (as in the case of a property that is intended to add additional info to another property).

No Additional Information (1)

No Additional Information - indicates that the element is functioning normally as indicated by PrimaryStatus = "OK".

Stressed (2)

Stressed - indicates that the element is functioning, but needs attention. Examples of "Stressed" states are overload, overheated, and so on.

Predictive Failure (3)

Predictive Failure - indicates that an element is functioning normally but a failure is predicted in the near future.

Non-Recoverable Error (4)

Non-Recoverable Error - indicates that this element is in an error condition that requires human intervention.

Supporting Entity in Error (5)

Supporting Entity in Error - indicates that this element might 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.

DMTF Reserved

Vendor Reserved

ElapsedTime

Data type: datetime
Access type: Read-only

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.

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.

Note that the Name property of CIM_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. Note that if there is an associated instance of CIM_EnabledLogicalElementCapabilities, restrictions on this properties may exist as defined in ElementNameMask and MaxElementNameLen properties defined in that class.

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. 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.

ErrorDescription

Data type: string
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_Job.ErrorCode")

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.

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 that of its subcomponents. The possible values are 0 to 30, where 5 means the element is entirely healthy and 30 means the element is completely non-functional.

This property is inherited from CIM_ManagedSystemElement.

Unknown (0)

Unknown - The implementation cannot report on HealthState at this time.

OK (5)

OK - The element is fully functional and is operating within normal operational parameters and without error.

Degraded/Warning (10)

Degraded/Warning - The element is in working order and all functionality is provided. However, the element is not working to the best of its abilities. For example, the element might not be operating at optimal performance or it might be reporting recoverable errors.

Minor failure (15)

Minor failure - All functionality is available but some might be degraded.

Major failure (20)

Major failure - The element is failing. It is possible that some or all of the functionality of this component is degraded or not working.

Critical failure (25)

Critical failure - The element is non-functional and recovery might not be possible.

Non-recoverable error (30)

Non-recoverable error - The element has completely failed, and recovery is not possible. All functionality provided by this element has been lost.

DMTF Reserved

DMTF Reserved - DMTF has reserved the unused portion of the continuum for additional HealthStates in the future.

InstallDate

Data type: datetime
Access type: Read-only

A datetime value that indicates when the object was installed. 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

An optional property that may be used to opaquely and uniquely identify an instance of this class within the scope of the instantiating Namespace. Various subclasses of this class may override this property to make it required, or a key. Such subclasses may also modify the preferred algorithms for ensuring uniqueness that are defined below.

To ensure uniqueness within the NameSpace, the value of InstanceID should be constructed using the following "preferred" algorithm:

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 that is creating or defining the InstanceID or that is a registered ID assigned to the business entity by a recognized global authority. (This requirement 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 reused to identify different underlying (real-world) elements. If not null and the above "preferred" algorithm is not used, the defining entity must assure that the resulting InstanceID is not reused across any InstanceIDs produced by this or other providers for the NameSpace of this instance.

If not set to null for DMTF-defined instances, the "preferred" algorithm 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 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.

JobStatus

Data type: string
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_ManagedSystemElement.OperationalStatus")

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.

LocalOrUtcTime

Data type: uint16
Access type: Read/write

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".

Local Time (1)

Local Time

UTC Time (2)

UTC Time

Name

Data type: string
Access type: Read-only
Qualifiers: MaxLen (1024)

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.

This property is inherited from CIM_ManagedSystemElement.

Notify

Data type: string
Access type: Read/write

The User who is to be notified upon the Job completion or failure.

OperatingStatus

Data type: uint16
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.EnabledState")

Provides a current status value for the operational condition of the element and can be used for providing more detail with respect to the value of EnabledState. It can also provide the transitional states when an element is transitioning from one state to another, such as when an element is transitioning between EnabledState and RequestedState, as well as other transitional conditions.

A Null return indicates the implementation (provider) does not implement this property.

This property is inherited from CIM_ManagedSystemElement.

Unknown (0)

Unknown - indicates the implementation is in general capable of returning this property, but is unable to do so at this time.

Not Available (1)

Servicing (2)

Servicing - describes an element being configured, maintained, cleaned, or otherwise administered.

Starting (3)

Starting - describes an element being initialized.

Stopping (4)

Stopping - describes an element being brought to an orderly stop.

Stopped (5)

Stopped - describes an orderly stop.

Aborted (6)

Aborted - describes an abrupt stop where the state and configuration of the element might need to be updated.

Dormant (7)

Dormant - indicates that the element is inactive or quiesced.

Completed (8)

Completed - indicates that the element has completed its operation. This value should be combined with either OK, Error, or Degraded in the PrimaryStatus so that a client can tell if the complete operation Completed with OK (passed), Completed with Error (failed), or Completed with Degraded (the operation finished, but it did not complete OK or did not report an error).

Migrating (9)

Migrating - element is being moved between host elements.

Emigrating (10)

Emigrating - element is being moved away from host element.

Immigrating (11)

Immigrating - element is being moved to new host element.

Snapshotting (12)

Snapshotting

Shutting Down (13)

Shutting Down - describes an element being brought to an abrupt stop.

In Test (14)

In Test - element is performing test functions.

Transitioning (15)

Transitioning - describes an element that is between states, that is, it is not fully available in either its previous state or its next state. This value should be used if other values indicating a transition to a specific state are not applicable.

In Service (16)

In Service - describes an element that is in service and operational.

DMTF Reserved

Vendor Reserved

OperationalStatus

Data type: uint16 array
Access type: Read-only
Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_ManagedSystemElement.StatusDescriptions")

Indicates the current statuses of the element.

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 because it required the deprecated qualifier. Due to the widespread use of the existing Status property in management applications, it is strongly recommended that providers or 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 (because it is single-valued) should also provide the primary status of the element.

This property is inherited from CIM_ManagedSystemElement.

Unknown (0)

Unknown

Other (1)

Other

OK (2)

Degraded (3)

Degraded

Stressed (4)

Stressed - indicates that the element is functioning, but needs attention. Examples of "Stressed" states are overload, overheated, and so on.

Predictive Failure (5)

Predictive Failure - indicates that an element is functioning nominally but predicting a failure in the near future.

Error (6)

Error

Non-Recoverable Error (7)

Non-Recoverable Error

Starting (8)

Starting

Stopping (9)

Stopping

Stopped (10)

Stopped - indicates that a clean and orderly stop has occurred.

In Service (11)

In Service - describes an element being configured, maintained, cleaned, or otherwise administered.

No Contact (12)

No Contact - indicates that the monitoring system has knowledge of this element, but has never been able to establish communications with it.

Lost Communication (13)

Lost Communication - indicates that the ManagedSystemElement is known to exist and has been contacted successfully in the past, but is currently unreachable.

Aborted (14)

Aborted - indicates that an abrupt stop has occurred, where the state and configuration of the element might need to be updated.

Dormant (15)

Dormant - indicates that the element is inactive or quiesced.

Supporting Entity in Error (16)

Completed (17)

Completed - indicates that the element has completed its operation. This value should be combined with either OK, Error, or Degraded so that a client can tell if the complete operation Completed with OK (passed), Completed with Error (failed), or Completed with Degraded (the operation finished, but it did not complete OK or did not report an error).

Power Mode (18)

Power Mode - indicates that the element has additional power model information contained in the Associated PowerManagementService association.

DMTF Reserved

Vendor Reserved

OtherRecoveryAction

Data type: string
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_Job.RecoveryAction")

A string describing the recovery action when the RecoveryAction property of the instance is 1 ("Other").

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 caused the job to be created.

PercentComplete

Data type: uint16
Access type: Read-only
Qualifiers: MinValue ("0"), MaxValue ("101"), PUnit ("percent"), Units ("Percent")

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.

PrimaryStatus

Data type: uint16
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_ManagedSystemElement.DetailedStatus", "CIM_ManagedSystemElement.HealthState")

Provides a high level status value, intended to align with Red-Yellow-Green type representation of status. It should be used in conjunction with DetailedStatus to provide high level and detailed health status of the Managed Element and its subcomponents.

This property is inherited from CIM_ManagedSystemElement.

Unknown (0)

Unknown - indicates the implementation is in general capable of returning this property, but is unable to do so at this time.

OK (1)

OK - indicates the Managed Element is functioning normally.

Degraded (2)

Degraded - indicates the managed element is functioning below normal.

Error (3)

Error - indicates the managed element is in an Error condition.

DMTF Reserved

Vendor Reserved

Priority

Data type: uint32
Access type: Read/write

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.

RecoveryAction

Data type: uint16
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_Job.OtherRecoveryAction")

Describes the recovery action to be taken for an unsuccessfully run Job. The possible values are:

Unknown (0)

Unknown - meaning it is unknown as to what recovery action to take.

Other (1)

Other - indicating that the recovery action will be specified in the OtherRecoveryAction property.

Do Not Continue (2)

Do Not Continue - meaning stop the execution of the job and appropriately update its status.

Continue With Next Job (3)

Continue With Next Job - meaning continue with the next job in the queue .

Re-run Job (4)

Re-run Job - indicating that the job should be re-run.

Run Recovery Job (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.

RunDay

Data type: sint8
Access type: Read/write
Qualifiers: MinValue ("-31"), MaxValue ("31"), ModelCorrespondence ("CIM_Job.RunMonth", "CIM_Job.RunDayOfWeek", "CIM_Job.RunStartInterval")

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.

RunDayOfWeek

Data type: sint8
Access type: Read/write
Qualifiers: ModelCorrespondence ("CIM_Job.RunMonth", "CIM_Job.RunDay", "CIM_Job.RunStartInterval")

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.

-Saturday (-7)

-Saturday

-Friday (-6)

-Friday

-Thursday (-5)

-Thursday

-Wednesday (-4)

-Wednesday

-Tuesday (-3)

-Tuesday

-Monday (-2)

-Monday

-Sunday (-1)

-Sunday

ExactDayOfMonth (0)

ExactDayOfMonth

Sunday (1)

Sunday

Monday (2)

Monday

Tuesday (3)

Tuesday

Wednesday (4)

Wednesday

Thursday (5)

Thursday

Friday (6)

Friday

Saturday (7)

Saturday

RunMonth

Data type: uint8
Access type: Read/write
Qualifiers: ModelCorrespondence ("CIM_Job.RunDay", "CIM_Job.RunDayOfWeek", "CIM_Job.RunStartInterval")

The month during which the Job should be processed. Specify 0 for January, 1 for February, and so on.

January (0)

January

February (1)

February

March (2)

March

April (3)

April

May (4)

May

June (5)

June

July (6)

July

August (7)

August

September (8)

September

October (9)

October

November (10)

November

December (11)

December

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 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.

ScheduledStartTime

Data type: datetime
Access type: Read/write
Qualifiers: Deprecated ("CIM_Job.RunMonth", "CIM_Job.RunDay", "CIM_Job.RunDayOfWeek", "CIM_Job.RunStartInterval")

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.

StartTime

Data type: datetime
Access type: Read-only

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.

Status

Data type: string
Access type: Read-only
Qualifiers: Deprecated ("CIM_ManagedSystemElement.OperationalStatus"), MaxLen (10)

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:

Status is more correctly defined as an array. This definition overcomes the limitation of describing status using a single value, when it is really a multi-valued property (for example, an element might be OK AND Stopped.
A MaxLen of 10 is too restrictive and leads to unclear enumerated values.
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.

This property is inherited from CIM_ManagedSystemElement.

("OK")

("Error")

("Degraded")

("Unknown")

("Pred Fail")

("Starting")

("Stopping")

("Service")

("Stressed")

("NonRecover")

("No Contact")

("Lost Comm")

("Stopped")

StatusDescriptions

Data type: string array
Access type: Read-only
Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_ManagedSystemElement.OperationalStatus")

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.

This property is inherited from CIM_ManagedSystemElement.

TimeSubmitted

Data type: datetime
Access type: Read-only

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.

UntilTime

Data type: datetime
Access type: Read/write
Qualifiers: ModelCorrespondence ("CIM_Job.LocalOrUtcTime")

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.

Requirements


Minimum supported client	None supported
Minimum supported server	Windows Server 2016
Namespace	Root\MSPS
MOF	MSPSService.Mof
DLL	MSPSService.dll

CIM_Job class

Syntax

Members

Methods

Properties

Requirements

See also

Additional resources