Description 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. | Qualifiers:Version ( "2.10.0" ) | Parameters (local in grey) | | ModelCorrespondence { "CIM_Printer.AvailableJobSheets" } string RequiredJobSheets [ ] ; Describes the job sheets that should be used when this Job is output on the Printer. | ModelCorrespondence { "CIM_Printer.PaperTypesAvailable" , "CIM_PrintService.PaperTypesAvailable" } string RequiredPaperType ; A 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'. | Units ( "Pixels per Inch" ) ModelCorrespondence { "CIM_Printer.VerticalResolution" } uint32 VerticalResolution ; The vertical resolution in Pixels per Inch for the Job. | ModelCorrespondence { "CIM_Printer.MaxNumberUp" } uint32 NumberUp ; The number of print-stream pages that should be rendered onto a single media sheet when the Printer outputs this PrintJob. | MaxLen ( 256 ) Propagated ( "CIM_PrintQueue.SystemName" ) Key string SystemName ; The Name of the scoping System. | ModelCorrespondence { "CIM_PrintJob.PrintJobStatus" } Override ( "JobStatus" ) string JobStatus ; The inherited JobStatus is used to provide additional information about the status of a PrintJob beyond that enumerated by PrintJobStatus. | MaxLen ( 256 ) Propagated ( "CIM_PrintQueue.CreationClassName" ) Key string QueueCreationClassName ; The CreationClassName of the scoping Queue. | MaxLen ( 256 ) Propagated ( "CIM_PrintQueue.Name" ) Key string QueueName ; The Name of the scoping Queue. | Units ( "Pixels per Inch" ) ModelCorrespondence { "CIM_Printer.HorizontalResolution" } uint32 HorizontalResolution ; The horizontal resolution in Pixels per Inch for the Job. | ModelCorrespondence { "CIM_PrintJob.Language" , "CIM_Printer.MimeTypesSupported" , "CIM_PrintService.MimeTypesSupported" } string MimeTypes [ ] ; Specifies the MIME types that are used by the PrintJob if Language is set to indicate that a MIME type is in use (value=47). | ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , "6" , "7" , "8" , "9" , "10" , "11" , "12" , "13" , "14" , "15" , "16" , "17" , "18" , "19" , "20" , "21" } ArrayType ( "Indexed" ) Values { "Unknown" , "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" } ModelCorrespondence { "CIM_Printer.Capabilities" , "CIM_PrintService.Capabilities" } uint16 Finishing [ ] ; An 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. | ModelCorrespondence { "CIM_Printer.NaturalLanguagesSupported" } string NaturalLanguage ; Identifies 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. | string JobOrigination ; Provides 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. | ValueMap { "1" , "2" , "3" , "4" , "5" , "6" , "7" , "8" , "9" , "10" , "11" , "12" , "13" , "14" , "15" , "16" , "17" , "18" , "19" , "20" , "21" , "22" , "23" , "24" , "25" , "26" , "27" , "28" , "29" , "30" , "31" , "32" , "33" , "34" , "35" , "36" , "37" , "38" , "39" , "40" , "41" , "42" , "43" , "44" , "45" , "46" , "47" , "48" , "50" , "51" , "52" , "53" , "54" , "55" , "56" , "57" , "58" , "59" , "60" } Values { "Other" , "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" } MappingStrings { "MIB.IETF|Printer-MIB.prtInterpreterLangFamily" } ModelCorrespondence { "CIM_Printer.LanguagesSupported" , "CIM_PrintService.LanguagesSupported" , "CIM_PrintJob.MimeTypes" } uint16 Language ; Specifies the print language that is used by this Job. | ModelCorrespondence { "CIM_PrintJob.PrintJobStatus" } datetime TimeCompleted ; The 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). | ValueMap { "1" , "2" , "3" , "4" , "5" , "6" , "7" } Values { "Other" , "Unknown" , "Pending" , "Blocked" , "Complete" , "Completed With Error" , "Printing" } ModelCorrespondence { "CIM_PrintJob.TimeCompleted" , "CIM_PrintJob.JobStatus" } uint16 PrintJobStatus ; Describes the current state of this Job with respect to the PrintQueue and the Printer. Additional information can be specified in JobStatus. | ModelCorrespondence { "CIM_Printer.CharSetsSupported" } string CharSet ; Specifies 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'. | Key string JobID ; Uniquely identifies this Job within its scoping Queue. | ModelCorrespondence { "CIM_Printer.MaxCopies" } uint32 Copies ; The number of physical copies of the output that will be produced from this Job. | Units ( "KiloBytes" ) ModelCorrespondence { "CIM_Printer.MaxSizeSupported" , "CIM_PrintQueue.MaxJobSize" } uint32 JobSize ; Specifies the size of the PrintJob (as a byte stream) in units of Kbytes. | MaxLen ( 256 ) Propagated ( "CIM_PrintQueue.SystemCreationClassName" ) Key string SystemCreationClassName ; The CreationClassName of the scoping System. | Deprecated { "No Value" } string SchedulingInformation ; Note: The use of this free-form string property is deprecated in lieu of the more semantically rich SettingData class, JobScheduleSettingData. | Write ModelCorrespondence { "CIM_Job.LocalOrUtcTime" } datetime UntilTime ; 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. | MaxValue ( 31 ) MinValue ( 31 ) Write ModelCorrespondence { "CIM_Job.RunMonth" , "CIM_Job.RunDayOfWeek" , "CIM_Job.RunStartInterval" } sint8 RunDay ; 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. | Write boolean DeleteOnCompletion ; 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. | Write ModelCorrespondence { "CIM_Job.RunMonth" , "CIM_Job.RunDay" , "CIM_Job.RunDayOfWeek" , "CIM_Job.RunStartInterval" } datetime 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. | ModelCorrespondence { "CIM_Job.ErrorCode" } string ErrorDescription ; 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. | ModelCorrespondence { "CIM_Job.ErrorDescription" } uint16 ErrorCode ; 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. | datetime TimeSubmitted ; 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. | Write Deprecated { "CIM_Job.RunMonth" , "CIM_Job.RunDay" , "CIM_Job.RunDayOfWeek" , "CIM_Job.RunStartInterval" } datetime ScheduledStartTime ; 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. | Write uint32 JobRunTimes = 1 ; 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. | datetime ElapsedTime ; 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. | Write string Notify ; The User who is to be notified upon the Job completion or failure. | datetime StartTime ; 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. | ModelCorrespondence { "CIM_Job.RecoveryAction" } string OtherRecoveryAction ; A string describing the recovery action when the RecoveryAction property of the instance is 1 ('Other'). | ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , "6" , "7" , "8" , "9" , "10" , "11" } Values { "January" , "February" , "March" , "April" , "May" , "June" , "July" , "August" , "September" , "October" , "November" , "December" } Write ModelCorrespondence { "CIM_Job.RunDay" , "CIM_Job.RunDayOfWeek" , "CIM_Job.RunStartInterval" } uint8 RunMonth ; The month during which the Job should be processed. Specify 0 for January, 1 for February, and so on. | ValueMap { "-7" , "-6" , "-5" , "-4" , "-3" , "-2" , "-1" , "0" , "1" , "2" , "3" , "4" , "5" , "6" , "7" } Values { "-Saturday" , "-Friday" , "-Thursday" , "-Wednesday" , "-Tuesday" , "-Monday" , "-Sunday" , "ExactDayOfMonth" , "Sunday" , "Monday" , "Tuesday" , "Wednesday" , "Thursday" , "Friday" , "Saturday" } Write ModelCorrespondence { "CIM_Job.RunMonth" , "CIM_Job.RunDay" , "CIM_Job.RunStartInterval" } sint8 RunDayOfWeek ; 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. | ValueMap { "0" , "1" , "2" , "3" , "4" , "5" } Values { "Unknown" , "Other" , "Do Not Continue" , "Continue With Next Job" , "Re-run Job" , "Run Recovery Job" } ModelCorrespondence { "CIM_Job.OtherRecoveryAction" } uint16 RecoveryAction ; Describes 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. | ModelCorrespondence { "CIM_OwningJobElement" } string Owner ; The User that submitted the Job, or the Service or method name that caused the job to be created. | ValueMap { "1" , "2" } Values { "Local Time" , "UTC Time" } Write uint16 LocalOrUtcTime ; 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'. | MaxValue ( 101 ) MinValue ( 0 ) Units ( "Percent" ) uint16 PercentComplete ; 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. | Write uint32 Priority ; 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. | ValueMap { "0" , "1" , "2" , "3" , "4" , "6" , "7" , ".." , "32768..65535" } Values { "Success" , "Not Supported" , "Unknown" , "Timeout" , "Failed" , "Access Denied" , "Not Found" , "DMTF Reserved" , "Vendor Specific" } Deprecated { "CIM_ConcreteJob.RequestStateChange()" } uint32KillJob( | | Indicates whether or not the Job should be automatically deleted upon termination. This parameter takes precedence over the property, DeleteOnCompletion. Qualifiers:IN
| | boolean DeleteOnKill |
)
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. | ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , "6" , "7" , "8" , "9" , "10" , "11" , "12" , "13" , "14" , "15" , "16" , "17" , "18" , ".." , "0x8000.." } ArrayType ( "Indexed" ) Values { "Unknown" , "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" } ModelCorrespondence { "CIM_ManagedSystemElement.StatusDescriptions" } uint16 OperationalStatus [ ] ; Indicates 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. | ArrayType ( "Indexed" ) ModelCorrespondence { "CIM_ManagedSystemElement.OperationalStatus" } string StatusDescriptions [ ] ; 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. | ValueMap { "OK" , "Error" , "Degraded" , "Unknown" , "Pred Fail" , "Starting" , "Stopping" , "Service" , "Stressed" , "NonRecover" , "No Contact" , "Lost Comm" , "Stopped" } MaxLen ( 10 ) Deprecated { "CIM_ManagedSystemElement.OperationalStatus" } string Status ; 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: 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. | MappingStrings { "MIF.DMTF|ComponentID|001.5" } datetime InstallDate ; A datetime value that indicates when the object was installed. Lack of a value does not indicate that the object is not installed. | MaxLen ( 1024 ) string Name ; 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. | ValueMap { "0" , "5" , "10" , "15" , "20" , "25" , "30" , ".." } Values { "Unknown" , "OK" , "Degraded/Warning" , "Minor failure" , "Major failure" , "Critical failure" , "Non-recoverable error" , "DMTF Reserved" } uint16 HealthState ; 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. 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. | string ElementName ; 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 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. | MaxLen ( 64 ) string Caption ; The Caption property is a short textual description (one- line string) of the object. | string Description ; The Description property provides a textual description of the object. |
| | | | |
|