CIM_Job class

Article
05/31/2018

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 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-cim-job.md)	[!Note] This method is deprecated. Instead we recommend that you use the RequestStateChange method. Shuts down a job.

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

Indicates the ability of the instrumentation to communicate with the underlying managed element.

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

This property is inherited from CIM_ManagedSystemElement.

Unknown (0)

The implementation is in general capable of returning this property, but is unable to do so at this time.

Not Available (1)

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 is established with the element, but does not convey any quality of service.

Lost Communication (3)

The Managed Element is known to exist and has been contacted successfully in the past, but is currently unreachable.

No Contact (4)

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

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

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.

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

This property is inherited from CIM_ManagedSystemElement.

Not Available (0)

No Additional Information (1)

The element is functioning normally as indicated by PrimaryStatus = "OK".

Stressed (2)

The element is functioning, but needs attention. Examples of "Stressed" states are overload, overheated, and so on.

Predictive Failure (3)

An element is functioning normally but a failure is predicted in the near future.

Non-Recoverable Error (4)

This element is in an error condition that requires human intervention.

Supporting Entity in Error (5)

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 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 that of its subcomponents.

This property is inherited from CIM_ManagedSystemElement.

Unknown (0)

The implementation cannot report on HealthState at this time.

OK (5)

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

Degraded/Warning (10)

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)

All functionality is available but some 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 not working.

Critical failure (25)

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

Non-recoverable error (30)

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

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

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:

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

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 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 to notify when a job completes or fails.

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)

The implementation (ie, the provider) is in general capable of returning this property, but is unable to do so at this time.

Not Available (1)

Servicing (2)

An element is being configured, maintained, cleaned, or otherwise administered.

Starting (3)

The element is being initialized.

Stopping (4)

An element is being brought to an orderly stop.

Stopped (5)

A clean and orderly stop has occurred.

Aborted (6)

An abrupt stop, where the state and configuration of the element might need to be updated, has occurred.

Dormant (7)

The element is inactive or quiesced.

Completed (8)

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)

The element is being moved between host elements.

Emigrating (10)

The element is being moved away from host element.

Immigrating (11)

The element is being moved to new host element.

Snapshotting (12)

Shutting Down (13)

The element is being brought to an abrupt stop.

In Test (14)

The managed element is performing test functions.

Transitioning (15)

The 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)

The element 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. Various operational statuses are defined.

OperationalStatus replaces the Status property 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)

Other (1)

OK (2)

Degraded (3)

Stressed (4)

The element is functioning, but needs attention. Examples of "Stressed" states are overload, overheated, and so on.

Predictive Failure (5)

An element is functioning nominally but predicting a failure in the near future.

Error (6)

Non-Recoverable Error (7)

Starting (8)

Stopping (9)

Stopped (10)

A clean and orderly stop has occurred.

In Service (11)

An element is being configured, maintained, cleaned, or otherwise administered.

No Contact (12)

The monitoring system has knowledge of this element, but has never been able to establish communications with it.

Lost Communication (13)

The managed system element is known to exist and has been contacted successfully in the past, but is currently unreachable.

Aborted (14)

An abrupt stop, where the state and configuration of the element might need to be updated, has occurred.

Dormant (15)

The element is inactive or quiesced.

Supporting Entity in Error (16)

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.

Completed (17)

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)

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 that describes the recovery action when the RecoveryAction property 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 requested the job.

PercentComplete

Data type: uint16
Access type: Read-only
Qualifiers: MinValue ("0"), MaxValue ("101"), PUnit ("percent"), Units ("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")

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)

The implementation is in general capable of returning this property, but is unable to do so at this time.

OK (1)

The managed element is functioning normally.

Degraded (2)

The managed element is functioning below normal.

Error (3)

The managed element is in an Error condition.

DMTF Reserved

Vendor Reserved

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.

TBD

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)

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 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 2012 R2
Namespace	Root\Microsoft\IPAM
MOF	IPAMServerPSProvider.mof
DLL	IPAMServerPSProvider.dll

Partager via

CIM_Job class

Syntax

Members

Methods

Properties

Requirements

See also

Ressources supplémentaires