CIM211 Class Declaration
CIM_PrintJob

Table of Contents:
Class Hierarchy
Class Attributes
Class Qualifiers
Properties
Methods
Associations in which the class can participate
Sub Profiling Summary

Class Hierarchy

CIM_PrintJob --> CIM_Job --> CIM_LogicalElement --> CIM_ManagedSystemElement --> CIM_ManagedElement --> [top]

Class Attributes

Class Declaration Attributes
NameValue
SUPERCLASSCIM_Job
NAMECIM_PrintJob

Class Qualifiers

Class CIM_PrintJob Qualifiers
NameTypeValueFrom Class
Versionstring2.10.0 CIM_PrintJob
DescriptionstringDescription of a print request that is either waiting on a Queue for a Printer to become available or in the process of being output on a Printer, or that has previously been printed on a Printer. PrintJobs are weak to their current Queue, or to the last Queue that held them. CIM_PrintJob
DescriptionstringA 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. CIM_Job
DescriptionstringCIM_LogicalElement is a base class for all the components of a System that represent abstract system components, such as Files, Processes, or LogicalDevices. CIM_LogicalElement
DescriptionstringCIM_ManagedSystemElement is the base class for the System Element hierarchy. Any distinguishable component of a System is a candidate for inclusion in this class. Examples of system components include: - software components such as application servers, databases, and applications - operating system components such as files, processes, and threads - device components such as disk drives, controllers, processors, and printers - physical components such as chips and cards. CIM_ManagedSystemElement
DescriptionstringManagedElement is an abstract class that provides a common superclass (or top of the inheritance tree) for the non-association classes in the CIM Schema. CIM_ManagedElement

Properties

Properties
NameTypeValueQualifiersClassOrigin
SystemCreationClassNamestring Key
Propagated
Description
MaxLen
CIM_PrintJob
SystemNamestring Key
Propagated
Description
MaxLen
CIM_PrintJob
QueueCreationClassNamestring Key
Propagated
Description
MaxLen
CIM_PrintJob
QueueNamestring Key
Propagated
Description
MaxLen
CIM_PrintJob
JobStatusstring Override
Description
ModelCorrespondence
CIM_PrintJob
JobIDstring Key
Description
CIM_PrintJob
SchedulingInformationstring Deprecated
Description
CIM_PrintJob
JobSizeuint32 Description
Units
ModelCorrespondence
CIM_PrintJob
Languageuint16 Description
ValueMap
Values
MappingStrings
ModelCorrespondence
CIM_PrintJob
MimeTypesstring[] Description
ModelCorrespondence
CIM_PrintJob
RequiredPaperTypestring Description
ModelCorrespondence
CIM_PrintJob
Finishinguint16[] Description
ValueMap
Values
ArrayType
ModelCorrespondence
CIM_PrintJob
Copiesuint32 Description
ModelCorrespondence
CIM_PrintJob
HorizontalResolutionuint32 Description
Units
ModelCorrespondence
CIM_PrintJob
VerticalResolutionuint32 Description
Units
ModelCorrespondence
CIM_PrintJob
CharSetstring Description
ModelCorrespondence
CIM_PrintJob
NaturalLanguagestring Description
ModelCorrespondence
CIM_PrintJob
NumberUpuint32 Description
ModelCorrespondence
CIM_PrintJob
PrintJobStatusuint16 Description
ValueMap
Values
ModelCorrespondence
CIM_PrintJob
TimeCompleteddatetime Description
ModelCorrespondence
CIM_PrintJob
RequiredJobSheetsstring[] Description
ModelCorrespondence
CIM_PrintJob
JobOriginationstring Description CIM_PrintJob
TimeSubmitteddatetime Description CIM_Job
ScheduledStartTimedatetime Deprecated
Write
Description
CIM_Job
StartTimedatetime Description CIM_Job
ElapsedTimedatetime Description CIM_Job
JobRunTimesuint321 Write
Description
CIM_Job
RunMonthuint8 Write
Description
ValueMap
Values
ModelCorrespondence
CIM_Job
RunDaysint8 Write
Description
MinValue
MaxValue
ModelCorrespondence
CIM_Job
RunDayOfWeeksint8 Write
Description
ValueMap
Values
ModelCorrespondence
CIM_Job
RunStartIntervaldatetime Write
Description
ModelCorrespondence
CIM_Job
LocalOrUtcTimeuint16 Write
Description
ValueMap
Values
CIM_Job
UntilTimedatetime Write
Description
ModelCorrespondence
CIM_Job
Notifystring Write
Description
CIM_Job
Ownerstring Description
ModelCorrespondence
CIM_Job
Priorityuint32 Write
Description
CIM_Job
PercentCompleteuint16 Description
Units
MinValue
MaxValue
CIM_Job
DeleteOnCompletionboolean Write
Description
CIM_Job
ErrorCodeuint16 Description
ModelCorrespondence
CIM_Job
ErrorDescriptionstring Description
ModelCorrespondence
CIM_Job
RecoveryActionuint16 Description
ValueMap
Values
ModelCorrespondence
CIM_Job
OtherRecoveryActionstring Description
ModelCorrespondence
CIM_Job
InstallDatedatetime Description
MappingStrings
CIM_ManagedSystemElement
Namestring Description
MaxLen
CIM_ManagedSystemElement
OperationalStatusuint16[] Description
ValueMap
Values
ArrayType
ModelCorrespondence
CIM_ManagedSystemElement
StatusDescriptionsstring[] Description
ArrayType
ModelCorrespondence
CIM_ManagedSystemElement
Statusstring Deprecated
Description
ValueMap
MaxLen
CIM_ManagedSystemElement
HealthStateuint16 Description
ValueMap
Values
CIM_ManagedSystemElement
Captionstring Description
MaxLen
CIM_ManagedElement
Descriptionstring Description CIM_ManagedElement
ElementNamestring Description CIM_ManagedElement

Property Qualifiers

Property SystemCreationClassName Qualifiers
NameTypeValueFrom Class
Keybooleantrue CIM_PrintJob
PropagatedstringCIM_PrintQueue.SystemCreationClassName CIM_PrintJob
DescriptionstringThe CreationClassName of the scoping System. CIM_PrintJob
MaxLenuint32256 CIM_PrintJob

Property SystemName Qualifiers
NameTypeValueFrom Class
Keybooleantrue CIM_PrintJob
PropagatedstringCIM_PrintQueue.SystemName CIM_PrintJob
DescriptionstringThe Name of the scoping System. CIM_PrintJob
MaxLenuint32256 CIM_PrintJob

Property QueueCreationClassName Qualifiers
NameTypeValueFrom Class
Keybooleantrue CIM_PrintJob
PropagatedstringCIM_PrintQueue.CreationClassName CIM_PrintJob
DescriptionstringThe CreationClassName of the scoping Queue. CIM_PrintJob
MaxLenuint32256 CIM_PrintJob

Property QueueName Qualifiers
NameTypeValueFrom Class
Keybooleantrue CIM_PrintJob
PropagatedstringCIM_PrintQueue.Name CIM_PrintJob
DescriptionstringThe Name of the scoping Queue. CIM_PrintJob
MaxLenuint32256 CIM_PrintJob

Property JobStatus Qualifiers
NameTypeValueFrom Class
OverridestringJobStatus CIM_PrintJob
DescriptionstringThe inherited JobStatus is used to provide additional information about the status of a PrintJob beyond that enumerated by PrintJobStatus. CIM_PrintJob
ModelCorrespondencestringCIM_PrintJob.PrintJobStatus CIM_PrintJob

Property JobID Qualifiers
NameTypeValueFrom Class
Keybooleantrue CIM_PrintJob
DescriptionstringUniquely identifies this Job within its scoping Queue. CIM_PrintJob

Property SchedulingInformation Qualifiers
NameTypeValueFrom Class
DescriptionstringNote: The use of this free-form string property is deprecated in lieu of the more semantically rich SettingData class, JobScheduleSettingData. CIM_PrintJob

Property JobSize Qualifiers
NameTypeValueFrom Class
DescriptionstringSpecifies the size of the PrintJob (as a byte stream) in units of Kbytes. CIM_PrintJob
UnitsstringKiloBytes CIM_PrintJob
ModelCorrespondencestringCIM_Printer.MaxSizeSupported
CIM_PrintQueue.MaxJobSize
CIM_PrintJob

Property Language Qualifiers
NameTypeValueFrom Class
DescriptionstringSpecifies the print language that is used by this Job. CIM_PrintJob
ValueMapstring
[See below.]
CIM_PrintJob
ValuesstringOther
Unknown
PCL
HPGL
PJL
PS
PSPrinter
IPDS
PPDS
EscapeP
Epson
DDIF
Interpress
ISO6429
Line Data
MODCA
REGIS
SCS
SPDL
TEK4014
PDS
IGP
CodeV
DSCDSE
WPS
LN03
CCITT
QUIC
CPAP
DecPPL
Simple Text
NPAP
DOC
imPress
Pinwriter
NPDL
NEC201PL
Automatic
Pages
LIPS
TIFF
Diagnostic
CaPSL
EXCL
LCDS
XES
MIME
TIPSI
Prescribe
LinePrinter
IDP
XJCL
PDF
RPDL
IntermecIPL
UBIFingerprint
UBIDirectProtocol
Fujitsu
PCLXL
CIM_PrintJob
MappingStringsstringMIB.IETF|Printer-MIB.prtInterpreterLangFamily CIM_PrintJob
ModelCorrespondencestringCIM_Printer.LanguagesSupported
CIM_PrintService.LanguagesSupported
CIM_PrintJob.MimeTypes
CIM_PrintJob

NameValue
1Other
2Unknown
3PCL
4HPGL
5PJL
6PS
7PSPrinter
8IPDS
9PPDS
10EscapeP
11Epson
12DDIF
13Interpress
14ISO6429
15Line Data
16MODCA
17REGIS
18SCS
19SPDL
20TEK4014
21PDS
22IGP
23CodeV
24DSCDSE
25WPS
26LN03
27CCITT
28QUIC
29CPAP
30DecPPL
31Simple Text
32NPAP
33DOC
34imPress
35Pinwriter
36NPDL
37NEC201PL
38Automatic
39Pages
40LIPS
41TIFF
42Diagnostic
43CaPSL
44EXCL
45LCDS
46XES
47MIME
48TIPSI
50Prescribe
51LinePrinter
52IDP
53XJCL
54PDF
55RPDL
56IntermecIPL
57UBIFingerprint
58UBIDirectProtocol
59Fujitsu
60PCLXL
Property MimeTypes Qualifiers
NameTypeValueFrom Class
DescriptionstringSpecifies the MIME types that are used by the PrintJob if Language is set to indicate that a MIME type is in use (value=47). CIM_PrintJob
ModelCorrespondencestringCIM_PrintJob.Language
CIM_Printer.MimeTypesSupported
CIM_PrintService.MimeTypesSupported
CIM_PrintJob

Property RequiredPaperType Qualifiers
NameTypeValueFrom Class
DescriptionstringA string that specifies the type of paper that is required by this PrintJob. Each string should be expressed in the form that is specified by ISO/IEC 10175 Document Printing Application (DPA), which is also summarized in Appendix C of RFC 1759 (Printer MIB). Examples of valid strings are " iso-a4-colored " and " na-10x14-envelope " . CIM_PrintJob
ModelCorrespondencestringCIM_Printer.PaperTypesAvailable
CIM_PrintService.PaperTypesAvailable
CIM_PrintJob

Property Finishing Qualifiers
NameTypeValueFrom Class
DescriptionstringAn array of integers that indicates the type of finishing that is required by this Job. It is equivalent to the Capabilities property that is provided by the Printer. CIM_PrintJob
ValueMapstring
[See below.]
CIM_PrintJob
ValuesstringUnknown
Other
Color Printing
Duplex Printing
Copies
Collation
Stapling
Transparency Printing
Punch
Cover
Bind
Black and White Printing
One Sided
Two Sided Long Edge
Two Sided Short Edge
Portrait
Landscape
Reverse Portrait
Reverse Landscape
Quality High
Quality Normal
Quality Low
CIM_PrintJob
ArrayTypestringIndexed CIM_PrintJob
ModelCorrespondencestringCIM_Printer.Capabilities
CIM_PrintService.Capabilities
CIM_PrintJob

NameValue
0Unknown
1Other
2Color Printing
3Duplex Printing
4Copies
5Collation
6Stapling
7Transparency Printing
8Punch
9Cover
10Bind
11Black and White Printing
12One Sided
13Two Sided Long Edge
14Two Sided Short Edge
15Portrait
16Landscape
17Reverse Portrait
18Reverse Landscape
19Quality High
20Quality Normal
21Quality Low
Property Copies Qualifiers
NameTypeValueFrom Class
DescriptionstringThe number of physical copies of the output that will be produced from this Job. CIM_PrintJob
ModelCorrespondencestringCIM_Printer.MaxCopies CIM_PrintJob

Property HorizontalResolution Qualifiers
NameTypeValueFrom Class
DescriptionstringThe horizontal resolution in Pixels per Inch for the Job. CIM_PrintJob
UnitsstringPixels per Inch CIM_PrintJob
ModelCorrespondencestringCIM_Printer.HorizontalResolution CIM_PrintJob

Property VerticalResolution Qualifiers
NameTypeValueFrom Class
DescriptionstringThe vertical resolution in Pixels per Inch for the Job. CIM_PrintJob
UnitsstringPixels per Inch CIM_PrintJob
ModelCorrespondencestringCIM_Printer.VerticalResolution CIM_PrintJob

Property CharSet Qualifiers
NameTypeValueFrom Class
DescriptionstringSpecifies the character set and encoding method that should be used by the Printer for the management of this Job. The strings should conform to the semantics and syntax that are specified by section 4.1.2 ( " Charset parameter " ) in RFC 2046 (MIME Part 2) and contained in the IANA character-set registry. Examples include " utf-8 " , " us-ascii " and " iso-8859-1 " . CIM_PrintJob
ModelCorrespondencestringCIM_Printer.CharSetsSupported CIM_PrintJob

Property NaturalLanguage Qualifiers
NameTypeValueFrom Class
DescriptionstringIdentifies the language that should be used by the Printer for the management of this Job. The specified value should conform to RFC 1766. For example, " en " is used for English. CIM_PrintJob
ModelCorrespondencestringCIM_Printer.NaturalLanguagesSupported CIM_PrintJob

Property NumberUp Qualifiers
NameTypeValueFrom Class
DescriptionstringThe number of print-stream pages that should be rendered onto a single media sheet when the Printer outputs this PrintJob. CIM_PrintJob
ModelCorrespondencestringCIM_Printer.MaxNumberUp CIM_PrintJob

Property PrintJobStatus Qualifiers
NameTypeValueFrom Class
DescriptionstringDescribes the current state of this Job with respect to the PrintQueue and the Printer. Additional information can be specified in JobStatus. CIM_PrintJob
ValueMapstring
[See below.]
CIM_PrintJob
ValuesstringOther
Unknown
Pending
Blocked
Complete
Completed With Error
Printing
CIM_PrintJob
ModelCorrespondencestringCIM_PrintJob.TimeCompleted
CIM_PrintJob.JobStatus
CIM_PrintJob

NameValue
1Other
2Unknown
3Pending
4Blocked
5Complete
6Completed With Error
7Printing
Property TimeCompleted Qualifiers
NameTypeValueFrom Class
DescriptionstringThe time when this Job was completed. This value is valid only if the PrintJobStatus has been assigned to " Complete " (value=5) or " Completed With Error " (value=6). CIM_PrintJob
ModelCorrespondencestringCIM_PrintJob.PrintJobStatus CIM_PrintJob

Property RequiredJobSheets Qualifiers
NameTypeValueFrom Class
DescriptionstringDescribes the job sheets that should be used when this Job is output on the Printer. CIM_PrintJob
ModelCorrespondencestringCIM_Printer.AvailableJobSheets CIM_PrintJob

Property JobOrigination Qualifiers
NameTypeValueFrom Class
DescriptionstringProvides additional information, beyond Job Owner that is inherited from CIM_Job, to identify the origins of the PrintJob. This property could include information such as the System, Application, or Process that created the Job. CIM_PrintJob

Property JobStatus Qualifiers
NameTypeValueFrom Class
DescriptionstringA 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. CIM_Job
ModelCorrespondencestringCIM_ManagedSystemElement.OperationalStatus CIM_Job

Property TimeSubmitted Qualifiers
NameTypeValueFrom Class
DescriptionstringThe 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. CIM_Job

Property ScheduledStartTime Qualifiers
NameTypeValueFrom Class
Writebooleantrue CIM_Job
DescriptionstringThe 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. CIM_Job

Property StartTime Qualifiers
NameTypeValueFrom Class
DescriptionstringThe 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. CIM_Job

Property ElapsedTime Qualifiers
NameTypeValueFrom Class
DescriptionstringThe 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. CIM_Job

Property JobRunTimes Qualifiers
NameTypeValueFrom Class
Writebooleantrue CIM_Job
DescriptionstringThe 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. CIM_Job

Property RunMonth Qualifiers
NameTypeValueFrom Class
Writebooleantrue CIM_Job
DescriptionstringThe month during which the Job should be processed. Specify 0 for January, 1 for February, and so on. CIM_Job
ValueMapstring
[See below.]
CIM_Job
ValuesstringJanuary
February
March
April
May
June
July
August
September
October
November
December
CIM_Job
ModelCorrespondencestringCIM_Job.RunDay
CIM_Job.RunDayOfWeek
CIM_Job.RunStartInterval
CIM_Job

NameValue
0January
1February
2March
3April
4May
5June
6July
7August
8September
9October
10November
11December
Property RunDay Qualifiers
NameTypeValueFrom Class
Writebooleantrue CIM_Job
DescriptionstringThe 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. CIM_Job
MinValuesint64-31 CIM_Job
MaxValuesint6431 CIM_Job
ModelCorrespondencestringCIM_Job.RunMonth
CIM_Job.RunDayOfWeek
CIM_Job.RunStartInterval
CIM_Job

Property RunDayOfWeek Qualifiers
NameTypeValueFrom Class
Writebooleantrue CIM_Job
DescriptionstringA 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. CIM_Job
ValueMapstring
[See below.]
CIM_Job
Valuesstring-Saturday
-Friday
-Thursday
-Wednesday
-Tuesday
-Monday
-Sunday
ExactDayOfMonth
Sunday
Monday
Tuesday
Wednesday
Thursday
Friday
Saturday
CIM_Job
ModelCorrespondencestringCIM_Job.RunMonth
CIM_Job.RunDay
CIM_Job.RunStartInterval
CIM_Job

NameValue
-7-Saturday
-6-Friday
-5-Thursday
-4-Wednesday
-3-Tuesday
-2-Monday
-1-Sunday
0ExactDayOfMonth
1Sunday
2Monday
3Tuesday
4Wednesday
5Thursday
6Friday
7Saturday
Property RunStartInterval Qualifiers
NameTypeValueFrom Class
Writebooleantrue CIM_Job
DescriptionstringThe 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. CIM_Job
ModelCorrespondencestringCIM_Job.RunMonth
CIM_Job.RunDay
CIM_Job.RunDayOfWeek
CIM_Job.RunStartInterval
CIM_Job

Property LocalOrUtcTime Qualifiers
NameTypeValueFrom Class
Writebooleantrue CIM_Job
DescriptionstringThis 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 " . CIM_Job
ValueMapstring
[See below.]
CIM_Job
ValuesstringLocal Time
UTC Time
CIM_Job

NameValue
1Local Time
2UTC Time
Property UntilTime Qualifiers
NameTypeValueFrom Class
Writebooleantrue CIM_Job
DescriptionstringThe 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. CIM_Job
ModelCorrespondencestringCIM_Job.LocalOrUtcTime CIM_Job

Property Notify Qualifiers
NameTypeValueFrom Class
Writebooleantrue CIM_Job
DescriptionstringThe User who is to be notified upon the Job completion or failure. CIM_Job

Property Owner Qualifiers
NameTypeValueFrom Class
DescriptionstringThe User that submitted the Job, or the Service or method name that caused the job to be created. CIM_Job
ModelCorrespondencestringCIM_OwningJobElement CIM_Job

Property Priority Qualifiers
NameTypeValueFrom Class
Writebooleantrue CIM_Job
DescriptionstringIndicates 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. CIM_Job

Property PercentComplete Qualifiers
NameTypeValueFrom Class
DescriptionstringThe 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. CIM_Job
UnitsstringPercent CIM_Job
MinValuesint640 CIM_Job
MaxValuesint64101 CIM_Job

Property DeleteOnCompletion Qualifiers
NameTypeValueFrom Class
Writebooleantrue CIM_Job
DescriptionstringIndicates 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. CIM_Job

Property ErrorCode Qualifiers
NameTypeValueFrom Class
DescriptionstringA 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. CIM_Job
ModelCorrespondencestringCIM_Job.ErrorDescription CIM_Job

Property ErrorDescription Qualifiers
NameTypeValueFrom Class
DescriptionstringA 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. CIM_Job
ModelCorrespondencestringCIM_Job.ErrorCode CIM_Job

Property RecoveryAction Qualifiers
NameTypeValueFrom Class
DescriptionstringDescribes the recovery action to be taken for an unsuccessfully run Job. The possible values are: 0 = " Unknown " , meaning it is unknown as to what recovery action to take 1 = " Other " , indicating that the recovery action will be specified in the OtherRecoveryAction property 2 = " Do Not Continue " , meaning stop the execution of the job and appropriately update its status 3 = " Continue With Next Job " , meaning continue with the next job in the queue 4 = " Re-run Job " , indicating that the job should be re-run 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. CIM_Job
ValueMapstring
[See below.]
CIM_Job
ValuesstringUnknown
Other
Do Not Continue
Continue With Next Job
Re-run Job
Run Recovery Job
CIM_Job
ModelCorrespondencestringCIM_Job.OtherRecoveryAction CIM_Job

NameValue
0Unknown
1Other
2Do Not Continue
3Continue With Next Job
4Re-run Job
5Run Recovery Job
Property OtherRecoveryAction Qualifiers
NameTypeValueFrom Class
DescriptionstringA string describing the recovery action when the RecoveryAction property of the instance is 1 ( " Other " ). CIM_Job
ModelCorrespondencestringCIM_Job.RecoveryAction CIM_Job

Property InstallDate Qualifiers
NameTypeValueFrom Class
DescriptionstringA datetime value that indicates when the object was installed. Lack of a value does not indicate that the object is not installed. CIM_ManagedSystemElement
MappingStringsstringMIF.DMTF|ComponentID|001.5 CIM_ManagedSystemElement

Property Name Qualifiers
NameTypeValueFrom Class
DescriptionstringThe Name property defines the label by which the object is known. When subclassed, the Name property can be overridden to be a Key property. CIM_ManagedSystemElement
MaxLenuint321024 CIM_ManagedSystemElement

Property OperationalStatus Qualifiers
NameTypeValueFrom Class
DescriptionstringIndicates the current statuses of the element. Various operational statuses are defined. Many of the enumeration ’ s values are self-explanatory. However, a few are not and are described here in more detail. " Stressed " indicates that the element is functioning, but needs attention. Examples of " Stressed " states are overload, overheated, and so on. " Predictive Failure " indicates that an element is functioning nominally but predicting a failure in the near future. " In Service " describes an element being configured, maintained, cleaned, or otherwise administered. " No Contact " indicates that the monitoring system has knowledge of this element, but has never been able to establish communications with it. " Lost Communication " indicates that the ManagedSystem Element is known to exist and has been contacted successfully in the past, but is currently unreachable. " Stopped " and " Aborted " are similar, although the former implies a clean and orderly stop, while the latter implies an abrupt stop where the state and configuration of the element might need to be updated. " Dormant " indicates that the element is inactive or quiesced. " 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. " 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 " indicates that the element has additional power model information contained in the Associated PowerManagementService association. 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. CIM_ManagedSystemElement
ValueMapstring
[See below.]
CIM_ManagedSystemElement
ValuesstringUnknown
Other
OK
Degraded
Stressed
Predictive Failure
Error
Non-Recoverable Error
Starting
Stopping
Stopped
In Service
No Contact
Lost Communication
Aborted
Dormant
Supporting Entity in Error
Completed
Power Mode
DMTF Reserved
Vendor Reserved
CIM_ManagedSystemElement
ArrayTypestringIndexed CIM_ManagedSystemElement
ModelCorrespondencestringCIM_ManagedSystemElement.StatusDescriptions CIM_ManagedSystemElement

NameValue
0Unknown
1Other
2OK
3Degraded
4Stressed
5Predictive Failure
6Error
7Non-Recoverable Error
8Starting
9Stopping
10Stopped
11In Service
12No Contact
13Lost Communication
14Aborted
15Dormant
16Supporting Entity in Error
17Completed
18Power Mode
..DMTF Reserved
0x8000..Vendor Reserved
Property StatusDescriptions Qualifiers
NameTypeValueFrom Class
DescriptionstringStrings 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. CIM_ManagedSystemElement
ArrayTypestringIndexed CIM_ManagedSystemElement
ModelCorrespondencestringCIM_ManagedSystemElement.OperationalStatus CIM_ManagedSystemElement

Property Status Qualifiers
NameTypeValueFrom Class
DescriptionstringA 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: 1) 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. 2) A MaxLen of 10 is too restrictive and leads to unclear enumerated values. 3) 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. CIM_ManagedSystemElement
ValueMapstring
[See below.]
CIM_ManagedSystemElement
MaxLenuint3210 CIM_ManagedSystemElement

NameValue
OK[none]
Error[none]
Degraded[none]
Unknown[none]
Pred Fail[none]
Starting[none]
Stopping[none]
Service[none]
Stressed[none]
NonRecover[none]
No Contact[none]
Lost Comm[none]
Stopped[none]
Property HealthState Qualifiers
NameTypeValueFrom Class
DescriptionstringIndicates 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. The following continuum is defined: " Non-recoverable Error " (30) - The element has completely failed, and recovery is not possible. All functionality provided by this element has been lost. " Critical Failure " (25) - The element is non-functional and recovery might not be possible. " 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. " Minor Failure " (15) - All functionality is available but some might be degraded. " 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. " OK " (5) - The element is fully functional and is operating within normal operational parameters and without error. " Unknown " (0) - The implementation cannot report on HealthState at this time. DMTF has reserved the unused portion of the continuum for additional HealthStates in the future. CIM_ManagedSystemElement
ValueMapstring
[See below.]
CIM_ManagedSystemElement
ValuesstringUnknown
OK
Degraded/Warning
Minor failure
Major failure
Critical failure
Non-recoverable error
DMTF Reserved
CIM_ManagedSystemElement

NameValue
0Unknown
5OK
10Degraded/Warning
15Minor failure
20Major failure
25Critical failure
30Non-recoverable error
..DMTF Reserved
Property Caption Qualifiers
NameTypeValueFrom Class
DescriptionstringThe Caption property is a short textual description (one- line string) of the object. CIM_ManagedElement
MaxLenuint3264 CIM_ManagedElement

Property Description Qualifiers
NameTypeValueFrom Class
DescriptionstringThe Description property provides a textual description of the object. CIM_ManagedElement

Property ElementName Qualifiers
NameTypeValueFrom Class
DescriptionstringA 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 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. CIM_ManagedElement

Methods

NameTypeValueQualifiersParametersClassOrigin
KillJobuint32 Deprecated
Description
ValueMap
Values
DeleteOnKillCIM_Job

Method Qualifiers

Method KillJob Qualifiers
NameTypeValueFrom Class
DescriptionstringKillJob 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. CIM_Job
ValueMapstring
[See below.]
CIM_Job
ValuesstringSuccess
Not Supported
Unknown
Timeout
Failed
Access Denied
Not Found
DMTF Reserved
Vendor Specific
CIM_Job

Parameters

Method KillJob Parameters
NameTypeQualifiers
DeleteOnKillbooleanIN
Description

Parameter Qualifiers

Parameter DeleteOnKill Qualifiers
NameTypeValueFrom Class
INbooleantrue CIM_Job
DescriptionstringIndicates whether or not the Job should be automatically deleted upon termination. This parameter takes precedence over the property, DeleteOnCompletion. CIM_Job

Associations this class can participate in

Association
Class
Reference
Class
Role
CIM_PrintJobFileCIM_PrintJobGroupComponent
CIM_OwningPrintQueueCIM_PrintJobDependent
CIM_PrinterServicingJobCIM_PrintJobDependent
CIM_ProcessOfJobCIM_JobGroupComponent
CIM_RecoveryJobCIM_JobAntecedent
CIM_RecoveryJobCIM_JobDependent
CIM_ExecutionRequirementCIM_JobDependent
CIM_JobDestinationJobsCIM_JobDependent
CIM_ExecutionCandidateCIM_JobDependent
CIM_ExecutionTargetCIM_JobDependent
CIM_OwningJobElementCIM_JobOwnedElement
CIM_AffectedJobElementCIM_JobAffectingElement
CIM_LogicalElementPerformsUoWCIM_LogicalElementAntecedent
CIM_ImportedShareRootCIM_LogicalElementAntecedent
CIM_ImportedShareRootCIM_LogicalElementDependent
CIM_LogicalElementUnitOfWorkDefCIM_LogicalElementAntecedent
CIM_SharedElementRootCIM_LogicalElementAntecedent
CIM_OperationLogCIM_LogicalElementDependent
CIM_AllocatedFromStoragePoolCIM_LogicalElementDependent
CIM_ResidesOnExtentCIM_LogicalElementDependent
CIM_AssociatedMemoryCIM_LogicalElementDependent
CIM_AttachedElementCIM_LogicalElementSystemElement
CIM_AttachedElementCIM_LogicalElementSameElement
CIM_MountedElementCIM_LogicalElementSystemElement
CIM_MountedElementCIM_LogicalElementSameElement
CIM_ImportedShareCIM_LogicalElementSystemElement
CIM_ImportedShareCIM_LogicalElementSameElement
CIM_SharedElementCIM_LogicalElementSystemElement
CIM_RedundancyComponentCIM_ManagedSystemElementPartComponent
CIM_SystemComponentCIM_ManagedSystemElementPartComponent
CIM_UseOfLogCIM_ManagedSystemElementDependent
CIM_DiagnosticTestForMSECIM_ManagedSystemElementDependent
CIM_CollectedMSEsCIM_ManagedSystemElementMember
CIM_DiagnosticResultForMSECIM_ManagedSystemElementSystemElement
CIM_ElementConfigurationCIM_ManagedSystemElementElement
CIM_ElementSettingCIM_ManagedSystemElementElement
CIM_ActsAsSpareCIM_ManagedSystemElementSpare
CIM_ComponentCIM_ManagedElementGroupComponent
CIM_ComponentCIM_ManagedElementPartComponent
CIM_ConcreteComponentCIM_ManagedElementGroupComponent
CIM_ConcreteComponentCIM_ManagedElementPartComponent
CIM_CredentialContextCIM_ManagedElementElementProvidingContext
CIM_DefaultElementCapabilitiesCIM_ManagedElementManagedElement
CIM_DependencyCIM_ManagedElementAntecedent
CIM_DependencyCIM_ManagedElementDependent
CIM_HostedDependencyCIM_ManagedElementAntecedent
CIM_HostedDependencyCIM_ManagedElementDependent
CIM_ScopedSettingCIM_ManagedElementAntecedent
CIM_MetricDefForMECIM_ManagedElementAntecedent
CIM_MetricForMECIM_ManagedElementAntecedent
CIM_RelatedElementCausingErrorCIM_ManagedElementDependent
CIM_RelatedElementCausingErrorCIM_ManagedElementAntecedent
CIM_SparedCIM_ManagedElementAntecedent
CIM_SparedCIM_ManagedElementDependent
CIM_ConcreteDependencyCIM_ManagedElementAntecedent
CIM_ConcreteDependencyCIM_ManagedElementDependent
CIM_ElementAsUserCIM_ManagedElementAntecedent
CIM_RecordAppliesToElementCIM_ManagedElementDependent
CIM_AuthenticationTargetCIM_ManagedElementDependent
CIM_AuthorizationSubjectCIM_ManagedElementDependent
CIM_AuthorizationTargetCIM_ManagedElementDependent
CIM_ElementSoftwareIdentityCIM_ManagedElementDependent
CIM_IsSpareCIM_ManagedElementAntecedent
CIM_ProvidesServiceToElementCIM_ManagedElementDependent
CIM_ElementCapabilitiesCIM_ManagedElementManagedElement
CIM_IdentityContextCIM_ManagedElementElementProvidingContext
CIM_LogicalIdentityCIM_ManagedElementSystemElement
CIM_LogicalIdentityCIM_ManagedElementSameElement
CIM_ConcreteIdentityCIM_ManagedElementSystemElement
CIM_ConcreteIdentityCIM_ManagedElementSameElement
CIM_SWRManageableAspectCIM_ManagedElementSystemElement
CIM_MemberOfCollectionCIM_ManagedElementMember
CIM_MemberPrincipalCIM_ManagedElementMember
CIM_ElementInPolicyRoleCollectionCIM_ManagedElementMember
CIM_OwningCollectionElementCIM_ManagedElementOwningElement
CIM_ParametersForMethodCIM_ManagedElementTheMethod
CIM_ParameterValueSourcesCIM_ManagedElementValueSource
CIM_PolicySetAppliesToElementCIM_ManagedElementManagedElement
CIM_AuthorizationRuleAppliesToTargetCIM_ManagedElementManagedElement
CIM_RoleLimitedToTargetCIM_ManagedElementTargetElement
CIM_StatisticsCIM_ManagedElementElement
CIM_SynchronizedCIM_ManagedElementSystemElement
CIM_SynchronizedCIM_ManagedElementSyncedElement
CIM_StorageSynchronizedCIM_ManagedElementSystemElement
CIM_StorageSynchronizedCIM_ManagedElementSyncedElement
CIM_AssignedIdentityCIM_ManagedElementManagedElement
CIM_AuthorizedSubjectCIM_ManagedElementPrivilegedElement
CIM_AuthorizedTargetCIM_ManagedElementTargetElement
CIM_ElementConformsToProfileCIM_ManagedElementManagedElement
CIM_ElementLocationCIM_ManagedElementElement
CIM_ElementProfileCIM_ManagedElementManagedElement
CIM_ElementSecuritySensitivityCIM_ManagedElementManagedElement
CIM_ElementSettingDataCIM_ManagedElementManagedElement
CIM_ElementStatisticalDataCIM_ManagedElementManagedElement
CIM_OwningJobElementCIM_ManagedElementOwningElement
CIM_AffectedJobElementCIM_ManagedElementAffectedElement
CIM_ServiceAffectsElementCIM_ManagedElementAffectedElement
CIM_ServiceAvailableToElementCIM_ManagedElementUserOfService
CIM_SAPAvailableForElementCIM_ManagedElementManagedElement
CIM_ManagementSAPCIM_ManagedElementManagedElement