Class CIM_PrintService
extends CIM_Service

The Service that provides support for printing. The basic assumption of the Printing Model is that a PrintService accepts a PrintJob for processing, using its PrintSAP. The Job is then placed on a PrintQueue (that is indicated by the QueueForPrintService association). Printers take Jobs from Queues (indicated by the PrinterServicingQueue association). 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'.

Table of Contents
Hierarchy
Direct Known Subclasses
Class Qualifiers
Class Properties
Class Methods


Class Hierarchy

CIM_ManagedElement
   |
   +--CIM_ManagedSystemElement
   |
   +--CIM_LogicalElement
   |
   +--CIM_EnabledLogicalElement
   |
   +--CIM_Service
   |
   +--CIM_PrintService

Direct Known Subclasses

Class Qualifiers

NameData TypeValue
DescriptionstringThe Service that provides support for printing. The basic assumption of the Printing Model is that a PrintService accepts a PrintJob for processing, using its PrintSAP. The Job is then placed on a PrintQueue (that is indicated by the QueueForPrintService association). Printers take Jobs from Queues (indicated by the PrinterServicingQueue association). 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'.
UMLPackagePathstringCIM::Device::Printing
Versionstring2.29.0

Class Properties

Local Class Properties

NameData TypeDefault ValueQualifiers
NameData TypeValue
Charsetstring
DescriptionstringThe current charset for human-readable text output from this instance of PrintService to network clients. Values shall conform to section 4.1.2 Charset Parameter in RFC 2046 and be contained in IANA Charset Registry, e.g., 'utf-8' and 'us-ascii'.
Experimentalbooleantrue
MappingStringsstringRFC2911.IETF|Section 4.4.17 charset-configured
ModelCorrespondencestringCIM_PrintServiceCapabilities.Charset
Descriptionstring
DescriptionstringThe description of this specific instance of PrintService. This text shall be generated as a factory default by the manufacturer and may be changed out-of-band by the system administrator.
MappingStringsstringRFC2911.IETF|Section 4.4.6 printer-info
OverridestringDescription
Requiredbooleantrue
DriverInstallerURIstring
DescriptionstringThe URI for the driver installer for this PrintService. This URI may be generated as a factory default by the manufacturer and may be changed out-of-band to a site-specific URI by the system administrator.
Experimentalbooleantrue
MappingStringsstringRFC2911.IETF|Section 4.4.8 printer-driver-installer
ElementNamestring
DescriptionstringThe user-friendly name for this instance of PrintService. In addition, the user-friendly name can be used as an index property for a search or query. (Note: The name does not have to be unique within a namespace.) This name shall be generated as a factory default by the manufacturer and may be changed out-of-band to a site-specific name by the system administrator.
MappingStringsstringRFC2911.IETF|Section 4.4.4 printer-name
OverridestringElementName
Requiredbooleantrue
IsAcceptingJobsboolean
DescriptionstringSpecifies whether this instance of PrintService is currently accepting incoming Jobs (i.e., Enabled) or iscurrently rejecting incoming Jobs (i.e., Disabled).
Experimentalbooleantrue
MappingStringsstringRFC2911.IETF|Section 4.4.23 printer-is-accepting-jobs
ModelCorrespondencestringCIM_PrintService.State, CIM_PrintService.StateMessage, CIM_PrintService.StateReasons, CIM_SoftwareElement.SoftwareElementState, CIM_EnabledLogicalElement.EnabledState
Locationstring
DescriptionstringPhysical location of the imaging system that hosts this instance of PrintService (i.e., location of the Printer if this is an embedded PrintService).
Experimentalbooleantrue
MappingStringsstringRFC2911.IETF|Section 4.4.5 printer-location
ModelCorrespondencestringCIM_ElementLocation.PhysicalLocation
MakeAndModelstring
DescriptionstringThe make and model of the imaging system that hosts this instance of PrintService (i.e., the make and model of the Printer if this is an embedded PrintService).
Experimentalbooleantrue
MappingStringsstringRFC2911.IETF|Section 4.4.9 printer-make-and-model
ModelCorrespondencestringCIM_PhysicalElement.Model
MessageFromOperatorstring
DescriptionstringA human-readable message to end users from the operator, system administrator, or management software for this instance of PrintService.
Experimentalbooleantrue
MappingStringsstringRFC2911.IETF|Section 4.4.25
ModelCorrespondencestringCIM_PrintService.NaturalLanguage
MoreInfoManufacturerURIstring
DescriptionstringThe URI for more info about this type of PrintService (rather than this specific instance of PrintService). This URI shall be generated as a factory default by the manufacturer and may be changed out-of-band to a site-specific URI by the system administrator.
Experimentalbooleantrue
MappingStringsstringRFC2911.IETF|Section 4.4.10
ModelCorrespondencestringCIM_PrintService.MoreInfoURI
MoreInfoURIstring
DescriptionstringThe URI for more info about this specific instance of PrintService. This URI shall be generated as a factory default by the manufacturer and may be changed out-of-band to a site-specific URI by the system administrator.
Experimentalbooleantrue
MappingStringsstringRFC2911.IETF|Section 4.4.7 printer-more-info
ModelCorrespondencestringCIM_PrintService.MoreInfoManufacturerURI
MultipleOperationTimeoutuint32
DescriptionstringTime in seconds for this instance of PrintService to wait for additional Job operations (e.g., IPP Send-Document) for an open Job before taking recovery actions (e.g., closing and processing the Job or aborting the Job). Value should be between 60 and 240 seconds.
Experimentalbooleantrue
MappingStringsstringRFC2911.IETF|Section 4.4.31 multiple-operation-time-out
PUnitstringsecond
UnitsstringSeconds
NaturalLanguagestring
DescriptionstringThe natural language for human-readable text output from this instance of PrintService to network clients. Values shall conform to IETF Tags for Identifying Languages (RFC 5646) or successor and shall be contained in the IANA Language Subtag Registry (RFC 5645), e.g., 'en-us' (US English) and 'fr' (French).
Experimentalbooleantrue
MappingStringsstringRFC2911.IETF|Section 4.4.19 natural-language-configured
ModelCorrespondencestringCIM_PrintServiceCapabilities.NaturalLanguage
Stateuint16
DescriptionstringThe state of this instance of PrintService. 1 (Other) means the PrintService is in some non-standard state. 2 (Unknown) means the PrintService state is unknown. 3 (Idle) means the PrintService is ready but idle. 4 (Processing) means the PrintSevice is processing one or more Jobs. 5 (Stopped) means the PrintSevice cannot process any Jobs and human intervention is required.
Experimentalbooleantrue
MappingStringsstringRFC2911.IETF|Section 4.4.11 printer-state
ModelCorrespondencestringCIM_PrintService.StateMessage, CIM_PrintService.StateReasons, CIM_PrintService.IsAcceptingJobs, CIM_SoftwareElement.SoftwareElementState, CIM_EnabledLogicalElement.EnabledState
ValueMapstring1, 2, 3, 4, 5, ..
ValuesstringOther, Unknown, Idle, Processing, Stopped, DMTF Reserved
StateMessagestring
DescriptionstringThe human-readable state message for this instance of PrintService, e.g., 'Paused by operator at 12:04'.
Experimentalbooleantrue
MappingStringsstringRFC2911.IETF|Section 4.4.13 printer-state-message
ModelCorrespondencestringCIM_PrintService.State, CIM_PrintService.StateReasons, CIM_PrintService.IsAcceptingJobs, CIM_SoftwareElement.SoftwareElementState, CIM_EnabledLogicalElement.EnabledState
Uptimeuint32
DescriptionstringTime in seconds since the last startup of this instance of PrintService.
Experimentalbooleantrue
MappingStringsstringMIB.IETF|HOST-RESOURCES-MIB.hrSystemUptime, RFC2911.IETF|Section 4.4.29 printer-up-time
ModelCorrespondencestringCIM_ApplicationSystem.StartupTime, CIM_OperatingSystem.LastBootUpTime
PUnitstringsecond
UnitsstringSeconds
AuthenticationSupportedstring[]
DescriptionstringThe supported client authentication methods for this instance of PrintService and any associated PrintJobs. Complete standard values are in the IANA IPP Registry. Standard values defined in IPP/1.1 (RFC 2911) include: Value 'none' means client authentication method is to allow anonymous access. Value 'requesting-user-name' means client authentication method is to verify the requesting user name. Value 'basic' means client authentication method is to use HTTP Basic (RFC 2617). Value 'digest' means client authentication method is to use HTTP Digest (RFC 2617). Value 'certificate' means client authentication method method is to verify the supplied certificate.
Experimentalbooleantrue
MappingStringsstringRFC2911.IETF|Section 4.4.2 uri-authentication-supported
ModelCorrespondencestringCIM_ServiceAccessURI.LabeledURI, CIM_PrintJob.JobURI
AvailableFiltersstring[]
DeprecatedstringNo value
DescriptionstringNote: The use of this property has been deprecated, due to ambiguity. Print filter information is not available in open standard print protocols (i.e., no known mapping). Deprecated description: Describes the filters that are available within this Print Service. For example, a PrintService can convert a Job that is submitted in one page description language to another, so that it can be passed to an available Printer.
Capabilitiesuint16[]
ArrayTypestringIndexed
DeprecatedstringNo value
DescriptionstringNote: The use of this property has been deprecated, due to ambiguity. Instead use PrintServiceCapabilities properties (e.g., Finishings). Deprecated description: An array of integers that indicates the capabilities that are supported by this service. Information such as values 'Duplex Printing' or 'Transparency Printing' is specified in this property.
MappingStringsstringMIB.IETF|Printer-MIB.prtInterpreterLangFamily, MIB.IETF|IANA-PRINTER-MIB.PrtInterpreterLangFamilyTC, RFC2911.IETF|Section 4.4.22 document-format-supported
ModelCorrespondencestringCIM_Printer.Capabilities, CIM_PrintJob.Finishing, CIM_PrintService.CapabilityDescriptions
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21
ValuesstringUnknown, Other, Color Printing, Duplex Printing, Copies, Collation, Stapling, Transparency Printing, Punch, Cover, Bind, Black and White Printing, One Sided, Two Sided Long Edge, Two Sided Short Edge, Portrait, Landscape, Reverse Portrait, Reverse Landscape, Quality High, Quality Normal, Quality Low
CapabilityDescriptionsstring[]
ArrayTypestringIndexed
DeprecatedstringNo value
DescriptionstringNote: The use of this property has been deprecated, due to ambiguity. Instead use properties defined in the PrintServiceCapabilities class. Deprecated description: An array of free-form strings that provides more detailed explanations for any of the Printer features that are indicated in the Capabilities array. Note, each entry of this array is related to the entry in the Capabilities array that is located at the same index.
ModelCorrespondencestringCIM_PrintService.Capabilities
LanguagesSupporteduint16[]
ArrayTypestringIndexed
DeprecatedstringCIM_PrintService.MimeTypesSupported
DescriptionstringNote: The use of this property has been deprecated, due to ambiguity. Instead use MimeTypesSupported. Enumerated print languages are only available in the IETF Printer MIB v1/v2 (RFC 1759/3805) and are not available in open standard print protocols (i.e., no known mapping). Deprecated description: An array that indicates the print languages that are supported by the PrintService. A PrintService can support more languages than those available on the underlying Printer through the use of filters. An administrator can also choose to prevent some languages from being exported by the PrintService. Note: For legacy compatiblity reasons, this property is NOT exactly aligned (in order of values) with the authoritative PrtInterpreterLangFamilyTC in the IANA Printer MIB, unlike the newer property PrintInterpreter.LangType (which is exactly aligned with the IANA Printer MIB).
MappingStringsstringMIB.IETF|Printer-MIB.prtInterpreterLangFamily
ModelCorrespondencestringCIM_Printer.LanguagesSupported, CIM_PrintJob.Language
ValueMapstring1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, ..
ValuesstringOther, Unknown, PCL, HPGL, PJL, PS, PSPrinter, IPDS, PPDS, EscapeP, Epson, DDIF, Interpress, ISO6429, Line Data, MODCA, REGIS, SCS, SPDL, TEK4014, PDS, IGP, CodeV, DSCDSE, WPS, LN03, CCITT, QUIC, CPAP, DecPPL, Simple Text, NPAP, DOC, imPress, Pinwriter, NPDL, NEC201PL, Automatic, Pages, LIPS, TIFF, Diagnostic, CaPSL, EXCL, LCDS, XES, MIME, TIPSI, Prescribe, LinePrinter, IDP, XJCL, PDF, RPDL, IntermecIPL, UBIFingerprint, UBIDirectProtocol, Fujitsu, PCLXL, ART, CGM, JPEG, CALS1, CALS2, NIRS, C4, XPS, OpenXPS, DMTF Reserved
MimeTypesSupportedstring[]
DescriptionstringAn array of input document formats (MIME types) that are supported by the PrintService.
MappingStringsstringRFC2911.IETF|Section 4.4.22 document-format-supported
ModelCorrespondencestringCIM_Printer.MimeTypesSupported, CIM_PrintJob.MimeTypes, CIM_PrintServiceSettings.DocumentFormat
PaperTypesAvailablestring[]
DescriptionstringAn array of free-form strings that specifies the types and sizes of paper that can be used by Jobs that are submitted to this PrintService. This list can be different than the paper types that are installed on the Printer, because the PrintService can include support for manually making other types available or only a subset of paper types can be exported using this PrintService. The values of the property SHOULD conform to the requirements of the PWG Media Standardized Names specification [PWG5101.1], which defines the normative values for this property. See older Appendix B 'Media Size Names' and Appendix C 'Media Names' of IETF Printer MIB v2 [RFC3805] which list the values of standardized media names defined in ISO DPA [ISO10175].
MappingStringsstringPWG5101-1.PWG|Media Standardized Names, MIB.IETF|Printer-MIB.prtInputMediaName, RFC2911.IETF|Printer.media-supported, RFC2911.IETF|Section 4.2 Job Template Attributes, RFC2911.IETF|Section 4.2.11 media, RFC2911.IETF|APPENDIX C 'media' keyword values
ModelCorrespondencestringCIM_Printer.PaperTypesAvailable, CIM_PrintJob.RequiredPaperType, CIM_PrintServiceSettings.Media
SecuritySupportedstring[]
DescriptionstringThe supported network security mechanisms for this instance of PrintService and any associated PrintJobs. Complete standard values are in the IANA IPP Registry. Standard values defined in IPP/1.1 (RFC 2911) include: Value 'none' means network security mechanism is not used. Value 'ssl3' means network security mechanism is to use SSL3 (Netscape SSL). Value 'tls' means network security mechanism is to use TLS (RFC 2246 or successor).
Experimentalbooleantrue
MappingStringsstringRFC2911.IETF|Section 4.4.3 uri-security-supported
ModelCorrespondencestringCIM_ServiceAccessURI.LabeledURI, CIM_PrintJob.JobURI
StateReasonsstring[]
DescriptionstringThe state reasons (conditions) of this instance of PrintService. Complete standard values are in the IANA IPP Registry. Additional vendor or site values may also be used. Standard values defined in IPP/1.1 (RFC 2911) include: Value 'none' means there are no current state reasons. Value 'paused' means the PrintService has been paused. Value 'toner-empty' means the Printer is out of toner.
Experimentalbooleantrue
MappingStringsstringRFC2911.IETF|Section 4.4.12 printer-state-reasons
ModelCorrespondencestringCIM_PrintService.State, CIM_PrintService.StateMessage, CIM_PrintService.IsAcceptingJobs, CIM_SoftwareElement.SoftwareElementState, CIM_EnabledLogicalElement.EnabledState

Inherited Properties

NameData TypeClass Origin
CaptionstringCIM_ManagedElement
CommunicationStatusuint16CIM_ManagedSystemElement
CreationClassNamestringCIM_Service
DetailedStatusuint16CIM_ManagedSystemElement
EnabledDefaultuint16CIM_EnabledLogicalElement
EnabledStateuint16CIM_EnabledLogicalElement
Generationuint64CIM_ManagedElement
HealthStateuint16CIM_ManagedSystemElement
InstallDatedatetimeCIM_ManagedSystemElement
InstanceIDstringCIM_ManagedElement
LoSIDstringCIM_Service
LoSOrgIDstringCIM_Service
NamestringCIM_Service
OperatingStatusuint16CIM_ManagedSystemElement
OtherEnabledStatestringCIM_EnabledLogicalElement
PrimaryOwnerContactstringCIM_Service
PrimaryOwnerNamestringCIM_Service
PrimaryStatusuint16CIM_ManagedSystemElement
RequestedStateuint16CIM_EnabledLogicalElement
StartedbooleanCIM_Service
StartModestringCIM_Service
StatusstringCIM_ManagedSystemElement
SystemCreationClassNamestringCIM_Service
SystemNamestringCIM_Service
TimeOfLastStateChangedatetimeCIM_EnabledLogicalElement
TransitioningToStateuint16CIM_EnabledLogicalElement
AvailableRequestedStatesuint16[]CIM_EnabledLogicalElement
OperationalStatusuint16[]CIM_ManagedSystemElement
StatusDescriptionsstring[]CIM_ManagedSystemElement

Class Methods

Inherited Class Methods

NameReturn TypeClass Origin
ChangeAffectedElementsAssignedSequenceuint32CIM_Service
RequestStateChangeuint32CIM_EnabledLogicalElement
StartServiceuint32CIM_Service
StopServiceuint32CIM_Service