# 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

Name | Data Type | Value
--- | --- | ---
Description | string | 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'.
UMLPackagePath | string | CIM::Device::Printing
Version | string | 2.29.0

## Class Properties

### Local Class Properties

Name | Data Type | Default Value | Qualifiers
--- | --- | --- | ---
Name | Data Type | Value
Charset | string |
Description | string | The 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'.
Experimental | boolean | true
MappingStrings | string | RFC2911.IETF|Section 4.4.17 charset-configured
ModelCorrespondence | string | CIM_PrintServiceCapabilities.Charset
Description | string |
Description | string | The 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.
MappingStrings | string | RFC2911.IETF|Section 4.4.6 printer-info
Override | string | Description
Required | boolean | true
DriverInstallerURI | string |
Description | string | The 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.
Experimental | boolean | true
MappingStrings | string | RFC2911.IETF|Section 4.4.8 printer-driver-installer
ElementName | string |
Description | string | The 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.
MappingStrings | string | RFC2911.IETF|Section 4.4.4 printer-name
Override | string | ElementName
Required | boolean | true
IsAcceptingJobs | boolean |
Description | string | Specifies whether this instance of PrintService is currently accepting incoming Jobs (i.e., Enabled) or iscurrently rejecting incoming Jobs (i.e., Disabled).
Experimental | boolean | true
MappingStrings | string | RFC2911.IETF|Section 4.4.23 printer-is-accepting-jobs
ModelCorrespondence | string | CIM_PrintService.State, CIM_PrintService.StateMessage, CIM_PrintService.StateReasons, CIM_SoftwareElement.SoftwareElementState, CIM_EnabledLogicalElement.EnabledState
Location | string |
Description | string | Physical location of the imaging system that hosts this instance of PrintService (i.e., location of the Printer if this is an embedded PrintService).
Experimental | boolean | true
MappingStrings | string | RFC2911.IETF|Section 4.4.5 printer-location
ModelCorrespondence | string | CIM_ElementLocation.PhysicalLocation
MakeAndModel | string |
Description | string | The 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).
Experimental | boolean | true
MappingStrings | string | RFC2911.IETF|Section 4.4.9 printer-make-and-model
ModelCorrespondence | string | CIM_PhysicalElement.Model
MessageFromOperator | string |
Description | string | A human-readable message to end users from the operator, system administrator, or management software for this instance of PrintService.
Experimental | boolean | true
MappingStrings | string | RFC2911.IETF|Section 4.4.25
ModelCorrespondence | string | CIM_PrintService.NaturalLanguage
MoreInfoManufacturerURI | string |
Description | string | The 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.
Experimental | boolean | true
MappingStrings | string | RFC2911.IETF|Section 4.4.10
ModelCorrespondence | string | CIM_PrintService.MoreInfoURI
MoreInfoURI | string |
Description | string | The 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.
Experimental | boolean | true
MappingStrings | string | RFC2911.IETF|Section 4.4.7 printer-more-info
ModelCorrespondence | string | CIM_PrintService.MoreInfoManufacturerURI
MultipleOperationTimeout | uint32 |
Description | string | Time 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.
Experimental | boolean | true
MappingStrings | string | RFC2911.IETF|Section 4.4.31 multiple-operation-time-out
PUnit | string | second
Units | string | Seconds
NaturalLanguage | string |
Description | string | The 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).
Experimental | boolean | true
MappingStrings | string | RFC2911.IETF|Section 4.4.19 natural-language-configured
ModelCorrespondence | string | CIM_PrintServiceCapabilities.NaturalLanguage
State | uint16 |
Description | string | The 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.
Experimental | boolean | true
MappingStrings | string | RFC2911.IETF|Section 4.4.11 printer-state
ModelCorrespondence | string | CIM_PrintService.StateMessage, CIM_PrintService.StateReasons, CIM_PrintService.IsAcceptingJobs, CIM_SoftwareElement.SoftwareElementState, CIM_EnabledLogicalElement.EnabledState
ValueMap | string | 1, 2, 3, 4, 5, ..
Values | string | Other, Unknown, Idle, Processing, Stopped, DMTF Reserved
StateMessage | string |
Description | string | The human-readable state message for this instance of PrintService, e.g., 'Paused by operator at 12:04'.
Experimental | boolean | true
MappingStrings | string | RFC2911.IETF|Section 4.4.13 printer-state-message
ModelCorrespondence | string | CIM_PrintService.State, CIM_PrintService.StateReasons, CIM_PrintService.IsAcceptingJobs, CIM_SoftwareElement.SoftwareElementState, CIM_EnabledLogicalElement.EnabledState
Uptime | uint32 |
Description | string | Time in seconds since the last startup of this instance of PrintService.
Experimental | boolean | true
MappingStrings | string | MIB.IETF|HOST-RESOURCES-MIB.hrSystemUptime, RFC2911.IETF|Section 4.4.29 printer-up-time
ModelCorrespondence | string | CIM_ApplicationSystem.StartupTime, CIM_OperatingSystem.LastBootUpTime
PUnit | string | second
Units | string | Seconds
AuthenticationSupported | string[] |
Description | string | The 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.
Experimental | boolean | true
MappingStrings | string | RFC2911.IETF|Section 4.4.2 uri-authentication-supported
ModelCorrespondence | string | CIM_ServiceAccessURI.LabeledURI, CIM_PrintJob.JobURI
AvailableFilters | string[] |
Deprecated | string | No value
Description | string | Note: 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.
Capabilities | uint16[] |
ArrayType | string | Indexed
Deprecated | string | No value
Description | string | Note: 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.
MappingStrings | string | MIB.IETF|Printer-MIB.prtInterpreterLangFamily, MIB.IETF|IANA-PRINTER-MIB.PrtInterpreterLangFamilyTC, RFC2911.IETF|Section 4.4.22 document-format-supported
ModelCorrespondence | string | CIM_Printer.Capabilities, CIM_PrintJob.Finishing, CIM_PrintService.CapabilityDescriptions
ValueMap | string | 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21
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 Low
CapabilityDescriptions | string[] |
ArrayType | string | Indexed
Deprecated | string | No value
Description | string | Note: 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.
ModelCorrespondence | string | CIM_PrintService.Capabilities
LanguagesSupported | uint16[] |
ArrayType | string | Indexed
Deprecated | string | CIM_PrintService.MimeTypesSupported
Description | string | Note: 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).
MappingStrings | string | MIB.IETF|Printer-MIB.prtInterpreterLangFamily
ModelCorrespondence | string | CIM_Printer.LanguagesSupported, CIM_PrintJob.Language
ValueMap | string | 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, ..
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, PDF, RPDL, IntermecIPL, UBIFingerprint, UBIDirectProtocol, Fujitsu, PCLXL, ART, CGM, JPEG, CALS1, CALS2, NIRS, C4, XPS, OpenXPS, DMTF Reserved
MimeTypesSupported | string[] |
Description | string | An array of input document formats (MIME types) that are supported by the PrintService.
MappingStrings | string | RFC2911.IETF|Section 4.4.22 document-format-supported
ModelCorrespondence | string | CIM_Printer.MimeTypesSupported, CIM_PrintJob.MimeTypes, CIM_PrintServiceSettings.DocumentFormat
PaperTypesAvailable | string[] |
Description | string | An 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].
MappingStrings | string | PWG5101-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
ModelCorrespondence | string | CIM_Printer.PaperTypesAvailable, CIM_PrintJob.RequiredPaperType, CIM_PrintServiceSettings.Media
SecuritySupported | string[] |
Description | string | The 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).
Experimental | boolean | true
MappingStrings | string | RFC2911.IETF|Section 4.4.3 uri-security-supported
ModelCorrespondence | string | CIM_ServiceAccessURI.LabeledURI, CIM_PrintJob.JobURI
StateReasons | string[] |
Description | string | The 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.
Experimental | boolean | true
MappingStrings | string | RFC2911.IETF|Section 4.4.12 printer-state-reasons
ModelCorrespondence | string | CIM_PrintService.State, CIM_PrintService.StateMessage, CIM_PrintService.IsAcceptingJobs, CIM_SoftwareElement.SoftwareElementState, CIM_EnabledLogicalElement.EnabledState

### Inherited Properties

Name | Data Type | Class Origin
--- | --- | ---
Caption | string | CIM_ManagedElement
CommunicationStatus | uint16 | CIM_ManagedSystemElement
CreationClassName | string | CIM_Service
DetailedStatus | uint16 | CIM_ManagedSystemElement
EnabledDefault | uint16 | CIM_EnabledLogicalElement
EnabledState | uint16 | CIM_EnabledLogicalElement
Generation | uint64 | CIM_ManagedElement
HealthState | uint16 | CIM_ManagedSystemElement
InstallDate | datetime | CIM_ManagedSystemElement
InstanceID | string | CIM_ManagedElement
Name | string | CIM_Service
OperatingStatus | uint16 | CIM_ManagedSystemElement
OtherEnabledState | string | CIM_EnabledLogicalElement
PrimaryOwnerContact | string | CIM_Service
PrimaryOwnerName | string | CIM_Service
PrimaryStatus | uint16 | CIM_ManagedSystemElement
RequestedState | uint16 | CIM_EnabledLogicalElement
Started | boolean | CIM_Service
StartMode | string | CIM_Service
Status | string | CIM_ManagedSystemElement
SystemCreationClassName | string | CIM_Service
SystemName | string | CIM_Service
TimeOfLastStateChange | datetime | CIM_EnabledLogicalElement
TransitioningToState | uint16 | CIM_EnabledLogicalElement
AvailableRequestedStates | uint16[] | CIM_EnabledLogicalElement
OperationalStatus | uint16[] | CIM_ManagedSystemElement
StatusDescriptions | string[] | CIM_ManagedSystemElement

## Class Methods

### Inherited Class Methods

Name | Return Type | Class Origin
--- | --- | ---
ChangeAffectedElementsAssignedSequence | uint32 | CIM_Service
RequestStateChange | uint32 | CIM_EnabledLogicalElement
StartService | uint32 | CIM_Service
StopService | uint32 | CIM_Service