CIM_ConcreteJob class

Article
01/07/2021

A concrete version of the CIM_Job class. This class represent a generic instantiable unit of work to run, such as a batch or a print job.

Syntax

[Abstract, Version("2.22.0"), UMLPackagePath("CIM::Core::CoreElements"), AMENDMENT]
class CIM_ConcreteJob : CIM_Job
{
  string   InstanceID;
  string   Name;
  uint16   JobState;
  datetime TimeOfLastStateChange;
  datetime TimeBeforeRemoval = "00000000000500.000000:000";
};

Members

The CIM_ConcreteJob class has these types of members:

Methods
Properties

Methods

The CIM_ConcreteJob class has these methods.

Method	Description
GetError	Retrieves error information for the operational status of a concrete job.
RequestStateChange	Requests the specified state change to a concrete job.

Properties

The CIM_ConcreteJob class has these properties.

InstanceID

Data type: string
Access type: Read-only
Qualifiers: Key, Override ("InstanceID")

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.

JobState

Data type: uint16
Access type: Read-only

The operational state of the job, and the transition between those states.

New (2)

the job has never been started.

Starting (3)

The job is moving from the 'New', 'Suspended', or 'Service' states into the 'Running' state.

Running (4)

The Job is running.

Suspended (5)

The Job is stopped, but can be restarted in a seamless manner.

Shutting Down (6)

The job is moving to a 'Completed', 'Terminated', or 'Killed' state.

Completed (7)

The job has completed normally.

Terminated (8)

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)

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)

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)

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.

DMTF Reserved (13..32767)

Vendor Reserved (32768..65535)

Name

Data type: string
Access type: Read-only
Qualifiers: Required, Override ("Name")

The user-friendly name of the instance. In addition, the user-friendly name can be used as a property for a search or query.

Note

The name does not have to be unique within the namespace.

TimeBeforeRemoval

Data type: datetime
Access type: Read/write
Qualifiers: Required

Indicates how long a completed job is retained. The default value is "00000000000500.000000:000" (five minutes).

TimeOfLastStateChange

Data type: datetime
Access type: Read-only

The date or time when the state of the job last changed.

Note

If the state of the Job has not changed and this property is populated, then it must be set to a zero interval value.

Requirements

Requirement	Value
Minimum supported client	Windows 8
Minimum supported server	Windows Server 2012
Namespace	Root\virtualization\v2
MOF	WindowsVirtualization.V2.mof
DLL	Vmms.exe