Class CIM_ConcreteJob
extends CIM_Job

A concrete version of Job. This class represents a generic and instantiable unit of work, such as a batch or a print job.

Table of Contents
Hierarchy
Direct Known Subclasses
Class Qualifiers
Class Properties
Class Methods


Class Hierarchy

CIM_ManagedElement
   |
   +--CIM_ManagedSystemElement
   |
   +--CIM_LogicalElement
   |
   +--CIM_Job
   |
   +--CIM_ConcreteJob

Direct Known Subclasses

CIM_BatchJob

Class Qualifiers

NameData TypeValue
DescriptionstringA concrete version of Job. This class represents a generic and instantiable unit of work, such as a batch or a print job.
UMLPackagePathstringCIM::Core::CoreElements
Versionstring2.38.0

Class Properties

Local Class Properties

NameData TypeDefault ValueQualifiers
NameData TypeValue
InstanceIDstring
DescriptionstringWithin 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 that is creating or defining the InstanceID, or that is a registered ID that is 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 re-used to identify different underlying (real-world) elements. If the above 'preferred' algorithm is not used, the defining entity must assure that the resulting InstanceID is not re-used across any InstanceIDs produced by this or other providers for the NameSpace of this instance. For DMTF defined instances, the 'preferred' algorithm must be used with the <OrgID> set to 'CIM'.
Keybooleantrue
OverridestringInstanceID
JobInParametersstring
DescriptionstringThe input (including inout), parameters of the job, formatted as an embedded instance with a class name of "__JobInParameters". In the case where a job represents an intrinsic operation or an extrinsic method call, that embedded instance contains properties representing the input parameters of that call. Each input parameter is mapped to a corresponding property of the same name and type. REF-typed parameters are represented as Reference-qualified properties of type string whose value is the instance path in WBEM URI format. The value of each property shall be the value of the corresponding input parameter at the time the job was started.
EmbeddedObjectbooleantrue
JobOutParametersstring
DescriptionstringThe output (including inout), parameters of the job, formatted as an embedded instance with a class name of "__JobOutParameters". This property shall be NULL unless JobStatus has the value Completed (7). In the case where a job represents an intrinsic operation or an extrinsic method call, that embedded instance contains properties representing the output parameters and return value of that call. Each output parameter is mapped to a corresponding property of the same name and type, and the return value is mapped to a property with the name __ReturnValue of the same type. REF-typed parameters and return values are mapped to Reference-qualified properties of type string whose value is the instance path in WBEM URI format. The value of each such property shall be the value of the corresponding output parameter or return value at the time the job completed.
EmbeddedObjectbooleantrue
JobStateuint16
DescriptionstringJobState is an integer enumeration that indicates the operational state of a Job. It can also indicate transitions between these states, for example, 'Shutting Down' and 'Starting'. Following is a brief description of the states: New (2) indicates that the job has never been started. Starting (3) indicates that the job is moving from the 'New', 'Suspended', or 'Service' states into the 'Running' state. Running (4) indicates that the Job is running. Suspended (5) indicates that the Job is stopped, but can be restarted in a seamless manner. Shutting Down (6) indicates that the job is moving to a 'Completed', 'Terminated', or 'Killed' state. Completed (7) indicates that the job has completed normally. Terminated (8) indicates that the job has been stopped by a 'Terminate' state change request. The job and all its underlying processes are ended and can be restarted (this is job-specific) only as a new job. Killed (9) indicates that the job has been stopped by a 'Kill' state change request. Underlying processes might have been left running, and cleanup might be required to free up resources. Exception (10) indicates that the Job is in an abnormal state that might be indicative of an error condition. Actual status might be displayed though job-specific objects. Service (11) indicates that the Job is in a vendor-specific state that supports problem discovery, or resolution, or both. Query pending (12) waiting for a client to resolve a query
ValueMapstring2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13..32767, 32768..65535
ValuesstringNew, Starting, Running, Suspended, Shutting Down, Completed, Terminated, Killed, Exception, Service, Query Pending, DMTF Reserved, Vendor Reserved
Namestring
DescriptionstringThe user-friendly name for this instance of a Job. In addition, the user-friendly name can be used as a property for a search or query. (Note: Name does not have to be unique within a namespace.)
MaxLenuint321024
OverridestringName
Requiredbooleantrue
TimeBeforeRemovaldatetime00000000000500.000000:000
DescriptionstringThe amount of time that the Job is retained after it has finished executing, either succeeding or failing in that execution. The job must remain in existence for some period of time regardless of the value of the DeleteOnCompletion property. The default is five minutes.
Requiredbooleantrue
Writebooleantrue
TimeOfLastStateChangedatetime
DescriptionstringThe date or time when the state of the Job last changed. If the state of the Job has not changed and this property is populated, then it must be set to a 0 interval value. If a state change was requested, but rejected or not yet processed, the property must not be updated.

Inherited Properties

NameData Type
Captionstring
CommunicationStatusuint16
DeleteOnCompletionboolean
Descriptionstring
DetailedStatusuint16
ElapsedTimedatetime
ElementNamestring
ErrorCodeuint16
ErrorDescriptionstring
Generationuint64
HealthStateuint16
InstallDatedatetime
JobRunTimesuint32
JobStatusstring
LocalOrUtcTimeuint16
Notifystring
OperatingStatusuint16
OtherRecoveryActionstring
Ownerstring
PercentCompleteuint16
PrimaryStatusuint16
Priorityuint32
RecoveryActionuint16
RunDaysint8
RunDayOfWeeksint8
RunMonthuint8
RunStartIntervaldatetime
ScheduledStartTimedatetime
StartTimedatetime
Statusstring
TimeSubmitteddatetime
UntilTimedatetime
OperationalStatusuint16[]
StatusDescriptionsstring[]

Class Methods

Inherited Class Methods

NameReturn Type
KillJobuint32