Class Hierarchy
Class Attributes
Class Qualifiers
Properties
Methods
Associations in which the class can participate
Sub Profiling Summary
CIM_PrintQueue --> CIM_JobDestination --> CIM_EnabledLogicalElement --> CIM_LogicalElement --> CIM_ManagedSystemElement --> CIM_ManagedElement --> [top]
Class Declaration Attributes Name Value SUPERCLASS CIM_JobDestination NAME CIM_PrintQueue
Class CIM_PrintQueue Qualifiers Name Type Value From Class Version string 2.14.0 CIM_PrintQueue UMLPackagePath string CIM::Device::Printing CIM_PrintQueue Description string Capabilities and management of a Printer Queue. A PrintQueue holds PrintJobs that are placed on the Queue by a Print Service. Jobs can move from Queue to Queue. The ABNF for CIM references to PWG Standards and MIBs is in the directory 'ftp://ftp.pwg.org/pub/pwg/general/process' in the file 'pwg-cim-references-format-20060309.txt'. An example for a MappingStrings reference to a PWG Standard is 'PWG5101-1.PWG|Section 4 Media Color Names'. An example for a MappingStrings reference to a PWG MIB is 'MIB.PWG|PWG-IMAGING-COUNTER-MIB.icMonitorCompletedJobs'. CIM_PrintQueue UMLPackagePath string CIM::System::Processing CIM_JobDestination Description string JobDestination is an EnabledLogicalElement representing where a Job is submitted for processing. It can refer to a queue that contains zero or more Jobs, such as a print queue containing print Jobs. JobDestinations are hosted on Systems, similar to the way that Services are hosted on Systems. Also, they may be enabled/disabled similar to Services. CIM_JobDestination UMLPackagePath string CIM::Core::CoreElements CIM_EnabledLogicalElement Description string This class extends LogicalElement to abstract the concept of an element that is enabled and disabled, such as a LogicalDevice or a ServiceAccessPoint. CIM_EnabledLogicalElement UMLPackagePath string CIM::Core::CoreElements CIM_LogicalElement 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 UMLPackagePath string CIM::Core::CoreElements CIM_ManagedSystemElement 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 UMLPackagePath string CIM::Core::CoreElements CIM_ManagedElement 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 QueueEnabled Qualifiers Name Type Value From Class Description string Note: Both this property and QueueAccepting are deprecated in lieu of EnabledState. Deprecated description: Indicates that Jobs on the Queue will be passed to a Printer. When false, a Job will remain on the Queue and will not be passed to a Printer for output. This property, coupled with the information in QueueAccepting, aligns with various values of the inherited EnabledState property: - When both QueueEnabled and QueueAccepting are true, then EnabledState is set to 2 ("Enabled") - When both QueueEnabled and QueueAccepting are false, then EnabledState is set to 3 ("Disabled") - When QueueEnabled is true and QueueAccepting is false (for instance, when the Queue outputs jobs to the printer, but does not accept new jobs), then EnabledState is set to 6 ("Enabled but Offline") - When QueueEnabled is false and QueueAccepting is true (for instance, when the Queue accepts print jobs but does not send them to a printer), then EnabledState is set to 8 ("Deferred"). CIM_PrintQueue
Property QueueAccepting Qualifiers Name Type Value From Class Description string Note: Both this property and QueueEnabled are deprecated in lieu of EnabledState. Deprecated description: When false, no PrintService can place PrintJobs on the PrintQueue. The ability of an individual PrintService to place a Job on the Queue can be specified using the QueueAcceptingFromService property in the QueueForPrint Service association. This property, coupled with the information in QueueEnabled, aligns with various values of the inherited EnabledState property: - When both QueueEnabled and QueueAccepting are true, then EnabledState is set to 2 ("Enabled") - When both QueueEnabled and QueueAccepting are false, then EnabledState is set to 3 ("Disabled") - When QueueEnabled is true and QueueAccepting is false (for instance, when the Queue outputs jobs to the printer, but does not accept new jobs), then EnabledState is set to 6 ("Enabled but Offline") - When QueueEnabled is false and QueueAccepting is true (for instance, when the Queue accepts print jobs but does not send them to a printer), then EnabledState is set to 8 ("Deferred"). CIM_PrintQueue
Property NumberOnQueue Qualifiers Name Type Value From Class Description string The current number of Jobs on the Queue. CIM_PrintQueue Gauge boolean true CIM_PrintQueue MappingStrings string MIB.IETF|Job-Monitoring-MIB.jmGeneralNumberOfActiveJobs
RFC2911.IETF|Printer.queued-job-countCIM_PrintQueue
Property QueueStatus Qualifiers Name Type Value From Class Description string Gives Queue-specific status information, beyond the ManagedSystemElement.Status property. This method can be used to provide further qualification as to the status of the Queue or to indicate a secondary condition (for example, spool area is full). CIM_PrintQueue ValueMap string [See below.] CIM_PrintQueue Values string Other
Unknown
No Additional Status
QueueSpoolAreaFullCIM_PrintQueue MappingStrings string RFC2911.IETF|Printer.printer-state-reasons CIM_PrintQueue
Name Value 0 Other 1 Unknown 2 No Additional Status 3 QueueSpoolAreaFull
Property QueueStatusInfo Qualifiers Name Type Value From Class Description string Provides a textual explanation for the status of the Queue. The settings of both QueueStatus and the Status property that are inherited from ManagedSystemElement can be described by QueueStatusInfo. For example, if "Stopping" is the value that is assigned to Status, then this property might contain an explanation as to why the Queue is being stopped. CIM_PrintQueue MappingStrings string RFC2911.IETF|Printer.printer-state-message CIM_PrintQueue
Property MaxJobSize Qualifiers Name Type Value From Class Description string Specifies the largest possible Job (in terms of a single byte stream) that can be submitted to this Queue. A value of 0 indicates that no limit has been set. Units are Kbytes. CIM_PrintQueue Units string KiloBytes CIM_PrintQueue MappingStrings string RFC2911.IETF|Section 4.4.33 job-k-octets-supported CIM_PrintQueue ModelCorrespondence string CIM_PrintJob.JobSize CIM_PrintQueue PUnit string byte * 10^3 CIM_PrintQueue
Property DefaultJobPriority Qualifiers Name Type Value From Class Description string Specifies the priority that will be assigned to a new Job that is submitted to this Queue, if the Job does not explicitly specify a priority. The range of valid priorities and the interpretation of priorities can be determined from the JobPriorityHigh and JobPriorityLow properties. CIM_PrintQueue MappingStrings string RFC2911.IETF|Printer.job-priority-default CIM_PrintQueue ModelCorrespondence string CIM_PrintQueue.JobPriorityHigh
CIM_PrintQueue.JobPriorityLowCIM_PrintQueue
Property JobPriorityHigh Qualifiers Name Type Value From Class Description string Specifies the numeric value that is used to represent the highest priority Jobs that are submitted to this Queue. The range of numeric values for priority can be inverted, for example, a high priority job is represented by a low integer value. This value is indicated by JobPriorityLow being greater than JobPriorityHigh. If both values (PriorityLow and PriorityHigh) are assigned to 0, then the Queue does not support Job priorities. The values and usage of the property SHOULD conform to the semantics of the 'job-priority-supported' attribute of the Printer object defined in IPP/1.1 [RFC2911]. CIM_PrintQueue MappingStrings string RFC2911.IETF|Printer.job-priority-supported CIM_PrintQueue ModelCorrespondence string CIM_PrintQueue.JobPriorityLow
CIM_Job.PriorityCIM_PrintQueue
Property JobPriorityLow Qualifiers Name Type Value From Class Description string Specifies the numeric value that is used to represent the lowest priority Jobs that are submitted to this Queue. The range of numeric values for priority can be inverted, for example, a low priority job is represented by a high integer value. This value is indicated by JobPriorityLow being greater than JobPriorityHigh. If both values (PriorityLow and PriorityHigh) are assigned to 0, then the Queue does not support Job priorities. The values and usage of the property SHOULD conform to the semantics of the 'job-priority-supported' attribute of the Printer object defined in IPP/1.1 [RFC2911]. CIM_PrintQueue MappingStrings string RFC2911.IETF|Printer.job-priority-supported CIM_PrintQueue ModelCorrespondence string CIM_PrintQueue.JobPriorityHigh
CIM_Job.PriorityCIM_PrintQueue
Property AvailableJobSheets Qualifiers Name Type Value From Class Description string Specifies the job sheets that are supported by this Queue. Typically the job sheets that are provided by a Queue will be the union or aggregation of those provided by all the Printers that it supports. However, a system administrator can choose to restrict access to some job sheets on a particular Queue. A Queue can also support additional job sheets through the use of a filter that adds a banner or some other page when a Job is taken from the Queue. CIM_PrintQueue MappingStrings string MIB.IETF|Printer-MIB.prtAuxiliarySheetStartupPage
MIB.IETF|Printer-MIB.prtAuxiliarySheetBannerPage
RFC2911.IETF|Printer.job-sheets-supportedCIM_PrintQueue ModelCorrespondence string CIM_PrintJob.RequiredJobSheets CIM_PrintQueue
Property SystemCreationClassName Qualifiers Name Type Value From Class Key boolean true CIM_JobDestination Description string The scoping System's CreationClassName. CIM_JobDestination MaxLen uint32 256 CIM_JobDestination Propagated string CIM_System.CreationClassName CIM_JobDestination
Property SystemName Qualifiers Name Type Value From Class Key boolean true CIM_JobDestination Description string The scoping System's Name. CIM_JobDestination MaxLen uint32 256 CIM_JobDestination Propagated string CIM_System.Name CIM_JobDestination
Property CreationClassName Qualifiers Name Type Value From Class Key boolean true CIM_JobDestination Description string CreationClassName indicates the name of the class or the subclass used in the creation of an instance. When used with the other key properties of this class, this property allows all instances of this class and its subclasses to be uniquely identified. CIM_JobDestination MaxLen uint32 256 CIM_JobDestination
Property Name Qualifiers Name Type Value From Class Key boolean true CIM_JobDestination Description string The inherited Name serves as key of a JobDestination instance in a System. CIM_JobDestination MaxLen uint32 256 CIM_JobDestination
Property EnabledState Qualifiers Name Type Value From Class Description string EnabledState is an integer enumeration that indicates the enabled and disabled states of an element. It can also indicate the transitions between these requested states. For example, shutting down (value=4) and starting (value=10) are transient states between enabled and disabled. The following text briefly summarizes the various enabled and disabled states: Enabled (2) indicates that the element is or could be executing commands, will process any queued commands, and queues new requests. Disabled (3) indicates that the element will not execute commands and will drop any new requests. Shutting Down (4) indicates that the element is in the process of going to a Disabled state. Not Applicable (5) indicates the element does not support being enabled or disabled. Enabled but Offline (6) indicates that the element might be completing commands, and will drop any new requests. Test (7) indicates that the element is in a test state. Deferred (8) indicates that the element might be completing commands, but will queue any new requests. Quiesce (9) indicates that the element is enabled but in a restricted mode.Starting (10) indicates that the element is in the process of going to an Enabled state. New requests are queued. CIM_EnabledLogicalElement ValueMap string [See below.] CIM_EnabledLogicalElement Values string Unknown
Other
Enabled
Disabled
Shutting Down
Not Applicable
Enabled but Offline
In Test
Deferred
Quiesce
Starting
DMTF Reserved
Vendor ReservedCIM_EnabledLogicalElement ModelCorrespondence string CIM_EnabledLogicalElement.OtherEnabledState CIM_EnabledLogicalElement
Name Value 0 Unknown 1 Other 2 Enabled 3 Disabled 4 Shutting Down 5 Not Applicable 6 Enabled but Offline 7 In Test 8 Deferred 9 Quiesce 10 Starting 11..32767 DMTF Reserved 32768..65535 Vendor Reserved
Property OtherEnabledState Qualifiers Name Type Value From Class Description string A string that describes the enabled or disabled state of the element when the EnabledState property is set to 1 ("Other"). This property must be set to null when EnabledState is any value other than 1. CIM_EnabledLogicalElement ModelCorrespondence string CIM_EnabledLogicalElement.EnabledState CIM_EnabledLogicalElement
Property RequestedState Qualifiers Name Type Value From Class Description string RequestedState is an integer enumeration that indicates the last requested or desired state for the element, irrespective of the mechanism through which it was requested. The actual state of the element is represented by EnabledState. This property is provided to compare the last requested and current enabled or disabled states. Note that when EnabledState is set to 5 ("Not Applicable"), then this property has no meaning. Refer to the EnabledState property description for explanations of the values in the RequestedState enumeration. "Unknown" (0) indicates the last requested state for the element is unknown.Note that the value "No Change" (5) has been deprecated in lieu of indicating the last requested state is "Unknown" (0). If the last requested or desired state is unknown, RequestedState should have the value "Unknown" (0), but may have the value "No Change" (5).Offline (6) indicates that the element has been requested to transition to the Enabled but Offline EnabledState. It should be noted that there are two new values in RequestedState that build on the statuses of EnabledState. These are "Reboot" (10) and "Reset" (11). Reboot refers to doing a "Shut Down" and then moving to an "Enabled" state. Reset indicates that the element is first "Disabled" and then "Enabled". The distinction between requesting "Shut Down" and "Disabled" should also be noted. Shut Down requests an orderly transition to the Disabled state, and might involve removing power, to completely erase any existing state. The Disabled state requests an immediate disabling of the element, such that it will not execute or accept any commands or processing requests. This property is set as the result of a method invocation (such as Start or StopService on CIM_Service), or can be overridden and defined as WRITEable in a subclass. The method approach is considered superior to a WRITEable property, because it allows an explicit invocation of the operation and the return of a result code. If knowledge of the last RequestedState is not supported for the EnabledLogicalElement, the property shall be NULL or have the value 12 "Not Applicable". CIM_EnabledLogicalElement ValueMap string [See below.] CIM_EnabledLogicalElement Values string Unknown
Enabled
Disabled
Shut Down
No Change
Offline
Test
Deferred
Quiesce
Reboot
Reset
Not Applicable
DMTF Reserved
Vendor ReservedCIM_EnabledLogicalElement ModelCorrespondence string CIM_EnabledLogicalElement.EnabledState CIM_EnabledLogicalElement
Name Value 0 Unknown 2 Enabled 3 Disabled 4 Shut Down 5 No Change 6 Offline 7 Test 8 Deferred 9 Quiesce 10 Reboot 11 Reset 12 Not Applicable .. DMTF Reserved 32768..65535 Vendor Reserved
Property EnabledDefault Qualifiers Name Type Value From Class Write boolean true CIM_EnabledLogicalElement Description string An enumerated value indicating an administrator's default or startup configuration for the Enabled State of an element. By default, the element is "Enabled" (value=2). CIM_EnabledLogicalElement ValueMap string [See below.] CIM_EnabledLogicalElement Values string Enabled
Disabled
Not Applicable
Enabled but Offline
No Default
Quiesce
DMTF Reserved
Vendor ReservedCIM_EnabledLogicalElement
Name Value 2 Enabled 3 Disabled 5 Not Applicable 6 Enabled but Offline 7 No Default 9 Quiesce .. DMTF Reserved 32768..65535 Vendor Reserved
Property TimeOfLastStateChange Qualifiers Name Type Value From Class Description string The date or time when the EnabledState of the element last changed. If the state of the element has not changed and this property is populated, then it must be set to a 0 interval value. If a state change was requested, but rejected or not yet processed, the property must not be updated. CIM_EnabledLogicalElement
Property AvailableRequestedStates Qualifiers Name Type Value From Class Description string AvailableRequestedStates indicates the possible values for the RequestedState parameter of the method RequestStateChange, used to initiate a state change. The values listed shall be a subset of the values contained in the RequestedStatesSupported property of the associated instance of CIM_EnabledLogicalElementCapabilities where the values selected are a function of the current state of the CIM_EnabledLogicalElement. This property may be non-null if an implementation is able to advertise the set of possible values as a function of the current state. This property shall be null if an implementation is unable to determine the set of possible values as a function of the current state. CIM_EnabledLogicalElement ValueMap string [See below.] CIM_EnabledLogicalElement Values string Enabled
Disabled
Shut Down
Offline
Test
Defer
Quiesce
Reboot
ResetCIM_EnabledLogicalElement ModelCorrespondence string CIM_EnabledLogicalElement.RequestStateChange
CIM_EnabledLogicalElementCapabilities.RequestedStatesSupportedCIM_EnabledLogicalElement
Name Value 2 Enabled 3 Disabled 4 Shut Down 6 Offline 7 Test 8 Defer 9 Quiesce 10 Reboot 11 Reset
Property TransitioningToState Qualifiers Name Type Value From Class Description string TransitioningToState indicates the target state to which the instance is transitioning. A value of 5 "No Change" shall indicate that no transition is in progress.A value of 12 "Not Applicable" shall indicate the implementation does not support representing ongoing transitions. A value other than 5 or 12 shall identify the state to which the element is in the process of transitioning. CIM_EnabledLogicalElement ValueMap string [See below.] CIM_EnabledLogicalElement Values string Unknown
Enabled
Disabled
Shut Down
No Change
Offline
Test
Defer
Quiesce
Reboot
Reset
Not ApplicableCIM_EnabledLogicalElement ModelCorrespondence string CIM_EnabledLogicalElement.RequestStateChange
CIM_EnabledLogicalElement.RequestedState
CIM_EnabledLogicalElement.EnabledStateCIM_EnabledLogicalElement
Name Value 0 Unknown 2 Enabled 3 Disabled 4 Shut Down 5 No Change 6 Offline 7 Test 8 Defer 9 Quiesce 10 Reboot 11 Reset 12 Not Applicable
Name Value 0 Unknown 2 Enabled 3 Disabled 4 Shut Down 5 No Change 6 Offline 7 Test 8 Defer 9 Quiesce 10 Reboot 11 Reset 12 Not Applicable
Name Value 0 Unknown 2 Enabled 3 Disabled 4 Shut Down 5 No Change 6 Offline 7 Test 8 Defer 9 Quiesce 10 Reboot 11 Reset 12 Not Applicable
Name Value 0 Unknown 2 Enabled 3 Disabled 4 Shut Down 5 No Change 6 Offline 7 Test 8 Defer 9 Quiesce 10 Reboot 11 Reset 12 Not Applicable
Name Value 0 Unknown 2 Enabled 3 Disabled 4 Shut Down 5 No Change 6 Offline 7 Test 8 Defer 9 Quiesce 10 Reboot 11 Reset 12 Not Applicable
Name Value 0 Unknown 2 Enabled 3 Disabled 4 Shut Down 5 No Change 6 Offline 7 Test 8 Defer 9 Quiesce 10 Reboot 11 Reset 12 Not Applicable
Name Value 0 Unknown 2 Enabled 3 Disabled 4 Shut Down 5 No Change 6 Offline 7 Test 8 Defer 9 Quiesce 10 Reboot 11 Reset 12 Not Applicable
Name Value 0 Unknown 2 Enabled 3 Disabled 4 Shut Down 5 No Change 6 Offline 7 Test 8 Defer 9 Quiesce 10 Reboot 11 Reset 12 Not Applicable
Name Value 0 Unknown 2 Enabled 3 Disabled 4 Shut Down 5 No Change 6 Offline 7 Test 8 Defer 9 Quiesce 10 Reboot 11 Reset 12 Not Applicable
Name Value 0 Unknown 2 Enabled 3 Disabled 4 Shut Down 5 No Change 6 Offline 7 Test 8 Defer 9 Quiesce 10 Reboot 11 Reset 12 Not Applicable
Name Value 0 Unknown 2 Enabled 3 Disabled 4 Shut Down 5 No Change 6 Offline 7 Test 8 Defer 9 Quiesce 10 Reboot 11 Reset 12 Not Applicable
Name Value 0 Unknown 2 Enabled 3 Disabled 4 Shut Down 5 No Change 6 Offline 7 Test 8 Defer 9 Quiesce 10 Reboot 11 Reset 12 Not Applicable
Name Value 0 Unknown 2 Enabled 3 Disabled 4 Shut Down 5 No Change 6 Offline 7 Test 8 Defer 9 Quiesce 10 Reboot 11 Reset 12 Not Applicable
Name Value 0 Unknown 2 Enabled 3 Disabled 4 Shut Down 5 No Change 6 Offline 7 Test 8 Defer 9 Quiesce 10 Reboot 11 Reset 12 Not Applicable
Name Value 0 Unknown 2 Enabled 3 Disabled 4 Shut Down 5 No Change 6 Offline 7 Test 8 Defer 9 Quiesce 10 Reboot 11 Reset 12 Not Applicable
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 PrimaryStatus Qualifiers Name Type Value From Class Description string PrimaryStatus provides a high level status value, intended to align with Red-Yellow-Green type representation of status. It should be used in conjunction with DetailedStatus to provide high level and detailed health status of the ManagedElement and its subcomponents. PrimaryStatus consists of one of the following values: Unknown, OK, Degraded or Error. "Unknown" indicates the implementation is in general capable of returning this property, but is unable to do so at this time. "OK" indicates the ManagedElement is functioning normally. "Degraded" indicates the ManagedElement is functioning below normal. "Error" indicates the ManagedElement is in an Error condition. CIM_ManagedSystemElement ValueMap string [See below.] CIM_ManagedSystemElement Values string Unknown
OK
Degraded
Error
DMTF Reserved
Vendor ReservedCIM_ManagedSystemElement ModelCorrespondence string CIM_ManagedSystemElement.DetailedStatus
CIM_ManagedSystemElement.HealthStateCIM_ManagedSystemElement
Name Value 0 Unknown 1 OK 2 Degraded 3 Error .. DMTF Reserved 0x8000.. Vendor Reserved
Property DetailedStatus Qualifiers Name Type Value From Class Description string DetailedStatus compliments PrimaryStatus with additional status detail. It consists of one of the following values: Not Available, No Additional Information, Stressed, Predictive Failure, Error, Non-Recoverable Error, SupportingEntityInError. Detailed status is used to expand upon the PrimaryStatus of the element. A Null return indicates the implementation (provider) does not implement this property. "Not Available" indicates that the implementation (provider) is capable of returning a value for this property, but not ever for this particular piece of hardware/software or the property is intentionally not used because it adds no meaningful information (as in the case of a property that is intended to add additional info to another property). "No Additional Information" indicates that the element is functioning normally as indicated by PrimaryStatus = "OK". "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 normally but a failure is predicted in the near future. "Non-Recoverable Error " indicates that this element is in an error condition that requires human intervention. "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. CIM_ManagedSystemElement ValueMap string [See below.] CIM_ManagedSystemElement Values string Not Available
No Additional Information
Stressed
Predictive Failure
Non-Recoverable Error
Supporting Entity in Error
DMTF Reserved
Vendor ReservedCIM_ManagedSystemElement ModelCorrespondence string CIM_EnabledLogicalElement.PrimaryStatus
CIM_ManagedSystemElement.HealthStateCIM_ManagedSystemElement
Name Value 0 Not Available 1 No Additional Information 2 Stressed 3 Predictive Failure 4 Non-Recoverable Error 5 Supporting Entity in Error .. DMTF Reserved 0x8000.. Vendor Reserved
Property OperatingStatus Qualifiers Name Type Value From Class Description string OperatingStatus provides a current status value for the operational condition of the element and can be used for providing more detail with respect to the value of EnabledState. It can also provide the transitional states when an element is transitioning from one state to another, such as when an element is transitioning between EnabledState and RequestedState, as well as other transitional conditions.OperatingStatus consists of one of the following values: Unknown, Not Available, In Service, Starting, Stopping, Stopped, Aborted, Dormant, Completed, Migrating, Emmigrating, Immigrating, Snapshotting. Shutting Down, In Test A Null return indicates the implementation (provider) does not implement this property. "Unknown" indicates the implementation is in general capable of returning this property, but is unable to do so at this time. "None" indicates that the implementation (provider) is capable of returning a value for this property, but not ever for this particular piece of hardware/software or the property is intentionally not used because it adds no meaningful information (as in the case of a property that is intended to add additional info to another property). "Servicing" describes an element being configured, maintained, cleaned, or otherwise administered. "Starting" describes an element being initialized. "Stopping" describes an element being brought to an orderly stop. "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. "Completed" indicates that the element has completed its operation. This value should be combined with either OK, Error, or Degraded in the PrimaryStatus 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). "Migrating" element is being moved between host elements. "Immigrating" element is being moved to new host element. "Emigrating" element is being moved away from host element. "Shutting Down" describes an element being brought to an abrupt stop. "In Test" element is performing test functions. "Transitioning" describes an element that is between states, that is, it is not fully available in either its previous state or its next state. This value should be used if other values indicating a transition to a specific state are not applicable."In Service" describes an element that is in service and operational. CIM_ManagedSystemElement ValueMap string [See below.] CIM_ManagedSystemElement Values string Unknown
Not Available
Servicing
Starting
Stopping
Stopped
Aborted
Dormant
Completed
Migrating
Emigrating
Immigrating
Snapshotting
Shutting Down
In Test
Transitioning
In Service
DMTF Reserved
Vendor ReservedCIM_ManagedSystemElement ModelCorrespondence string CIM_EnabledLogicalElement.EnabledState CIM_ManagedSystemElement
Name Value 0 Unknown 1 Not Available 2 Servicing 3 Starting 4 Stopping 5 Stopped 6 Aborted 7 Dormant 8 Completed 9 Migrating 10 Emigrating 11 Immigrating 12 Snapshotting 13 Shutting Down 14 In Test 15 Transitioning 16 In Service .. DMTF Reserved 0x8000.. Vendor Reserved
Property CommunicationStatus Qualifiers Name Type Value From Class Description string CommunicationStatus indicates the ability of the instrumentation to communicate with the underlying ManagedElement. CommunicationStatus consists of one of the following values: Unknown, None, Communication OK, Lost Communication, or No Contact. A Null return indicates the implementation (provider) does not implement this property. "Unknown" indicates the implementation is in general capable of returning this property, but is unable to do so at this time. "Not Available" indicates that the implementation (provider) is capable of returning a value for this property, but not ever for this particular piece of hardware/software or the property is intentionally not used because it adds no meaningful information (as in the case of a property that is intended to add additional info to another property). "Communication OK " indicates communication is established with the element, but does not convey any quality of service. "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 Managed Element is known to exist and has been contacted successfully in the past, but is currently unreachable. CIM_ManagedSystemElement ValueMap string [See below.] CIM_ManagedSystemElement Values string Unknown
Not Available
Communication OK
Lost Communication
No Contact
DMTF Reserved
Vendor ReservedCIM_ManagedSystemElement
Name Value 0 Unknown 1 Not Available 2 Communication OK 3 Lost Communication 4 No Contact .. DMTF Reserved 0x8000.. Vendor Reserved
Name Value 0 Unknown 1 Not Available 2 Communication OK 3 Lost Communication 4 No Contact .. DMTF Reserved 0x8000.. Vendor Reserved
Name Value 0 Unknown 1 Not Available 2 Communication OK 3 Lost Communication 4 No Contact .. DMTF Reserved 0x8000.. Vendor Reserved
Name Value 0 Unknown 1 Not Available 2 Communication OK 3 Lost Communication 4 No Contact .. DMTF Reserved 0x8000.. Vendor 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 RequestStateChange uint32 Description
ValueMap
Values
ModelCorrespondenceRequestedState
TimeoutPeriodCIM_EnabledLogicalElement Method Qualifiers
Method RequestStateChange Qualifiers Name Type Value From Class Description string Requests that the state of the element be changed to the value specified in the RequestedState parameter. When the requested state change takes place, the EnabledState and RequestedState of the element will be the same. Invoking the RequestStateChange method multiple times could result in earlier requests being overwritten or lost. A return code of 0 shall indicate the state change was successfully initiated. A return code of 3 shall indicate that the state transition cannot complete within the interval specified by the TimeoutPeriod parameter. A return code of 4096 (0x1000) shall indicate the state change was successfully initiated, a ConcreteJob has been created, and its reference returned in the output parameter Job. Any other return code indicates an error condition. CIM_EnabledLogicalElement ValueMap string [See below.] CIM_EnabledLogicalElement Values string Completed with No Error
Not Supported
Unknown or Unspecified Error
Cannot complete within Timeout Period
Failed
Invalid Parameter
In Use
DMTF Reserved
Method Parameters Checked - Job Started
Invalid State Transition
Use of Timeout Parameter Not Supported
Busy
Method Reserved
Vendor SpecificCIM_EnabledLogicalElement ModelCorrespondence string CIM_EnabledLogicalElement.RequestedState CIM_EnabledLogicalElement Parameters
Method RequestStateChange Parameters Name Type Qualifiers RequestedState uint16 IN
Description
ValueMap
Values
ModelCorrespondenceTimeoutPeriod datetime IN
Description
Method RequestStateChange Parameters Name Type Qualifiers RequestedState uint16 IN
Description
ValueMap
Values
ModelCorrespondenceTimeoutPeriod datetime IN
Description
Method RequestStateChange Parameters Name Type Qualifiers RequestedState uint16 IN
Description
ValueMap
Values
ModelCorrespondenceTimeoutPeriod datetime IN
DescriptionParameter Qualifiers
Parameter RequestedState Qualifiers Name Type Value From Class IN boolean true CIM_EnabledLogicalElement Description string The state requested for the element. This information will be placed into the RequestedState property of the instance if the return code of the RequestStateChange method is 0 ('Completed with No Error'), or 4096 (0x1000) ('Job Started'). Refer to the description of the EnabledState and RequestedState properties for the detailed explanations of the RequestedState values. CIM_EnabledLogicalElement ValueMap string [See below.] CIM_EnabledLogicalElement Values string Enabled
Disabled
Shut Down
Offline
Test
Defer
Quiesce
Reboot
Reset
DMTF Reserved
Vendor ReservedCIM_EnabledLogicalElement ModelCorrespondence string CIM_EnabledLogicalElement.RequestedState CIM_EnabledLogicalElement IN boolean true CIM_EnabledLogicalElement Description string A timeout period that specifies the maximum amount of time that the client expects the transition to the new state to take. The interval format must be used to specify the TimeoutPeriod. A value of 0 or a null parameter indicates that the client has no time requirements for the transition. If this property does not contain 0 or null and the implementation does not support this parameter, a return code of 'Use Of Timeout Parameter Not Supported' shall be returned. CIM_EnabledLogicalElement