Class CIM_PrintQueue
extends CIM_JobDestination

Capabilities and management of a Printer Queue. A PrintQueue holds PrintJobs - which are placed on the Queue by a Print Service. Jobs can move from Queue to Queue.

Class Hierarchy

CIM_ManagedElement
   |
   +--CIM_ManagedSystemElement
   |
   +--CIM_LogicalElement
   |
   +--CIM_EnabledLogicalElement
   |
   +--CIM_JobDestination
   |
   +--CIM_PrintQueue

Direct Known Subclasses

None.

Class Qualifiers

NameData TypeValueScopeFlavors
DescriptionstringCapabilities and management of a Printer Queue. A PrintQueue holds PrintJobs - which are placed on the Queue by a Print Service. Jobs can move from Queue to Queue.None TRANSLATABLE= true
Versionstring2.7.0TOSUBCLASS= falseTRANSLATABLE= true

Local Class Properties

NameData TypeQualifiers
NameData TypeValueScopeFlavors
Captionstring
DescriptionstringThe Caption property is a short textual description (one- line string) of the object.None TRANSLATABLE= true
MaxLenuint3264None None
CreationClassNamestring
DescriptionstringCreationClassName 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.None TRANSLATABLE= true
KeybooleantrueNone OVERRIDABLE= false
MaxLenuint32256None None
DefaultJobPriorityuint32
DescriptionstringSpecifies the priority that will be assigned to a new Job being submitted to this Queue, if the Job does not explicitly specify a priority. The range of valid priorities and the interpretation of priorities may be determined from the JobPriorityHigh and JobPriorityLow properties.None TRANSLATABLE= true
ModelCorrespondencestringCIM_PrintQueue.JobPriorityHigh, CIM_PrintQueue.JobPriorityLowNone None
Descriptionstring
DescriptionstringThe Description property provides a textual description of the object.None TRANSLATABLE= true
ElementNamestring
DescriptionstringA user-friendly name for the object. This property allows each instance to define a user-friendly name IN ADDITION TO its key properties/identity data, and description information. Note that ManagedSystemElement's Name property 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 MAY be present in both the Name and ElementName properties.None TRANSLATABLE= true
EnabledDefaultuint16
DescriptionstringAn enumerated value indicating an administrator's default/startup configuration for an element's Enabled State. By default, the element is "Enabled" (value=2).None TRANSLATABLE= true
ValueMapstring2, 3, 5, 6, 7, 8..32767, 32768..65535None None
ValuesstringEnabled, Disabled, Not Applicable, Enabled but Offline, No Default, DMTF Reserved, Vendor ReservedNone TRANSLATABLE= true
WritebooleantrueNone None
EnabledStateuint16
DescriptionstringEnabledState is an integer enumeration that indicates the enabled/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/disabled states: Enabled (2) indicates that the element is/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 doesn't support being enabled/disabled. Enabled but Offline (6) indicates that the element may 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 may be completing commands, but will queue any new requests. Quiesce (9) indicates that the element is enabled but in a restricted mode. The element's behavior is similar to the Enabled state, but it only processes a restricted set of commands. All other requests are queued. Starting (10) indicates that the element is in the process of going to an Enabled state. New requests are queued.None TRANSLATABLE= true
ModelCorrespondencestringCIM_EnabledLogicalElement.OtherEnabledStateNone None
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11..32767, 32768..65535None None
ValuesstringUnknown, Other, Enabled, Disabled, Shutting Down, Not Applicable, Enabled but Offline, In Test, Deferred, Quiesce, Starting, DMTF Reserved, Vendor ReservedNone TRANSLATABLE= true
InstallDatedatetime
DescriptionstringA datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed.None TRANSLATABLE= true
MappingStringsstringMIF.DMTF|ComponentID|001.5None None
JobPriorityHighuint32
DescriptionstringSpecifies 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 may be inversed, e.g. a high priority job is represented by a low integer value. This is indicated by JobPriorityLow being greater than JobPriorityHigh. If both values (PriorityLow and Priority High) are assigned to zero, then the Queue does not support Job priorities.None TRANSLATABLE= true
ModelCorrespondencestringCIM_PrintQueue.JobPriorityLow, CIM_Job.PriorityNone None
JobPriorityLowuint32
DescriptionstringSpecifies 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 may be inversed, e.g. a low priority job is represented by a high integer value. This is indicated by JobPriorityLow being greater than JobPriorityHigh. If both values (PriorityLow and PriorityHigh) are assigned to zero, then the Queue does not support Job priorities.None TRANSLATABLE= true
ModelCorrespondencestringCIM_PrintQueue.JobPriorityHigh, CIM_Job.PriorityNone None
MaxJobSizeuint32
DescriptionstringSpecifies the largest possible Job (in terms of a single byte stream) that may be submitted to this Queue. A value of zero indicates that no limit has been set. Units are Kbytes.None TRANSLATABLE= true
ModelCorrespondencestringCIM_PrintJob.JobSizeNone None
UnitsstringKiloBytesNone TRANSLATABLE= true
Namestring
DescriptionstringThe inherited Name serves as key of a JobDestination instance in a System.None TRANSLATABLE= true
KeybooleantrueNone OVERRIDABLE= false
MaxLenuint32256None None
OverridestringNameNone OVERRIDABLE= false
NumberOnQueueuint32
DescriptionstringThe current number of Jobs on the Queue.None TRANSLATABLE= true
GaugebooleantrueNone None
OtherEnabledStatestring
DescriptionstringA string describing the element's enabled/disabled state when the EnabledState property is set to 1 ("Other"). This property MUST be set to NULL when EnabledState is any value other than 1.None TRANSLATABLE= true
ModelCorrespondencestringCIM_EnabledLogicalElement.EnabledStateNone None
QueueAcceptingboolean
DeprecatedstringCIM_EnabledLogicalElement.EnabledStateTOSUBCLASS= falseNone
DescriptionstringWhen 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 (i.e., when the Queue is outputting jobs to the printer, but not accepting new jobs), then EnabledState is set to 6 ("Enabled but Offline") - When QueueEnabled is FALSE and QueueAccepting is TRUE (i.e., when the Queue is accepting print jobs but not sending them to a printer), then EnabledState is set to 8 ("Deferred") Both this property and QueueEnabled are deprecated in lieu of EnabledState.None TRANSLATABLE= true
QueueEnabledboolean
DeprecatedstringCIM_EnabledLogicalElement.EnabledStateTOSUBCLASS= falseNone
DescriptionstringIndicates 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 (i.e., when the Queue is outputting jobs to the printer, but not accepting new jobs), then EnabledState is set to 6 ("Enabled but Offline") - When QueueEnabled is FALSE and QueueAccepting is TRUE (i.e., when the Queue is accepting print jobs but not sending them to a printer), then EnabledState is set to 8 ("Deferred") Both this property and QueueAccepting are deprecated in lieu of EnabledState.None TRANSLATABLE= true
QueueStatusuint16
DescriptionstringGives Queue-specific status information, beyond the ManagedSystemElement.Status property. This may be used to provide further qualification as to the status of the Queue or to indicate a secondary condition (e.g. spool area is full).None TRANSLATABLE= true
ValueMapstring0, 1, 2, 3None None
ValuesstringOther, Unknown, No Additional Status, QueueSpoolAreaFullNone TRANSLATABLE= true
QueueStatusInfostring
DescriptionstringProvides a textual explanation for the status of the Queue. The settings of both QueueStatus and the Status property inherited from ManagedSystemElement may be described by QueueStatusInfo. For example, if "Stopping" is the value assigned to Status, then this property may contain an explanation as to why the Queue is being stopped.None TRANSLATABLE= true
RequestedStateuint16
DescriptionstringRequestedState is an integer enumeration indicating the last requested or desired state for the element. The actual state of the element is represented by EnabledState. This property is provided to compare the last requested and current enabled/disabled states. Note that when EnabledState is set to 5 ("Not Applicable"), then this property has no meaning. By default, the element's RequestedState is 5 ("No Change"). Refer to the EnabledState's property Description for explanations of the values in the RequestedState enumeration. 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). The former, Reboot, refers to doing a "Shut Down" and then moving to an "Enabled" state. The latter, Reset, indicates that the element is first "Disabled" and then "Enabled". The distinction between requesting "Shut Down" and "Disabled" should also be noted. The former, Shut Down, requests an orderly transition to the Disabled state, and MAY involve removing power, to completely erase any existing state. The latter, 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 may be overridden and defined as WRITEable in a subclass. The method approach is considered superior to a WRITEable property, since it allows an explicit invocation of the operation and the return of a result code.None TRANSLATABLE= true
ModelCorrespondencestringCIM_EnabledLogicalElement.EnabledStateNone None
ValueMapstring2, 3, 4, 5, 6, 7, 8, 9, 10, 11, .., 32768..65535None None
ValuesstringEnabled, Disabled, Shut Down, No Change, Offline, Test, Deferred, Quiesce, Reboot, Reset, DMTF Reserved, Vendor ReservedNone TRANSLATABLE= true
Statusstring
DeprecatedstringCIM_ManagedSystemElement.OperationalStatusTOSUBCLASS= falseNone
DescriptionstringA string indicating the current status of the object. Various operational and non-operational statuses are defined. This property is deprecated in lieu of OperationalStatus, which includes the same semantics in its enumeration. This change is made for 3 reasons: 1) Status is more correctly defined as an array. This overcomes the limitation of describing status via a single value, when it is really a multi-valued property (for example, an element may be OK AND Stopped. 2) A MaxLen of 10 is too restrictive and leads to unclear enumerated values. And, 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.None TRANSLATABLE= true
MaxLenuint3210None None
ValueMapstringOK, Error, Degraded, Unknown, Pred Fail, Starting, Stopping, Service, Stressed, NonRecover, No Contact, Lost Comm, StoppedNone None
SystemCreationClassNamestring
DescriptionstringThe scoping System's CreationClassName.None TRANSLATABLE= true
KeybooleantrueNone OVERRIDABLE= false
MaxLenuint32256None None
PropagatedstringCIM_System.CreationClassNameNone OVERRIDABLE= false
SystemNamestring
DescriptionstringThe scoping System's Name.None TRANSLATABLE= true
KeybooleantrueNone OVERRIDABLE= false
MaxLenuint32256None None
PropagatedstringCIM_System.NameNone OVERRIDABLE= false
TimeOfLastStateChangedatetime
DescriptionstringThe date/time when the element's EnabledState 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.None TRANSLATABLE= true
AvailableJobSheetsstring[]
DescriptionstringSpecifies the job sheets that are supported by this Queue. Typically the job sheets provided by a Queue will be the union or aggregation of those provided by all the Printers that it supports. However, a system administrator may choose to restrict access to some job sheets on a particular Queue. A Queue might 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.None TRANSLATABLE= true
ModelCorrespondencestringCIM_PrintJob.RequiredJobSheetsNone None
OperationalStatusuint16[]
ArrayTypestringIndexedNone OVERRIDABLE= false
DescriptionstringIndicates the current status(es) of the element. Various health and operational statuses are defined. Many of the enumeration's values are self- explanatory. However, a few are not and are described in more detail. "Stressed" indicates that the element is functioning, but needs attention. Examples of "Stressed" states are overload, overheated, etc. "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 element's state and configuration may need to be updated. "Dormant" indicates that the element is inactive or quiesced. "Supporting Entity in Error" describes that this element may 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 the element has completed its operation. This value should be combined with either OK, Error, or Degraded so that a client can till if the complete operation passed (Completed with OK), and failure (Completed with Error). Completed with Degraded would imply the operation finished, but did not complete OK or report an error. "Power Mode" indicates 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 since it required the DEPRECATED qualifier. Due to the widespread use of the existing Status property in management applications, it is strongly RECOMMENDED that providers/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 (since it is single-valued) SHOULD also provide the primary status of the element.None TRANSLATABLE= true
ModelCorrespondencestringCIM_ManagedSystemElement.StatusDescriptionsNone None
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, .., 0x8000..None None
ValuesstringUnknown, Other, OK, Degraded, Stressed, Predictive Failure, Error, Non-Recoverable Error, Starting, Stopping, Stopped, In Service, No Contact, Lost Communication, Aborted, Dormant, Supporting Entity in Error, Completed, Power Mode, DMTF Reserved, Vendor ReservedNone TRANSLATABLE= true
StatusDescriptionsstring[]
ArrayTypestringIndexedNone OVERRIDABLE= false
DescriptionstringStrings describing the various OperationalStatus array values. For example, if "Stopping" is the value assigned to OperationalStatus, then this property may contain an explanation as to why an object is being stopped. Note that entries in this array are correlated with those at the same array index in OperationalStatus.None TRANSLATABLE= true
ModelCorrespondencestringCIM_ManagedSystemElement.OperationalStatusNone None