Class Hierarchy
Class Attributes
Class Qualifiers
Properties
Methods
Associations in which the class can participate
Sub Profiling Summary
CIM_PrintJob --> CIM_Job --> CIM_LogicalElement --> CIM_ManagedSystemElement --> CIM_ManagedElement --> [top]
Class Declaration Attributes Name Value SUPERCLASS CIM_Job NAME CIM_PrintJob
Class CIM_PrintJob Qualifiers Name Type Value From Class Version string 2.10.0 CIM_PrintJob Description string 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. CIM_PrintJob Description string A 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 Description string CIM_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 Description string CIM_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 Description string ManagedElement 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
Property Qualifiers
Property SystemCreationClassName Qualifiers Name Type Value From Class Key boolean true CIM_PrintJob Propagated string CIM_PrintQueue.SystemCreationClassName CIM_PrintJob Description string The CreationClassName of the scoping System. CIM_PrintJob MaxLen uint32 256 CIM_PrintJob
Property SystemName Qualifiers Name Type Value From Class Key boolean true CIM_PrintJob Propagated string CIM_PrintQueue.SystemName CIM_PrintJob Description string The Name of the scoping System. CIM_PrintJob MaxLen uint32 256 CIM_PrintJob
Property QueueCreationClassName Qualifiers Name Type Value From Class Key boolean true CIM_PrintJob Propagated string CIM_PrintQueue.CreationClassName CIM_PrintJob Description string The CreationClassName of the scoping Queue. CIM_PrintJob MaxLen uint32 256 CIM_PrintJob
Property QueueName Qualifiers Name Type Value From Class Key boolean true CIM_PrintJob Propagated string CIM_PrintQueue.Name CIM_PrintJob Description string The Name of the scoping Queue. CIM_PrintJob MaxLen uint32 256 CIM_PrintJob
Property JobStatus Qualifiers Name Type Value From Class Override string JobStatus CIM_PrintJob Description string The inherited JobStatus is used to provide additional information about the status of a PrintJob beyond that enumerated by PrintJobStatus. CIM_PrintJob ModelCorrespondence string CIM_PrintJob.PrintJobStatus CIM_PrintJob
Property JobID Qualifiers Name Type Value From Class Key boolean true CIM_PrintJob Description string Uniquely identifies this Job within its scoping Queue. CIM_PrintJob
Property SchedulingInformation Qualifiers Name Type Value From Class Description string Note: 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 Name Type Value From Class Description string Specifies the size of the PrintJob (as a byte stream) in units of Kbytes. CIM_PrintJob Units string KiloBytes CIM_PrintJob ModelCorrespondence string CIM_Printer.MaxSizeSupported
CIM_PrintQueue.MaxJobSizeCIM_PrintJob
Property Language Qualifiers Name Type Value From Class Description string Specifies the print language that is used by this Job. CIM_PrintJob ValueMap string [See below.] CIM_PrintJob Values string 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
RPDL
IntermecIPL
UBIFingerprint
UBIDirectProtocol
Fujitsu
PCLXLCIM_PrintJob MappingStrings string MIB.IETF|Printer-MIB.prtInterpreterLangFamily CIM_PrintJob ModelCorrespondence string CIM_Printer.LanguagesSupported
CIM_PrintService.LanguagesSupported
CIM_PrintJob.MimeTypesCIM_PrintJob
Name Value 1 Other 2 Unknown 3 PCL 4 HPGL 5 PJL 6 PS 7 PSPrinter 8 IPDS 9 PPDS 10 EscapeP 11 Epson 12 DDIF 13 Interpress 14 ISO6429 15 Line Data 16 MODCA 17 REGIS 18 SCS 19 SPDL 20 TEK4014 21 PDS 22 IGP 23 CodeV 24 DSCDSE 25 WPS 26 LN03 27 CCITT 28 QUIC 29 CPAP 30 DecPPL 31 Simple Text 32 NPAP 33 DOC 34 imPress 35 Pinwriter 36 NPDL 37 NEC201PL 38 Automatic 39 Pages 40 LIPS 41 TIFF 42 Diagnostic 43 CaPSL 44 EXCL 45 LCDS 46 XES 47 MIME 48 TIPSI 50 Prescribe 51 LinePrinter 52 IDP 53 XJCL 54 55 RPDL 56 IntermecIPL 57 UBIFingerprint 58 UBIDirectProtocol 59 Fujitsu 60 PCLXL
Property MimeTypes Qualifiers Name Type Value From Class Description string 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). CIM_PrintJob ModelCorrespondence string CIM_PrintJob.Language
CIM_Printer.MimeTypesSupported
CIM_PrintService.MimeTypesSupportedCIM_PrintJob
Property RequiredPaperType Qualifiers Name Type Value From Class Description string 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 " . CIM_PrintJob ModelCorrespondence string CIM_Printer.PaperTypesAvailable
CIM_PrintService.PaperTypesAvailableCIM_PrintJob
Property Finishing Qualifiers Name Type Value From Class Description string 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. CIM_PrintJob ValueMap string [See below.] CIM_PrintJob Values string 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 LowCIM_PrintJob ArrayType string Indexed CIM_PrintJob ModelCorrespondence string CIM_Printer.Capabilities
CIM_PrintService.CapabilitiesCIM_PrintJob
Name Value 0 Unknown 1 Other 2 Color Printing 3 Duplex Printing 4 Copies 5 Collation 6 Stapling 7 Transparency Printing 8 Punch 9 Cover 10 Bind 11 Black and White Printing 12 One Sided 13 Two Sided Long Edge 14 Two Sided Short Edge 15 Portrait 16 Landscape 17 Reverse Portrait 18 Reverse Landscape 19 Quality High 20 Quality Normal 21 Quality Low
Property Copies Qualifiers Name Type Value From Class Description string The number of physical copies of the output that will be produced from this Job. CIM_PrintJob ModelCorrespondence string CIM_Printer.MaxCopies CIM_PrintJob
Property HorizontalResolution Qualifiers Name Type Value From Class Description string The horizontal resolution in Pixels per Inch for the Job. CIM_PrintJob Units string Pixels per Inch CIM_PrintJob ModelCorrespondence string CIM_Printer.HorizontalResolution CIM_PrintJob
Property VerticalResolution Qualifiers Name Type Value From Class Description string The vertical resolution in Pixels per Inch for the Job. CIM_PrintJob Units string Pixels per Inch CIM_PrintJob ModelCorrespondence string CIM_Printer.VerticalResolution CIM_PrintJob
Property CharSet Qualifiers Name Type Value From Class Description string 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 " . CIM_PrintJob ModelCorrespondence string CIM_Printer.CharSetsSupported CIM_PrintJob
Property NaturalLanguage Qualifiers Name Type Value From Class Description string 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. CIM_PrintJob ModelCorrespondence string CIM_Printer.NaturalLanguagesSupported CIM_PrintJob
Property NumberUp Qualifiers Name Type Value From Class Description string The number of print-stream pages that should be rendered onto a single media sheet when the Printer outputs this PrintJob. CIM_PrintJob ModelCorrespondence string CIM_Printer.MaxNumberUp CIM_PrintJob
Property PrintJobStatus Qualifiers Name Type Value From Class Description string Describes the current state of this Job with respect to the PrintQueue and the Printer. Additional information can be specified in JobStatus. CIM_PrintJob ValueMap string [See below.] CIM_PrintJob Values string Other
Unknown
Pending
Blocked
Complete
Completed With Error
PrintingCIM_PrintJob ModelCorrespondence string CIM_PrintJob.TimeCompleted
CIM_PrintJob.JobStatusCIM_PrintJob
Name Value 1 Other 2 Unknown 3 Pending 4 Blocked 5 Complete 6 Completed With Error 7 Printing
Property TimeCompleted Qualifiers Name Type Value From Class Description string 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). CIM_PrintJob ModelCorrespondence string CIM_PrintJob.PrintJobStatus CIM_PrintJob
Property RequiredJobSheets Qualifiers Name Type Value From Class Description string Describes the job sheets that should be used when this Job is output on the Printer. CIM_PrintJob ModelCorrespondence string CIM_Printer.AvailableJobSheets CIM_PrintJob
Property JobOrigination Qualifiers Name Type Value From Class Description string 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. CIM_PrintJob
Property JobStatus Qualifiers Name Type Value From Class Description string A 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 ModelCorrespondence string CIM_ManagedSystemElement.OperationalStatus CIM_Job
Property TimeSubmitted Qualifiers Name Type Value From Class Description string 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. CIM_Job
Property ScheduledStartTime Qualifiers Name Type Value From Class Write boolean true CIM_Job Description string 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. CIM_Job
Property StartTime Qualifiers Name Type Value From Class Description string 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. CIM_Job
Property ElapsedTime Qualifiers Name Type Value From Class Description string 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. CIM_Job
Property JobRunTimes Qualifiers Name Type Value From Class Write boolean true CIM_Job Description string 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. CIM_Job
Property RunMonth Qualifiers Name Type Value From Class Write boolean true CIM_Job Description string The month during which the Job should be processed. Specify 0 for January, 1 for February, and so on. CIM_Job ValueMap string [See below.] CIM_Job Values string January
February
March
April
May
June
July
August
September
October
November
DecemberCIM_Job ModelCorrespondence string CIM_Job.RunDay
CIM_Job.RunDayOfWeek
CIM_Job.RunStartIntervalCIM_Job
Name Value 0 January 1 February 2 March 3 April 4 May 5 June 6 July 7 August 8 September 9 October 10 November 11 December
Property RunDay Qualifiers Name Type Value From Class Write boolean true CIM_Job Description string 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. CIM_Job MinValue sint64 -31 CIM_Job MaxValue sint64 31 CIM_Job ModelCorrespondence string CIM_Job.RunMonth
CIM_Job.RunDayOfWeek
CIM_Job.RunStartIntervalCIM_Job
Property RunDayOfWeek Qualifiers Name Type Value From Class Write boolean true CIM_Job Description string 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. CIM_Job ValueMap string [See below.] CIM_Job Values string -Saturday
-Friday
-Thursday
-Wednesday
-Tuesday
-Monday
-Sunday
ExactDayOfMonth
Sunday
Monday
Tuesday
Wednesday
Thursday
Friday
SaturdayCIM_Job ModelCorrespondence string CIM_Job.RunMonth
CIM_Job.RunDay
CIM_Job.RunStartIntervalCIM_Job
Name Value -7 -Saturday -6 -Friday -5 -Thursday -4 -Wednesday -3 -Tuesday -2 -Monday -1 -Sunday 0 ExactDayOfMonth 1 Sunday 2 Monday 3 Tuesday 4 Wednesday 5 Thursday 6 Friday 7 Saturday
Property RunStartInterval Qualifiers Name Type Value From Class Write boolean true CIM_Job Description string 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. CIM_Job ModelCorrespondence string CIM_Job.RunMonth
CIM_Job.RunDay
CIM_Job.RunDayOfWeek
CIM_Job.RunStartIntervalCIM_Job
Property LocalOrUtcTime Qualifiers Name Type Value From Class Write boolean true CIM_Job Description string 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 " . CIM_Job ValueMap string [See below.] CIM_Job Values string Local Time
UTC TimeCIM_Job
Name Value 1 Local Time 2 UTC Time
Property UntilTime Qualifiers Name Type Value From Class Write boolean true CIM_Job Description string 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. CIM_Job ModelCorrespondence string CIM_Job.LocalOrUtcTime CIM_Job
Property Notify Qualifiers Name Type Value From Class Write boolean true CIM_Job Description string The User who is to be notified upon the Job completion or failure. CIM_Job
Property Owner Qualifiers Name Type Value From Class Description string The User that submitted the Job, or the Service or method name that caused the job to be created. CIM_Job ModelCorrespondence string CIM_OwningJobElement CIM_Job
Property Priority Qualifiers Name Type Value From Class Write boolean true CIM_Job Description string 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. CIM_Job
Property PercentComplete Qualifiers Name Type Value From Class Description string 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. CIM_Job Units string Percent CIM_Job MinValue sint64 0 CIM_Job MaxValue sint64 101 CIM_Job
Property DeleteOnCompletion Qualifiers Name Type Value From Class Write boolean true CIM_Job Description string 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. CIM_Job
Property ErrorCode Qualifiers Name Type Value From Class Description string 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. CIM_Job ModelCorrespondence string CIM_Job.ErrorDescription CIM_Job
Property ErrorDescription Qualifiers Name Type Value From Class Description string 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. CIM_Job ModelCorrespondence string CIM_Job.ErrorCode CIM_Job
Property RecoveryAction Qualifiers Name Type Value From Class Description string 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. CIM_Job ValueMap string [See below.] CIM_Job Values string Unknown
Other
Do Not Continue
Continue With Next Job
Re-run Job
Run Recovery JobCIM_Job ModelCorrespondence string CIM_Job.OtherRecoveryAction CIM_Job
Name Value 0 Unknown 1 Other 2 Do Not Continue 3 Continue With Next Job 4 Re-run Job 5 Run Recovery Job
Property OtherRecoveryAction Qualifiers Name Type Value From Class Description string A string describing the recovery action when the RecoveryAction property of the instance is 1 ( " Other " ). CIM_Job ModelCorrespondence string CIM_Job.RecoveryAction CIM_Job
Property InstallDate Qualifiers Name Type Value From Class Description string A datetime value that indicates when the object was installed. Lack of a value does not indicate that the object is not installed. CIM_ManagedSystemElement MappingStrings string MIF.DMTF|ComponentID|001.5 CIM_ManagedSystemElement
Property Name Qualifiers Name Type Value From Class Description string 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. CIM_ManagedSystemElement MaxLen uint32 1024 CIM_ManagedSystemElement
Property OperationalStatus Qualifiers Name Type Value From Class Description string 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. CIM_ManagedSystemElement ValueMap string [See below.] CIM_ManagedSystemElement Values string 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 ReservedCIM_ManagedSystemElement ArrayType string Indexed CIM_ManagedSystemElement ModelCorrespondence string CIM_ManagedSystemElement.StatusDescriptions CIM_ManagedSystemElement
Name Value 0 Unknown 1 Other 2 OK 3 Degraded 4 Stressed 5 Predictive Failure 6 Error 7 Non-Recoverable Error 8 Starting 9 Stopping 10 Stopped 11 In Service 12 No Contact 13 Lost Communication 14 Aborted 15 Dormant 16 Supporting Entity in Error 17 Completed 18 Power Mode .. DMTF Reserved 0x8000.. Vendor Reserved
Property StatusDescriptions Qualifiers Name Type Value From Class Description string 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. CIM_ManagedSystemElement ArrayType string Indexed CIM_ManagedSystemElement ModelCorrespondence string CIM_ManagedSystemElement.OperationalStatus CIM_ManagedSystemElement
Property Status Qualifiers Name Type Value From Class Description string 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. CIM_ManagedSystemElement ValueMap string [See below.] CIM_ManagedSystemElement MaxLen uint32 10 CIM_ManagedSystemElement
Name Value 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 Name Type Value From Class Description string 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. CIM_ManagedSystemElement ValueMap string [See below.] CIM_ManagedSystemElement Values string Unknown
OK
Degraded/Warning
Minor failure
Major failure
Critical failure
Non-recoverable error
DMTF ReservedCIM_ManagedSystemElement
Name Value 0 Unknown 5 OK 10 Degraded/Warning 15 Minor failure 20 Major failure 25 Critical failure 30 Non-recoverable error .. DMTF Reserved
Property Caption Qualifiers Name Type Value From Class Description string The Caption property is a short textual description (one- line string) of the object. CIM_ManagedElement MaxLen uint32 64 CIM_ManagedElement
Property Description Qualifiers Name Type Value From Class Description string The Description property provides a textual description of the object. CIM_ManagedElement
Property ElementName Qualifiers Name Type Value From Class Description string 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. CIM_ManagedElement
Name Type Value Qualifiers Parameters ClassOrigin KillJob uint32 Deprecated
Description
ValueMap
ValuesDeleteOnKill CIM_Job Method Qualifiers
Method KillJob Qualifiers Name Type Value From Class Description string 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. CIM_Job ValueMap string [See below.] CIM_Job Values string Success
Not Supported
Unknown
Timeout
Failed
Access Denied
Not Found
DMTF Reserved
Vendor SpecificCIM_Job Parameters
Method KillJob Parameters Name Type Qualifiers DeleteOnKill boolean IN
DescriptionParameter Qualifiers
Parameter DeleteOnKill Qualifiers Name Type Value From Class IN boolean true CIM_Job Description string Indicates whether or not the Job should be automatically deleted upon termination. This parameter takes precedence over the property, DeleteOnCompletion. CIM_Job