7 Network Working Group T. Hastings, Editor
8 Request for Comments: 2911 R. Herriot
9 Obsoletes: 2566 Xerox Corporation
10 Category: Standards Track R. deBry
11 Utah Valley State College
19 Internet Printing Protocol/1.1: Model and Semantics
23 This document specifies an Internet standards track protocol for the
24 Internet community, and requests discussion and suggestions for
25 improvements. Please refer to the current edition of the "Internet
26 Official Protocol Standards" (STD 1) for the standardization state
27 and status of this protocol. Distribution of this memo is unlimited.
31 Copyright (C) The Internet Society (2000). All Rights Reserved.
35 This document is one of a set of documents, which together describe
36 all aspects of a new Internet Printing Protocol (IPP). IPP is an
37 application level protocol that can be used for distributed printing
38 using Internet tools and technologies. This document describes a
39 simplified model consisting of abstract objects, their attributes,
40 and their operations that is independent of encoding and transport.
41 The model consists of a Printer and a Job object. A Job optionally
42 supports multiple documents. IPP 1.1 semantics allow end-users and
43 operators to query printer capabilities, submit print jobs, inquire
44 about the status of print jobs and printers, cancel, hold, release,
45 and restart print jobs. IPP 1.1 semantics allow operators to pause,
46 resume, and purge (jobs from) Printer objects. This document also
47 addresses security, internationalization, and directory issues.
58 Hastings, et al. Standards Track [Page 1]
60 RFC 2911 IPP/1.1: Model and Semantics September 2000
63 The full set of IPP documents includes:
65 Design Goals for an Internet Printing Protocol [RFC2567]
66 Rationale for the Structure and Model and Protocol for the Internet
67 Printing Protocol [RFC2568]
68 Internet Printing Protocol/1.1: Model and Semantics (this document)
69 Internet Printing Protocol/1.1: Encoding and Transport [RFC2910]
70 Internet Printing Protocol/1.1: Implementer's Guide [IPP-IIG]
71 Mapping between LPD and IPP Protocols [RFC2569]
73 The "Design Goals for an Internet Printing Protocol" document takes a
74 broad look at distributed printing functionality, and it enumerates
75 real-life scenarios that help to clarify the features that need to be
76 included in a printing protocol for the Internet. It identifies
77 requirements for three types of users: end users, operators, and
78 administrators. It calls out a subset of end user requirements that
79 are satisfied in IPP/1.0. A few OPTIONAL operator operations have
80 been added to IPP/1.1.
82 The "Rationale for the Structure and Model and Protocol for the
83 Internet Printing Protocol" document describes IPP from a high level
84 view, defines a roadmap for the various documents that form the suite
85 of IPP specification documents, and gives background and rationale
86 for the IETF working group's major decisions.
88 The "Internet Printing Protocol/1.1: Encoding and Transport" document
89 is a formal mapping of the abstract operations and attributes defined
90 in the model document onto HTTP/1.1 [RFC2616]. It defines the
91 encoding rules for a new Internet MIME media type called
92 "application/ipp". This document also defines the rules for
93 transporting over HTTP a message body whose Content-Type is
94 "application/ipp". This document defines a new scheme named 'ipp'
95 for identifying IPP printers and jobs.
97 The "Internet Printing Protocol/1.1: Implementer's Guide" document
98 gives insight and advice to implementers of IPP clients and IPP
99 objects. It is intended to help them understand IPP/1.1 and some of
100 the considerations that may assist them in the design of their client
101 and/or IPP object implementations. For example, a typical order of
102 processing requests is given, including error checking. Motivation
103 for some of the specification decisions is also included.
105 The "Mapping between LPD and IPP Protocols" document gives some
106 advice to implementers of gateways between IPP and LPD (Line Printer
107 Daemon) implementations.
114 Hastings, et al. Standards Track [Page 2]
116 RFC 2911 IPP/1.1: Model and Semantics September 2000
122 1.1 Simplified Printing Model 10
124 2.1 Printer Object 13
126 2.3 Object Relationships 16
127 2.4 Object Identity 17
129 3.1 Common Semantics 21
130 3.1.1 Required Parameters 21
131 3.1.2 Operation IDs and Request IDs 22
133 3.1.4 Character Set and Natural Language Operation Attribute 24
134 3.1.4.1 Request Operation Attributes 25
135 3.1.4.2 Response Operation Attributes 29
136 3.1.5 Operation Targets 30
137 3.1.6 Operation Response Status Codes and Status Messages 32
138 3.1.6.1 "status-code" (type2 enum) 32
139 3.1.6.2 "status-message" (text(255)) 33
140 3.1.6.3 "detailed-status-message" (text(MAX)) 33
141 3.1.6.4 "document-access-error" (text(MAX)) 34
142 3.1.7 Unsupported Attributes 34
144 3.1.9 Job Creation Operations 38
145 3.2 Printer Operations 41
146 3.2.1 Print-Job Operation 41
147 3.2.1.1 Print-Job Request 41
148 3.2.1.2 Print-Job Response 46
149 3.2.2 Print-URI Operation 48
150 3.2.3 Validate-Job Operation 49
151 3.2.4 Create-Job Operation 49
152 3.2.5 Get-Printer-Attributes Operation 50
153 3.2.5.1 Get-Printer-Attributes Request 51
154 3.2.5.2 Get-Printer-Attributes Response 53
155 3.2.6 Get-Jobs Operation 54
156 3.2.6.1 Get-Jobs Request 54
157 3.2.6.2 Get-Jobs Response 56
158 3.2.7 Pause-Printer Operation 57
159 3.2.7.1 Pause-Printer Request 59
160 3.2.7.2 Pause-Printer Response 60
161 3.2.8 Resume-Printer Operation 60
162 3.2.9 Purge-Jobs Operation 61
163 3.3 Job Operations 62
164 3.3.1 Send-Document Operation 62
165 3.3.1.1 Send-Document Request 64
166 3.3.1.2 Send-Document Response 65
170 Hastings, et al. Standards Track [Page 3]
172 RFC 2911 IPP/1.1: Model and Semantics September 2000
175 3.3.2 Send-URI Operation 66
176 3.3.3 Cancel-Job Operation 66
177 3.3.3.1 Cancel-Job Request 67
178 3.3.3.2 Cancel-Job Response 68
179 3.3.4 Get-Job-Attributes Operation 69
180 3.3.4.1 Get-Job-Attributes Request 69
181 3.3.4.2 Get-Job-Attributes Response 70
182 3.3.5 Hold-Job Operation 71
183 3.3.5.1 Hold-Job Request 72
184 3.3.5.2 Hold-Job Response 73
185 3.3.6 Release-Job Operation 74
186 3.3.7 Restart-Job Operation 75
187 3.3.7.1 Restart-Job Request 76
188 3.3.7.2 Restart-Job Response 78
189 4. Object Attributes 78
190 4.1 Attribute Syntaxes 78
192 4.1.1.1 'textWithoutLanguage' 80
193 4.1.1.2 'textWithLanguage' 80
195 4.1.2.1 'nameWithoutLanguage' 82
196 4.1.2.2 'nameWithLanguage' 82
197 4.1.2.3 Matching 'name' attribute values 83
203 4.1.8 'naturalLanguage' 87
204 4.1.9 'mimeMediaType' 87
205 4.1.9.1 Application/octet-stream -- Auto-Sensing 88
207 4.1.10 'octetString' 89
210 4.1.13 'rangeOfInteger' 90
212 4.1.15 'resolution' 90
214 4.2 Job Template Attributes 91
215 4.2.1 job-priority (integer(1:100)) 94
216 4.2.2 job-hold-until (type3 keyword | name (MAX)) 95
217 4.2.3 job-sheets (type3 keyword | name(MAX)) 96
218 4.2.4 multiple-document-handling (type2 keyword) 96
219 4.2.5 copies (integer(1:MAX)) 98
220 4.2.6 finishings (1setOf type2 enum) 98
221 4.2.7 page-ranges (1setOf rangeOfInteger (1:MAX)) 101
222 4.2.8 sides (type2 keyword) 102
226 Hastings, et al. Standards Track [Page 4]
228 RFC 2911 IPP/1.1: Model and Semantics September 2000
231 4.2.9 number-up (integer(1:MAX)) 102
232 4.2.10 orientation-requested (type2 enum) 103
233 4.2.11 media (type3 keyword | name(MAX)) 104
234 4.2.12 printer-resolution (resolution) 105
235 4.2.13 print-quality (type2 enum) 105
236 4.3 Job Description Attributes 106
237 4.3.1 job-uri (uri) 107
238 4.3.2 job-id (integer(1:MAX)) 108
239 4.3.3 job-printer-uri (uri) 108
240 4.3.4 job-more-info (uri) 108
241 4.3.5 job-name (name(MAX)) 108
242 4.3.6 job-originating-user-name (name(MAX)) 109
243 4.3.7 job-state (type1 enum) 109
244 4.3.7.1 Forwarding Servers 112
245 4.3.7.2 Partitioning of Job States 112
246 4.3.8 job-state-reasons (1setOf type2 keyword) 113
247 4.3.9 job-state-message (text(MAX)) 118
248 4.3.10 job-detailed-status-messages (1setOf text(MAX)) 118
249 4.3.11 job-document-access-errors (1setOf text(MAX)) 118
250 4.3.12 number-of-documents (integer(0:MAX)) 119
251 4.3.13 output-device-assigned (name(127)) 119
252 4.3.14 Event Time Job Description Attributes 119
253 4.3.14.1 time-at-creation (integer(MIN:MAX)) 120
254 4.3.14.2 time-at-processing (integer(MIN:MAX)) 120
255 4.3.14.3 time-at-completed (integer(MIN:MAX)) 120
256 4.3.14.4 job-printer-up-time (integer(1:MAX)) 120
257 4.3.14.5 date-time-at-creation (dateTime) 121
258 4.3.14.6 date-time-at-processing (dateTime) 121
259 4.3.14.7 date-time-at-completed (dateTime) 121
260 4.3.15 number-of-intervening-jobs (integer(0:MAX)) 121
261 4.3.16 job-message-from-operator (text(127)) 121
262 4.3.17 Job Size Attributes 121
263 4.3.17.1 job-k-octets (integer(0:MAX)) 122
264 4.3.17.2 job-impressions (integer(0:MAX)) 122
265 4.3.17.3 job-media-sheets (integer(0:MAX)) 123
266 4.3.18 Job Progress Attributes 123
267 4.3.18.1 job-k-octets-processed (integer(0:MAX)) 123
268 4.3.18.2 job-impressions-completed (integer(0:MAX)) 123
269 4.3.18.3 job-media-sheets-completed (integer(0:MAX)) 124
270 4.3.19 attributes-charset (charset) 124
271 4.3.20 attributes-natural-language (naturalLanguage) 124
272 4.4 Printer Description Attributes 124
273 4.4.1 printer-uri-supported (1setOf uri) 126
274 4.4.2 uri-authentication-supported (1setOf type2 keyword) 127
275 4.4.3 uri-security-supported (1setOf type2 keyword) 128
276 4.4.4 printer-name (name(127)) 129
277 4.4.5 printer-location (text(127)) 129
278 4.4.6 printer-info (text(127)) 130
282 Hastings, et al. Standards Track [Page 5]
284 RFC 2911 IPP/1.1: Model and Semantics September 2000
287 4.4.7 printer-more-info (uri) 130
288 4.4.8 printer-driver-installer (uri) 130
289 4.4.9 printer-make-and-model (text(127)) 130
290 4.4.10 printer-more-info-manufacturer (uri) 130
291 4.4.11 printer-state (type1 enum) 131
292 4.4.12 printer-state-reasons (1setOf type2 keyword) 131
293 4.4.13 printer-state-message (text(MAX)) 134
294 4.4.14 ipp-versions-supported (1setOf type2 keyword) 134
295 4.4.15 operations-supported (1setOf type2 enum) 135
296 4.4.16 multiple-document-jobs-supported (boolean) 136
297 4.4.17 charset-configured (charset) 136
298 4.4.18 charset-supported (1setOf charset) 137
299 4.4.19 natural-language-configured (naturalLanguage) 137
300 4.4.20 generated-natural-language-supported
301 (1setOf naturalLanguage) 137
302 4.4.21 document-format-default (mimeMediaType) 138
303 4.4.22 document-format-supported (1setOf mimeMediaType) 138
304 4.4.23 printer-is-accepting-jobs (boolean) 138
305 4.4.24 queued-job-count (integer(0:MAX)) 138
306 4.4.25 printer-message-from-operator (text(127)) 139
307 4.4.26 color-supported (boolean) 139
308 4.4.27 reference-uri-schemes-supported (1setOf uriScheme) 139
309 4.4.28 pdl-override-supported (type2 keyword) 139
310 4.4.29 printer-up-time (integer(1:MAX)) 140
311 4.4.30 printer-current-time (dateTime) 140
312 4.4.31 multiple-operation-time-out (integer(1:MAX)) 141
313 4.4.32 compression-supported (1setOf type3 keyword) 141
314 4.4.33 job-k-octets-supported (rangeOfInteger(0:MAX)) 142
315 4.4.34 job-impressions-supported (rangeOfInteger(0:MAX)) 142
316 4.4.35 job-media-sheets-supported (rangeOfInteger(0:MAX)) 142
317 4.4.36 pages-per-minute (integer(0:MAX)) 142
318 4.4.37 pages-per-minute-color (integer(0:MAX)) 142
320 5.1 Client Conformance Requirements 143
321 5.2 IPP Object Conformance Requirements 145
324 5.2.3 IPP Object Attributes 146
327 5.2.6 Attribute Syntaxes 147
329 5.3 Charset and Natural Language Requirements 148
330 6. IANA Considerations 148
331 6.1 Typed 'keyword' and 'enum' Extensions 149
332 6.2 Attribute Extensibility 151
333 6.3 Attribute Syntax Extensibility 152
334 6.4 Operation Extensibility 152
338 Hastings, et al. Standards Track [Page 6]
340 RFC 2911 IPP/1.1: Model and Semantics September 2000
343 6.5 Attribute Group Extensibility 153
344 6.6 Status Code Extensibility 153
345 6.7 Out-of-band Attribute Value Extensibility 154
346 6.8 Registration of MIME types/sub-types for document-formats 154
347 6.9 Registration of charsets for use in 'charset'
349 7. Internationalization Considerations 154
350 8. Security Considerations 158
351 8.1 Security Scenarios 159
352 8.1.1 Client and Server in the Same Security Domain 159
353 8.1.2 Client and Server in Different Security Domains 159
354 8.1.3 Print by Reference 160
355 8.2 URIs in Operation, Job, and Printer attributes 160
356 8.3 URIs for each authentication mechanisms 160
357 8.4 Restricted Queries 161
358 8.5 Operations performed by operators and system
360 8.6 Queries on jobs submitted using non-IPP protocols 162
362 10. Authors' Addresses 166
363 11. Formats for IPP Registration Proposals 168
364 11.1 Type2 keyword attribute values registration 169
365 11.2 Type3 keyword attribute values registration 169
366 11.3 Type2 enum attribute values registration 169
367 11.4 Type3 enum attribute values registration 170
368 11.5 Attribute registration 170
369 11.6 Attribute Syntax registration 171
370 11.7 Operation registration 171
371 11.8 Attribute Group registration 171
372 11.9 Status code registration 172
373 11.10 Out-of-band Attribute Value registration 172
374 12. APPENDIX A: Terminology 173
375 12.1 Conformance Terminology 173
377 12.2 Model Terminology 173
379 12.2.2 Attributes 173
380 12.2.2.1 Attribute Name 173
381 12.2.2.2 Attribute Group Name 174
382 12.2.2.3 Attribute Value 174
383 12.2.2.4 Attribute Syntax 174
385 12.2.4 print-stream page 176
386 12.2.5 impression 177
387 13. APPENDIX B: Status Codes and Suggested Status Code Messages 177
388 13.1 Status Codes 178
389 13.1.1 Informational 178
390 13.1.2 Successful Status Codes 178
394 Hastings, et al. Standards Track [Page 7]
396 RFC 2911 IPP/1.1: Model and Semantics September 2000
399 13.1.2.1 successful-ok (0x0000) 178
400 13.1.2.2 successful-ok-ignored-or-substituted-attributes
402 13.1.2.3 successful-ok-conflicting-attributes (0x0002) 179
403 13.1.3 Redirection Status Codes 179
404 13.1.4 Client Error Status Codes 179
405 13.1.4.1 client-error-bad-request (0x0400) 180
406 13.1.4.2 client-error-forbidden (0x0401) 180
407 13.1.4.3 client-error-not-authenticated (0x0402) 180
408 13.1.4.4 client-error-not-authorized (0x0403) 180
409 13.1.4.5 client-error-not-possible (0x0404) 180
410 13.1.4.6 client-error-timeout (0x0405) 181
411 13.1.4.7 client-error-not-found (0x0406) 181
412 13.1.4.8 client-error-gone (0x0407) 181
413 13.1.4.9 client-error-request-entity-too-large (0x0408) 182
414 13.1.4.10 client-error-request-value-too-long (0x0409) 182
415 13.1.4.11 client-error-document-format-not-supported (0x040A) 182
416 13.1.4.12 client-error-attributes-or-values-not-supported
418 13.1.4.13 client-error-uri-scheme-not-supported (0x040C) 183
419 13.1.4.14 client-error-charset-not-supported (0x040D) 183
420 13.1.4.15 client-error-conflicting-attributes (0x040E) 183
421 13.1.4.16 client-error-compression-not-supported (0x040F) 184
422 13.1.4.17 client-error-compression-error (0x0410) 184
423 13.1.4.18 client-error-document-format-error (0x0411) 184
424 13.1.4.19 client-error-document-access-error (0x0412) 184
425 13.1.5 Server Error Status Codes 185
426 13.1.5.1 server-error-internal-error (0x0500) 185
427 13.1.5.2 server-error-operation-not-supported (0x0501) 185
428 13.1.5.3 server-error-service-unavailable (0x0502) 185
429 13.1.5.4 server-error-version-not-supported (0x0503) 185
430 13.1.5.5 server-error-device-error (0x0504) 186
431 13.1.5.6 server-error-temporary-error (0x0505) 186
432 13.1.5.7 server-error-not-accepting-jobs (0x0506) 187
433 13.1.5.8 server-error-busy (0x0507) 187
434 13.1.5.9 server-error-job-canceled (0x0508) 187
435 13.1.5.10 server-error-multiple-document-jobs-not-supported
437 13.2 Status Codes for IPP Operations 187
438 14. APPENDIX C: "media" keyword values 190
439 15. APPENDIX D: Processing IPP Attributes 208
441 15.2 Page Description Language (PDL) Override 210
442 15.3 Using Job Template Attributes During Document Processing 212
443 16. APPENDIX E: Generic Directory Schema 214
444 17. APPENDIX F: Differences between the IPP/1.0 and IPP/1.1
445 "Model and Semantics" Documents 215
446 18. Full Copyright Statement 224
450 Hastings, et al. Standards Track [Page 8]
452 RFC 2911 IPP/1.1: Model and Semantics September 2000
457 The Internet Printing Protocol (IPP) is an application level protocol
458 that can be used for distributed printing using Internet tools and
459 technologies. IPP version 1.1 (IPP/1.1) focuses primarily on end
460 user functionality with a few administrative operations included.
461 This document is just one of a suite of documents that fully define
462 IPP. The full set of IPP documents includes:
464 Design Goals for an Internet Printing Protocol [RFC2567]
465 Rationale for the Structure and Model and Protocol for the Internet
466 Printing Protocol [RFC2568]
467 Internet Printing Protocol/1.1: Model and Semantics (this document)
468 Internet Printing Protocol/1.1: Encoding and Transport [RFC2910]
469 Internet Printing Protocol/1.1: Implementer's Guide [IPP-IIG]
470 Mapping between LPD and IPP Protocols [RFC2569]
472 Anyone reading these documents for the first time is strongly
473 encouraged to read the IPP documents in the above order.
475 This document is laid out as follows:
477 - The rest of Section 1 is an introduction to the IPP simplified
478 model for distributed printing.
479 - Section 2 introduces the object types covered in the model with
480 their basic behaviors, attributes, and interactions.
481 - Section 3 defines the operations included in IPP/1.1. IPP
482 operations are synchronous, therefore, for each operation, there is
483 a both request and a response.
484 - Section 4 defines the attributes (and their syntaxes) that are used
486 - Sections 5 - 6 summarizes the implementation conformance
487 requirements for objects that support the protocol and IANA
488 considerations, respectively.
489 - Sections 7 - 11 cover the Internationalization and Security
490 considerations as well as References, Author contact information,
491 and Formats for Registration Proposals.
492 - Sections 12 - 14 are appendices that cover Terminology, Status
493 Codes and Messages, and "media" keyword values.
495 Note: This document uses terms such as "attributes", "keywords",
496 and "support". These terms have special meaning and are defined
497 in the model terminology section 12.2. Capitalized terms, such
498 as MUST, MUST NOT, REQUIRED, SHOULD, SHOULD NOT, MAY, NEED NOT,
499 and OPTIONAL, have special meaning relating to conformance.
500 These terms are defined in section 12.1 on conformance
501 terminology, most of which is taken from RFC 2119 [RFC2119].
506 Hastings, et al. Standards Track [Page 9]
508 RFC 2911 IPP/1.1: Model and Semantics September 2000
511 - Section 15 is an appendix that helps to clarify the effects of
512 interactions between related attributes and their values.
513 - Section 16 is an appendix that enumerates the subset of Printer
514 attributes that form a generic directory schema. These attributes
515 are useful when registering a Printer so that a client can find the
516 Printer not just by name, but by filtered searches as well.
517 - Section 17 is an appendix summarizing the additions and changes
518 from the IPP/1.0 "Model and Semantics" document [RFC2566] to make
519 this IPP/1.1 document.
520 - Section 18 is the full copyright notice.
522 1.1 Simplified Printing Model
524 In order to achieve its goal of realizing a workable printing
525 protocol for the Internet, the Internet Printing Protocol (IPP) is
526 based on a simplified printing model that abstracts the many
527 components of real world printing solutions. The Internet is a
528 distributed computing environment where requesters of print services
529 (clients, applications, printer drivers, etc.) cooperate and interact
530 with print service providers. This model and semantics document
531 describes a simple, abstract model for IPP even though the underlying
532 configurations may be complex "n-tier" client/server systems. An
533 important simplifying step in the IPP model is to expose only the key
534 objects and interfaces required for printing. The model described in
535 this model document does not include features, interfaces, and
536 relationships that are beyond the scope of the first version of IPP
537 (IPP/1.1). IPP/1.1 incorporates many of the relevant ideas and
538 lessons learned from other specification and development efforts
539 [HTPP] [ISO10175] [LDPA] [P1387.4] [PSIS] [RFC1179] [SWP]. IPP is
540 heavily influenced by the printing model introduced in the Document
541 Printing Application (DPA) [ISO10175] standard. Although DPA
542 specifies both end user and administrative features, IPP version 1.1
543 (IPP/1.1) focuses primarily on end user functionality with a few
544 additional OPTIONAL operator operations.
546 The IPP/1.1 model encapsulates the important components of
547 distributed printing into two object types:
549 - Printer (Section 2.1)
552 Each object type has an associated set of operations (see section 3)
553 and attributes (see section 4).
562 Hastings, et al. Standards Track [Page 10]
564 RFC 2911 IPP/1.1: Model and Semantics September 2000
567 It is important, however, to understand that in real system
568 implementations (which lie underneath the abstracted IPP/1.1 model),
569 there are other components of a print service which are not
570 explicitly defined in the IPP/1.1 model. The following figure
571 illustrates where IPP/1.1 fits with respect to these other
578 / \ +. . . . . . . | +---------+
579 End-User | Print Driver |---| File |
580 +-----------+ +-----+ +------+-------+ +----+----+
581 | Browser | | GUI | | |
582 +-----+-----+ +--+--+ | |
584 | +---+------------+---+ |
585 N D S | | IPP Client |------------+
586 O I E | +---------+----------+
589 F C R -------------- Transport ------------------
592 A R Y +--------+--------+ |
594 I +--------+--------+ |
596 N +-----------------+ | IPP Printer
598 +-----------------+ |
604 An IPP Printer object encapsulates the functions normally associated
605 with physical output devices along with the spooling, scheduling and
606 multiple device management functions often associated with a print
607 server. Printer objects are optionally registered as entries in a
608 directory where end users find and select them based on some sort of
609 filtered and context based searching mechanism (see section 16). The
610 directory is used to store relatively static information about the
611 Printer, allowing end users to search for and find Printers that
612 match their search criteria, for example: name, context, printer
613 capabilities, etc. The more dynamic information, such as state,
614 currently loaded and ready media, number of jobs at the Printer,
618 Hastings, et al. Standards Track [Page 11]
620 RFC 2911 IPP/1.1: Model and Semantics September 2000
623 errors, warnings, and so forth, is directly associated with the
624 Printer object itself rather than with the entry in the directory
625 which only represents the Printer object.
627 IPP clients implement the IPP protocol on the client side and give
628 end users (or programs running on behalf of end users) the ability to
629 query Printer objects and submit and manage print jobs. An IPP
630 server is just that part of the Printer object that implements the
631 server-side protocol. The rest of the Printer object implements (or
632 gateways into) the application semantics of the print service itself.
633 The Printer objects may be embedded in an output device or may be
634 implemented on a host on the network that communicates with an output
637 When a job is submitted to the Printer object and the Printer object
638 validates the attributes in the submission request, the Printer
639 object creates a new Job object. The end user then interacts with
640 this new Job object to query its status and monitor the progress of
641 the job. An end user can also cancel their print jobs by using the
642 Job object's Cancel-Job operation. An end-user can also hold,
643 release, and restart their print jobs using the Job object's OPTIONAL
644 Hold-Job, Release-Job, and Restart-Job operations, if implemented.
646 A privileged operator or administrator of a Printer object can
647 cancel, hold, release, and restart any user's job using the REQUIRED
648 Cancel-Job and the OPTIONAL Hold-Job, Release-Job, and Restart-Job
649 operations. In additional privileged operator or administrator of a
650 Printer object can pause, resume, or purge (jobs from) a Printer
651 object using the OPTIONAL Pause-Printer, Resume-Printer, and Purge-
652 Jobs operations, if implemented.
654 The notification service is out of scope for this IPP/1.1 document,
655 but using such a notification service, the end user is able to
656 register for and receive Printer specific and Job specific events.
657 An end user can query the status of Printer objects and can follow
658 the progress of Job objects by polling using the Get-Printer-
659 Attributes, Get-Jobs, and Get-Job-Attributes operations.
663 The IPP/1.1 model introduces objects of type Printer and Job. Each
664 type of object models relevant aspects of a real-world entity such as
665 a real printer or real print job. Each object type is defined as a
666 set of possible attributes that may be supported by instances of that
667 object type. For each object (instance), the actual set of supported
668 attributes and values describe a specific implementation. The
669 object's attributes and values describe its state, capabilities,
670 realizable features, job processing functions, and default behaviors
674 Hastings, et al. Standards Track [Page 12]
676 RFC 2911 IPP/1.1: Model and Semantics September 2000
679 and characteristics. For example, the Printer object type is defined
680 as a set of attributes that each Printer object potentially supports.
681 In the same manner, the Job object type is defined as a set of
682 attributes that are potentially supported by each Job object.
684 Each attribute included in the set of attributes defining an object
687 - "REQUIRED": each object MUST support the attribute.
688 - "RECOMMENDED": each object SHOULD support the attribute.
689 - "OPTIONAL": each object MAY support the attribute.
691 Some definitions of attribute values indicate that an object MUST or
692 SHOULD support the value; otherwise, support of the value is
695 However, if an implementation supports an attribute, it MUST support
696 at least one of the possible values for that attribute.
700 The major component of the IPP/1.1 model is the Printer object. A
701 Printer object implements the server-side of the IPP/1.1 protocol.
702 Using the protocol, end users may query the attributes of the Printer
703 object and submit print jobs to the Printer object. The actual
704 implementation components behind the Printer abstraction may take on
705 different forms and different configurations. However, the model
706 abstraction allows the details of the configuration of real
707 components to remain opaque to the end user. Section 3 describes
708 each of the Printer operations in detail.
710 The capabilities and state of a Printer object are described by its
711 attributes. Printer attributes are divided into two groups:
713 - "job-template" attributes: These attributes describe supported job
714 processing capabilities and defaults for the Printer object. (See
716 - "printer-description" attributes: These attributes describe the
717 Printer object's identification, state, location, references to
718 other sources of information about the Printer object, etc. (see
721 Since a Printer object is an abstraction of a generic document output
722 device and print service provider, a Printer object could be used to
723 represent any real or virtual device with semantics consistent with
724 the Printer object, such as a fax device, an imager, or even a CD
730 Hastings, et al. Standards Track [Page 13]
732 RFC 2911 IPP/1.1: Model and Semantics September 2000
735 Some examples of configurations supporting a Printer object include:
737 1) An output device with no spooling capabilities
738 2) An output device with a built-in spooler
739 3) A print server supporting IPP with one or more associated
741 3a) The associated output devices may or may not be capable of
743 3b) The associated output devices may or may not support IPP
745 The following figures show some examples of how Printer objects can
746 be realized on top of various distributed printing configurations.
747 The embedded case below represents configurations 1 and 2. The hosted
748 and fan-out figures below represent configurations 3a and 3b.
750 In this document the term "client" refers to a software entity that
751 sends IPP operation requests to an IPP Printer object and accepts IPP
752 operation responses. A client MAY be:
754 1. contained within software controlled by an end user, e.g.
755 activated by the "Print" menu item in an application or
757 2. the print server component that sends IPP requests to either an
758 output device or another "downstream" print server.
760 The term "IPP Printer" is a network entity that accepts IPP operation
761 requests and returns IPP operation responses. As such, an IPP object
764 1. an (embedded) device component that accepts IPP requests and
765 controls the device or
767 2. a component of a print server that accepts IPP requests (where
768 the print server controls one or more networked devices using
769 IPP or other protocols).
773 ##### indicates a Printer object which is
774 either embedded in an output device or is
775 hosted in a server. The Printer object
776 might or might not be capable of queuing/spooling.
778 any indicates any network protocol or direct
779 connect, including IPP
786 Hastings, et al. Standards Track [Page 14]
788 RFC 2911 IPP/1.1: Model and Semantics September 2000
794 O +--------+ | ########### |
795 /|\ | client |------------IPP------------># Printer # |
796 / \ +--------+ | # Object # |
802 O +--------+ ########### | |
803 /|\ | client |--IPP--># Printer #-any->| output device |
804 / \ +--------+ # Object # | |
805 ########### +---------------+
810 +-->| output device |
812 O +--------+ ########### / +---------------+
813 /|\ | client |-IPP-># Printer #--*
814 / \ +--------+ # Object # \ +---------------+
816 +-->| output device |
822 A Job object is used to model a print job. A Job object contains
823 documents. The information required to create a Job object is sent
824 in a create request from the end user via an IPP Client to the
825 Printer object. The Printer object validates the create request, and
826 if the Printer object accepts the request, the Printer object creates
827 the new Job object. Section 3 describes each of the Job operations
830 The characteristics and state of a Job object are described by its
831 attributes. Job attributes are grouped into two groups as follows:
833 - "job-template" attributes: These attributes can be supplied by
834 the client or end user and include job processing instructions
835 which are intended to override any Printer object defaults
836 and/or instructions embedded within the document data. (See
842 Hastings, et al. Standards Track [Page 15]
844 RFC 2911 IPP/1.1: Model and Semantics September 2000
847 - "job-description" attributes: These attributes describe the Job
848 object's identification, state, size, etc. The client supplies
849 some of these attributes, and the Printer object generates
850 others. (See section 4.3)
852 An implementation MUST support at least one document per Job object.
853 An implementation MAY support multiple documents per Job object. A
856 - a stream of document data in a format supported by the Printer
857 object (typically a Page Description Language - PDL), or
858 - a reference to such a stream of document data
860 In IPP/1.1, a document is not modeled as an IPP object, therefore it
861 has no object identifier or associated attributes. All job
862 processing instructions are modeled as Job object attributes. These
863 attributes are called Job Template attributes and they apply equally
864 to all documents within a Job object.
866 2.3 Object Relationships
868 IPP objects have relationships that are maintained persistently along
869 with the persistent storage of the object attributes.
871 A Printer object can represent either one or more physical output
872 devices or a logical device which "processes" jobs but never actually
873 uses a physical output device to put marks on paper. Examples of
874 logical devices include a Web page publisher or a gateway into an
875 online document archive or repository. A Printer object contains
876 zero or more Job objects.
878 A Job object is contained by exactly one Printer object, however the
879 identical document data associated with a Job object could be sent to
880 either the same or a different Printer object. In this case, a
881 second Job object would be created which would be almost identical to
882 the first Job object, however it would have new (different) Job
883 object identifiers (see section 2.4).
885 A Job object is either empty (before any documents have been added)
886 or contains one or more documents. If the contained document is a
887 stream of document data, that stream can be contained in only one
888 document. However, there can be identical copies of the stream in
889 other documents in the same or different Job objects. If the
890 contained document is just a reference to a stream of document data,
891 other documents (in the same or different Job object(s)) may contain
898 Hastings, et al. Standards Track [Page 16]
900 RFC 2911 IPP/1.1: Model and Semantics September 2000
905 All Printer and Job objects are identified by a Uniform Resource
906 Identifier (URI) [RFC2396] so that they can be persistently and
907 unambiguously referenced. Since every URL is a specialized form of a
908 URI, even though the more generic term URI is used throughout the
909 rest of this document, its usage is intended to cover the more
910 specific notion of URL as well.
912 An administrator configures Printer objects to either support or not
913 support authentication and/or message privacy using Transport Layer
914 Security (TLS) [RFC2246] (the mechanism for security configuration is
915 outside the scope of this IPP/1.1 document). In some situations,
916 both types of connections (both authenticated and unauthenticated)
917 can be established using a single communication channel that has some
918 sort of negotiation mechanism. In other situations, multiple
919 communication channels are used, one for each type of security
920 configuration. Section 8 provides a full description of all security
921 considerations and configurations.
923 If a Printer object supports more than one communication channel,
924 some or all of those channels might support and/or require different
925 security mechanisms. In such cases, an administrator could expose
926 the simultaneous support for these multiple communication channels as
927 multiple URIs for a single Printer object where each URI represents
928 one of the communication channels to the Printer object. To support
929 this flexibility, the IPP Printer object type defines a multi-valued
930 identification attribute called the "printer-uri-supported"
931 attribute. It MUST contain at least one URI. It MAY contain more
932 than one URI. That is, every Printer object will have at least one
933 URI that identifies at least one communication channel to the Printer
934 object, but it may have more than one URI where each URI identifies a
935 different communication channel to the Printer object. The
936 "printer-uri-supported" attribute has two companion attributes, the
937 "uri-security-supported" attribute and the "uri-authentication-
938 supported". Both have the same cardinality as "printer-uri-
939 supported". The purpose of the "uri-security-supported" attribute is
940 to indicate the security mechanisms (if any) used for each URI listed
941 in "printer-uri-supported". The purpose of the "uri-authentication-
942 supported" attribute is to indicate the authentication mechanisms (if
943 any) used for each URI listed in "printer-uri-supported". These
944 three attributes are fully described in sections 4.4.1, 4.4.2, and
947 When a job is submitted to the Printer object via a create request,
948 the client supplies only a single Printer object URI. The client
949 supplied Printer object URI MUST be one of the values in the
950 "printer-uri-supported" Printer attribute.
954 Hastings, et al. Standards Track [Page 17]
956 RFC 2911 IPP/1.1: Model and Semantics September 2000
959 IPP/1.1 does not specify how the client obtains the client supplied
960 URI, but it is RECOMMENDED that a Printer object be registered as an
961 entry in a directory service. End-users and programs can then
962 interrogate the directory searching for Printers. Section 16 defines
963 a generic schema for Printer object entries in the directory service
964 and describes how the entry acts as a bridge to the actual IPP
965 Printer object. The entry in the directory that represents the IPP
966 Printer object includes the possibly many URIs for that Printer
967 object as values in one its attributes.
969 When a client submits a create request to the Printer object, the
970 Printer object validates the request and creates a new Job object.
971 The Printer object assigns the new Job object a URI which is stored
972 in the "job-uri" Job attribute. This URI is then used by clients as
973 the target for subsequent Job operations. The Printer object
974 generates a Job URI based on its configured security policy and the
975 URI used by the client in the create request.
977 For example, consider a Printer object that supports both a
978 communication channel secured by the use of SSL3 (using HTTP over
979 SSL3 with an "https" schemed URI) and another open communication
980 channel that is not secured with SSL3 (using a simple "http" schemed
981 URI). If a client were to submit a job using the secure URI, the
982 Printer object would assign the new Job object a secure URI as well.
983 If a client were to submit a job using the open-channel URI, the
984 Printer would assign the new Job object an open-channel URI.
986 In addition, the Printer object also populates the Job object's
987 "job-printer-uri" attribute. This is a reference back to the Printer
988 object that created the Job object. If a client only has access to a
989 Job object's "job-uri" identifier, the client can query the Job's
990 "job-printer-uri" attribute in order to determine which Printer
991 object created the Job object. If the Printer object supports more
992 than one URI, the Printer object picks the one URI supplied by the
993 client when creating the job to build the value for and to populate
994 the Job's "job-printer-uri" attribute.
996 Allowing Job objects to have URIs allows for flexibility and
997 scalability. For example, in some implementations, the Printer
998 object might create Jobs that are processed in the same local
999 environment as the Printer object itself. In this case, the Job URI
1000 might just be a composition of the Printer's URI and some unique
1001 component for the Job object, such as the unique 32-bit positive
1002 integer mentioned later in this paragraph. In other implementations,
1003 the Printer object might be a central clearing-house for validating
1004 all Job object creation requests, but the Job object itself might be
1005 created in some environment that is remote from the Printer object.
1006 In this case, the Job object's URI may have no physical-location
1010 Hastings, et al. Standards Track [Page 18]
1012 RFC 2911 IPP/1.1: Model and Semantics September 2000
1015 relationship at all to the Printer object's URI. Again, the fact
1016 that Job objects have URIs allows for flexibility and scalability,
1017 however, many existing printing systems have local models or
1018 interface constraints that force print jobs to be identified using
1019 only a 32-bit positive integer rather than an independent URI. This
1020 numeric Job ID is only unique within the context of the Printer
1021 object to which the create request was originally submitted.
1022 Therefore, in order to allow both types of client access to IPP Job
1023 objects (either by Job URI or by numeric Job ID), when the Printer
1024 object successfully processes a create request and creates a new Job
1025 object, the Printer object MUST generate both a Job URI and a Job ID.
1026 The Job ID (stored in the "job-id" attribute) only has meaning in the
1027 context of the Printer object to which the create request was
1028 originally submitted. This requirement to support both Job URIs and
1029 Job IDs allows all types of clients to access Printer objects and Job
1030 objects no matter the local constraints imposed on the client
1033 In addition to identifiers, Printer objects and Job objects have
1034 names ("printer-name" and "job-name"). An object name NEED NOT be
1035 unique across all instances of all objects. A Printer object's name
1036 is chosen and set by an administrator through some mechanism outside
1037 the scope of this IPP/1.1 document. A Job object's name is
1038 optionally chosen and supplied by the IPP client submitting the job.
1039 If the client does not supply a Job object name, the Printer object
1040 generates a name for the new Job object. In all cases, the name only
1045 - Each Printer object is identified with one or more URIs. The
1046 Printer's "printer-uri-supported" attribute contains the URI(s).
1047 - The Printer object's "uri-security-supported" attribute
1048 identifies the communication channel security protocols that may
1049 or may not have been configured for the various Printer object
1050 URIs (e.g., 'tls' or 'none').
1051 - The Printer object's "uri-authentication-supported" attribute
1052 identifies the authentication mechanisms that may or may not
1053 have been configured for the various Printer object URIs (e.g.,
1054 'digest' or 'none').
1055 - Each Job object is identified with a Job URI. The Job's "job-
1056 uri" attribute contains the URI.
1057 - Each Job object is also identified with Job ID which is a 32-
1058 bit, positive integer. The Job's "job-id" attribute contains
1059 the Job ID. The Job ID is only unique within the context of the
1060 Printer object which created the Job object.
1066 Hastings, et al. Standards Track [Page 19]
1068 RFC 2911 IPP/1.1: Model and Semantics September 2000
1071 - Each Job object has a "job-printer-uri" attribute which contains
1072 the URI of the Printer object that was used to create the Job
1073 object. This attribute is used to determine the Printer object
1074 that created a Job object when given only the URI for the Job
1075 object. This linkage is necessary to determine the languages,
1076 charsets, and operations which are supported on that Job (the
1077 basis for such support comes from the creating Printer object).
1078 - Each Printer object has a name (which is not necessarily
1079 unique). The administrator chooses and sets this name through
1080 some mechanism outside the scope of this IPP/1.1 document. The
1081 Printer object's "printer-name" attribute contains the name.
1082 - Each Job object has a name (which is not necessarily unique).
1083 The client optionally supplies this name in the create request.
1084 If the client does not supply this name, the Printer object
1085 generates a name for the Job object. The Job object's "job-name"
1086 attribute contains the name.
1090 IPP objects support operations. An operation consists of a request
1091 and a response. When a client communicates with an IPP object, the
1092 client issues an operation request to the URI for that object.
1093 Operation requests and responses have parameters that identify the
1094 operation. Operations also have attributes that affect the run-time
1095 characteristics of the operation (the intended target, localization
1096 information, etc.). These operation-specific attributes are called
1097 operation attributes (as compared to object attributes such as
1098 Printer object attributes or Job object attributes). Each request
1099 carries along with it any operation attributes, object attributes,
1100 and/or document data required to perform the operation. Each request
1101 requires a response from the object. Each response indicates success
1102 or failure of the operation with a status code as a response
1103 parameter. The response contains any operation attributes, object
1104 attributes, and/or status messages generated during the execution of
1105 the operation request.
1107 This section describes the semantics of the IPP operations, both
1108 requests and responses, in terms of the parameters, attributes, and
1109 other data associated with each operation.
1122 Hastings, et al. Standards Track [Page 20]
1124 RFC 2911 IPP/1.1: Model and Semantics September 2000
1127 The IPP/1.1 Printer operations are:
1129 Print-Job (section 3.2.1)
1130 Print-URI (section 3.2.2)
1131 Validate-Job (section 3.2.3)
1132 Create-Job (section 3.2.4)
1133 Get-Printer-Attributes (section 3.2.5)
1134 Get-Jobs (section 3.2.6)
1135 Pause-Printer (section 3.3.5)
1136 Resume-Printer (section 3.3.6)
1137 Purge-Jobs (section 3.3.7)
1139 The Job operations are:
1141 Send-Document (section 3.3.1)
1142 Send-URI (section 3.3.2)
1143 Cancel-Job (section 3.3.3)
1144 Get-Job-Attributes (section 3.3.4)
1145 Hold-Job (section 3.3.5)
1146 Release-Job (section 3.3.6)
1147 Restart-Job (section 3.3.7)
1149 The Send-Document and Send-URI Job operations are used to add a new
1150 document to an existing multi-document Job object created using the
1151 Create-Job operation.
1153 3.1 Common Semantics
1155 All IPP operations require some common parameters and operation
1156 attributes. These common elements and their semantic characteristics
1157 are defined and described in more detail in the following sections.
1159 3.1.1 Required Parameters
1161 Every operation request contains the following REQUIRED parameters:
1163 - a "version-number",
1164 - an "operation-id",
1165 - a "request-id", and
1166 - the attributes that are REQUIRED for that type of request.
1168 Every operation response contains the following REQUIRED parameters:
1170 - a "version-number",
1172 - the "request-id" that was supplied in the corresponding request,
1174 - the attributes that are REQUIRED for that type of response.
1178 Hastings, et al. Standards Track [Page 21]
1180 RFC 2911 IPP/1.1: Model and Semantics September 2000
1183 The "Encoding and Transport" document [RFC2910] defines special rules
1184 for the encoding of these parameters. All other operation elements
1185 are represented using the more generic encoding rules for attributes
1186 and groups of attributes.
1188 3.1.2 Operation IDs and Request IDs
1190 Each IPP operation request includes an identifying "operation-id"
1191 value. Valid values are defined in the "operations-supported"
1192 Printer attribute section (see section 4.4.15). The client specifies
1193 which operation is being requested by supplying the correct
1194 "operation-id" value.
1196 In addition, every invocation of an operation is identified by a
1197 "request-id" value. For each request, the client chooses the
1198 "request-id" which MUST be an integer (possibly unique depending on
1199 client requirements) in the range from 1 to 2**31 - 1 (inclusive).
1200 This "request-id" allows clients to manage multiple outstanding
1201 requests. The receiving IPP object copies all 32-bits of the client-
1202 supplied "request-id" attribute into the response so that the client
1203 can match the response with the correct outstanding request, even if
1204 the "request-id" is out of range. If the request is terminated
1205 before the complete "request-id" is received, the IPP object rejects
1206 the request and returns a response with a "request-id" of 0.
1208 Note: In some cases, the transport protocol underneath IPP might be a
1209 connection oriented protocol that would make it impossible for a
1210 client to receive responses in any order other than the order in
1211 which the corresponding requests were sent. In such cases, the
1212 "request-id" attribute would not be essential for correct protocol
1213 operation. However, in other mappings, the operation responses can
1214 come back in any order. In these cases, the "request-id" would be
1219 Operation requests and responses are both composed of groups of
1220 attributes and/or document data. The attributes groups are:
1222 - Operation Attributes: These attributes are passed in the
1223 operation and affect the IPP object's behavior while processing
1224 the operation request and may affect other attributes or groups
1225 of attributes. Some operation attributes describe the document
1226 data associated with the print job and are associated with new
1227 Job objects, however most operation attributes do not persist
1228 beyond the life of the operation. The description of each
1229 operation attribute includes conformance statements indicating
1230 which operation attributes are REQUIRED and which are OPTIONAL
1234 Hastings, et al. Standards Track [Page 22]
1236 RFC 2911 IPP/1.1: Model and Semantics September 2000
1239 for an IPP object to support and which attributes a client MUST
1240 supply in a request and an IPP object MUST supply in a response.
1241 - Job Template Attributes: These attributes affect the processing
1242 of a job. A client OPTIONALLY supplies Job Template Attributes
1243 in a create request, and the receiving object MUST be prepared
1244 to receive all supported attributes. The Job object can later
1245 be queried to find out what Job Template attributes were
1246 originally requested in the create request, and such attributes
1247 are returned in the response as Job Object Attributes. The
1248 Printer object can be queried about its Job Template attributes
1249 to find out what type of job processing capabilities are
1250 supported and/or what the default job processing behaviors are,
1251 though such attributes are returned in the response as Printer
1252 Object Attributes. The "ipp-attribute-fidelity" operation
1253 attribute affects processing of all client-supplied Job Template
1254 attributes (see sections 3.2.1.2 and 15 for a full description
1255 of "ipp-attribute-fidelity" and its relationship to other
1257 - Job Object Attributes: These attributes are returned in response
1258 to a query operation directed at a Job object.
1259 - Printer Object Attributes: These attributes are returned in
1260 response to a query operation directed at a Printer object.
1261 - Unsupported Attributes: In a create request, the client supplies
1262 a set of Operation and Job Template attributes. If any of these
1263 attributes or their values is unsupported by the Printer object,
1264 the Printer object returns the set of unsupported attributes in
1265 the response. Sections 3.1.7, 3.2.1.2, and 15 give a full
1266 description of how Job Template attributes supplied by the
1267 client in a create request are processed by the Printer object
1268 and how unsupported attributes are returned to the client.
1269 Because of extensibility, any IPP object might receive a request
1270 that contains new or unknown attributes or values for which it
1271 has no support. In such cases, the IPP object processes what it
1272 can and returns the unsupported attributes in the response. The
1273 Unsupported Attribute group is defined for all operation
1274 responses for returning unsupported attributes that the client
1275 supplied in the request.
1277 Later in this section, each operation is formally defined by
1278 identifying the allowed and expected groups of attributes for each
1279 request and response. The model identifies a specific order for each
1280 group in each request or response, but the attributes within each
1281 group may be in any order, unless specified otherwise.
1283 The attributes within a group MUST be unique; if an attribute with
1284 the same name occurs more than once, the group is mal-formed.
1285 Clients MUST NOT submit such malformed requests and Printers MUST NOT
1286 return such malformed responses. If such a malformed request is
1290 Hastings, et al. Standards Track [Page 23]
1292 RFC 2911 IPP/1.1: Model and Semantics September 2000
1295 submitted to a Printer, the Printer MUST either (1) reject the
1296 request with the 'client-error-bad-request' status code (see section
1297 13.1.4.1) or (2) process the request normally after selecting only
1298 one of the attribute instances, depending on implementation. Which
1299 attribute is selected when there are duplicate attributes depends on
1300 implementation. The IPP Printer MUST NOT use the values from more
1301 than one such duplicate attribute instance.
1303 Each attribute definition includes the attribute's name followed by
1304 the name of its attribute syntax(es) in parenthesizes. In addition,
1305 each 'integer' attribute is followed by the allowed range in
1306 parentheses, (m:n), for values of that attribute. Each 'text' or
1307 'name' attribute is followed by the maximum size in octets in
1308 parentheses, (size), for values of that attribute. For more details
1309 on attribute syntax notation, see the descriptions of these
1310 attributes syntaxes in section 4.1.
1312 Note: Document data included in the operation is not strictly an
1313 attribute, but it is treated as a special attribute group for
1314 ordering purposes. The only operations that support supplying the
1315 document data within an operation request are Print-Job and Send-
1316 Document. There are no operation responses that include document
1319 Some operations are REQUIRED for IPP objects to support; the others
1320 are OPTIONAL (see section 5.2.2). Therefore, before using an
1321 OPTIONAL operation, a client SHOULD first use the REQUIRED Get-
1322 Printer-Attributes operation to query the Printer's "operations-
1323 supported" attribute in order to determine which OPTIONAL Printer and
1324 Job operations are actually supported. The client SHOULD NOT use an
1325 OPTIONAL operation that is not supported. When an IPP object
1326 receives a request to perform an operation it does not support, it
1327 returns the 'server-error-operation-not-supported' status code (see
1328 section 13.1.5.2). An IPP object is non-conformant if it does not
1329 support a REQUIRED operation.
1331 3.1.4 Character Set and Natural Language Operation Attributes
1333 Some Job and Printer attributes have values that are text strings and
1334 names intended for human understanding rather than machine
1335 understanding (see the 'text' and 'name' attribute syntax
1336 descriptions in section 4.1). The following sections describe two
1337 special Operation Attributes called "attributes-charset" and
1338 "attributes-natural-language". These attributes are always part of
1339 the Operation Attributes group. For most attribute groups, the order
1340 of the attributes within the group is not important. However, for
1341 these two attributes within the Operation Attributes group, the order
1342 is critical. The "attributes-charset" attribute MUST be the first
1346 Hastings, et al. Standards Track [Page 24]
1348 RFC 2911 IPP/1.1: Model and Semantics September 2000
1351 attribute in the group and the "attributes-natural-language"
1352 attribute MUST be the second attribute in the group. In other words,
1353 these attributes MUST be supplied in every IPP request and response,
1354 they MUST come first in the group, and MUST come in the specified
1355 order. For job creation operations, the IPP Printer implementation
1356 saves these two attributes with the new Job object as Job Description
1357 attributes. For the sake of brevity in this document, these
1358 operation attribute descriptions are not repeated with every
1359 operation request and response, but have a reference back to this
1362 3.1.4.1 Request Operation Attributes
1364 The client MUST supply and the Printer object MUST support the
1365 following REQUIRED operation attributes in every IPP/1.1 operation
1368 "attributes-charset" (charset):
1369 This operation attribute identifies the charset (coded
1370 character set and encoding method) used by any 'text' and
1371 'name' attributes that the client is supplying in this request.
1372 It also identifies the charset that the Printer object MUST use
1373 (if supported) for all 'text' and 'name' attributes and status
1374 messages that the Printer object returns in the response to
1375 this request. See Sections 4.1.1 and 4.1.2 for the definition
1376 of the 'text' and 'name' attribute syntaxes.
1378 All clients and IPP objects MUST support the 'utf-8' charset
1379 [RFC2279] and MAY support additional charsets provided that
1380 they are registered with IANA [IANA-CS]. If the Printer object
1381 does not support the client supplied charset value, the Printer
1382 object MUST reject the request, set the "attributes-charset" to
1383 'utf-8' in the response, and return the 'client-error-charset-
1384 not-supported' status code and any 'text' or 'name' attributes
1385 using the 'utf-8' charset. The Printer NEED NOT return any
1386 attributes in the Unsupported Attributes Group (See sections
1387 3.1.7 and 3.2.1.2). The Printer object MUST indicate the
1388 charset(s) supported as the values of the "charset-supported"
1389 Printer attribute (see Section 4.4.18), so that the client can
1390 query to determine which charset(s) are supported.
1392 Note to client implementers: Since IPP objects are only
1393 required to support the 'utf-8' charset, in order to maximize
1394 interoperability with multiple IPP object implementations, a
1395 client may want to supply 'utf-8' in the "attributes-charset"
1396 operation attribute, even though the client is only passing and
1397 able to present a simpler charset, such as US-ASCII [ASCII] or
1398 ISO-8859-1 [ISO8859-1]. Then the client will have to filter
1402 Hastings, et al. Standards Track [Page 25]
1404 RFC 2911 IPP/1.1: Model and Semantics September 2000
1407 out (or charset convert) those characters that are returned in
1408 the response that it cannot present to its user. On the other
1409 hand, if both the client and the IPP objects also support a
1410 charset in common besides utf-8, the client may want to use
1411 that charset in order to avoid charset conversion or data loss.
1413 See the 'charset' attribute syntax description in Section 4.1.7
1414 for the syntax and semantic interpretation of the values of
1415 this attribute and for example values.
1417 "attributes-natural-language" (naturalLanguage):
1418 This operation attribute identifies the natural language used
1419 by any 'text' and 'name' attributes that the client is
1420 supplying in this request. This attribute also identifies the
1421 natural language that the Printer object SHOULD use for all
1422 'text' and 'name' attributes and status messages that the
1423 Printer object returns in the response to this request. See
1424 the 'naturalLanguage' attribute syntax description in section
1425 4.1.8 for the syntax and semantic interpretation of the values
1426 of this attribute and for example values.
1428 There are no REQUIRED natural languages required for the
1429 Printer object to support. However, the Printer object's
1430 "generated-natural-language-supported" attribute identifies the
1431 natural languages supported by the Printer object and any
1432 contained Job objects for all text strings generated by the IPP
1433 object. A client MAY query this attribute to determine which
1434 natural language(s) are supported for generated messages.
1436 For any of the attributes for which the Printer object
1437 generates text, i.e., for the "job-state-message", "printer-
1438 state-message", and status messages (see Section 3.1.6), the
1439 Printer object MUST be able to generate these text strings in
1440 any of its supported natural languages. If the client requests
1441 a natural language that is not supported, the Printer object
1442 MUST return these generated messages in the Printer's
1443 configured natural language as specified by the Printer's
1444 "natural-language-configured" attribute" (see Section 4.4.19).
1446 For other 'text' and 'name' attributes supplied by the client,
1447 authentication system, operator, system administrator, or
1448 manufacturer (i.e., for "job-originating-user-name", "printer-
1449 name" (name), "printer-location" (text), "printer-info" (text),
1450 and "printer-make-and-model" (text)), the Printer object is
1451 only required to support the configured natural language of the
1458 Hastings, et al. Standards Track [Page 26]
1460 RFC 2911 IPP/1.1: Model and Semantics September 2000
1463 Printer identified by the Printer object's "natural-language-
1464 configured" attribute, though support of additional natural
1465 languages for these attributes is permitted.
1467 For any 'text' or 'name' attribute in the request that is in a
1468 different natural language than the value supplied in the
1469 "attributes-natural-language" operation attribute, the client
1470 MUST use the Natural Language Override mechanism (see sections
1471 4.1.1.2 and 4.1.2.2) for each such attribute value supplied.
1472 The client MAY use the Natural Language Override mechanism
1473 redundantly, i.e., use it even when the value is in the same
1474 natural language as the value supplied in the "attributes-
1475 natural-language" operation attribute of the request.
1477 The IPP object MUST accept any natural language and any Natural
1478 Language Override, whether the IPP object supports that natural
1479 language or not (and independent of the value of the "ipp-
1480 attribute-fidelity" Operation attribute). That is the IPP
1481 object accepts all client supplied values no matter what the
1482 values are in the Printer object's "generated-natural-
1483 language-supported" attribute. That attribute, "generated-
1484 natural-language-supported", only applies to generated
1485 messages, not client supplied messages. The IPP object MUST
1486 remember that natural language for all client-supplied
1487 attributes, and when returning those attributes in response to
1488 a query, the IPP object MUST indicate that natural language.
1490 Each value whose attribute syntax type is 'text' or 'name' (see
1491 sections 4.1.1 and 4.1.2) has an Associated Natural-Language.
1492 This document does not specify how this association is stored
1493 in a Printer or Job object. When such a value is encoded in a
1494 request or response, the natural language is either implicit or
1497 - In the implicit case, the value contains only the text/name
1498 value, and the language is specified by the "attributes-
1499 natural-language" operation attribute in the request or
1500 response (see sections 4.1.1.1 textWithoutLanguage and
1501 4.1.2.1 nameWithoutLanguage).
1503 - In the explicit case (also known as the Natural-Language
1504 Override case), the value contains both the language and the
1505 text/name value (see sections 4.1.1.2 textWithLanguage and
1506 4.1.2.2 nameWithLanguage).
1508 For example, the "job-name" attribute MAY be supplied by the
1509 client in a create request. The text value for this attribute
1510 will be in the natural language identified by the "attribute-
1514 Hastings, et al. Standards Track [Page 27]
1516 RFC 2911 IPP/1.1: Model and Semantics September 2000
1519 natural-language" attribute, or if different, as identified by
1520 the Natural Language Override mechanism. If supplied, the IPP
1521 object will use the value of the "job-name" attribute to
1522 populate the Job object's "job-name" attribute. Whenever any
1523 client queries the Job object's "job-name" attribute, the IPP
1524 object returns the attribute as stored and uses the Natural
1525 Language Override mechanism to specify the natural language, if
1526 it is different from that reported in the "attributes-natural-
1527 language" operation attribute of the response. The IPP object
1528 MAY use the Natural Language Override mechanism redundantly,
1529 i.e., use it even when the value is in the same natural
1530 language as the value supplied in the "attributes-natural-
1531 language" operation attribute of the response.
1533 An IPP object MUST NOT reject a request based on a supplied
1534 natural language in an "attributes-natural-language" Operation
1535 attribute or in any attribute that uses the Natural Language
1538 Clients SHOULD NOT supply 'text' or 'name' attributes that use an
1539 illegal combination of natural language and charset. For example,
1540 suppose a Printer object supports charsets 'utf-8', 'iso-8859-1', and
1541 'iso-8859-7'. Suppose also, that it supports natural languages 'en'
1542 (English), 'fr' (French), and 'el' (Greek). Although the Printer
1543 object supports the charset 'iso-8859-1' and natural language 'el',
1544 it probably does not support the combination of Greek text strings
1545 using the 'iso-8859-1' charset. The Printer object handles this
1546 apparent incompatibility differently depending on the context in
1549 - In a create request: If the client supplies a text or name
1550 attribute (for example, the "job-name" operation attribute) that
1551 uses an apparently incompatible combination, it is a client
1552 choice that does not affect the Printer object or its correct
1553 operation. Therefore, the Printer object simply accepts the
1554 client supplied value, stores it with the Job object, and
1555 responds back with the same combination whenever the client (or
1556 any client) queries for that attribute.
1557 - In a query-type operation, like Get-Printer-Attributes: If the
1558 client requests an apparently incompatible combination, the
1559 Printer object responds (as described in section 3.1.4.2) using
1560 the Printer's configured natural language rather than the
1561 natural language requested by the client.
1563 In either case, the Printer object does not reject the request
1564 because of the apparent incompatibility. The potential incompatible
1565 combination of charset and natural language can occur either at the
1566 global operation level or at the Natural Language Override
1570 Hastings, et al. Standards Track [Page 28]
1572 RFC 2911 IPP/1.1: Model and Semantics September 2000
1575 attribute-by-attribute level. In addition, since the response always
1576 includes explicit charset and natural language information, there is
1577 never any question or ambiguity in how the client interprets the
1580 3.1.4.2 Response Operation Attributes
1582 The Printer object MUST supply and the client MUST support the
1583 following REQUIRED operation attributes in every IPP/1.1 operation
1586 "attributes-charset" (charset):
1587 This operation attribute identifies the charset used by any
1588 'text' and 'name' attributes that the Printer object is
1589 returning in this response. The value in this response MUST be
1590 the same value as the "attributes-charset" operation attribute
1591 supplied by the client in the request. If this is not possible
1592 (i.e., the charset requested is not supported), the request
1593 would have been rejected. See "attributes-charset" described
1594 in Section 3.1.4.1 above.
1596 If the Printer object supports more than just the 'utf-8'
1597 charset, the Printer object MUST be able to code convert
1598 between each of the charsets supported on a highest fidelity
1599 possible basis in order to return the 'text' and 'name'
1600 attributes in the charset requested by the client. However,
1601 some information loss MAY occur during the charset conversion
1602 depending on the charsets involved. For example, the Printer
1603 object may convert from a UTF-8 'a' to a US-ASCII 'a' (with no
1604 loss of information), from an ISO Latin 1 CAPITAL LETTER A WITH
1605 ACUTE ACCENT to US-ASCII 'A' (losing the accent), or from a
1606 UTF-8 Japanese Kanji character to some ISO Latin 1 error
1607 character indication such as '?', decimal code equivalent, or
1608 to the absence of a character, depending on implementation.
1610 Whether an implementation that supports more than one charset
1611 stores the data in the charset supplied by the client or code
1612 converts to one of the other supported charsets, depends on
1613 implementation. The strategy should try to minimize loss of
1614 information during code conversion. On each response, such an
1615 implementation converts from its internal charset to that
1618 "attributes-natural-language" (naturalLanguage):
1619 This operation attribute identifies the natural language used
1620 by any 'text' and 'name' attributes that the IPP object is
1621 returning in this response. Unlike the "attributes-charset"
1622 operation attribute, the IPP object NEED NOT return the same
1626 Hastings, et al. Standards Track [Page 29]
1628 RFC 2911 IPP/1.1: Model and Semantics September 2000
1631 value as that supplied by the client in the request. The IPP
1632 object MAY return the natural language of the Job object or the
1633 Printer's configured natural language as identified by the
1634 Printer object's "natural-language-configured" attribute,
1635 rather than the natural language supplied by the client. For
1636 any 'text' or 'name' attribute or status message in the
1637 response that is in a different natural language than the value
1638 returned in the "attributes-natural-language" operation
1639 attribute, the IPP object MUST use the Natural Language
1640 Override mechanism (see sections 4.1.1.2 and 4.1.2.2) on each
1641 attribute value returned. The IPP object MAY use the Natural
1642 Language Override mechanism redundantly, i.e., use it even when
1643 the value is in the same natural language as the value supplied
1644 in the "attributes-natural-language" operation attribute of the
1647 3.1.5 Operation Targets
1649 All IPP operations are directed at IPP objects. For Printer
1650 operations, the operation is always directed at a Printer object
1651 using one of its URIs (i.e., one of the values in the Printer
1652 object's "printer-uri-supported" attribute). Even if the Printer
1653 object supports more than one URI, the client supplies only one URI
1654 as the target of the operation. The client identifies the target
1655 object by supplying the correct URI in the "printer-uri (uri)"
1656 operation attribute.
1658 For Job operations, the operation is directed at either:
1660 - The Job object itself using the Job object's URI. In this case,
1661 the client identifies the target object by supplying the correct
1662 URI in the "job-uri (uri)" operation attribute.
1663 - The Printer object that created the Job object using both the
1664 Printer objects URI and the Job object's Job ID. Since the
1665 Printer object that created the Job object generated the Job ID,
1666 it MUST be able to correctly associate the client supplied Job
1667 ID with the correct Job object. The client supplies the Printer
1668 object's URI in the "printer-uri (uri)" operation attribute and
1669 the Job object's Job ID in the "job-id (integer(1:MAX))"
1670 operation attribute.
1672 If the operation is directed at the Job object directly using the Job
1673 object's URI, the client MUST NOT include the redundant "job-id"
1674 operation attribute.
1682 Hastings, et al. Standards Track [Page 30]
1684 RFC 2911 IPP/1.1: Model and Semantics September 2000
1687 The operation target attributes are REQUIRED operation attributes
1688 that MUST be included in every operation request. Like the charset
1689 and natural language attributes (see section 3.1.4), the operation
1690 target attributes are specially ordered operation attributes. In all
1691 cases, the operation target attributes immediately follow the
1692 "attributes-charset" and "attributes-natural-language" attributes
1693 within the operation attribute group, however the specific ordering
1696 - In the case where there is only one operation target attribute
1697 (i.e., either only the "printer-uri" attribute or only the
1698 "job-uri" attribute), that attribute MUST be the third attribute
1699 in the operation attributes group.
1700 - In the case where Job operations use two operation target
1701 attributes (i.e., the "printer-uri" and "job-id" attributes),
1702 the "printer-uri" attribute MUST be the third attribute and the
1703 "job-id" attribute MUST be the fourth attribute.
1705 In all cases, the target URIs contained within the body of IPP
1706 operation requests and responses must be in absolute format rather
1707 than relative format (a relative URL identifies a resource with the
1708 scope of the HTTP server, but does not include scheme, host or port).
1710 The following rules apply to the use of port numbers in URIs that
1711 identify IPP objects:
1713 1. If the URI scheme allows the port number to be explicitly
1714 included in the URI string, and a port number is specified
1715 within the URI, then that port number MUST be used by the
1716 client to contact the IPP object.
1718 2. If the URI scheme allows the port number to be explicitly
1719 included in the URI string, and a port number is not specified
1720 within the URI, then default port number implied by that URI
1721 scheme MUST be used by the client to contact the IPP object.
1723 3. If the URI scheme does not allow an explicit port number to be
1724 specified within the URI, then the default port number implied
1725 by that URI MUST be used by the client to contact the IPP
1728 Note: The IPP "Encoding and Transport document [RFC2910] shows a
1729 mapping of IPP onto HTTP/1.1 [RFC2616] and defines a new default port
1730 number for using IPP over HTTP/1.1.
1738 Hastings, et al. Standards Track [Page 31]
1740 RFC 2911 IPP/1.1: Model and Semantics September 2000
1743 3.1.6 Operation Response Status Codes and Status Messages
1745 Every operation response includes a REQUIRED "status-code" parameter
1746 and an OPTIONAL "status-message" operation attribute, and an OPTIONAL
1747 "detailed-status-message" operation attribute. The Print-URI and
1748 Send-URI response MAY include an OPTIONAL "document-access-error"
1749 operation attribute.
1751 3.1.6.1 "status-code" (type2 enum)
1753 The REQUIRED "status-code" parameter provides information on the
1754 processing of a request.
1756 The status code is intended for use by automata. A client
1757 implementation of IPP SHOULD convert status code values into any
1758 localized message that has semantic meaning to the end user.
1760 The "status-code" value is a numeric value that has semantic meaning.
1761 The "status-code" syntax is similar to a "type2 enum" (see section
1762 4.1 on "Attribute Syntaxes") except that values can range only from
1763 0x0000 to 0x7FFF. Section 13 describes the status codes, assigns the
1764 numeric values, and suggests a corresponding status message for each
1765 status code for use by the client when the user's natural language is
1768 If the Printer performs an operation with no errors and it encounters
1769 no problems, it MUST return the status code 'successful-ok' in the
1770 response. See section 13.
1772 If the client supplies unsupported values for the following
1773 parameters or Operation attributes, the Printer object MUST reject
1774 the operation, NEED NOT return the unsupported attribute value in the
1775 Unsupported Attributes group, and MUST return the indicated status
1778 Parameter/Attribute Status code
1780 version-number server-error-version-not-supported
1781 operation-id server-error-operation-not-supported
1782 attributes-charset client-error-charset-not-supported
1783 compression client-error-compression-not-supported
1784 document-format client-error-document-format-not-supported
1785 document-uri client-error-uri-scheme-not-supported,
1786 client-error-document-access-error
1788 If the client supplies unsupported values for other attributes, or
1789 unsupported attributes, the Printer returns the status code defined
1790 in section 3.1.7 on Unsupported Attributes.
1794 Hastings, et al. Standards Track [Page 32]
1796 RFC 2911 IPP/1.1: Model and Semantics September 2000
1799 3.1.6.2 "status-message" (text(255))
1801 The OPTIONAL "status-message" operation attribute provides a short
1802 textual description of the status of the operation. The "status-
1803 message" attribute's syntax is "text(255)", so the maximum length is
1804 255 octets (see section 4.1.1). The status message is intended for
1805 the human end user. If a response does include a "status-message"
1806 attribute, an IPP client NEED NOT examine or display the messages,
1807 however it SHOULD do so in some implementation specific manner. The
1808 "status-message" is especially useful for a later version of a
1809 Printer object to return as supplemental information for the human
1810 user to accompany a status code that an earlier version of a client
1811 might not understand.
1813 If the Printer object supports the "status-message" operation
1814 attribute, the Printer object MUST be able to generate this message
1815 in any of the natural languages identified by the Printer object's
1816 "generated-natural-language-supported" attribute (see the
1817 "attributes-natural-language" operation attribute specified in
1818 section 3.1.4.1. Section 13 suggests the text for the status message
1819 returned by the Printer for use with the English natural language.
1821 As described in section 3.1.4.1 for any returned 'text' attribute, if
1822 there is a choice for generating this message, the Printer object
1823 uses the natural language indicated by the value of the "attributes-
1824 natural-language" in the client request if supported, otherwise the
1825 Printer object uses the value in the Printer object's own "natural-
1826 language-configured" attribute.
1828 If the Printer object supports the "status-message" operation
1829 attribute, it SHOULD use the REQUIRED 'utf-8' charset to return a
1830 status message for the following error status codes (see section 13):
1831 'client-error-bad-request', 'client-error-charset-not-supported',
1832 'server-error-internal-error', 'server-error-operation-not-
1833 supported', and 'server-error-version-not-supported'. In this case,
1834 it MUST set the value of the "attributes-charset" operation attribute
1835 to 'utf-8' in the error response.
1837 3.1.6.3 "detailed-status-message" (text(MAX))
1839 The OPTIONAL "detailed-status-message" operation attribute provides
1840 additional more detailed technical and implementation-specific
1841 information about the operation. The "detailed-status-message"
1842 attribute's syntax is "text(MAX)", so the maximum length is 1023
1843 octets (see section 4.1.1). If the Printer objects supports the
1844 "detailed-status-message" operation attribute, the Printer NEED NOT
1845 localize the message, since it is intended for use by the system
1846 administrator or other experienced technical persons. Localization
1850 Hastings, et al. Standards Track [Page 33]
1852 RFC 2911 IPP/1.1: Model and Semantics September 2000
1855 might obscure the technical meaning of such messages. Clients MUST
1856 NOT attempt to parse the value of this attribute. See the
1857 "document-access-error" operation attribute (section 3.1.6.4) for
1858 additional errors that a program can process.
1860 3.1.6.4 "document-access-error" (text(MAX))
1862 This OPTIONAL operation attribute provides additional information
1863 about any document access errors encountered by the Printer before it
1864 returned a response to the Print-URI (section 3.2.2) or Send-URI
1865 (section 3.3.1) operation. For errors in the protocol identified by
1866 the URI scheme in the "document-uri" operation attribute, such as
1867 'http:' or 'ftp:', the error code is returned in parentheses,
1868 followed by the URI. For example:
1870 (404) http://ftp.pwg.org/pub/pwg/ipp/new_MOD/ipp-model-v11.pdf
1872 Most Internet protocols use decimal error codes (unlike IPP), so the
1873 ASCII error code representation is in decimal.
1875 3.1.7 Unsupported Attributes
1877 The Unsupported Attributes group contains attributes that are not
1878 supported by the operation. This group is primarily for the job
1879 creation operations, but all operations can return this group.
1881 A Printer object MUST include an Unsupported Attributes group in a
1882 response if the status code is one of the following: 'successful-
1883 ok-ignored-or-substituted-attributes', 'successful-ok-conflicting-
1884 attributes', 'client-error-attributes-or-values-not-supported' or
1885 'client-error-conflicting-attributes'.
1887 If the status code is one of the four specified in the preceding
1888 paragraph, the Unsupported Attributes group MUST contain all of those
1889 attributes and only those attributes that are:
1891 a. an Operation or Job Template attribute supplied in the request,
1894 b. unsupported by the printer. See below for details on the three
1895 categories "unsupported" attributes.
1897 If the status code is one of those in the table in section 3.1.6.1,
1898 the Unsupported Attributes group NEED NOT contain the unsupported
1899 parameter or attribute indicated in that table.
1906 Hastings, et al. Standards Track [Page 34]
1908 RFC 2911 IPP/1.1: Model and Semantics September 2000
1911 If the Printer object is not returning any Unsupported Attributes in
1912 the response, the Printer object SHOULD omit Group 2 rather than
1913 sending an empty group. However, a client MUST be able to accept an
1916 Unsupported attributes fall into three categories:
1918 1. The Printer object does not support the supplied attribute (no
1919 matter what the attribute syntax or value).
1921 2. The Printer object does support the attribute, but does not
1922 support some or all of the particular attribute syntaxes or
1923 values supplied by the client (i.e., the Printer object does
1924 not have those attribute syntaxes or values in its
1925 corresponding "xxx-supported" attribute).
1927 3. The Printer object does support the attributes and values
1928 supplied, but the particular values are in conflict with one
1929 another, because they violate a constraint, such as not being
1930 able to staple transparencies.
1932 In the case of an unsupported attribute name, the Printer object
1933 returns the client-supplied attribute with a substituted value of
1934 'unsupported'. This value's syntax type is "out-of-band" and its
1935 encoding is defined by special rules for "out-of-band" values in the
1936 "Encoding and Transport" document [RFC2910]. Its value indicates no
1937 support for the attribute itself (see the beginning of section 4.1).
1939 In the case of a supported attribute with one or more unsupported
1940 attribute syntaxes or values, the Printer object simply returns the
1941 client-supplied attribute with the unsupported attribute syntaxes or
1942 values as supplied by the client. This indicates support for the
1943 attribute, but no support for that particular attribute syntax or
1944 value. If the client supplies a multi-valued attribute with more
1945 than one value and the Printer object supports the attribute but only
1946 supports a subset of the client-supplied attribute syntaxes or
1947 values, the Printer object
1949 MUST return only those attribute syntaxes or values that are
1952 In the case of two (or more) supported attribute values that are in
1953 conflict with one another (although each is supported independently,
1954 the values conflict when requested together within the same job), the
1955 Printer object MUST return all the values that it ignores or
1956 substitutes to resolve the conflict, but not any of the values that
1962 Hastings, et al. Standards Track [Page 35]
1964 RFC 2911 IPP/1.1: Model and Semantics September 2000
1967 it is still using. The choice for exactly how to resolve the
1968 conflict is implementation dependent. See sections 3.2.1.2 and 15.
1969 See The Implementer's Guide [IPP-IIG] for an example.
1973 Each operation request and response carries with it a "version-
1974 number" parameter. Each value of the "version-number" is in the form
1975 "X.Y" where X is the major version number and Y is the minor version
1976 number. By including a version number in the client request, it
1977 allows the client to identify which version of IPP it is interested
1978 in using, i.e., the version whose conformance requirements the client
1979 may be depending upon the Printer to meet.
1981 If the IPP object does not support that major version number supplied
1982 by the client, i.e., the major version field of the "version-number"
1983 parameter does not match any of the values of the Printer's "ipp-
1984 versions-supported" (see section 4.4.14), the object MUST respond
1985 with a status code of 'server-error-version-not-supported' along with
1986 the closest version number that is supported (see section 13.1.5.4).
1987 If the major version number is supported, but the minor version
1988 number is not, the IPP object SHOULD accept and attempt to perform
1989 the request (or reject the request if the operation is not
1990 supported), else it rejects the request and returns the 'server-
1991 error-version-not-supported' status code. In all cases, the IPP
1992 object MUST return the "version-number" that it supports that is
1993 closest to the version number supplied by the client in the request.
1995 There is no version negotiation per se. However, if after receiving
1996 a 'server-error-version-not-supported' status code from an IPP
1997 object, a client SHOULD try again with a different version number. A
1998 client MAY also determine the versions supported either from a
1999 directory that conforms to Appendix E (see section 16) or by querying
2000 the Printer object's "ipp-versions-supported" attribute (see section
2001 4.4.14) to determine which versions are supported.
2003 An IPP object implementation MUST support version '1.1', i.e., meet
2004 the conformance requirements for IPP/1.1 as specified in this
2005 document and [RFC2910]. It is recommended that IPP object
2006 implementations accept any request with the major version '1' (or
2007 reject the request if the operation is not supported).
2009 There is only one notion of "version number" that covers both IPP
2010 Model and IPP Protocol changes. Thus the version number MUST change
2011 when introducing a new version of the Model and Semantics document
2012 (this document) or a new version of the "Encoding and Transport"
2018 Hastings, et al. Standards Track [Page 36]
2020 RFC 2911 IPP/1.1: Model and Semantics September 2000
2023 Changes to the major version number of the Model and Semantics
2024 document indicate structural or syntactic changes that make it
2025 impossible for older version of IPP clients and Printer objects to
2026 correctly parse and correctly process the new or changed attributes,
2027 operations and responses. If the major version number changes, the
2028 minor version numbers is set to zero. As an example, adding the
2029 REQUIRED "ipp-attribute-fidelity" attribute to version '1.1' (if it
2030 had not been part of version '1.0'), would have required a change to
2031 the major version number, since an IPP/1.0 Printer would not have
2032 processed a request with the correct semantics that contained the
2033 "ipp-attribute-fidelity" attribute that it did not know about. Items
2034 that might affect the changing of the major version number include
2035 any changes to the Model and Semantics document (this document) or
2036 the "Encoding and Transport" document [RFC2910] itself, such as:
2038 - reordering of ordered attributes or attribute sets
2039 - changes to the syntax of existing attributes
2040 - adding REQUIRED (for an IPP object to support) operation
2042 - adding values to existing REQUIRED operation attributes
2043 - adding REQUIRED operations
2045 Changes to the minor version number indicate the addition of new
2046 features, attributes and attribute values that may not be understood
2047 by all IPP objects, but which can be ignored if not understood.
2048 Items that might affect the changing of the minor version number
2049 include any changes to the model objects and attributes but not the
2050 encoding and transport rules [RFC2910] (except adding attribute
2051 syntaxes). Examples of such changes are:
2053 - grouping all extensions not included in a previous version into
2055 - adding new attribute values
2056 - adding new object attributes
2057 - adding OPTIONAL (for an IPP object to support) operation
2058 attributes (i.e., those attributes that an IPP object can ignore
2059 without confusing clients)
2060 - adding OPTIONAL (for an IPP object to support) operation
2061 attribute groups (i.e., those attributes that an IPP object can
2062 ignore without confusing clients)
2063 - adding new attribute syntaxes
2064 - adding OPTIONAL operations
2065 - changing Job Description attributes or Printer Description
2066 attributes from OPTIONAL to REQUIRED or vice versa.
2067 - adding OPTIONAL attribute syntaxes to an existing attribute.
2069 The encoding of the "version-number" MUST NOT change over any version
2070 number (either major or minor). This rule guarantees that all future
2074 Hastings, et al. Standards Track [Page 37]
2076 RFC 2911 IPP/1.1: Model and Semantics September 2000
2079 versions will be backwards compatible with all previous versions (at
2080 least for checking the "version-number"). In addition, any protocol
2081 elements (attributes, error codes, tags, etc.) that are not carried
2082 forward from one version to the next are deprecated so that they can
2083 never be reused with new semantics.
2085 Implementations that support a certain version NEED NOT support ALL
2086 previous versions. As each new version is defined (through the
2087 release of a new IPP specification document), that version will
2088 specify which previous versions MUST and which versions SHOULD be
2089 supported in compliant implementations.
2091 3.1.9 Job Creation Operations
2093 In order to "submit a print job" and create a new Job object, a
2094 client issues a create request. A create request is any one of
2095 following three operation requests:
2097 - The Print-Job Request: A client that wants to submit a print job
2098 with only a single document uses the Print-Job operation. The
2099 operation allows for the client to "push" the document data to
2100 the Printer object by including the document data in the request
2103 - The Print-URI Request: A client that wants to submit a print job
2104 with only a single document (where the Printer object "pulls"
2105 the document data instead of the client "pushing" the data to
2106 the Printer object) uses the Print-URI operation. In this
2107 case, the client includes in the request only a URI reference to
2108 the document data (not the document data itself).
2110 - The Create-Job Request: A client that wants to submit a print
2111 job with multiple documents uses the Create-Job operation. This
2112 operation is followed by an arbitrary number (one or more) of
2113 Send-Document and/or Send-URI operations (each creating another
2114 document for the newly create Job object). The Send-Document
2115 operation includes the document data in the request (the client
2116 "pushes" the document data to the printer), and the Send-URI
2117 operation includes only a URI reference to the document data in
2118 the request (the Printer "pulls" the document data from the
2119 referenced location). The last Send-Document or Send-URI
2120 request for a given Job object includes a "last-document"
2121 operation attribute set to 'true' indicating that this is the
2124 Throughout this model document, the term "create request" is used to
2125 refer to any of these three operation requests.
2130 Hastings, et al. Standards Track [Page 38]
2132 RFC 2911 IPP/1.1: Model and Semantics September 2000
2135 A Create-Job operation followed by only one Send-Document operation
2136 is semantically equivalent to a Print-Job operation, however, for
2137 performance reasons, the client SHOULD use the Print-Job operation
2138 for all single document jobs. Also, Print-Job is a REQUIRED
2139 operation (all implementations MUST support it) whereas Create-Job is
2140 an OPTIONAL operation, hence some implementations might not support
2143 Job submission time is the point in time when a client issues a
2144 create request. The initial state of every Job object is the
2145 'pending', 'pending-held', or 'processing' state (see section 4.3.7).
2146 When the Printer object begins processing the print job, the Job
2147 object's state moves to 'processing'. This is known as job
2148 processing time. There are validation checks that must be done at
2149 job submission time and others that must be performed at job
2152 At job submission time and at the time a Validate-Job operation is
2153 received, the Printer MUST do the following:
2155 1. Process the client supplied attributes and either accept or
2157 2. Validate the syntax of and support for the scheme of any client
2160 At job submission time the Printer object MUST validate whether or
2161 not the supplied attributes, attribute syntaxes, and values are
2162 supported by matching them with the Printer object's corresponding
2163 "xxx-supported" attributes. See section 3.1.7 for details. [IPP-
2164 IIG] presents suggested steps for an IPP object to either accept or
2165 reject any request and additional steps for processing create
2168 At job submission time the Printer object NEED NOT perform the
2169 validation checks reserved for job processing time such as:
2171 1. Validating the document data
2172 2. Validating the actual contents of any client supplied URI
2173 (resolve the reference and follow the link to the document
2176 At job submission time, these additional job processing time
2177 validation checks are essentially useless, since they require
2178 actually parsing and interpreting the document data, are not
2179 guaranteed to be 100% accurate, and MUST be done, yet again, at job
2180 processing time. Also, in the case of a URI, checking for
2181 availability at job submission time does not guarantee availability
2186 Hastings, et al. Standards Track [Page 39]
2188 RFC 2911 IPP/1.1: Model and Semantics September 2000
2191 at job processing time. In addition, at job processing time, the
2192 Printer object might discover any of the following conditions that
2193 were not detectable at job submission time:
2195 - runtime errors in the document data,
2196 - nested document data that is in an unsupported format,
2197 - the URI reference is no longer valid (i.e., the server hosting
2198 the document might be down), or
2199 - any other job processing error
2201 At job submission time, a Printer object, especially a non-spooling
2202 Printer, MAY accept jobs that it does not have enough space for. In
2203 such a situation, a Printer object MAY stop reading data from a
2204 client for an indefinite period of time. A client MUST be prepared
2205 for a write operation to block for an indefinite period of time (see
2206 section 5.1 on client conformance).
2208 When a Printer object has too little space for starting a new job, it
2209 MAY reject a new create request. In this case, a Printer object MUST
2210 return a response (in reply to the rejected request) with a status-
2211 code of 'server-error-busy' (see section 14.1.5.8) and it MAY close
2212 the connection before receiving all bytes of the operation. A
2213 Printer SHOULD indicate that it is temporarily unable to accept jobs
2214 by setting the 'spool-space-full' value in its "printer-state-
2215 reasons" attribute and removing the value when it can accept another
2216 job (see section 4.4.12).
2218 When receiving a 'server-error-busy' status-code in an operation
2219 response, a client MUST be prepared for the Printer object to close
2220 the connection before the client has sent all of the data (especially
2221 for the Print-Job operation). A client MUST be prepared to keep
2222 submitting a create request until the IPP Printer object accepts the
2225 At job processing time, since the Printer object has already
2226 responded with a successful status code in the response to the create
2227 request, if the Printer object detects an error, the Printer object
2228 is unable to inform the end user of the error with an operation
2229 status code. In this case, the Printer, depending on the error, can
2230 set the job object's "job-state", "job-state-reasons", or "job-
2231 state-message" attributes to the appropriate value(s) so that later
2232 queries can report the correct job status.
2234 Note: Asynchronous notification of events is outside the scope of
2235 this IPP/1.1 document.
2242 Hastings, et al. Standards Track [Page 40]
2244 RFC 2911 IPP/1.1: Model and Semantics September 2000
2247 3.2 Printer Operations
2249 All Printer operations are directed at Printer objects. A client
2250 MUST always supply the "printer-uri" operation attribute in order to
2251 identify the correct target of the operation.
2253 3.2.1 Print-Job Operation
2255 This REQUIRED operation allows a client to submit a print job with
2256 only one document and supply the document data (rather than just a
2257 reference to the data). See Section 15 for the suggested steps for
2258 processing create operations and their Operation and Job Template
2261 3.2.1.1 Print-Job Request
2263 The following groups of attributes are supplied as part of the
2266 Group 1: Operation Attributes
2268 Natural Language and Character Set:
2269 The "attributes-charset" and "attributes-natural-language"
2270 attributes as described in section 3.1.4.1. The Printer object
2271 MUST copy these values to the corresponding Job Description
2272 attributes described in sections 4.3.19 and 4.3.20.
2275 The "printer-uri" (uri) operation attribute which is the target
2276 for this operation as described in section 3.1.5.
2278 Requesting User Name:
2279 The "requesting-user-name" (name(MAX)) attribute SHOULD be
2280 supplied by the client as described in section 8.3.
2282 "job-name" (name(MAX)):
2283 The client OPTIONALLY supplies this attribute. The Printer
2284 object MUST support this attribute. It contains the client
2285 supplied Job name. If this attribute is supplied by the
2286 client, its value is used for the "job-name" attribute of the
2287 newly created Job object. The client MAY automatically include
2288 any information that will help the end-user distinguish amongst
2289 his/her jobs, such as the name of the application program along
2290 with information from the document, such as the document name,
2291 document subject, or source file name. If this attribute is
2292 not supplied by the client, the Printer generates a name to use
2293 in the "job-name" attribute of the newly created Job object
2294 (see Section 4.3.5).
2298 Hastings, et al. Standards Track [Page 41]
2300 RFC 2911 IPP/1.1: Model and Semantics September 2000
2303 "ipp-attribute-fidelity" (boolean):
2304 The client OPTIONALLY supplies this attribute. The Printer
2305 object MUST support this attribute. The value 'true' indicates
2306 that total fidelity to client supplied Job Template attributes
2307 and values is required, else the Printer object MUST reject the
2308 Print-Job request. The value 'false' indicates that a
2309 reasonable attempt to print the Job object is acceptable and
2310 the Printer object MUST accept the Print-Job request. If not
2311 supplied, the Printer object assumes the value is 'false'. All
2312 Printer objects MUST support both types of job processing. See
2313 section 15 for a full description of "ipp-attribute-fidelity"
2314 and its relationship to other attributes, especially the
2315 Printer object's "pdl-override-supported" attribute.
2317 "document-name" (name(MAX)):
2318 The client OPTIONALLY supplies this attribute. The Printer
2319 object MUST support this attribute. It contains the client
2320 supplied document name. The document name MAY be different
2321 than the Job name. Typically, the client software
2322 automatically supplies the document name on behalf of the end
2323 user by using a file name or an application generated name. If
2324 this attribute is supplied, its value can be used in a manner
2325 defined by each implementation. Examples include: printed
2326 along with the Job (job start sheet, page adornments, etc.),
2327 used by accounting or resource tracking management tools, or
2328 even stored along with the document as a document level
2329 attribute. IPP/1.1 does not support the concept of document
2332 "compression" (type3 keyword):
2333 The client OPTIONALLY supplies this attribute. The Printer
2334 object MUST support this attribute and the "compression-
2335 supported" attribute (see section 4.4.32). The client supplied
2336 "compression" operation attribute identifies the compression
2337 algorithm used on the document data. The following cases exist:
2339 a) If the client omits this attribute, the Printer object MUST
2340 assume that the data is not compressed (i.e. the Printer
2341 follows the rules below as if the client supplied the
2342 "compression" attribute with a value of 'none').
2343 b) If the client supplies this attribute, but the value is not
2344 supported by the Printer object, i.e., the value is not one
2345 of the values of the Printer object's "compression-
2346 supported" attribute, the Printer object MUST reject the
2347 request, and return the 'client-error-compression-not-
2348 supported' status code. See section 3.1.7 for returning
2349 unsupported attributes and values.
2354 Hastings, et al. Standards Track [Page 42]
2356 RFC 2911 IPP/1.1: Model and Semantics September 2000
2359 c) If the client supplies the attribute and the Printer object
2360 supports the attribute value, the Printer object uses the
2361 corresponding decompression algorithm on the document data.
2362 d) If the decompression algorithm fails before the Printer
2363 returns an operation response, the Printer object MUST
2364 reject the request and return the 'client-error-
2365 compression-error' status code.
2366 e) If the decompression algorithm fails after the Printer
2367 returns an operation response, the Printer object MUST abort
2368 the job and add the 'compression-error' value to the job's
2369 "job-state-reasons" attribute.
2370 f) If the decompression algorithm succeeds, the document data
2371 MUST then have the format specified by the job's "document-
2372 format" attribute, if supplied (see "document-format"
2373 operation attribute definition below).
2375 "document-format" (mimeMediaType):
2376 The client OPTIONALLY supplies this attribute. The Printer
2377 object MUST support this attribute. The value of this
2378 attribute identifies the format of the supplied document data.
2379 The following cases exist:
2381 a) If the client does not supply this attribute, the Printer
2382 object assumes that the document data is in the format
2383 defined by the Printer object's "document-format-default"
2384 attribute. (i.e. the Printer follows the rules below as if
2385 the client supplied the "document-format" attribute with a
2386 value equal to the printer's default value).
2387 b) If the client supplies this attribute, but the value is not
2388 supported by the Printer object, i.e., the value is not one
2389 of the values of the Printer object's "document-format-
2390 supported" attribute, the Printer object MUST reject the
2391 request and return the 'client-error-document-format-not-
2392 supported' status code.
2393 c) If the client supplies this attribute and its value is
2394 'application/octet-stream' (i.e. to be auto-sensed, see
2395 Section 4.1.9.1), and the format is not one of the
2396 document-formats that the Printer can auto-sense, and this
2397 check occurs before the Printer returns an operation
2398 response, then the Printer MUST reject the request and
2399 return the 'client-error-document-format-not-supported'
2401 d) If the client supplies this attribute, and the value is
2402 supported by the Printer object, the Printer is capable of
2403 interpreting the document data.
2410 Hastings, et al. Standards Track [Page 43]
2412 RFC 2911 IPP/1.1: Model and Semantics September 2000
2415 e) If interpreting of the document data fails before the
2416 Printer returns an operation response, the Printer object
2417 MUST reject the request and return the 'client-error-
2418 document-format-error' status code.
2419 f) If interpreting of the document data fails after the Printer
2420 returns an operation response, the Printer object MUST abort
2421 the job and add the 'document-format-error' value to the
2422 job's "job-state-reasons" attribute.
2424 "document-natural-language" (naturalLanguage):
2425 The client OPTIONALLY supplies this attribute. The Printer
2426 object OPTIONALLY supports this attribute. This attribute
2427 specifies the natural language of the document for those
2428 document-formats that require a specification of the natural
2429 language in order to image the document unambiguously. There
2430 are no particular values required for the Printer object to
2433 "job-k-octets" (integer(0:MAX)):
2434 The client OPTIONALLY supplies this attribute. The Printer
2435 object OPTIONALLY supports this attribute and the "job-k-
2436 octets-supported" attribute (see section 4.4.33). The client
2437 supplied "job-k-octets" operation attribute identifies the
2438 total size of the document(s) in K octets being submitted (see
2439 section 4.3.17.1 for the complete semantics). If the client
2440 supplies the attribute and the Printer object supports the
2441 attribute, the value of the attribute is used to populate the
2442 Job object's "job-k-octets" Job Description attribute.
2444 For this attribute and the following two attributes ("job-
2445 impressions", and "job-media-sheets"), if the client supplies
2446 the attribute, but the Printer object does not support the
2447 attribute, the Printer object ignores the client-supplied
2448 value. If the client supplies the attribute and the Printer
2449 supports the attribute, and the value is within the range of
2450 the corresponding Printer object's "xxx-supported" attribute,
2451 the Printer object MUST use the value to populate the Job
2452 object's "xxx" attribute. If the client supplies the attribute
2453 and the Printer supports the attribute, but the value is
2454 outside the range of the corresponding Printer object's "xxx-
2455 supported" attribute, the Printer object MUST copy the
2456 attribute and its value to the Unsupported Attributes response
2457 group, reject the request, and return the 'client-error-
2458 attributes-or-values-not-supported' status code. If the client
2459 does not supply the attribute, the Printer object MAY choose to
2460 populate the corresponding Job object attribute depending on
2461 whether the Printer object supports the attribute and is able
2462 to calculate or discern the correct value.
2466 Hastings, et al. Standards Track [Page 44]
2468 RFC 2911 IPP/1.1: Model and Semantics September 2000
2471 "job-impressions" (integer(0:MAX)):
2472 The client OPTIONALLY supplies this attribute. The Printer
2473 object OPTIONALLY supports this attribute and the "job-
2474 impressions-supported" attribute (see section 4.4.34). The
2475 client supplied "job-impressions" operation attribute
2476 identifies the total size in number of impressions of the
2477 document(s) being submitted (see section 4.3.17.2 for the
2478 complete semantics).
2480 See last paragraph under "job-k-octets".
2482 "job-media-sheets" (integer(0:MAX)):
2483 The client OPTIONALLY supplies this attribute. The Printer
2484 object OPTIONALLY supports this attribute and the "job-media-
2485 sheets-supported" attribute (see section 4.4.35). The client
2486 supplied "job-media-sheets" operation attribute identifies the
2487 total number of media sheets to be produced for this job (see
2488 section 4.3.17.3 for the complete semantics).
2490 See last paragraph under "job-k-octets".
2492 Group 2: Job Template Attributes
2494 The client OPTIONALLY supplies a set of Job Template attributes as
2495 defined in section 4.2. If the client is not supplying any Job
2496 Template attributes in the request, the client SHOULD omit Group 2
2497 rather than sending an empty group. However, a Printer object
2498 MUST be able to accept an empty group.
2500 Group 3: Document Content
2502 The client MUST supply the document data to be processed.
2504 In addition to the MANDATORY parameters required for every
2505 operation request, the simplest Print-Job Request consists of just
2506 the "attributes-charset" and "attributes-natural-language"
2507 operation attributes; the "printer-uri" target operation
2508 attribute; the Document Content and nothing else. In this simple
2509 case, the Printer object:
2511 - creates a new Job object (the Job object contains a single
2513 - stores a generated Job name in the "job-name" attribute in the
2514 natural language and charset requested (see Section 3.1.4.1) (if
2515 those are supported, otherwise using the Printer object's
2516 default natural language and charset), and
2522 Hastings, et al. Standards Track [Page 45]
2524 RFC 2911 IPP/1.1: Model and Semantics September 2000
2527 - at job processing time, uses its corresponding default value
2528 attributes for the supported Job Template attributes that were
2529 not supplied by the client as IPP attribute or embedded
2530 instructions in the document data.
2532 3.2.1.2 Print-Job Response
2534 The Printer object MUST return to the client the following sets of
2535 attributes as part of the Print-Job Response:
2537 Group 1: Operation Attributes
2540 In addition to the REQUIRED status code returned in every
2541 response, the response OPTIONALLY includes a "status-message"
2542 (text(255)) and/or a "detailed-status-message" (text(MAX))
2543 operation attribute as described in sections 13 and 3.1.6. If
2544 the client supplies unsupported or conflicting Job Template
2545 attributes or values, the Printer object MUST reject or accept
2546 the Print-Job request depending on the whether the client
2547 supplied a 'true' or 'false' value for the "ipp-attribute-
2548 fidelity" operation attribute. See the Implementer's Guide
2549 [IPP-IIG] for a complete description of the suggested steps for
2550 processing a create request.
2552 Natural Language and Character Set:
2553 The "attributes-charset" and "attributes-natural-language"
2554 attributes as described in section 3.1.4.2.
2556 Group 2: Unsupported Attributes
2558 See section 3.1.7 for details on returning Unsupported Attributes.
2560 The value of the "ipp-attribute-fidelity" supplied by the client
2561 does not affect what attributes the Printer object returns in this
2562 group. The value of "ipp-attribute-fidelity" only affects whether
2563 the Print-Job operation is accepted or rejected. If the job is
2564 accepted, the client may query the job using the Get-Job-
2565 Attributes operation requesting the unsupported attributes that
2566 were returned in the create response to see which attributes were
2567 ignored (not stored on the Job object) and which attributes were
2568 stored with other (substituted) values.
2578 Hastings, et al. Standards Track [Page 46]
2580 RFC 2911 IPP/1.1: Model and Semantics September 2000
2583 Group 3: Job Object Attributes
2586 The Printer object MUST return the Job object's URI by
2587 returning the contents of the REQUIRED "job-uri" Job object
2588 attribute. The client uses the Job object's URI when directing
2589 operations at the Job object. The Printer object always uses
2590 its configured security policy when creating the new URI.
2591 However, if the Printer object supports more than one URI, the
2592 Printer object also uses information about which URI was used
2593 in the Print-Job Request to generated the new URI so that the
2594 new URI references the correct access channel. In other words,
2595 if the Print-Job Request comes in over a secure channel, the
2596 Printer object MUST generate a Job URI that uses the secure
2599 "job-id" (integer(1:MAX)):
2600 The Printer object MUST return the Job object's Job ID by
2601 returning the REQUIRED "job-id" Job object attribute. The
2602 client uses this "job-id" attribute in conjunction with the
2603 "printer-uri" attribute used in the Print-Job Request when
2604 directing Job operations at the Printer object.
2606 "job-state" (type1 enum):
2607 The Printer object MUST return the Job object's REQUIRED "job-
2608 state" attribute. The value of this attribute (along with the
2609 value of the next attribute: "job-state-reasons") is taken
2610 from a "snapshot" of the new Job object at some meaningful
2611 point in time (implementation defined) between when the Printer
2612 object receives the Print-Job Request and when the Printer
2613 object returns the response.
2615 "job-state-reasons" (1setOf type2 keyword):
2616 The Printer object MUST return the Job object's REQUIRED "job-
2617 state-reasons" attribute.
2619 "job-state-message" (text(MAX)):
2620 The Printer object OPTIONALLY returns the Job object's OPTIONAL
2621 "job-state-message" attribute. If the Printer object supports
2622 this attribute then it MUST be returned in the response. If
2623 this attribute is not returned in the response, the client can
2624 assume that the "job-state-message" attribute is not supported
2625 and will not be returned in a subsequent Job object query.
2627 "number-of-intervening-jobs" (integer(0:MAX)):
2628 The Printer object OPTIONALLY returns the Job object's OPTIONAL
2629 "number-of-intervening-jobs" attribute. If the Printer object
2630 supports this attribute then it MUST be returned in the
2634 Hastings, et al. Standards Track [Page 47]
2636 RFC 2911 IPP/1.1: Model and Semantics September 2000
2639 response. If this attribute is not returned in the response,
2640 the client can assume that the "number-of-intervening-jobs"
2641 attribute is not supported and will not be returned in a
2642 subsequent Job object query.
2644 Note: Since any printer state information which affects a job's
2645 state is reflected in the "job-state" and "job-state-reasons"
2646 attributes, it is sufficient to return only these attributes
2647 and no specific printer status attributes.
2649 Note: In addition to the MANDATORY parameters required for every
2650 operation response, the simplest response consists of the just the
2651 "attributes-charset" and "attributes-natural-language" operation
2652 attributes and the "job-uri", "job-id", and "job-state" Job Object
2653 Attributes. In this simplest case, the status code is 'successful-
2654 ok' and there is no "status-message" or "detailed-status-message"
2655 operation attribute.
2657 3.2.2 Print-URI Operation
2659 This OPTIONAL operation is identical to the Print-Job operation
2660 (section 3.2.1) except that a client supplies a URI reference to the
2661 document data using the "document-uri" (uri) operation attribute (in
2662 Group 1) rather than including the document data itself. Before
2663 returning the response, the Printer MUST validate that the Printer
2664 supports the retrieval method (e.g., http, ftp, etc.) implied by the
2665 URI, and MUST check for valid URI syntax. If the client-supplied URI
2666 scheme is not supported, i.e. the value is not in the Printer
2667 object's "referenced-uri-scheme-supported" attribute, the Printer
2668 object MUST reject the request and return the 'client-error-uri-
2669 scheme-not-supported' status code.
2671 The IPP Printer MAY validate the accessibility of the document as
2672 part of the operation or subsequently. If the Printer determines an
2673 accessibility problem before returning an operation response, it
2674 rejects the request and returns the 'client-error-document-access-
2675 error' status code. The Printer MAY also return a specific document
2676 access error code using the "document-access-error" operation
2677 attribute (see section 3.1.6.4).
2679 If the Printer determines this document accessibility problem after
2680 accepting the request and returning an operation response with one of
2681 the successful status codes, the Printer adds the 'document-access-
2682 error' value to the job's "job-state-reasons" attribute and MAY
2683 populate the job's "job-document-access-errors" Job Description
2684 attribute (see section 4.3.11). See The Implementer's Guide [IPP-
2685 IIG] for suggested additional checks.
2690 Hastings, et al. Standards Track [Page 48]
2692 RFC 2911 IPP/1.1: Model and Semantics September 2000
2695 If the Printer object supports this operation, it MUST support the
2696 "reference-uri-schemes-supported" Printer attribute (see section
2699 It is up to the IPP object to interpret the URI and subsequently
2700 "pull" the document from the source referenced by the URI string.
2702 3.2.3 Validate-Job Operation
2704 This REQUIRED operation is similar to the Print-Job operation
2705 (section 3.2.1) except that a client supplies no document data and
2706 the Printer allocates no resources (i.e., it does not create a new
2707 Job object). This operation is used only to verify capabilities of a
2708 printer object against whatever attributes are supplied by the client
2709 in the Validate-Job request. By using the Validate-Job operation a
2710 client can validate that an identical Print-Job operation (with the
2711 document data) would be accepted. The Validate-Job operation also
2712 performs the same security negotiation as the Print-Job operation
2713 (see section 8), so that a client can check that the client and
2714 Printer object security requirements can be met before performing a
2715 Print-Job operation.
2717 The Validate-Job operation does not accept a "document-uri" attribute
2718 in order to allow a client to check that the same Print-URI operation
2719 will be accepted, since the client doesn't send the data with the
2720 Print-URI operation. The client SHOULD just issue the Print-URI
2723 The Printer object returns the same status codes, Operation
2724 Attributes (Group 1) and Unsupported Attributes (Group 2) as the
2725 Print-Job operation. However, no Job Object Attributes (Group 3) are
2726 returned, since no Job object is created.
2728 3.2.4 Create-Job Operation
2730 This OPTIONAL operation is similar to the Print-Job operation
2731 (section 3.2.1) except that in the Create-Job request, a client does
2732 not supply document data or any reference to document data. Also,
2733 the client does not supply any of the "document-name", "document-
2734 format", "compression", or "document-natural-language" operation
2735 attributes. This operation is followed by one or more Send-Document
2736 or Send-URI operations. In each of those operation requests, the
2737 client OPTIONALLY supplies the "document-name", "document-format",
2738 and "document-natural-language" attributes for each document in the
2739 multi-document Job object.
2746 Hastings, et al. Standards Track [Page 49]
2748 RFC 2911 IPP/1.1: Model and Semantics September 2000
2751 If a Printer object supports the Create-Job operation, it MUST also
2752 support the Send-Document operation and also MAY support the Send-URI
2755 If the Printer object supports this operation, it MUST support the
2756 "multiple-operation-time-out" Printer attribute (see section 4.4.31).
2758 If the Printer object supports this operation, then it MUST support
2759 the "multiple-document-jobs-supported" Printer Description attribute
2760 (see section 4.4.16) and indicate whether or not it supports
2761 multiple-document jobs.
2763 If the Printer object supports this operation and supports multiple
2764 documents in a job, then it MUST support the "multiple-document-
2765 handling" Job Template job attribute with at least one value (see
2766 section 4.2.4) and the associated "multiple-document-handling-
2767 default" and "multiple-document-handling-supported" Job Template
2768 Printer attributes (see section 4.2).
2770 After the Create-Job operation has completed, the value of the "job-
2771 state" attribute is similar to the "job-state" after a Print-Job,
2772 even though no document-data has arrived. A Printer MAY set the
2773 'job-data-insufficient' value of the job's "job-state-reason"
2774 attribute to indicate that processing cannot begin until sufficient
2775 data has arrived and set the "job-state" to either 'pending' or
2776 'pending-held'. A non-spooling printer that doesn't implement the
2777 'pending' job state may even set the "job-state" to 'processing',
2778 even though there is not yet any data to process. See sections 4.3.7
2781 3.2.5 Get-Printer-Attributes Operation
2783 This REQUIRED operation allows a client to request the values of the
2784 attributes of a Printer object. In the request, the client supplies
2785 the set of Printer attribute names and/or attribute group names in
2786 which the requester is interested. In the response, the Printer
2787 object returns a corresponding attribute set with the appropriate
2788 attribute values filled in.
2790 For Printer objects, the possible names of attribute groups are:
2792 - 'job-template': the subset of the Job Template attributes that
2793 apply to a Printer object (the last two columns of the table in
2794 Section 4.2) that the implementation supports for Printer
2796 - 'printer-description': the subset of the attributes specified in
2797 Section 4.4 that the implementation supports for Printer
2802 Hastings, et al. Standards Track [Page 50]
2804 RFC 2911 IPP/1.1: Model and Semantics September 2000
2807 - 'all': the special group 'all' that includes all attributes that
2808 the implementation supports for Printer objects.
2810 Since a client MAY request specific attributes or named groups, there
2811 is a potential that there is some overlap. For example, if a client
2812 requests, 'printer-name' and 'all', the client is actually requesting
2813 the "printer-name" attribute twice: once by naming it explicitly, and
2814 once by inclusion in the 'all' group. In such cases, the Printer
2815 object NEED NOT return each attribute only once in the response even
2816 if it is requested multiple times. The client SHOULD NOT request the
2817 same attribute in multiple ways.
2819 It is NOT REQUIRED that a Printer object support all attributes
2820 belonging to a group (since some attributes are OPTIONAL). However,
2821 it is REQUIRED that each Printer object support all group names.
2823 3.2.5.1 Get-Printer-Attributes Request
2825 The following sets of attributes are part of the Get-Printer-
2828 Group 1: Operation Attributes
2830 Natural Language and Character Set:
2831 The "attributes-charset" and "attributes-natural-language"
2832 attributes as described in section 3.1.4.1.
2835 The "printer-uri" (uri) operation attribute which is the target
2836 for this operation as described in section 3.1.5.
2838 Requesting User Name:
2839 The "requesting-user-name" (name(MAX)) attribute SHOULD be
2840 supplied by the client as described in section 8.3.
2842 "requested-attributes" (1setOf keyword):
2843 The client OPTIONALLY supplies a set of attribute names and/or
2844 attribute group names in whose values the requester is
2845 interested. The Printer object MUST support this attribute.
2846 If the client omits this attribute, the Printer MUST respond as
2847 if this attribute had been supplied with a value of 'all'.
2849 "document-format" (mimeMediaType):
2850 The client OPTIONALLY supplies this attribute. The Printer
2851 object MUST support this attribute. This attribute is useful
2852 for a Printer object to determine the set of supported
2853 attribute values that relate to the requested document format.
2854 The Printer object MUST return the attributes and values that
2858 Hastings, et al. Standards Track [Page 51]
2860 RFC 2911 IPP/1.1: Model and Semantics September 2000
2863 it uses to validate a job on a create or Validate-Job operation
2864 in which this document format is supplied. The Printer object
2865 SHOULD return only (1) those attributes that are supported for
2866 the specified format and (2) the attribute values that are
2867 supported for the specified document format. By specifying the
2868 document format, the client can get the Printer object to
2869 eliminate the attributes and values that are not supported for
2870 a specific document format. For example, a Printer object
2871 might have multiple interpreters to support both
2872 'application/postscript' (for PostScript) and 'text/plain' (for
2873 text) documents. However, for only one of those interpreters
2874 might the Printer object be able to support "number-up" with
2875 values of '1', '2', and '4'. For the other interpreter it
2876 might be able to only support "number-up" with a value of '1'.
2877 Thus a client can use the Get-Printer-Attributes operation to
2878 obtain the attributes and values that will be used to
2879 accept/reject a create job operation.
2881 If the Printer object does not distinguish between different
2882 sets of supported values for each different document format
2883 when validating jobs in the create and Validate-Job operations,
2884 it MUST NOT distinguish between different document formats in
2885 the Get-Printer-Attributes operation. If the Printer object
2886 does distinguish between different sets of supported values for
2887 each different document format specified by the client, this
2888 specialization applies only to the following Printer object
2891 - Printer attributes that are Job Template attributes ("xxx-
2892 default" "xxx-supported", and "xxx-ready" in the Table in
2894 - "pdl-override-supported",
2895 - "compression-supported",
2896 - "job-k-octets-supported",
2897 - "job-impressions-supported",
2898 - "job-media-sheets-supported",
2899 - "printer-driver-installer",
2900 - "color-supported", and
2901 - "reference-uri-schemes-supported"
2903 The values of all other Printer object attributes (including
2904 "document-format-supported") remain invariant with respect to the
2905 client supplied document format (except for new Printer
2906 description attribute as registered according to section 6.2).
2908 If the client omits this "document-format" operation attribute,
2909 the Printer object MUST respond as if the attribute had been
2910 supplied with the value of the Printer object's "document-format-
2914 Hastings, et al. Standards Track [Page 52]
2916 RFC 2911 IPP/1.1: Model and Semantics September 2000
2919 default" attribute. It is RECOMMENDED that the client always
2920 supply a value for "document-format", since the Printer object's
2921 "document-format-default" may be 'application/octet-stream', in
2922 which case the returned attributes and values are for the union of
2923 the document formats that the Printer can automatically sense.
2924 For more details, see the description of the 'mimeMediaType'
2925 attribute syntax in section 4.1.9.
2927 If the client supplies a value for the "document-format" Operation
2928 attribute that is not supported by the Printer, i.e., is not among
2929 the values of the Printer object's "document-format-supported"
2930 attribute, the Printer object MUST reject the operation and return
2931 the 'client-error-document-format-not-supported' status code.
2933 3.2.5.2 Get-Printer-Attributes Response
2935 The Printer object returns the following sets of attributes as part
2936 of the Get-Printer-Attributes Response:
2938 Group 1: Operation Attributes
2941 In addition to the REQUIRED status code returned in every
2942 response, the response OPTIONALLY includes a "status-message"
2943 (text(255)) and/or a "detailed-status-message" (text(MAX))
2944 operation attribute as described in sections 13 and 3.1.6.
2946 Natural Language and Character Set:
2947 The "attributes-charset" and "attributes-natural-language"
2948 attributes as described in section 3.1.4.2.
2950 Group 2: Unsupported Attributes
2952 See section 3.1.7 for details on returning Unsupported Attributes.
2954 The response NEED NOT contain the "requested-attributes" operation
2955 attribute with any supplied values (attribute keywords) that were
2956 requested by the client but are not supported by the IPP object.
2957 If the Printer object does return unsupported attributes
2958 referenced in the "requested-attributes" operation attribute and
2959 that attribute included group names, such as 'all', the
2960 unsupported attributes MUST NOT include attributes described in
2961 the standard but not supported by the implementation.
2970 Hastings, et al. Standards Track [Page 53]
2972 RFC 2911 IPP/1.1: Model and Semantics September 2000
2975 Group 3: Printer Object Attributes
2977 This is the set of requested attributes and their current values.
2978 The Printer object ignores (does not respond with) any requested
2979 attribute which is not supported. The Printer object MAY respond
2980 with a subset of the supported attributes and values, depending on
2981 the security policy in force. However, the Printer object MUST
2982 respond with the 'unknown' value for any supported attribute
2983 (including all REQUIRED attributes) for which the Printer object
2984 does not know the value. Also the Printer object MUST respond
2985 with the 'no-value' for any supported attribute (including all
2986 REQUIRED attributes) for which the system administrator has not
2987 configured a value. See the description of the "out-of-band"
2988 values in the beginning of Section 4.1.
2990 3.2.6 Get-Jobs Operation
2992 This REQUIRED operation allows a client to retrieve the list of Job
2993 objects belonging to the target Printer object. The client may also
2994 supply a list of Job attribute names and/or attribute group names. A
2995 group of Job object attributes will be returned for each Job object
2998 This operation is similar to the Get-Job-Attributes operation, except
2999 that this Get-Jobs operation returns attributes from possibly more
3002 3.2.6.1 Get-Jobs Request
3004 The client submits the Get-Jobs request to a Printer object.
3006 The following groups of attributes are part of the Get-Jobs Request:
3008 Group 1: Operation Attributes
3010 Natural Language and Character Set:
3011 The "attributes-charset" and "attributes-natural-language"
3012 attributes as described in section 3.1.4.1.
3015 The "printer-uri" (uri) operation attribute which is the target
3016 for this operation as described in section 3.1.5.
3018 Requesting User Name:
3019 The "requesting-user-name" (name(MAX)) attribute SHOULD be
3020 supplied by the client as described in section 8.3.
3026 Hastings, et al. Standards Track [Page 54]
3028 RFC 2911 IPP/1.1: Model and Semantics September 2000
3031 "limit" (integer(1:MAX)):
3032 The client OPTIONALLY supplies this attribute. The Printer
3033 object MUST support this attribute. It is an integer value that
3034 determines the maximum number of jobs that a client will
3035 receive from the Printer even if "which-jobs" or "my-jobs"
3036 constrain which jobs are returned. The limit is a "stateless
3037 limit" in that if the value supplied by the client is 'N', then
3038 only the first 'N' jobs are returned in the Get-Jobs Response.
3039 There is no mechanism to allow for the next 'M' jobs after the
3040 first 'N' jobs. If the client does not supply this attribute,
3041 the Printer object responds with all applicable jobs.
3043 "requested-attributes" (1setOf type2 keyword):
3044 The client OPTIONALLY supplies this attribute. The Printer
3045 object MUST support this attribute. It is a set of Job
3046 attribute names and/or attribute groups names in whose values
3047 the requester is interested. This set of attributes is
3048 returned for each Job object that is returned. The allowed
3049 attribute group names are the same as those defined in the
3050 Get-Job-Attributes operation in section 3.3.4. If the client
3051 does not supply this attribute, the Printer MUST respond as if
3052 the client had supplied this attribute with two values: 'job-
3055 "which-jobs" (type2 keyword):
3056 The client OPTIONALLY supplies this attribute. The Printer
3057 object MUST support this attribute. It indicates which Job
3058 objects MUST be returned by the Printer object. The values for
3061 'completed': This includes any Job object whose state is
3062 'completed', 'canceled', or 'aborted'.
3063 'not-completed': This includes any Job object whose state is
3064 'pending', 'processing', 'processing-stopped', or 'pending-
3067 A Printer object MUST support both values. However, if the
3068 implementation does not keep jobs in the 'completed',
3069 'canceled', and 'aborted' states, then it returns no jobs when
3070 the 'completed' value is supplied.
3072 If a client supplies some other value, the Printer object MUST
3073 copy the attribute and the unsupported value to the Unsupported
3074 Attributes response group, reject the request, and return the
3075 'client-error-attributes-or-values-not-supported' status code.
3082 Hastings, et al. Standards Track [Page 55]
3084 RFC 2911 IPP/1.1: Model and Semantics September 2000
3087 If the client does not supply this attribute, the Printer
3088 object MUST respond as if the client had supplied the attribute
3089 with a value of 'not-completed'.
3091 "my-jobs" (boolean):
3092 The client OPTIONALLY supplies this attribute. The Printer
3093 object MUST support this attribute. It indicates whether jobs
3094 from all users or just the jobs submitted by the requesting
3095 user of this request MUST be considered as candidate jobs to be
3096 returned by the Printer object. If the client does not supply
3097 this attribute, the Printer object MUST respond as if the
3098 client had supplied the attribute with a value of 'false',
3099 i.e., jobs from all users. The means for authenticating the
3100 requesting user and matching the jobs is described in section
3103 3.2.6.2 Get-Jobs Response
3105 The Printer object returns all of the Job objects up to the number
3106 specified by the "limit" attribute that match the criteria as defined
3107 by the attribute values supplied by the client in the request. It is
3108 possible that no Job objects are returned since there may literally
3109 be no Job objects at the Printer, or there may be no Job objects that
3110 match the criteria supplied by the client. If the client requests
3111 any Job attributes at all, there is a set of Job Object Attributes
3112 returned for each Job object.
3114 It is not an error for the Printer to return 0 jobs. If the response
3115 returns 0 jobs because there are no jobs matching the criteria, and
3116 the request would have returned 1 or more jobs with a status code of
3117 'successful-ok' if there had been jobs matching the criteria, then
3118 the status code for 0 jobs MUST be 'successful-ok'.
3120 Group 1: Operation Attributes
3123 In addition to the REQUIRED status code returned in every
3124 response, the response OPTIONALLY includes a "status-message"
3125 (text(255)) and/or a "detailed-status-message" (text(MAX))
3126 operation attribute as described in sections 13 and 3.1.6.
3128 Natural Language and Character Set:
3129 The "attributes-charset" and "attributes-natural-language"
3130 attributes as described in section 3.1.4.2.
3138 Hastings, et al. Standards Track [Page 56]
3140 RFC 2911 IPP/1.1: Model and Semantics September 2000
3143 Group 2: Unsupported Attributes
3145 See section 3.1.7 for details on returning Unsupported Attributes.
3147 The response NEED NOT contain the "requested-attributes" operation
3148 attribute with any supplied values (attribute keywords) that were
3149 requested by the client but are not supported by the IPP object.
3150 If the Printer object does return unsupported attributes
3151 referenced in the "requested-attributes" operation attribute and
3152 that attribute included group names, such as 'all', the
3153 unsupported attributes MUST NOT include attributes described in
3154 the standard but not supported by the implementation.
3156 Groups 3 to N: Job Object Attributes
3158 The Printer object responds with one set of Job Object Attributes
3159 for each returned Job object. The Printer object ignores (does
3160 not respond with) any requested attribute or value which is not
3161 supported or which is restricted by the security policy in force,
3162 including whether the requesting user is the user that submitted
3163 the job (job originating user) or not (see section 8). However,
3164 the Printer object MUST respond with the 'unknown' value for any
3165 supported attribute (including all REQUIRED attributes) for which
3166 the Printer object does not know the value, unless it would
3167 violate the security policy. See the description of the "out-of-
3168 band" values in the beginning of Section 4.1.
3170 Jobs are returned in the following order:
3172 - If the client requests all 'completed' Jobs (Jobs in the
3173 'completed', 'aborted', or 'canceled' states), then the Jobs are
3174 returned newest to oldest (with respect to actual completion
3176 - If the client requests all 'not-completed' Jobs (Jobs in the
3177 'pending', 'processing', 'pending-held', and 'processing-
3178 stopped' states), then Jobs are returned in relative
3179 chronological order of expected time to complete (based on
3180 whatever scheduling algorithm is configured for the Printer
3183 3.2.7 Pause-Printer Operation
3185 This OPTIONAL operation allows a client to stop the Printer object
3186 from scheduling jobs on all its devices. Depending on
3187 implementation, the Pause-Printer operation MAY also stop the Printer
3188 from processing the current job or jobs. Any job that is currently
3189 being printed is either stopped as soon as the implementation permits
3194 Hastings, et al. Standards Track [Page 57]
3196 RFC 2911 IPP/1.1: Model and Semantics September 2000
3199 or is completed, depending on implementation. The Printer object
3200 MUST still accept create operations to create new jobs, but MUST
3201 prevent any jobs from entering the 'processing' state.
3203 If the Pause-Printer operation is supported, then the Resume-Printer
3204 operation MUST be supported, and vice-versa.
3206 The IPP Printer stops the current job(s) on its device(s) that were
3207 in the 'processing' or 'processing-stopped' states as soon as the
3208 implementation permits. If the implementation will take appreciable
3209 time to stop, the IPP Printer adds the 'moving-to-paused' value to
3210 the Printer object's "printer-state-reasons" attribute (see section
3211 4.4.12). When the device(s) have all stopped, the IPP Printer
3212 transitions the Printer object to the 'stopped' state, removes the
3213 'moving-to-paused' value, if present, and adds the 'paused' value to
3214 the Printer object's "printer-state-reasons" attribute.
3216 When the current job(s) complete that were in the 'processing' state,
3217 the IPP Printer transitions them to the 'completed' state. When the
3218 current job(s) stop in mid processing that were in the 'processing'
3219 state, the IPP Printer transitions them to the 'processing-stopped'
3220 state and adds the 'printer-stopped' value to the job's "job-state-
3223 For any jobs that are 'pending' or 'pending-held', the 'printer-
3224 stopped' value of the jobs' "job-state-reasons" attribute also
3225 applies. However, the IPP Printer NEED NOT update those jobs' "job-
3226 state-reasons" attributes and only need return the 'printer-stopped'
3227 value when those jobs are queried (so-called "lazy evaluation").
3229 Whether the Pause-Printer operation affects jobs that were submitted
3230 to the device from other sources than the IPP Printer object in the
3231 same way that the Pause-Printer operation affects jobs that were
3232 submitted to the IPP Printer object using IPP, depends on
3233 implementation, i.e., on whether the IPP protocol is being used as a
3234 universal management protocol or just to manage IPP jobs,
3237 The IPP Printer MUST accept the request in any state and transition
3238 the Printer to the indicated new "printer-state" before returning as
3250 Hastings, et al. Standards Track [Page 58]
3252 RFC 2911 IPP/1.1: Model and Semantics September 2000
3255 Current New "printer IPP Printer's response status
3256 "printer- "printer- -state- code and action:
3257 state" state" reasons"
3259 'idle' 'stopped' 'paused' 'successful-ok'
3260 'processing' 'processing' 'moving- OPTION 1: 'successful-ok';
3261 to- Later, when all output has
3262 paused' stopped, the "printer-state"
3263 becomes 'stopped', and the
3264 'paused' value replaces the
3265 'moving-to-paused' value in the
3266 "printer-state-reasons"
3268 'processing' 'stopped' 'paused' OPTION 2: 'successful-ok';
3269 all device output stopped
3271 'stopped' 'stopped' 'paused' 'successful-ok'
3273 Access Rights: The authenticated user (see section 8.3) performing
3274 this operation must be an operator or administrator of the Printer
3275 object (see Sections 1 and 8.5). Otherwise, the IPP Printer MUST
3276 reject the operation and return: 'client-error-forbidden', 'client-
3277 error-not-authenticated', or 'client-error-not-authorized' as
3280 3.2.7.1 Pause-Printer Request
3282 The following groups of attributes are part of the Pause-Printer
3285 Group 1: Operation Attributes
3287 Natural Language and Character Set:
3288 The "attributes-charset" and "attributes-natural-language"
3289 attributes as described in section 3.1.4.1.
3292 The "printer-uri" (uri) operation attribute which is the target
3293 for this operation as described in section 3.1.5.
3295 Requesting User Name:
3296 The "requesting-user-name" (name(MAX)) attribute SHOULD be
3297 supplied by the client as described in section 8.3.
3306 Hastings, et al. Standards Track [Page 59]
3308 RFC 2911 IPP/1.1: Model and Semantics September 2000
3311 3.2.7.2 Pause-Printer Response
3313 The following groups of attributes are part of the Pause-Printer
3316 Group 1: Operation Attributes
3319 In addition to the REQUIRED status code returned in every
3320 response, the response OPTIONALLY includes a "status-message"
3321 (text(255)) and/or a "detailed-status-message" (text(MAX))
3322 operation attribute as described in sections 13 and 3.1.6.
3324 Natural Language and Character Set:
3325 The "attributes-charset" and "attributes-natural-language"
3326 attributes as described in section 3.1.4.2.
3328 Group 2: Unsupported Attributes
3330 See section 3.1.7 for details on returning Unsupported Attributes.
3332 3.2.8 Resume-Printer Operation
3334 This operation allows a client to resume the Printer object
3335 scheduling jobs on all its devices. The Printer object MUST remove
3336 the 'paused' and 'moving-to-paused' values from the Printer object's
3337 "printer-state-reasons" attribute, if present. If there are no other
3338 reasons to keep a device paused (such as media-jam), the IPP Printer
3339 is free to transition itself to the 'processing' or 'idle' states,
3340 depending on whether there are jobs to be processed or not,
3341 respectively, and the device(s) resume processing jobs.
3343 If the Pause-Printer operation is supported, then the Resume-Printer
3344 operation MUST be supported, and vice-versa.
3346 The IPP Printer removes the 'printer-stopped' value from any job's
3347 "job-state-reasons" attributes contained in that Printer.
3349 The IPP Printer MUST accept the request in any state, transition the
3350 Printer object to the indicated new state as follows:
3362 Hastings, et al. Standards Track [Page 60]
3364 RFC 2911 IPP/1.1: Model and Semantics September 2000
3367 Current New "printer- IPP Printer's response status code and
3368 "printer- state" action:
3371 'idle' 'idle' 'successful-ok'
3372 'processing' 'processing' 'successful-ok'
3374 'stopped' 'processing' 'successful-ok';
3375 when there are jobs to be processed
3376 'stopped' 'idle' 'successful-ok';
3377 when there are no jobs to be processed.
3379 Access Rights: The authenticated user (see section 8.3) performing
3380 this operation must be an operator or administrator of the Printer
3381 object (see Sections 1 and 8.5). Otherwise, the IPP Printer MUST
3382 reject the operation and return: 'client-error-forbidden', 'client-
3383 error-not-authenticated', or 'client-error-not-authorized' as
3386 The Resume-Printer Request and Resume-Printer Response have the same
3387 attribute groups and attributes as the Pause-Printer operation (see
3388 sections 3.2.7.1 and 3.2.7.2).
3390 3.2.9 Purge-Jobs Operation
3392 This OPTIONAL operation allows a client to remove all jobs from an
3393 IPP Printer object, regardless of their job states, including jobs in
3394 the Printer object's Job History (see Section 4.3.7.2). After a
3395 Purge-Jobs operation has been performed, a Printer object MUST return
3396 no jobs in subsequent Get-Job-Attributes and Get-Jobs responses
3397 (until new jobs are submitted).
3399 Whether the Purge-Jobs (and Get-Jobs) operation affects jobs that
3400 were submitted to the device from other sources than the IPP Printer
3401 object in the same way that the Purge-Jobs operation affects jobs
3402 that were submitted to the IPP Printer object using IPP, depends on
3403 implementation, i.e., on whether the IPP protocol is being used as a
3404 universal management protocol or just to manage IPP jobs,
3407 Note: if an operator wants to cancel all jobs without clearing out
3408 the Job History, the operator uses the Cancel-Job operation on each
3409 job instead of using the Purge-Jobs operation.
3411 The Printer object MUST accept this operation in any state and
3412 transition the Printer object to the 'idle' state.
3418 Hastings, et al. Standards Track [Page 61]
3420 RFC 2911 IPP/1.1: Model and Semantics September 2000
3423 Access Rights: The authenticated user (see section 8.3) performing
3424 this operation must be an operator or administrator of the Printer
3425 object (see Sections 1 and 8.5). Otherwise, the IPP object MUST
3426 reject the operation and return: client-error-forbidden, client-
3427 error-not-authenticated, and client-error-not-authorized as
3430 The Purge-Jobs Request and Purge-Jobs Response have the same
3431 attribute groups and attributes as the Pause-Printer operation (see
3432 sections 3.2.7.1 and 3.2.7.2).
3436 All Job operations are directed at Job objects. A client MUST always
3437 supply some means of identifying the Job object in order to identify
3438 the correct target of the operation. That job identification MAY
3439 either be a single Job URI or a combination of a Printer URI with a
3440 Job ID. The IPP object implementation MUST support both forms of
3441 identification for every job.
3443 3.3.1 Send-Document Operation
3445 This OPTIONAL operation allows a client to create a multi-document
3446 Job object that is initially "empty" (contains no documents). In the
3447 Create-Job response, the Printer object returns the Job object's URI
3448 (the "job-uri" attribute) and the Job object's 32-bit identifier (the
3449 "job-id" attribute). For each new document that the client desires
3450 to add, the client uses a Send-Document operation. Each Send-
3451 Document Request contains the entire stream of document data for one
3454 If the Printer supports this operation but does not support multiple
3455 documents per job, the Printer MUST reject subsequent Send-Document
3456 operations supplied with data and return the 'server-error-multiple-
3457 document-jobs-not-supported'. However, the Printer MUST accept the
3458 first document with a 'true' or 'false' value for the "last-document"
3459 operation attribute (see below), so that clients MAY always submit
3460 one document jobs with a 'false' value for "last-document" in the
3461 first Send-Document and a 'true' for "last-document" in the second
3462 Send-Document (with no data).
3464 Since the Create-Job and the send operations (Send-Document or Send-
3465 URI operations) that follow could occur over an arbitrarily long
3466 period of time for a particular job, a client MUST send another send
3467 operation within an IPP Printer defined minimum time interval after
3468 the receipt of the previous request for the job. If a Printer object
3469 supports the Create-Job and Send-Document operations, the Printer
3470 object MUST support the "multiple-operation-time-out" attribute (see
3474 Hastings, et al. Standards Track [Page 62]
3476 RFC 2911 IPP/1.1: Model and Semantics September 2000
3479 section 4.4.31). This attribute indicates the minimum number of
3480 seconds the Printer object will wait for the next send operation
3481 before taking some recovery action.
3483 An IPP object MUST recover from an errant client that does not supply
3484 a send operation, sometime after the minimum time interval specified
3485 by the Printer object's "multiple-operation-time-out" attribute.
3486 Such recovery MAY include any of the following or other recovery
3489 1. Assume that the Job is an invalid job, start the process of
3490 changing the job state to 'aborted', add the 'aborted-by-
3491 system' value to the job's "job-state-reasons" attribute (see
3492 section 4.3.8), and clean up all resources associated with the
3493 Job. In this case, if another send operation is finally
3494 received, the Printer responds with an "client-error-not-
3495 possible" or "client-error-not-found" depending on whether or
3496 not the Job object is still around when the send operation
3498 2. Assume that the last send operation received was in fact the
3499 last document (as if the "last-document" flag had been set to
3500 'true'), close the Job object, and proceed to process it (i.e.,
3501 move the Job's state to 'pending').
3502 3. Assume that the last send operation received was in fact the
3503 last document, close the Job, but move it to the 'pending-held'
3504 and add the 'submission-interrupted' value to the job's "job-
3505 state-reasons" attribute (see section 4.3.8). This action
3506 allows the user or an operator to determine whether to continue
3507 processing the Job by moving it back to the 'pending' state
3508 using the Release-Job operation (see section 3.3.6) or to
3509 cancel the job using the Cancel-Job operation (see section
3512 Each implementation is free to decide the "best" action to take
3513 depending on local policy, whether any documents have been added,
3514 whether the implementation spools jobs or not, and/or any other
3515 piece of information available to it. If the choice is to abort the
3516 Job object, it is possible that the Job object may already have been
3517 processed to the point that some media sheet pages have been printed.
3519 Access Rights: The authenticated user (see section 8.3) performing
3520 this operation must either be the job owner (as determined in the
3521 Create-Job operation) or an operator or administrator of the Printer
3522 object (see Sections 1 and 8.5). Otherwise, the IPP object MUST
3523 reject the operation and return: 'client-error-forbidden', 'client-
3524 error-not-authenticated', or 'client-error-not-authorized' as
3530 Hastings, et al. Standards Track [Page 63]
3532 RFC 2911 IPP/1.1: Model and Semantics September 2000
3535 3.3.1.1 Send-Document Request
3537 The following attribute sets are part of the Send-Document Request:
3539 Group 1: Operation Attributes
3541 Natural Language and Character Set:
3542 The "attributes-charset" and "attributes-natural-language"
3543 attributes as described in section 3.1.4.1.
3546 Either (1) the "printer-uri" (uri) plus "job-id"
3547 (integer(1:MAX))or (2) the "job-uri" (uri) operation
3548 attribute(s) which define the target for this operation as
3549 described in section 3.1.5.
3551 Requesting User Name:
3552 The "requesting-user-name" (name(MAX)) attribute SHOULD be
3553 supplied by the client as described in section 8.3.
3555 "document-name" (name(MAX)):
3556 The client OPTIONALLY supplies this attribute. The Printer
3557 object MUST support this attribute. It contains the client
3558 supplied document name. The document name MAY be different than
3559 the Job name. It might be helpful, but NEED NOT be unique
3560 across multiple documents in the same Job. Typically, the
3561 client software automatically supplies the document name on
3562 behalf of the end user by using a file name or an application
3563 generated name. See the description of the "document-name"
3564 operation attribute in the Print-Job Request (section 3.2.1.1)
3565 for more information about this attribute.
3567 "compression" (type3 keyword):
3568 See the description of "compression" for the Print-Job operation
3571 "document-format" (mimeMediaType):
3572 See the description of "document-format" for the Print-Job
3573 operation in Section 3.2.1.1.
3575 "document-natural-language" (naturalLanguage):
3576 The client OPTIONALLY supplies this attribute. The Printer
3577 object OPTIONALLY supports this attribute. This attribute
3578 specifies the natural language of the document for those
3579 document-formats that require a specification of the natural
3580 language in order to image the document unambiguously. There
3581 are no particular values required for the Printer object to
3586 Hastings, et al. Standards Track [Page 64]
3588 RFC 2911 IPP/1.1: Model and Semantics September 2000
3591 "last-document" (boolean):
3592 The client MUST supply this attribute. The Printer object MUST
3593 support this attribute. It is a boolean flag that is set to
3594 'true' if this is the last document for the Job, 'false'
3597 Group 2: Document Content
3599 The client MUST supply the document data if the "last-document"
3600 flag is set to 'false'. However, since a client might not know
3601 that the previous document sent with a Send-Document (or Send-URI)
3602 operation was the last document (i.e., the "last-document"
3603 attribute was set to 'false'), it is legal to send a Send-Document
3604 request with no document data where the "last-document" flag is
3605 set to 'true'. Such a request MUST NOT increment the value of the
3606 Job object's "number-of-documents" attribute, since no real
3607 document was added to the job. It is not an error for a client to
3608 submit a job with no actual document data, i.e., only a single
3609 Create-Job and Send-Document request with a "last-document"
3610 operation attribute set to 'true' with no document data.
3612 3.3.1.2 Send-Document Response
3614 The following sets of attributes are part of the Send-Document
3617 Group 1: Operation Attributes
3620 In addition to the REQUIRED status code returned in every
3621 response, the response OPTIONALLY includes a "status-message"
3622 (text(255)) and/or a "detailed-status-message" (text(MAX))
3623 operation attribute as described in sections 13 and 3.1.6.
3625 Natural Language and Character Set:
3626 The "attributes-charset" and "attributes-natural-language"
3627 attributes as described in section 3.1.4.2.
3629 Group 2: Unsupported Attributes
3631 See section 3.1.7 for details on returning Unsupported Attributes.
3633 Group 3: Job Object Attributes
3635 This is the same set of attributes as described in the Print-Job
3636 response (see section 3.2.1.2).
3642 Hastings, et al. Standards Track [Page 65]
3644 RFC 2911 IPP/1.1: Model and Semantics September 2000
3647 3.3.2 Send-URI Operation
3649 This OPTIONAL operation is identical to the Send-Document operation
3650 (see section 3.3.1) except that a client MUST supply a URI reference
3651 ("document-uri" operation attribute) rather than the document data
3652 itself. If a Printer object supports this operation, clients can use
3653 both Send-URI or Send-Document operations to add new documents to an
3654 existing multi-document Job object. However, if a client needs to
3655 indicate that the previous Send-URI or Send-Document was the last
3656 document, the client MUST use the Send-Document operation with no
3657 document data and the "last-document" flag set to 'true' (rather than
3658 using a Send-URI operation with no "document-uri" operation
3661 If a Printer object supports this operation, it MUST also support the
3662 Print-URI operation (see section 3.2.2).
3664 The Printer object MUST validate the syntax and URI scheme of the
3665 supplied URI before returning a response, just as in the Print-URI
3666 operation. The IPP Printer MAY validate the accessibility of the
3667 document as part of the operation or subsequently (see section
3670 3.3.3 Cancel-Job Operation
3672 This REQUIRED operation allows a client to cancel a Print Job from
3673 the time the job is created up to the time it is completed, canceled,
3674 or aborted. Since a Job might already be printing by the time a
3675 Cancel-Job is received, some media sheet pages might be printed
3676 before the job is actually terminated.
3678 The IPP object MUST accept or reject the request based on the job's
3679 current state and transition the job to the indicated new state as
3698 Hastings, et al. Standards Track [Page 66]
3700 RFC 2911 IPP/1.1: Model and Semantics September 2000
3703 Current "job- New "job- IPP object's response status
3704 state" state" code and action:
3706 'pending' 'canceled' 'successful-ok'
3707 'pending-held' 'canceled' 'successful-ok'
3708 'processing' 'canceled' 'successful-ok'
3709 'processing' 'processing' 'successful-ok' See Rule 1
3710 'processing' 'processing' 'client-error-not-possible'
3712 'processing- 'canceled' 'successful-ok'
3714 'processing- 'processing- 'successful-ok' See Rule 1
3716 'processing- 'processing- 'client-error-not-possible'
3717 stopped' stopped' See Rule 2
3718 'completed' 'completed' 'client-error-not-possible'
3719 'canceled' 'canceled' 'client-error-not-possible'
3720 'aborted' 'aborted' 'client-error-not-possible'
3722 Rule 1: If the implementation requires some measurable time to
3723 cancel the job in the 'processing' or 'processing-stopped' job
3724 states, the IPP object MUST add the 'processing-to-stop-point' value
3725 to the job's "job-state-reasons" attribute and then transition the
3726 job to the 'canceled' state when the processing ceases (see section
3729 Rule 2: If the Job object already has the 'processing-to-stop-point'
3730 value in its "job-state-reasons" attribute, then the Printer object
3731 MUST reject a Cancel-Job operation.
3733 Access Rights: The authenticated user (see section 8.3) performing
3734 this operation must either be the job owner or an operator or
3735 administrator of the Printer object (see Sections 1 and 8.5).
3736 Otherwise, the IPP object MUST reject the operation and return:
3737 'client-error-forbidden', 'client-error-not-authenticated', or
3738 'client-error-not-authorized' as appropriate.
3740 3.3.3.1 Cancel-Job Request
3742 The following groups of attributes are part of the Cancel-Job
3745 Group 1: Operation Attributes
3747 Natural Language and Character Set:
3748 The "attributes-charset" and "attributes-natural-language"
3749 attributes as described in section 3.1.4.1.
3754 Hastings, et al. Standards Track [Page 67]
3756 RFC 2911 IPP/1.1: Model and Semantics September 2000
3760 Either (1) the "printer-uri" (uri) plus "job-id"
3761 (integer(1:MAX))or (2) the "job-uri" (uri) operation
3762 attribute(s) which define the target for this operation as
3763 described in section 3.1.5.
3765 Requesting User Name:
3766 The "requesting-user-name" (name(MAX)) attribute SHOULD be
3767 supplied by the client as described in section 8.3.
3769 "message" (text(127)):
3770 The client OPTIONALLY supplies this attribute. The Printer
3771 object OPTIONALLY supports this attribute. It is a message to
3772 the operator. This "message" attribute is not the same as the
3773 "job-message-from-operator" attribute. That attribute is used
3774 to report a message from the operator to the end user that
3775 queries that attribute. This "message" operation attribute is
3776 used to send a message from the client to the operator along
3777 with the operation request. It is an implementation decision
3778 of how or where to display this message to the operator (if at
3781 3.3.3.2 Cancel-Job Response
3783 The following sets of attributes are part of the Cancel-Job Response:
3785 Group 1: Operation Attributes
3788 In addition to the REQUIRED status code returned in every
3789 response, the response OPTIONALLY includes a "status-message"
3790 (text(255)) and/or a "detailed-status-message" (text(MAX))
3791 operation attribute as described in sections 13 and 3.1.6.
3793 Natural Language and Character Set:
3794 The "attributes-charset" and "attributes-natural-language"
3795 attributes as described in section 3.1.4.2.
3797 Group 2: Unsupported Attributes
3799 See section 3.1.7 for details on returning Unsupported Attributes.
3801 Once a successful response has been sent, the implementation
3802 guarantees that the Job will eventually end up in the 'canceled'
3803 state. Between the time of the Cancel-Job operation is accepted and
3804 when the job enters the 'canceled' job-state (see section 4.3.7), the
3805 "job-state-reasons" attribute SHOULD contain the 'processing-to-
3810 Hastings, et al. Standards Track [Page 68]
3812 RFC 2911 IPP/1.1: Model and Semantics September 2000
3815 value which indicates to later queries that although the Job might
3816 still be 'processing', it will eventually end up in the
3817 'canceled' state, not the 'completed' state.
3819 3.3.4 Get-Job-Attributes Operation
3821 This REQUIRED operation allows a client to request the values of
3822 attributes of a Job object and it is almost identical to the Get-
3823 Printer-Attributes operation (see section 3.2.5). The only
3824 differences are that the operation is directed at a Job object rather
3825 than a Printer object, there is no "document-format" operation
3826 attribute used when querying a Job object, and the returned attribute
3827 group is a set of Job object attributes rather than a set of Printer
3830 For Jobs, the possible names of attribute groups are:
3832 - 'job-template': the subset of the Job Template attributes that
3833 apply to a Job object (the first column of the table in Section
3834 4.2) that the implementation supports for Job objects.
3835 - 'job-description': the subset of the Job Description attributes
3836 specified in Section 4.3 that the implementation supports for
3838 - 'all': the special group 'all' that includes all attributes that
3839 the implementation supports for Job objects.
3841 Since a client MAY request specific attributes or named groups, there
3842 is a potential that there is some overlap. For example, if a client
3843 requests, 'job-name' and 'job-description', the client is actually
3844 requesting the "job-name" attribute once by naming it explicitly, and
3845 once by inclusion in the 'job-description' group. In such cases, the
3846 Printer object NEED NOT return the attribute only once in the
3847 response even if it is requested multiple times. The client SHOULD
3848 NOT request the same attribute in multiple ways.
3850 It is NOT REQUIRED that a Job object support all attributes belonging
3851 to a group (since some attributes are OPTIONAL). However it is
3852 REQUIRED that each Job object support all these group names.
3854 3.3.4.1 Get-Job-Attributes Request
3856 The following groups of attributes are part of the Get-Job-Attributes
3857 Request when the request is directed at a Job object:
3866 Hastings, et al. Standards Track [Page 69]
3868 RFC 2911 IPP/1.1: Model and Semantics September 2000
3871 Group 1: Operation Attributes
3873 Natural Language and Character Set:
3874 The "attributes-charset" and "attributes-natural-language"
3875 attributes as described in section 3.1.4.1.
3878 Either (1) the "printer-uri" (uri) plus "job-id"
3879 (integer(1:MAX)) or (2) the "job-uri" (uri) operation
3880 attribute(s) which define the target for this operation as
3881 described in section 3.1.5.
3883 Requesting User Name:
3884 The "requesting-user-name" (name(MAX)) attribute SHOULD be
3885 supplied by the client as described in section 8.3.
3887 "requested-attributes" (1setOf keyword):
3888 The client OPTIONALLY supplies this attribute. The IPP object
3889 MUST support this attribute. It is a set of attribute names
3890 and/or attribute group names in whose values the requester is
3891 interested. If the client omits this attribute, the IPP object
3892 MUST respond as if this attribute had been supplied with a value
3895 3.3.4.2 Get-Job-Attributes Response
3897 The Printer object returns the following sets of attributes as part
3898 of the Get-Job-Attributes Response:
3900 Group 1: Operation Attributes
3903 In addition to the REQUIRED status code returned in every
3904 response, the response OPTIONALLY includes a "status-message"
3905 (text(255)) and/or a "detailed-status-message" (text(MAX))
3906 operation attribute as described in sections 13 and 3.1.6.
3908 Natural Language and Character Set:
3909 The "attributes-charset" and "attributes-natural-language"
3910 attributes as described in section 3.1.4.2. The "attributes-
3911 natural-language" MAY be the natural language of the Job
3912 object, rather than the one requested.
3914 Group 2: Unsupported Attributes
3916 See section 3.1.7 for details on returning Unsupported Attributes.
3922 Hastings, et al. Standards Track [Page 70]
3924 RFC 2911 IPP/1.1: Model and Semantics September 2000
3927 The response NEED NOT contain the "requested-attributes" operation
3928 attribute with any supplied values (attribute keywords) that were
3929 requested by the client but are not supported by the IPP object.
3930 If the Printer object does return unsupported attributes
3931 referenced in the "requested-attributes" operation attribute and
3932 that attribute included group names, such as 'all', the
3933 unsupported attributes MUST NOT include attributes described in
3934 the standard but not supported by the implementation.
3936 Group 3: Job Object Attributes
3938 This is the set of requested attributes and their current values.
3939 The IPP object ignores (does not respond with) any requested
3940 attribute or value which is not supported or which is restricted
3941 by the security policy in force, including whether the requesting
3942 user is the user that submitted the job (job originating user) or
3943 not (see section 8). However, the IPP object MUST respond with
3944 the 'unknown' value for any supported attribute (including all
3945 REQUIRED attributes) for which the IPP object does not know the
3946 value, unless it would violate the security policy. See the
3947 description of the "out-of-band" values in the beginning of
3950 3.3.5 Hold-Job Operation
3952 This OPTIONAL operation allows a client to hold a pending job in the
3953 queue so that it is not eligible for scheduling. If the Hold-Job
3954 operation is supported, then the Release-Job operation MUST be
3955 supported, and vice-versa. The OPTIONAL "job-hold-until" operation
3956 attribute allows a client to specify whether to hold the job
3957 indefinitely or until a specified time period, if supported.
3959 The IPP object MUST accept or reject the request based on the job's
3960 current state and transition the job to the indicated new state as
3978 Hastings, et al. Standards Track [Page 71]
3980 RFC 2911 IPP/1.1: Model and Semantics September 2000
3983 Current "job- New "job-state" IPP object's response status
3984 state" code and action:
3986 'pending' 'pending-held' 'successful-ok' See Rule 1
3987 'pending' 'pending' 'successful-ok' See Rule 2
3988 'pending-held' 'pending-held' 'successful-ok' See Rule 1
3989 'pending-held' 'pending' 'successful-ok' See Rule 2
3990 'processing' 'processing' 'client-error-not-possible'
3991 'processing- 'processing- 'client-error-not-possible'
3993 'completed' 'completed' 'client-error-not-possible'
3994 'canceled' 'canceled' 'client-error-not-possible'
3995 'aborted' 'aborted' 'client-error-not-possible'
3997 Rule 1: If the implementation supports multiple reasons for a job to
3998 be in the 'pending-held' state, the IPP object MUST add the 'job-
3999 hold-until-specified' value to the job's "job-state-reasons"
4002 Rule 2: If the IPP object supports the "job-hold-until" operation
4003 attribute, but the specified time period has already started (or is
4004 the 'no-hold' value) and there are no other reasons to hold the job,
4005 the IPP object MUST make the job be a candidate for processing
4006 immediately (see Section 4.2.2) by putting the job in the 'pending'
4009 Note: In order to keep the Hold-Job operation simple, such a request
4010 is rejected when the job is in the 'processing' or 'processing-
4011 stopped' states. If an operation is needed to hold jobs while in
4012 these states, it will be added as an additional operation, rather
4013 than overloading the Hold-Job operation. Then it is clear to clients
4014 by querying the Printer object's "operations-supported" (see Section
4015 4.4.15) and the Job object's "job-state" (see Section 4.3.7)
4016 attributes which operations are possible.
4018 Access Rights: The authenticated user (see section 8.3) performing
4019 this operation must either be the job owner or an operator or
4020 administrator of the Printer object (see Sections 1 and 8.5).
4021 Otherwise, the IPP object MUST reject the operation and return:
4022 'client-error-forbidden', 'client-error-not-authenticated', or
4023 'client-error-not-authorized' as appropriate.
4025 3.3.5.1 Hold-Job Request
4027 The groups and operation attributes are the same as for a Cancel-Job
4028 request (see section 3.3.3.1), with the addition of the following
4029 Group 1 Operation attribute:
4034 Hastings, et al. Standards Track [Page 72]
4036 RFC 2911 IPP/1.1: Model and Semantics September 2000
4039 "job-hold-until" (type3 keyword | name(MAX)):
4040 The client OPTIONALLY supplies this Operation attribute. The
4041 IPP object MUST support this operation attribute in a Hold-Job
4042 request, if it supports the "job-hold-until" Job template
4043 attribute in create operations. See section 4.2.2. The IPP
4044 object SHOULD support the "job-hold-until" Job Template
4045 attribute for use in job create operations with at least the
4046 'indefinite' value, if it supports the Hold-Job operation.
4047 Otherwise, a client cannot create a job and hold it immediately
4048 (without picking some supported time period in the future).
4050 If supplied and supported as specified in the Printer's "job-
4051 hold-until-supported" attribute, the IPP object copies the
4052 supplied operation attribute to the Job object, replacing the
4053 job's previous "job-hold-until" attribute, if present, and
4054 makes the job a candidate for scheduling during the supplied
4057 If supplied, but either the "job-hold-until" Operation
4058 attribute itself or the value supplied is not supported, the
4059 IPP object accepts the request, returns the unsupported
4060 attribute or value in the Unsupported Attributes Group
4061 according to section 3.1.7, returns the 'successful-ok-
4062 ignored-or-substituted-attributes, and holds the job
4063 indefinitely until a client performs a subsequent Release-Job
4066 If the client (1) supplies a value that specifies a time period
4067 that has already started or the 'no-hold' value (meaning don't
4068 hold the job) and (2) the IPP object supports the "job-hold-
4069 until" operation attribute and there are no other reasons to
4070 hold the job, the IPP object MUST accept the operation and make
4071 the job be a candidate for processing immediately (see Section
4074 If the client does not supply a "job-hold-until" Operation
4075 attribute in the request, the IPP object MUST populate the job
4076 object with a "job-hold-until" attribute with the 'indefinite'
4077 value (if IPP object supports the "job-hold-until" attribute)
4078 and hold the job indefinitely, until a client performs a
4079 Release-Job operation.
4081 3.3.5.2 Hold-Job Response
4083 The groups and attributes are the same as for a Cancel-Job response
4084 (see section 3.3.3.2).
4090 Hastings, et al. Standards Track [Page 73]
4092 RFC 2911 IPP/1.1: Model and Semantics September 2000
4095 3.3.6 Release-Job Operation
4097 This OPTIONAL operation allows a client to release a previously held
4098 job so that it is again eligible for scheduling. If the Hold-Job
4099 operation is supported, then the Release-Job operation MUST be
4100 supported, and vice-versa.
4102 This operation removes the "job-hold-until" job attribute, if
4103 present, from the job object that had been supplied in the create or
4104 most recent Hold-Job or Restart-Job operation and removes its effect
4105 on the job. The IPP object MUST remove the 'job-hold-until-
4106 specified' value from the job's "job-state-reasons" attribute, if
4107 present. See section 4.3.8.
4109 The IPP object MUST accept or reject the request based on the job's
4110 current state and transition the job to the indicated new state as
4113 Current "job- New "job-state" IPP object's response status
4114 state" code and action:
4116 'pending' 'pending' 'successful-ok'
4117 No effect on the job.
4118 'pending-held' 'pending-held' 'successful-ok' See Rule 1
4119 'pending-held' 'pending' 'successful-ok'
4120 'processing' 'processing' 'successful-ok'
4121 No effect on the job.
4122 'processing- 'processing- 'successful-ok'
4123 stopped' stopped' No effect on the job.
4124 'completed' 'completed' 'client-error-not-possible'
4125 'canceled' 'canceled' 'client-error-not-possible'
4126 'aborted' 'aborted' 'client-error-not-possible'
4128 Rule 1: If there are other reasons to keep the job in the 'pending-
4129 held' state, such as 'resources-are-not-ready', the job remains in
4130 the 'pending-held' state. Thus the 'pending-held' state is not just
4131 for jobs that have the 'job-hold-until' applied to them, but are for
4132 any reason to keep the job from being a candidate for scheduling and
4133 processing, such as 'resources-are-not-ready'. See the "job-hold-
4134 until" attribute (section 4.2.2).
4136 Access Rights: The authenticated user (see section 8.3) performing
4137 this operation must either be the job owner or an operator or
4138 administrator of the Printer object (see Sections 1 and 8.5).
4139 Otherwise, the IPP object MUST reject the operation and return:
4140 'client-error-forbidden', 'client-error-not-authenticated', or
4141 'client-error-not-authorized' as appropriate.
4146 Hastings, et al. Standards Track [Page 74]
4148 RFC 2911 IPP/1.1: Model and Semantics September 2000
4151 The Release-Job Request and Release-Job Response have the same
4152 attribute groups and attributes as the Cancel-Job operation (see
4153 section 3.3.3.1 and 3.3.3.2).
4155 3.3.7 Restart-Job Operation
4157 This OPTIONAL operation allows a client to restart a job that is
4158 retained in the queue after processing has completed (see section
4161 The job is moved to the 'pending' or 'pending-held' job state and
4162 restarts at the beginning on the same IPP Printer object with the
4163 same attribute values. If any of the documents in the job were
4164 passed by reference (Print-URI or Send-URI), the Printer MUST re-
4165 fetch the data, since the semantics of Restart-Job are to repeat all
4166 Job processing. The Job Description attributes that accumulate job
4167 progress, such as "job-impressions-completed", "job-media-sheets-
4168 completed", and "job-k-octets-processed", MUST be reset to 0 so that
4169 they give an accurate record of the job from its restart point. The
4170 job object MUST continue to use the same "job-uri" and "job-id"
4173 Note: If in the future an operation is needed that does not reset
4174 the job progress attributes, then a new operation will be defined
4175 which makes a copy of the job, assigns a new "job-uri" and "job-id"
4176 to the copy and resets the job progress attributes in the new copy
4179 The IPP object MUST accept or reject the request based on the job's
4180 current state, transition the job to the indicated new state as
4202 Hastings, et al. Standards Track [Page 75]
4204 RFC 2911 IPP/1.1: Model and Semantics September 2000
4207 Current "job- New "job-state" IPP object's response status
4208 state" code and action:
4210 'pending' 'pending' 'client-error-not-possible'
4211 'pending-held' 'pending-held' 'client-error-not-possible'
4212 'processing' 'processing' 'client-error-not-possible'
4213 'processing- 'processing- 'client-error-not-possible'
4215 'completed' 'pending' or 'successful-ok' - job is started
4216 'pending-held' over.
4217 'completed' 'completed' 'client-error-not-possible' -
4219 'canceled' 'pending' or 'successful-ok' - job is started
4220 'pending-held' over.
4221 'canceled' 'canceled' 'client-error-not-possible' -
4223 'aborted' 'pending' or 'successful-ok' - job is started
4224 'pending-held' over.
4225 'aborted' 'aborted' 'client-error-not-possible' -
4228 Rule 1: If the Job Retention Period has expired for the job in this
4229 state, then the IPP object rejects the operation. See section
4232 Note: In order to prevent a user from inadvertently restarting a job
4233 in the middle, the Restart-Job request is rejected when the job is in
4234 the 'processing' or 'processing-stopped' states. If in the future an
4235 operation is needed to hold or restart jobs while in these states, it
4236 will be added as an additional operation, rather than overloading the
4237 Restart-Job operation, so that it is clear that the user intended
4238 that the current job not be completed.
4240 Access Rights: The authenticated user (see section 8.3) performing
4241 this operation must either be the job owner or an operator or
4242 administrator of the Printer object (see Sections 1 and 8.5).
4243 Otherwise, the IPP object MUST reject the operation and return:
4244 'client-error-forbidden', 'client-error-not-authenticated', or
4245 'client-error-not-authorized' as appropriate.
4247 3.3.7.1 Restart-Job Request
4249 The groups and attributes are the same as for a Cancel-Job request
4250 (see section 3.3.3.1), with the addition of the following Group 1
4251 Operation attribute:
4258 Hastings, et al. Standards Track [Page 76]
4260 RFC 2911 IPP/1.1: Model and Semantics September 2000
4263 "job-hold-until" (type3 keyword | name(MAX)):
4264 The client OPTIONALLY supplies this attribute. The IPP object
4265 MUST support this Operation attribute in a Restart-Job request,
4266 if it supports the "job-hold-until" Job Template attribute in
4267 create operations. See section 4.2.2. Otherwise, the IPP
4268 object NEED NOT support the "job-hold-until" Operation
4269 attribute in a Restart-Job request.
4271 If supplied and supported as specified in the Printer's "job-
4272 hold-until-supported" attribute, the IPP object copies the
4273 supplied Operation attribute to the Job object, replacing the
4274 job's previous "job-hold-until" attribute, if present, and
4275 makes the job a candidate for scheduling during the supplied
4276 named time period. See section 4.2.2.
4278 If supplied, but the value is not supported, the IPP object
4279 accepts the request, returns the unsupported attribute or value
4280 in the Unsupported Attributes Group according to section 3.1.7,
4281 returns the 'successful-ok-ignored-or-substituted-attributes'
4282 status code, and holds the job indefinitely until a client
4283 performs a subsequent Release-Job operation.
4285 If supplied, but the "job-hold-until" Operation attribute
4286 itself is not supported, the IPP object accepts the request,
4287 returns the unsupported attribute with the out-of-band
4288 'unsupported' value in the Unsupported Attributes Group
4289 according to section 3.1.7, returns the 'successful-ok-
4290 ignored-or-substituted-attributes' status code, and restarts
4291 the job, i.e., ignores the "job-hold-until" attribute.
4293 If the client (1) supplies a value that specifies a time period
4294 that has already started or the 'no-hold' value (meaning don't
4295 hold the job) and (2) the IPP object supports the "job-hold-
4296 until" operation attribute and there are no other reasons to
4297 hold the job, the IPP object makes the job a candidate for
4298 processing immediately (see Section 4.2.2).
4300 If the client does not supply a "job-hold-until" operation
4301 attribute in the request, the IPP object removes the "job-
4302 hold-until" attribute, if present, from the job. If there are
4303 no other reasons to hold the job, the Restart-Job operation
4304 makes the job a candidate for processing immediately (see
4314 Hastings, et al. Standards Track [Page 77]
4316 RFC 2911 IPP/1.1: Model and Semantics September 2000
4319 3.3.7.2 Restart-Job Response
4321 The groups and attributes are the same as for a Cancel-Job response
4322 (see section 3.3.3.2).
4324 Note: In the future an OPTIONAL Modify-Job or Set-Job-Attributes
4325 operation may be specified that allows the client to modify other
4326 attributes before releasing the restarted job.
4328 4. Object Attributes
4330 This section describes the attributes with their corresponding
4331 attribute syntaxes and values that are part of the IPP model. The
4332 sections below show the objects and their associated attributes which
4333 are included within the scope of this protocol. Many of these
4334 attributes are derived from other relevant documents:
4336 - Document Printing Application (DPA) [ISO10175]
4337 - RFC 1759 Printer MIB [RFC1759]
4339 Each attribute is uniquely identified in this document using a
4340 "keyword" (see section 12.2.1) which is the name of the attribute.
4341 The keyword is included in the section header describing that
4344 Note: Not only are keywords used to identify attributes, but one of
4345 the attribute syntaxes described below is "keyword" so that some
4346 attributes have keyword values. Therefore, these attributes are
4347 defined as having an attribute syntax that is a set of keywords.
4349 4.1 Attribute Syntaxes
4351 This section defines the basic attribute syntax types that all
4352 clients and IPP objects MUST be able to accept in responses and
4353 accept in requests, respectively. Each attribute description in
4354 sections 3 and 4 includes the name of attribute syntax(es) in the
4355 heading (in parentheses). A conforming implementation of an
4356 attribute MUST include the semantics of the attribute syntax(es) so
4357 identified. Section 6.3 describes how the protocol can be extended
4358 with new attribute syntaxes.
4360 The attribute syntaxes are specified in the following sub-sections,
4361 where the sub-section heading is the keyword name of the attribute
4362 syntax inside the single quotes. In operation requests and responses
4363 each attribute value MUST be represented as one of the attribute
4364 syntaxes specified in the sub-section heading for the attribute. In
4365 addition, the value of an attribute in a response (but not in a
4370 Hastings, et al. Standards Track [Page 78]
4372 RFC 2911 IPP/1.1: Model and Semantics September 2000
4375 request) MAY be one of the "out-of-band" values whose special
4376 encoding rules are defined in the "Encoding and Transport" document
4377 [RFC2910]. Standard "out-of-band" values are:
4379 'unknown': The attribute is supported by the IPP object, but the
4380 value is unknown to the IPP object for some reason.
4381 'unsupported': The attribute is unsupported by the IPP object.
4382 This value MUST be returned only as the value of an attribute
4383 in the Unsupported Attributes Group.
4384 'no-value': The attribute is supported by the Printer object, but
4385 the administrator has not yet configured a value.
4387 All attributes in a request MUST have one or more values as defined
4388 in Sections 4.2 to 4.4. Thus clients MUST NOT supply attributes with
4389 "out-of-band" values for operations defined in this document. All
4390 attributes in a response MUST have one or more values as defined in
4391 Sections 4.2 to 4.4 or a single "out-of-band" value.
4393 Most attributes are defined to have a single attribute syntax.
4394 However, a few attributes (e.g., "job-sheet", "media", "job-hold-
4395 until") are defined to have several attribute syntaxes, depending on
4396 the value. These multiple attribute syntaxes are separated by the
4397 "|" character in the sub-section heading to indicate the choice.
4398 Since each value MUST be tagged as to its attribute syntax in the
4399 protocol, a single-valued attribute instance may have any one of its
4400 attribute syntaxes and a multi-valued attribute instance may have a
4401 mixture of its defined attribute syntaxes.
4405 A text attribute is an attribute whose value is a sequence of zero or
4406 more characters encoded in a maximum of 1023 ('MAX') octets. MAX is
4407 the maximum length for each value of any text attribute. However, if
4408 an attribute will always contain values whose maximum length is much
4409 less than MAX, the definition of that attribute will include a
4410 qualifier that defines the maximum length for values of that
4411 attribute. For example: the "printer-location" attribute is
4412 specified as "printer-location (text(127))". In this case, text
4413 values for "printer-location" MUST NOT exceed 127 octets; if supplied
4414 with a longer text string via some external interface (other than the
4415 protocol), implementations are free to truncate to this shorter
4418 In this document, all text attributes are defined using the 'text'
4419 syntax. However, 'text' is used only for brevity; the formal
4420 interpretation of 'text' is: 'textWithoutLanguage |
4421 textWithLanguage'. That is, for any attribute defined in this
4422 document using the 'text' attribute syntax, all IPP objects and
4426 Hastings, et al. Standards Track [Page 79]
4428 RFC 2911 IPP/1.1: Model and Semantics September 2000
4431 clients MUST support both the 'textWithoutLanguage' and
4432 'textWithLanguage' attribute syntaxes. However, in actual usage and
4433 protocol execution, objects and clients accept and return only one of
4434 the two syntax per attribute. The syntax 'text' never appears "on-
4437 Both 'textWithoutLanguage' and 'textWithLanguage' are needed to
4438 support the real world needs of interoperability between sites and
4439 systems that use different natural languages as the basis for human
4440 communication. Generally, one natural language applies to all text
4441 attributes in a given request or response. The language is indicated
4442 by the "attributes-natural-language" operation attribute defined in
4443 section 3.1.4 or "attributes-natural-language" job attribute defined
4444 in section 4.3.20, and there is no need to identify the natural
4445 language for each text string on a value-by-value basis. In these
4446 cases, the attribute syntax 'textWithoutLanguage' is used for text
4447 attributes. In other cases, the client needs to supply or the
4448 Printer object needs to return a text value in a natural language
4449 that is different from the rest of the text values in the request or
4450 response. In these cases, the client or Printer object uses the
4451 attribute syntax 'textWithLanguage' for text attributes (this is the
4452 Natural Language Override mechanism described in section 3.1.4).
4454 The 'textWithoutLanguage' and 'textWithLanguage' attribute syntaxes
4455 are described in more detail in the following sections.
4457 4.1.1.1 'textWithoutLanguage'
4459 The 'textWithoutLanguage' syntax indicates a value that is sequence
4460 of zero or more characters encoded in a maximum of 1023 (MAX) octets.
4461 Text strings are encoded using the rules of some charset. The
4462 Printer object MUST support the UTF-8 charset [RFC2279] and MAY
4463 support additional charsets to represent 'text' values, provided that
4464 the charsets are registered with IANA [IANA-CS]. See Section 4.1.7
4465 for the definition of the 'charset' attribute syntax, including
4466 restricted semantics and examples of charsets.
4468 4.1.1.2 'textWithLanguage'
4470 The 'textWithLanguage' attribute syntax is a compound attribute
4471 syntax consisting of two parts: a 'textWithoutLanguage' part encoded
4472 in a maximum of 1023 (MAX) octets plus an additional
4473 'naturalLanguage' (see section 4.1.8) part that overrides the natural
4474 language in force. The 'naturalLanguage' part explicitly identifies
4475 the natural language that applies to the text part of that value and
4476 that value alone. For any give text attribute, the
4477 'textWithoutLanguage' part is limited to the maximum length defined
4478 for that 'text' attribute, and the 'naturalLanguage' part is always
4482 Hastings, et al. Standards Track [Page 80]
4484 RFC 2911 IPP/1.1: Model and Semantics September 2000
4487 limited to 63 (additional) octets. Using the 'textWithLanguage'
4488 attribute syntax rather than the normal 'textWithoutLanguage' syntax
4489 is the so-called Natural Language Override mechanism and MUST be
4490 supported by all IPP objects and clients.
4492 If the attribute is multi-valued (1setOf text), then the
4493 'textWithLanguage' attribute syntax MUST be used to explicitly
4494 specify each attribute value whose natural language needs to be
4495 overridden. Other values in a multi-valued 'text' attribute in a
4496 request or a response revert to the natural language of the operation
4499 In a create request, the Printer object MUST accept and store with
4500 the Job object any natural language in the "attributes-natural-
4501 language" operation attribute, whether the Printer object supports
4502 that natural language or not. Furthermore, the Printer object MUST
4503 accept and store any 'textWithLanguage' attribute value, whether the
4504 Printer object supports that natural language or not. These
4505 requirements are independent of the value of the "ipp-attribute-
4506 fidelity" operation attribute that the client MAY supply.
4508 Example: If the client supplies the "attributes-natural-language"
4509 operation attribute with the value: 'en' indicating English, but the
4510 value of the "job-name" attribute is in French, the client MUST use
4511 the 'textWithLanguage' attribute syntax with the following two
4514 'fr': Natural Language Override indicating French
4515 'Rapport Mensuel': the job name in French
4517 See the "Encoding and Transport" document [RFC2910] section 3.9 for
4518 the encoding of the two parts and Appendix A for a detailed example
4519 of the 'textWithLanguage' attribute syntax.
4523 This syntax type is used for user-friendly strings, such as a Printer
4524 name, that, for humans, are more meaningful than identifiers. Names
4525 are never translated from one natural language to another. The
4526 'name' attribute syntax is essentially the same as 'text', including
4527 the REQUIRED support of UTF-8 except that the sequence of characters
4528 is limited so that its encoded form MUST NOT exceed 255 (MAX) octets.
4530 Also like 'text', 'name' is really an abbreviated notation for either
4531 'nameWithoutLanguage' or 'nameWithLanguage'. That is, all IPP
4532 objects and clients MUST support both the 'nameWithoutLanguage' and
4533 'nameWithLanguage' attribute syntaxes. However, in actual usage and
4538 Hastings, et al. Standards Track [Page 81]
4540 RFC 2911 IPP/1.1: Model and Semantics September 2000
4543 protocol execution, objects and clients accept and return only one of
4544 the two syntax per attribute. The syntax 'name' never appears "on-
4547 Only the 'text' and 'name' attribute syntaxes permit the Natural
4548 Language Override mechanism.
4550 Some attributes are defined as 'type3 keyword | name'. These
4551 attributes support values that are either type3 keywords or names.
4552 This dual-syntax mechanism enables a site administrator to extend
4553 these attributes to legally include values that are locally defined
4554 by the site administrator. Such names are not registered with IANA.
4556 4.1.2.1 'nameWithoutLanguage'
4558 The 'nameWithoutLanguage' syntax indicates a value that is sequence
4559 of zero or more characters encoded in a maximum of 255 (MAX) octets.
4561 4.1.2.2 'nameWithLanguage'
4563 The 'nameWithLanguage' attribute syntax is a compound attribute
4564 syntax consisting of two parts: a 'nameWithoutLanguage' part encoded
4565 in a maximum of 1023 (MAX) octets plus an additional
4566 'naturalLanguage' (see section 4.1.8) part that overrides the natural
4567 language in force. The 'naturalLanguage' part explicitly identifies
4568 the natural language that applies to that name value and that name
4569 value alone. For any give text attribute, the 'textWithoutLanguage'
4570 part is limited to the maximum length defined for that 'text'
4571 attribute, and the 'naturalLanguage' part is always limited to 63
4572 (additional) octets. Using the 'textWithLanguage' attribute syntax
4573 rather than the normal 'textWithoutLanguage' syntax is the so-called
4574 Natural Language Override mechanism and MUST be supported by all IPP
4575 objects and clients.
4577 The 'nameWithLanguage' attribute syntax behaves the same as the
4578 'textWithLanguage' syntax. Using the 'textWithLanguage' attribute
4579 syntax rather than the normal 'textWithoutLanguage' syntax is the
4580 so-called Natural Language Override mechanism and MUST be supported
4581 by all IPP objects and clients. If a name is in a language that is
4582 different than the rest of the object or operation, then this
4583 'nameWithLanguage' syntax is used rather than the generic
4584 'nameWithoutLanguage' syntax.
4586 If the attribute is multi-valued (1setOf text), then the
4587 'nameWithLanguage' attribute syntax MUST be used to explicitly
4588 specify each attribute value whose natural language needs to be
4594 Hastings, et al. Standards Track [Page 82]
4596 RFC 2911 IPP/1.1: Model and Semantics September 2000
4599 Other values in a multi-valued 'name' attribute in a request or a
4600 response revert to the natural language of the operation attribute.
4602 In a create request, the Printer object MUST accept and store with
4603 the Job object any natural language in the "attributes-natural-
4604 language" operation attribute, whether the Printer object supports
4605 that natural language or not. Furthermore, the Printer object MUST
4606 accept and store any 'nameWithLanguage' attribute value, whether the
4607 Printer object supports that natural language or not. These
4608 requirements are independent of the value of the "ipp-attribute-
4609 fidelity" operation attribute that the client MAY supply.
4611 Example: If the client supplies the "attributes-natural-language"
4612 operation attribute with the value: 'en' indicating English, but the
4613 "printer-name" attribute is in German, the client MUST use the
4614 'nameWithLanguage' attribute syntax as follows:
4616 'de': Natural Language Override indicating German
4617 'Farbdrucker': the Printer name in German
4619 See the "Encoding and Transport" document [RFC2910] section 3.9 for
4620 the encoding of the two parts and Appendix A for a detailed example
4621 of the 'nameWithLanguage' attribute syntax.
4623 4.1.2.3 Matching 'name' attribute values
4625 For purposes of matching two 'name' attribute values for equality,
4626 such as in job validation (where a client-supplied value for
4627 attribute "xxx" is checked to see if the value is among the values of
4628 the Printer object's corresponding "xxx-supported" attribute), the
4629 following match rules apply:
4631 1. 'keyword' values never match 'name' values.
4633 2. 'name' (nameWithoutLanguage and nameWithLanguage) values match
4634 if (1) the name parts match and (2) the Associated Natural-
4635 Language parts (see section 3.1.4.1) match. The matching rules
4638 a. the name parts match if the two names are identical
4639 character by character, except it is RECOMMENDED that case
4640 be ignored. For example: 'Ajax-letter-head-white' MUST
4641 match 'Ajax-letter-head-white' and SHOULD match 'ajax-
4642 letter-head-white' and 'AJAX-LETTER-HEAD-WHITE'.
4650 Hastings, et al. Standards Track [Page 83]
4652 RFC 2911 IPP/1.1: Model and Semantics September 2000
4655 b. the Associated Natural-Language parts match if the shorter
4656 of the two meets the syntactic requirements of RFC 1766
4657 [RFC1766] and matches byte for byte with the longer. For
4658 example, 'en' matches 'en', 'en-us' and 'en-gb', but matches
4659 neither 'fr' nor 'e'.
4663 The 'keyword' attribute syntax is a sequence of characters, length: 1
4664 to 255, containing only the US-ASCII [ASCII] encoded values for
4665 lowercase letters ("a" - "z"), digits ("0" - "9"), hyphen ("-"), dot
4666 ("."), and underscore ("_"). The first character MUST be a lowercase
4667 letter. Furthermore, keywords MUST be in U.S. English.
4669 This syntax type is used for enumerating semantic identifiers of
4670 entities in the abstract protocol, i.e., entities identified in this
4671 document. Keywords are used as attribute names or values of
4672 attributes. Unlike 'text' and 'name' attribute values, 'keyword'
4673 values MUST NOT use the Natural Language Override mechanism, since
4674 they MUST always be US-ASCII and U.S. English.
4676 Keywords are for use in the protocol. A user interface will likely
4677 provide a mapping between protocol keywords and displayable user-
4678 friendly words and phrases which are localized to the natural
4679 language of the user. While the keywords specified in this document
4680 MAY be displayed to users whose natural language is U.S. English,
4681 they MAY be mapped to other U.S. English words for U.S. English
4682 users, since the user interface is outside the scope of this
4685 In the definition for each attribute of this syntax type, the full
4686 set of defined keyword values for that attribute are listed.
4688 When a keyword is used to represent an attribute (its name), it MUST
4689 be unique within the full scope of all IPP objects and attributes.
4690 When a keyword is used to represent a value of an attribute, it MUST
4691 be unique just within the scope of that attribute. That is, the same
4692 keyword MUST NOT be used for two different values within the same
4693 attribute to mean two different semantic ideas. However, the same
4694 keyword MAY be used across two or more attributes, representing
4695 different semantic ideas for each attribute. Section 6.1 describes
4696 how the protocol can be extended with new keyword values. Examples
4697 of attribute name keywords:
4700 "attributes-charset"
4706 Hastings, et al. Standards Track [Page 84]
4708 RFC 2911 IPP/1.1: Model and Semantics September 2000
4711 Note: This document uses "type1", "type2", and "type3" prefixes to
4712 the "keyword" basic syntax to indicate different levels of review for
4713 extensions (see section 6.1).
4717 The 'enum' attribute syntax is an enumerated integer value that is in
4718 the range from 1 to 2**31 - 1 (MAX). Each value has an associated
4719 'keyword' name. In the definition for each attribute of this syntax
4720 type, the full set of possible values for that attribute are listed.
4721 This syntax type is used for attributes for which there are enum
4722 values assigned by other standards, such as SNMP MIBs. A number of
4723 attribute enum values in this document are also used for
4724 corresponding attributes in other standards [RFC1759]. This syntax
4725 type is not used for attributes to which the administrator may assign
4726 values. Section 6.1 describes how the protocol can be extended with
4729 Enum values are for use in the protocol. A user interface will
4730 provide a mapping between protocol enum values and displayable user-
4731 friendly words and phrases which are localized to the natural
4732 language of the user. While the enum symbols specified in this
4733 document MAY be displayed to users whose natural language is U.S.
4734 English, they MAY be mapped to other U.S. English words for U.S.
4735 English users, since the user interface is outside the scope of this
4738 Note: SNMP MIBs use '2' for 'unknown' which corresponds to the IPP
4739 "out-of-band" value 'unknown'. See the description of the "out-of-
4740 band" values at the beginning of Section 4.1. Therefore, attributes
4741 of type 'enum' start at '3'.
4743 Note: This document uses "type1", "type2", and "type3" prefixes to
4744 the "enum" basic syntax to indicate different levels of review for
4745 extensions (see section 6.1).
4749 The 'uri' attribute syntax is any valid Uniform Resource Identifier
4750 or URI [RFC2396]. Most often, URIs are simply Uniform Resource
4751 Locators or URLs. The maximum length of URIs used as values of IPP
4752 attributes is 1023 octets. Although most other IPP attribute syntax
4753 types allow for only lower-cased values, this attribute syntax type
4754 conforms to the case-sensitive and case-insensitive rules specified
4755 in [RFC2396]. See also [IPP-IIG] for a discussion of case in URIs.
4762 Hastings, et al. Standards Track [Page 85]
4764 RFC 2911 IPP/1.1: Model and Semantics September 2000
4769 The 'uriScheme' attribute syntax is a sequence of characters
4770 representing a URI scheme according to RFC 2396 [RFC2396]. Though
4771 RFC 2396 requires that the values be case-insensitive, IPP requires
4772 all lower case values in IPP attributes to simplify comparing by IPP
4773 clients and Printer objects.
4775 Standard values for this syntax type are the following keywords:
4777 'ipp': for IPP schemed URIs (e.g., "ipp:...")
4778 'http': for HTTP schemed URIs (e.g., "http:...")
4779 'https': for use with HTTPS schemed URIs (e.g., "https:...") (not
4780 on IETF standards track)
4781 'ftp': for FTP schemed URIs (e.g., "ftp:...")
4782 'mailto': for SMTP schemed URIs (e.g., "mailto:...")
4783 'file': for file schemed URIs (e.g., "file:...")
4785 A Printer object MAY support any URI 'scheme' that has been
4786 registered with IANA [IANA-MT]. The maximum length of URI 'scheme'
4787 values used to represent IPP attribute values is 63 octets.
4791 The 'charset' attribute syntax is a standard identifier for a
4792 charset. A charset is a coded character set and encoding scheme.
4793 Charsets are used for labeling certain document contents and 'text'
4794 and 'name' attribute values. The syntax and semantics of this
4795 attribute syntax are specified in RFC 2046 [RFC2046] and contained in
4796 the IANA character-set Registry [IANA-CS] according to the IANA
4797 procedures [RFC2278]. Though RFC 2046 requires that the values be
4798 case-insensitive US-ASCII [ASCII], IPP requires all lower case values
4799 in IPP attributes to simplify comparing by IPP clients and Printer
4800 objects. When a character-set in the IANA registry has more than one
4801 name (alias), the name labeled as "(preferred MIME name)", if
4802 present, MUST be used.
4804 The maximum length of 'charset' values used to represent IPP
4805 attribute values is 63 octets.
4809 'utf-8': ISO 10646 Universal Multiple-Octet Coded Character Set
4810 (UCS) represented as the UTF-8 [RFC2279] transfer encoding
4811 scheme in which US-ASCII is a subset charset.
4812 'us-ascii': 7-bit American Standard Code for Information
4813 Interchange (ASCII), ANSI X3.4-1986 [ASCII]. That standard
4818 Hastings, et al. Standards Track [Page 86]
4820 RFC 2911 IPP/1.1: Model and Semantics September 2000
4823 defines US-ASCII, but RFC 2045 [RFC2045] eliminates most of the
4824 control characters from conformant usage in MIME and IPP.
4825 'iso-8859-1': 8-bit One-Byte Coded Character Set, Latin Alphabet
4826 Nr 1 [ISO8859-1]. That standard defines a coded character set
4827 that is used by Latin languages in the Western Hemisphere and
4828 Western Europe. US-ASCII is a subset charset.
4830 Some attribute descriptions MAY place additional requirements on
4831 charset values that may be used, such as REQUIRED values that MUST be
4832 supported or additional restrictions, such as requiring that the
4833 charset have US- ASCII as a subset charset.
4835 4.1.8 'naturalLanguage'
4837 The 'naturalLanguage' attribute syntax is a standard identifier for a
4838 natural language and optionally a country. The values for this
4839 syntax type are defined by RFC 1766 [RFC1766]. Though RFC 1766
4840 requires that the values be case-insensitive US-ASCII [ASCII], IPP
4841 requires all lower case to simplify comparing by IPP clients and
4842 Printer objects. Examples include:
4845 'en-us': for US English
4849 The maximum length of 'naturalLanguage' values used to represent IPP
4850 attribute values is 63 octets.
4852 4.1.9 'mimeMediaType'
4854 The 'mimeMediaType' attribute syntax is the Internet Media Type
4855 (sometimes called MIME type) as defined by RFC 2046 [RFC2046] and
4856 registered according to the procedures of RFC 2048 [RFC2048] for
4857 identifying a document format. The value MAY include a charset, or
4858 other, parameter, depending on the specification of the Media Type in
4859 the IANA Registry [IANA-MT]. Although most other IPP syntax types
4860 allow for only lower-cased values, this syntax type allows for
4861 mixed-case values which are case-insensitive.
4864 'text/html': An HTML document
4865 'text/plain': A plain text document in US-ASCII (RFC 2046
4866 indicates that in the absence of the charset parameter MUST
4867 mean US-ASCII rather than simply unspecified) [RFC2046].
4868 'text/plain; charset=US-ASCII': A plain text document in US-ASCII
4874 Hastings, et al. Standards Track [Page 87]
4876 RFC 2911 IPP/1.1: Model and Semantics September 2000
4879 'text/plain; charset=ISO-8859-1': A plain text document in ISO
4880 8859-1 (Latin 1) [ISO8859-1].
4881 'text/plain; charset=utf-8': A plain text document in ISO 10646
4882 represented as UTF-8 [RFC2279]
4883 'application/postscript': A PostScript document [RFC2046]
4884 'application/vnd.hp-PCL': A PCL document [IANA-MT] (charset
4885 escape sequence embedded in the document data)
4886 'application/pdf': Portable Document Format - see IANA MIME Media
4888 'application/octet-stream': Auto-sense - see section 4.1.9.1
4890 The maximum length of a 'mimeMediaType' value to represent IPP
4891 attribute values is 255 octets.
4893 4.1.9.1 Application/octet-stream -- Auto-Sensing the document format
4895 One special type is 'application/octet-stream'. If the Printer
4896 object supports this value, the Printer object MUST be capable of
4897 auto-sensing the format of the document data using an
4898 implementation-dependent method that examines some number of octets
4899 of the document data, either as part of the create operation and/or
4900 at document processing time. During auto-sensing, a Printer may
4901 determine that the document-data has a format that the Printer
4902 doesn't recognize. If the Printer determines this problem before
4903 returning an operation response, it rejects the request and returns
4904 the 'client-error-document-format-not-supported' status code. If the
4905 Printer determines this problem after accepting the request and
4906 returning an operation response with one of the successful status
4907 codes, the Printer adds the 'unsupported-document-format' value to
4908 the job's "job-state-reasons" attribute.
4910 If the Printer object's default value attribute "document-format-
4911 default" is set to 'application/octet-stream', the Printer object not
4912 only supports auto-sensing of the document format, but will depend on
4913 the result of applying its auto-sensing when the client does not
4914 supply the "document-format" attribute. If the client supplies a
4915 document format value, the Printer MUST rely on the supplied
4916 attribute, rather than trust its auto-sensing algorithm. To
4919 1. If the client does not supply a document format value, the
4920 Printer MUST rely on its default value setting (which may be
4921 'application/octet-stream' indicating an auto-sensing
4923 2. If the client supplies a value other than 'application/octet-
4924 stream', the client is supplying valid information about the
4925 format of the document data and the Printer object MUST trust
4926 the client supplied value more than the outcome of applying an
4930 Hastings, et al. Standards Track [Page 88]
4932 RFC 2911 IPP/1.1: Model and Semantics September 2000
4935 automatic format detection mechanism. For example, the client
4936 may be requesting the printing of a PostScript file as a
4937 'text/plain' document. The Printer object MUST print a text
4938 representation of the PostScript commands rather than interpret
4939 the stream of PostScript commands and print the result.
4940 3. If the client supplies a value of 'application/octet-stream',
4941 the client is indicating that the Printer object MUST use its
4942 auto-sensing mechanism on the client supplied document data
4943 whether auto-sensing is the Printer object's default or not.
4945 Note: Since the auto-sensing algorithm is probabilistic, if the
4946 client requests both auto-sensing ("document-format" set to
4947 'application/octet-stream') and true fidelity ("ipp-attribute-
4948 fidelity" set to 'true'), the Printer object might not be able to
4949 guarantee exactly what the end user intended (the auto-sensing
4950 algorithm might mistake one document format for another), but it is
4951 able to guarantee that its auto-sensing mechanism be used.
4953 When a Printer performs auto-sensing of a document in a submitted
4954 job, it is RECOMMENDED that the Printer indicate to the user that
4955 such auto-sensing has occurred and which document-format was auto-
4956 sensed by printing that information on the job's job-start-sheet.
4958 4.1.10 'octetString'
4960 The 'octetString' attribute syntax is a sequence of octets encoded in
4961 a maximum of 1023 octets which is indicated in sub-section headers
4962 using the notation: octetString(MAX). This syntax type is used for
4967 The 'boolean' attribute syntax has only two values: 'true' and
4972 The 'integer' attribute syntax is an integer value that is in the
4973 range from -2**31 (MIN) to 2**31 - 1 (MAX). Each individual
4974 attribute may specify the range constraint explicitly in sub-section
4975 headers if the range is different from the full range of possible
4976 integer values. For example: job-priority (integer(1:100)) for the
4977 "job-priority" attribute. However, the enforcement of that
4978 additional constraint is up to the IPP objects, not the protocol.
4986 Hastings, et al. Standards Track [Page 89]
4988 RFC 2911 IPP/1.1: Model and Semantics September 2000
4991 4.1.13 'rangeOfInteger'
4993 The 'rangeOfInteger' attribute syntax is an ordered pair of integers
4994 that defines an inclusive range of integer values. The first integer
4995 specifies the lower bound and the second specifies the upper bound.
4996 If a range constraint is specified in the header description for an
4997 attribute in this document whose attribute syntax is 'rangeOfInteger'
4998 (i.e., 'X:Y' indicating X as a minimum value and Y as a maximum
4999 value), then the constraint applies to both integers.
5003 The 'dateTime' attribute syntax is a standard, fixed length, 11 octet
5004 representation of the "DateAndTime" syntax as defined in RFC 2579
5005 [RFC2579]. RFC 2579 also identifies an 8 octet representation of a
5006 "DateAndTime" value, but IPP objects MUST use the 11 octet
5007 representation. A user interface will provide a mapping between
5008 protocol dateTime values and displayable user-friendly words or
5009 presentation values and phrases which are localized to the natural
5010 language and date format of the user, including time zone.
5014 The 'resolution' attribute syntax specifies a two-dimensional
5015 resolution in the indicated units. It consists of 3 values: a cross
5016 feed direction resolution (positive integer value), a feed direction
5017 resolution (positive integer value), and a units value. The
5018 semantics of these three components are taken from the Printer MIB
5019 [RFC1759] suggested values. That is, the cross feed direction
5020 component resolution component is the same as the
5021 prtMarkerAddressabilityXFeedDir object in the Printer MIB, the feed
5022 direction component resolution component is the same as the
5023 prtMarkerAddressabilityFeedDir in the Printer MIB, and the units
5024 component is the same as the prtMarkerAddressabilityUnit object in
5025 the Printer MIB (namely, '3' indicates dots per inch and '4'
5026 indicates dots per centimeter). All three values MUST be present
5027 even if the first two values are the same. Example: '300', '600',
5028 '3' indicates a 300 dpi cross-feed direction resolution, a 600 dpi
5029 feed direction resolution, since a '3' indicates dots per inch (dpi).
5033 The '1setOf X' attribute syntax is 1 or more values of attribute
5034 syntax type X. This syntax type is used for multi-valued attributes.
5035 The syntax type is called '1setOf' rather than just 'setOf' as a
5036 reminder that the set of values MUST NOT be empty (i.e., a set of
5042 Hastings, et al. Standards Track [Page 90]
5044 RFC 2911 IPP/1.1: Model and Semantics September 2000
5047 size 0). Sets are normally unordered. However each attribute
5048 description of this type may specify that the values MUST be in a
5049 certain order for that attribute.
5051 4.2 Job Template Attributes
5053 Job Template attributes describe job processing behavior. Support
5054 for Job Template attributes by a Printer object is OPTIONAL (see
5055 section 12.2.3 for a description of support for OPTIONAL attributes).
5056 Also, clients OPTIONALLY supply Job Template attributes in create
5059 Job Template attributes conform to the following rules. For each Job
5060 Template attribute called "xxx":
5062 1. If the Printer object supports "xxx" then it MUST support both
5063 a "xxx-default" attribute (unless there is a "No" in the table
5064 below) and a "xxx-supported" attribute. If the Printer object
5065 doesn't support "xxx", then it MUST support neither an "xxx-
5066 default" attribute nor an "xxx-supported" attribute, and it
5067 MUST treat an attribute "xxx" supplied by a client as
5068 unsupported. An attribute "xxx" may be supported for some
5069 document formats and not supported for other document formats.
5070 For example, it is expected that a Printer object would only
5071 support "orientation-requested" for some document formats (such
5072 as 'text/plain' or 'text/html') but not others (such as
5073 'application/postscript').
5075 2. "xxx" is OPTIONALLY supplied by the client in a create request.
5076 If "xxx" is supplied, the client is indicating a desired job
5077 processing behavior for this Job. When "xxx" is not supplied,
5078 the client is indicating that the Printer object apply its
5079 default job processing behavior at job processing time if the
5080 document content does not contain an embedded instruction
5081 indicating an xxx-related behavior.
5083 Since an administrator MAY change the default value attribute
5084 after a Job object has been submitted but before it has been
5085 processed, the default value used by the Printer object at job
5086 processing time may be different that the default value in
5087 effect at job submission time.
5089 3. The "xxx-supported" attribute is a Printer object attribute
5090 that describes which job processing behaviors are supported by
5091 that Printer object. A client can query the Printer object to
5092 find out what xxx-related behaviors are supported by inspecting
5093 the returned values of the "xxx-supported" attribute.
5098 Hastings, et al. Standards Track [Page 91]
5100 RFC 2911 IPP/1.1: Model and Semantics September 2000
5103 Note: The "xxx" in each "xxx-supported" attribute name is
5104 singular, even though an "xxx-supported" attribute usually has
5105 more than one value, such as "job-sheet-supported", unless the
5106 "xxx" Job Template attribute is plural, such as "finishings" or
5107 "sides". In such cases the "xxx-supported" attribute names
5108 are: "finishings- supported" and "sides-supported".
5110 4. The "xxx-default" default value attribute describes what will
5111 be done at job processing time when no other job processing
5112 information is supplied by the client (either explicitly as an
5113 IPP attribute in the create request or implicitly as an
5114 embedded instruction within the document data).
5116 If an application wishes to present an end user with a list of
5117 supported values from which to choose, the application SHOULD query
5118 the Printer object for its supported value attributes. The
5119 application SHOULD also query the default value attributes. If the
5120 application then limits selectable values to only those value that
5121 are supported, the application can guarantee that the values supplied
5122 by the client in the create request all fall within the set of
5123 supported values at the Printer. When querying the Printer, the
5124 client MAY enumerate each attribute by name in the Get-Printer-
5125 Attributes Request, or the client MAY just name the "job-template"
5126 group in order to get the complete set of supported attributes (both
5127 supported and default attributes).
5129 The "finishings" attribute is an example of a Job Template attribute.
5130 It can take on a set of values such as 'staple', 'punch', and/or
5131 'cover'. A client can query the Printer object for the "finishings-
5132 supported" attribute and the "finishings-default" attribute. The
5133 supported attribute contains a set of supported values. The default
5134 value attribute contains the finishing value(s) that will be used for
5135 a new Job if the client does not supply a "finishings" attribute in
5136 the create request and the document data does not contain any
5137 corresponding finishing instructions. If the client does supply the
5138 "finishings" attribute in the create request, the IPP object
5139 validates the value or values to make sure that they are a subset of
5140 the supported values identified in the Printer object's "finishings-
5141 supported" attribute. See section 3.1.7.
5143 The table below summarizes the names and relationships for all Job
5144 Template attributes. The first column of the table (labeled "Job
5145 Attribute") shows the name and syntax for each Job Template attribute
5146 in the Job object. These are the attributes that can optionally be
5147 supplied by the client in a create request. The last two columns
5148 (labeled "Printer: Default Value Attribute" and "Printer: Supported
5149 Values Attribute") show the name and syntax for each Job Template
5150 attribute in the Printer object (the default value attribute and the
5154 Hastings, et al. Standards Track [Page 92]
5156 RFC 2911 IPP/1.1: Model and Semantics September 2000
5159 supported values attribute). A "No" in the table means the Printer
5160 MUST NOT support the attribute (that is, the attribute is simply not
5161 applicable). For brevity in the table, the 'text' and 'name' entries
5162 do not show the maximum length for each attribute.
5164 +===================+======================+======================+
5165 | Job Attribute |Printer: Default Value| Printer: Supported |
5166 | | Attribute | Values Attribute |
5167 +===================+======================+======================+
5168 | job-priority | job-priority-default |job-priority-supported|
5169 | (integer 1:100) | (integer 1:100) |(integer 1:100) |
5170 +-------------------+----------------------+----------------------+
5171 | job-hold-until | job-hold-until- |job-hold-until- |
5172 | (type3 keyword | | default | supported |
5173 | name) | (type3 keyword | |(1setOf ( |
5174 | | name) |type3 keyword | name))|
5175 +-------------------+----------------------+----------------------+
5176 | job-sheets | job-sheets-default |job-sheets-supported |
5177 | (type3 keyword | | (type3 keyword | |(1setOf ( |
5178 | name) | name) |type3 keyword | name))|
5179 +-------------------+----------------------+----------------------+
5180 |multiple-document- |multiple-document- |multiple-document- |
5181 | handling | handling-default |handling-supported |
5182 | (type2 keyword) | (type2 keyword) |(1setOf type2 keyword)|
5183 +-------------------+----------------------+----------------------+
5184 | copies | copies-default | copies-supported |
5185 | (integer (1:MAX)) | (integer (1:MAX)) | (rangeOfInteger |
5187 +-------------------+----------------------+----------------------+
5188 | finishings | finishings-default | finishings-supported |
5189 |(1setOf type2 enum)|(1setOf type2 enum) |(1setOf type2 enum) |
5190 +-------------------+----------------------+----------------------+
5191 | page-ranges | No | page-ranges- |
5192 | (1setOf | | supported (boolean) |
5193 | rangeOfInteger | | |
5195 +-------------------+----------------------+----------------------+
5196 | sides | sides-default | sides-supported |
5197 | (type2 keyword) | (type2 keyword) |(1setOf type2 keyword)|
5198 +-------------------+----------------------+----------------------+
5199 | number-up | number-up-default | number-up-supported |
5200 | (integer (1:MAX)) | (integer (1:MAX)) |(1setOf (integer |
5202 | | | rangeOfInteger |
5210 Hastings, et al. Standards Track [Page 93]
5212 RFC 2911 IPP/1.1: Model and Semantics September 2000
5215 +-------------------+----------------------+----------------------+
5216 | orientation- |orientation-requested-|orientation-requested-|
5217 | requested | default | supported |
5218 | (type2 enum) | (type2 enum) | (1setOf type2 enum) |
5219 +-------------------+----------------------+----------------------+
5220 | media | media-default | media-supported |
5221 | (type3 keyword | | (type3 keyword | |(1setOf ( |
5222 | name) | name) |type3 keyword | name))|
5226 | | |type3 keyword | name))|
5227 +-------------------+----------------------+----------------------+
5228 | printer-resolution| printer-resolution- | printer-resolution- |
5229 | (resolution) | default | supported |
5230 | | (resolution) |(1setOf resolution) |
5231 +-------------------+----------------------+----------------------+
5232 | print-quality | print-quality-default| print-quality- |
5233 | (type2 enum) | (type2 enum) | supported |
5234 | | |(1setOf type2 enum) |
5235 +-------------------+----------------------+----------------------+
5237 4.2.1 job-priority (integer(1:100))
5239 This attribute specifies a priority for scheduling the Job. A higher
5240 value specifies a higher priority. The value 1 indicates the lowest
5241 possible priority. The value 100 indicates the highest possible
5242 priority. Among those jobs that are ready to print, a Printer MUST
5243 print all jobs with a priority value of n before printing those with
5244 a priority value of n-1 for all n.
5246 If the Printer object supports this attribute, it MUST always support
5247 the full range from 1 to 100. No administrative restrictions are
5248 permitted. This way an end-user can always make full use of the
5249 entire range with any Printer object. If privileged jobs are
5250 implemented outside IPP/1.1, they MUST have priorities higher than
5251 100, rather than restricting the range available to end-users.
5253 If the client does not supply this attribute and this attribute is
5254 supported by the Printer object, the Printer object MUST use the
5255 value of the Printer object's "job-priority-default" at job
5256 submission time (unlike most Job Template attributes that are used if
5257 necessary at job processing time).
5259 The syntax for the "job-priority-supported" is also integer(1:100).
5260 This single integer value indicates the number of priority levels
5261 supported. The Printer object MUST take the value supplied by the
5262 client and map it to the closest integer in a sequence of n integers
5266 Hastings, et al. Standards Track [Page 94]
5268 RFC 2911 IPP/1.1: Model and Semantics September 2000
5271 values that are evenly distributed over the range from 1 to 100 using
5274 roundToNearestInt((100x+50)/n)
5276 where n is the value of "job-priority-supported" and x ranges from 0
5279 For example, if n=1 the sequence of values is 50; if n=2, the
5280 sequence of values is: 25 and 75; if n = 3, the sequence of values
5281 is: 17, 50 and 83; if n = 10, the sequence of values is: 5, 15, 25,
5282 35, 45, 55, 65, 75, 85, and 95; if n = 100, the sequence of values
5283 is: 1, 2, 3, ... 100.
5285 If the value of the Printer object's "job-priority-supported" is 10
5286 and the client supplies values in the range 1 to 10, the Printer
5287 object maps them to 5, in the range 11 to 20, the Printer object maps
5290 4.2.2 job-hold-until (type3 keyword | name (MAX))
5292 This attribute specifies the named time period during which the Job
5293 MUST become a candidate for printing.
5295 Standard keyword values for named time periods are:
5297 'no-hold': immediately, if there are not other reasons to hold the
5299 'indefinite': - the job is held indefinitely, until a client
5300 performs a Release-Job (section 3.3.6)
5301 'day-time': during the day
5305 'second-shift': second-shift (after close of business)
5306 'third-shift': third-shift (after midnight)
5308 An administrator MUST associate allowable print times with a named
5309 time period (by means outside the scope of this IPP/1.1 document).
5310 An administrator is encouraged to pick names that suggest the type of
5311 time period. An administrator MAY define additional values using the
5312 'name' or 'keyword' attribute syntax, depending on implementation.
5314 If the value of this attribute specifies a time period that is in the
5315 future, the Printer SHOULD add the 'job-hold-until-specified' value
5316 to the job's "job-state-reasons" attribute, MUST move the job to the
5322 Hastings, et al. Standards Track [Page 95]
5324 RFC 2911 IPP/1.1: Model and Semantics September 2000
5327 'pending-held' state, and MUST NOT schedule the job for printing
5328 until the specified time-period arrives.
5330 When the specified time period arrives, the Printer MUST remove the
5331 'job-hold-until-specified' value from the job's "job-state-reason"
5332 attribute, if present. If there are no other job state reasons that
5333 keep the job in the 'pending-held' state, the Printer MUST consider
5334 the job as a candidate for processing by moving the job to the
5337 If this job attribute value is the named value 'no-hold', or the
5338 specified time period has already started, the job MUST be a
5339 candidate for processing immediately.
5341 If the client does not supply this attribute and this attribute is
5342 supported by the Printer object, the Printer object MUST use the
5343 value of the Printer object's "job-hold-until-default" at job
5344 submission time (unlike most Job Template attributes that are used if
5345 necessary at job processing time).
5347 4.2.3 job-sheets (type3 keyword | name(MAX))
5349 This attribute determines which job start/end sheet(s), if any, MUST
5350 be printed with a job.
5352 Standard keyword values are:
5354 'none': no job sheet is printed
5355 'standard': one or more site specific standard job sheets are
5356 printed, e.g. a single start sheet or both start and end sheet is
5359 An administrator MAY define additional values using the 'name' or
5360 'keyword' attribute syntax, depending on implementation.
5362 The effect of this attribute on jobs with multiple documents MAY be
5363 affected by the "multiple-document-handling" job attribute (section
5364 4.2.4), depending on the job sheet semantics.
5366 4.2.4 multiple-document-handling (type2 keyword)
5368 This attribute is relevant only if a job consists of two or more
5369 documents. This attribute MUST be supported with at least one value
5370 if the Printer supports multiple documents per job (see sections
5371 3.2.4 and 3.3.1). The attribute controls finishing operations and
5372 the placement of one or more print-stream pages into impressions and
5373 onto media sheets. When the value of the "copies" attribute exceeds
5374 1, it also controls the order in which the copies that result from
5378 Hastings, et al. Standards Track [Page 96]
5380 RFC 2911 IPP/1.1: Model and Semantics September 2000
5383 processing the documents are produced. For the purposes of this
5384 explanations, if "a" represents an instance of document data, then
5385 the result of processing the data in document "a" is a sequence of
5386 media sheets represented by "a(*)".
5388 Standard keyword values are:
5390 'single-document': If a Job object has multiple documents, say,
5391 the document data is called a and b, then the result of
5392 processing all the document data (a and then b) MUST be treated
5393 as a single sequence of media sheets for finishing operations;
5394 that is, finishing would be performed on the concatenation of
5395 the sequences a(*),b(*). The Printer object MUST NOT force the
5396 data in each document instance to be formatted onto a new
5397 print-stream page, nor to start a new impression on a new media
5398 sheet. If more than one copy is made, the ordering of the sets
5399 of media sheets resulting from processing the document data
5400 MUST be a(*), b(*), a(*), b(*), start on a new media sheet.
5401 'separate-documents-uncollated-copies': If a Job object has
5402 multiple documents, say, the document data is called a and b,
5403 then the result of processing the data in each document
5404 instance MUST be treated as a single sequence of media sheets
5405 for finishing operations; that is, the sets a(*) and b(*) would
5406 each be finished separately. The Printer object MUST force each
5407 copy of the result of processing the data in a single document
5408 to start on a new media sheet. If more than one copy is made,
5409 the ordering of the sets of media sheets resulting from
5410 processing the document data MUST be a(*), a(*), ..., b(*),
5412 'separate-documents-collated-copies': If a Job object has multiple
5413 documents, say, the document data is called a and b, then the
5414 result of processing the data in each document instance MUST be
5415 treated as a single sequence of media sheets for finishing
5416 operations; that is, the sets a(*) and b(*) would each be
5417 finished separately. The Printer object MUST force each copy of
5418 the result of processing the data in a single document to start
5419 on a new media sheet. If more than one copy is made, the
5420 ordering of the sets of media sheets resulting from processing
5421 the document data MUST be a(*), b(*), a(*), b(*), ... .
5422 'single-document-new-sheet': Same as 'single-document', except
5423 that the Printer object MUST ensure that the first impression
5424 of each document instance in the job is placed on a new media
5425 sheet. This value allows multiple documents to be stapled
5426 together with a single staple where each document starts on a
5434 Hastings, et al. Standards Track [Page 97]
5436 RFC 2911 IPP/1.1: Model and Semantics September 2000
5439 The 'single-document' value is the same as 'separate-documents-
5440 collated-copies' with respect to ordering of print-stream pages, but
5441 not media sheet generation, since 'single-document' will put the
5442 first page of the next document on the back side of a sheet if an odd
5443 number of pages have been produced so far for the job, while
5444 'separate-documents-collated- copies' always forces the next document
5445 or document copy on to a new sheet. In addition, if the "finishings"
5446 attribute specifies 'staple', then with 'single-document', documents
5447 a and b are stapled together as a single document with no regard to
5448 new sheets, with 'single-document-new-sheet', documents a and b are
5449 stapled together as a single document, but document b starts on a new
5450 sheet, but with 'separate-documents-uncollated-copies' and
5451 'separate-documents-collated-copies', documents a and b are stapled
5454 Note: None of these values provide means to produce uncollated sheets
5455 within a document, i.e., where multiple copies of sheet n are
5456 produced before sheet n+1 of the same document.
5458 The relationship of this attribute and the other attributes that
5459 control document processing is described in section 15.3.
5461 4.2.5 copies (integer(1:MAX))
5463 This attribute specifies the number of copies to be printed.
5465 On many devices the supported number of collated copies will be
5466 limited by the number of physical output bins on the device, and may
5467 be different from the number of uncollated copies which can be
5470 Note: The effect of this attribute on jobs with multiple documents is
5471 controlled by the "multiple-document-handling" job attribute (section
5472 4.2.4) and the relationship of this attribute and the other
5473 attributes that control document processing is described in section
5476 4.2.6 finishings (1setOf type2 enum)
5478 This attribute identifies the finishing operations that the Printer
5479 uses for each copy of each printed document in the Job. For Jobs with
5480 multiple documents, the "multiple-document-handling" attribute
5481 determines what constitutes a "copy" for purposes of finishing.
5490 Hastings, et al. Standards Track [Page 98]
5492 RFC 2911 IPP/1.1: Model and Semantics September 2000
5495 Standard enum values are:
5497 Value Symbolic Name and Description
5499 '3' 'none': Perform no finishing
5500 '4' 'staple': Bind the document(s) with one or more staples. The
5501 exact number and placement of the staples is site-
5503 '5' 'punch': This value indicates that holes are required in the
5504 finished document. The exact number and placement of the
5505 holes is site-defined The punch specification MAY be
5506 satisfied (in a site- and implementation-specific manner)
5507 either by drilling/punching, or by substituting pre-
5509 '6' 'cover': This value is specified when it is desired to select
5510 a non-printed (or pre-printed) cover for the document.
5511 This does not supplant the specification of a printed
5512 cover (on cover stock medium) by the document itself.
5513 '7' 'bind': This value indicates that a binding is to be applied
5514 to the document; the type and placement of the binding is
5516 '8' 'saddle-stitch': Bind the document(s) with one or more
5517 staples (wire stitches) along the middle fold. The exact
5518 number and placement of the staples and the middle fold
5519 is implementation and/or site-defined.
5520 '9' 'edge-stitch': Bind the document(s) with one or more staples
5521 (wire stitches) along one edge. The exact number and
5522 placement of the staples is implementation and/or site-
5524 '10'-'19' reserved for future generic finishing enum values.
5526 The following values are more specific; they indicate a corner or an
5527 edge as if the document were a portrait document (see below):
5529 '20' 'staple-top-left': Bind the document(s) with one or more
5530 staples in the top left corner.
5531 '21' 'staple-bottom-left': Bind the document(s) with one or more
5532 staples in the bottom left corner.
5533 '22' 'staple-top-right': Bind the document(s) with one or more
5534 staples in the top right corner.
5535 '23' 'staple-bottom-right': Bind the document(s) with one or more
5536 staples in the bottom right corner.
5537 '24' 'edge-stitch-left': Bind the document(s) with one or more
5538 staples (wire stitches) along the left edge. The exact
5539 number and placement of the staples is implementation
5540 and/or site-defined.
5546 Hastings, et al. Standards Track [Page 99]
5548 RFC 2911 IPP/1.1: Model and Semantics September 2000
5551 '25' 'edge-stitch-top': Bind the document(s) with one or more
5552 staples (wire stitches) along the top edge. The exact
5553 number and placement of the staples is implementation
5554 and/or site-defined.
5555 '26' 'edge-stitch-right': Bind the document(s) with one or more
5556 staples (wire stitches) along the right edge. The exact
5557 number and placement of the staples is implementation
5558 and/or site-defined.
5559 '27' 'edge-stitch-bottom': Bind the document(s) with one or more
5560 staples (wire stitches) along the bottom edge. The exact
5561 number and placement of the staples is implementation
5562 and/or site-defined.
5563 '28' 'staple-dual-left': Bind the document(s) with two staples
5564 (wire stitches) along the left edge assuming a portrait
5565 document (see above).
5566 '29' 'staple-dual-top': Bind the document(s) with two staples
5567 (wire stitches) along the top edge assuming a portrait
5568 document (see above).
5569 '30' 'staple-dual-right': Bind the document(s) with two staples
5570 (wire stitches) along the right edge assuming a portrait
5571 document (see above).
5572 '31' 'staple-dual-bottom': Bind the document(s) with two staples
5573 (wire stitches) along the bottom edge assuming a portrait
5574 document (see above).
5576 The 'staple-xxx' values are specified with respect to the document as
5577 if the document were a portrait document. If the document is
5578 actually a landscape or a reverse-landscape document, the client
5579 supplies the appropriate transformed value. For example, to position
5580 a staple in the upper left hand corner of a landscape document when
5581 held for reading, the client supplies the 'staple-bottom-left' value
5582 (since landscape is defined as a +90 degree rotation of the image
5583 with respect to the media from portrait, i.e., anti-clockwise). On
5584 the other hand, to position a staple in the upper left hand corner of
5585 a reverse-landscape document when held for reading, the client
5586 supplies the 'staple-top-right' value (since reverse-landscape is
5587 defined as a -90 degree rotation of the image with respect to the
5588 media from portrait, i.e., clockwise).
5590 The angle (vertical, horizontal, angled) of each staple with respect
5591 to the document depends on the implementation which may in turn
5592 depend on the value of the attribute.
5594 Note: The effect of this attribute on jobs with multiple documents is
5595 controlled by the "multiple-document-handling" job attribute (section
5596 4.2.4) and the relationship of this attribute and the other
5597 attributes that control document processing is described in section
5602 Hastings, et al. Standards Track [Page 100]
5604 RFC 2911 IPP/1.1: Model and Semantics September 2000
5607 If the client supplies a value of 'none' along with any other
5608 combination of values, it is the same as if only that other
5609 combination of values had been supplied (that is the 'none' value has
5612 4.2.7 page-ranges (1setOf rangeOfInteger (1:MAX))
5614 This attribute identifies the range(s) of print-stream pages that the
5615 Printer object uses for each copy of each document which are to be
5616 printed. Nothing is printed for any pages identified that do not
5617 exist in the document(s). Ranges MUST be in ascending order, for
5618 example: 1-3, 5-7, 15-19 and MUST NOT overlap, so that a non-spooling
5619 Printer object can process the job in a single pass. If the ranges
5620 are not ascending or are overlapping, the IPP object MUST reject the
5621 request and return the 'client-error-bad-request' status code. The
5622 attribute is associated with print-stream pages not application-
5623 numbered pages (for example, the page numbers found in the headers
5624 and or footers for certain word processing applications).
5626 For Jobs with multiple documents, the "multiple-document-handling"
5627 attribute determines what constitutes a "copy" for purposes of the
5628 specified page range(s). When "multiple-document-handling" is
5629 'single-document', the Printer object MUST apply each supplied page
5630 range once to the concatenation of the print-stream pages. For
5631 example, if there are 8 documents of 10 pages each, the page-range
5632 '41:60' prints the pages in the 5th and 6th documents as a single
5633 document and none of the pages of the other documents are printed.
5634 When "multiple-document- handling" is 'separate-documents-
5635 uncollated-copies' or 'separate-documents-collated-copies', the
5636 Printer object MUST apply each supplied page range repeatedly to each
5637 document copy. For the same job, the page-range '1:3, 10:10' would
5638 print the first 3 pages and the 10th page of each of the 8 documents
5639 in the Job, as 8 separate documents.
5641 In most cases, the exact pages to be printed will be generated by a
5642 device driver and this attribute would not be required. However,
5643 when printing an archived document which has already been formatted,
5644 the end user may elect to print just a subset of the pages contained
5645 in the document. In this case, if page-range = n.m is specified, the
5646 first page to be printed will be page n. All subsequent pages of the
5647 document will be printed through and including page m.
5649 "page-ranges-supported" is a boolean value indicating whether or not
5650 the printer is capable of supporting the printing of page ranges.
5651 This capability may differ from one PDL to another. There is no
5652 "page-ranges-default" attribute. If the "page-ranges" attribute is
5653 not supplied by the client, all pages of the document will be
5658 Hastings, et al. Standards Track [Page 101]
5660 RFC 2911 IPP/1.1: Model and Semantics September 2000
5663 Note: The effect of this attribute on jobs with multiple documents is
5664 controlled by the "multiple-document-handling" job attribute (section
5665 4.2.4) and the relationship of this attribute and the other
5666 attributes that control document processing is described in section
5669 4.2.8 sides (type2 keyword)
5671 This attribute specifies how print-stream pages are to be imposed
5672 upon the sides of an instance of a selected medium, i.e., an
5675 The standard keyword values are:
5677 'one-sided': imposes each consecutive print-stream page upon the
5678 same side of consecutive media sheets.
5679 'two-sided-long-edge': imposes each consecutive pair of print-
5680 stream pages upon front and back sides of consecutive media
5681 sheets, such that the orientation of each pair of print-stream
5682 pages on the medium would be correct for the reader as if for
5683 binding on the long edge. This imposition is sometimes called
5684 'duplex' or 'head-to-head'.
5685 'two-sided-short-edge': imposes each consecutive pair of print-
5686 stream pages upon front and back sides of consecutive media
5687 sheets, such that the orientation of each pair of print-stream
5688 pages on the medium would be correct for the reader as if for
5689 binding on the short edge. This imposition is sometimes called
5690 'tumble' or 'head-to-toe'.
5691 'two-sided-long-edge', 'two-sided-short-edge',
5692 'tumble', and 'duplex' all work the same for portrait or
5695 'tumble' in portrait but 'duplex' in landscape. 'head-to-head'
5696 also switches between 'duplex' and 'tumble' when using portrait
5697 and landscape modes.
5699 Note: The effect of this attribute on jobs with multiple documents is
5700 controlled by the "multiple-document-handling" job attribute (section
5701 4.2.4) and the relationship of this attribute and the other
5702 attributes that control document processing is described in section
5705 4.2.9 number-up (integer(1:MAX))
5707 This attribute specifies the number of print-stream pages to impose
5708 upon a single side of an instance of a selected medium. For example,
5714 Hastings, et al. Standards Track [Page 102]
5716 RFC 2911 IPP/1.1: Model and Semantics September 2000
5721 '1' the Printer MUST place one print-stream page on a single side
5722 of an instance of the selected medium (MAY add some sort
5723 of translation, scaling, or rotation).
5724 '2' the Printer MUST place two print-stream pages on a single side
5725 of an instance of the selected medium (MAY add some sort
5726 of translation, scaling, or rotation).
5727 '4' the Printer MUST place four print-stream pages on a single
5728 side of an instance of the selected medium (MAY add some
5729 sort of translation, scaling, or rotation).
5731 This attribute primarily controls the translation, scaling and
5732 rotation of print-stream pages.
5734 Note: The effect of this attribute on jobs with multiple documents is
5735 controlled by the "multiple-document-handling" job attribute (section
5736 4.2.4) and the relationship of this attribute and the other
5737 attributes that control document processing is described in section
5740 4.2.10 orientation-requested (type2 enum)
5742 This attribute indicates the desired orientation for printed print-
5743 stream pages; it does not describe the orientation of the client-
5744 supplied print-stream pages.
5746 For some document formats (such as 'application/postscript'), the
5747 desired orientation of the print-stream pages is specified within the
5748 document data. This information is generated by a device driver
5749 prior to the submission of the print job. Other document formats
5750 (such as 'text/plain') do not include the notion of desired
5751 orientation within the document data. In the latter case it is
5752 possible for the Printer object to bind the desired orientation to
5753 the document data after it has been submitted. It is expected that a
5754 Printer object would only support "orientations-requested" for some
5755 document formats (e.g., 'text/plain' or 'text/html') but not others
5756 (e.g., 'application/postscript'). This is no different than any
5757 other Job Template attribute since section 4.2, item 1, points out
5758 that a Printer object may support or not support any Job Template
5759 attribute based on the document format supplied by the client.
5760 However, a special mention is made here since it is very likely that
5761 a Printer object will support "orientation-requested" for only a
5762 subset of the supported document formats.
5770 Hastings, et al. Standards Track [Page 103]
5772 RFC 2911 IPP/1.1: Model and Semantics September 2000
5775 Standard enum values are:
5777 Value Symbolic Name and Description
5779 '3' 'portrait': The content will be imaged across the short edge
5781 '4' 'landscape': The content will be imaged across the long edge
5782 of the medium. Landscape is defined to be a rotation of
5783 the print-stream page to be imaged by +90 degrees with
5784 respect to the medium (i.e. anti-clockwise) from the
5785 portrait orientation. Note: The +90 direction was
5786 chosen because simple finishing on the long edge is the
5787 same edge whether portrait or landscape
5788 '5' 'reverse-landscape': The content will be imaged across the
5789 long edge of the medium. Reverse-landscape is defined to
5790 be a rotation of the print-stream page to be imaged by -
5791 90 degrees with respect to the medium (i.e. clockwise)
5792 from the portrait orientation. Note: The 'reverse-
5793 landscape' value was added because some applications
5794 rotate landscape -90 degrees from portrait, rather than
5796 '6' 'reverse-portrait': The content will be imaged across the
5797 short edge of the medium. Reverse-portrait is defined to
5798 be a rotation of the print-stream page to be imaged by
5799 180 degrees with respect to the medium from the portrait
5800 orientation. Note: The 'reverse-portrait' value was
5801 added for use with the "finishings" attribute in cases
5802 where the opposite edge is desired for finishing a
5803 portrait document on simple finishing devices that have
5804 only one finishing position. Thus a 'text'/plain'
5805 portrait document can be stapled "on the right" by a
5806 simple finishing device as is common use with some middle
5807 eastern languages such as Hebrew.
5809 Note: The effect of this attribute on jobs with multiple documents is
5810 controlled by the "multiple-document-handling" job attribute (section
5811 4.2.4) and the relationship of this attribute and the other
5812 attributes that control document processing is described in section
5815 4.2.11 media (type3 keyword | name(MAX))
5817 This attribute identifies the medium that the Printer uses for all
5818 impressions of the Job.
5820 The values for "media" include medium-names, medium-sizes, input-
5821 trays and electronic forms so that one attribute specifies the media.
5822 If a Printer object supports a medium name as a value of this
5826 Hastings, et al. Standards Track [Page 104]
5828 RFC 2911 IPP/1.1: Model and Semantics September 2000
5831 attribute, such a medium name implicitly selects an input-tray that
5832 contains the specified medium. If a Printer object supports a medium
5833 size as a value of this attribute, such a medium size implicitly
5834 selects a medium name that in turn implicitly selects an input-tray
5835 that contains the medium with the specified size. If a Printer
5836 object supports an input-tray as the value of this attribute, such an
5837 input-tray implicitly selects the medium that is in that input-tray
5838 at the time the job prints. This case includes manual-feed input-
5839 trays. If a Printer object supports an electronic form as the value
5840 of this attribute, such an electronic form implicitly selects a
5841 medium-name that in turn implicitly selects an input-tray that
5842 contains the medium specified by the electronic form. The electronic
5843 form also implicitly selects an image that the Printer MUST merge
5844 with the document data as its prints each page.
5846 Standard keyword values are taken from ISO DPA [ISO10175], the
5847 Printer MIB [RFC1759], and ASME-Y14.1M [ASME-Y14.1M] and are listed
5848 in section 14. An administrator MAY define additional values using
5849 the 'name' or 'keyword' attribute syntax, depending on
5852 There is also an additional Printer attribute named "media-ready"
5853 which differs from "media-supported" in that legal values only
5854 include the subset of "media-supported" values that are physically
5855 loaded and ready for printing with no operator intervention required.
5856 If an IPP object supports "media-supported", it NEED NOT support
5859 The relationship of this attribute and the other attributes that
5860 control document processing is described in section 15.3.
5862 4.2.12 printer-resolution (resolution)
5864 This attribute identifies the resolution that Printer uses for the
5867 4.2.13 print-quality (type2 enum)
5869 This attribute specifies the print quality that the Printer uses for
5872 The standard enum values are:
5874 Value Symbolic Name and Description
5876 '3' 'draft': lowest quality available on the printer
5877 '4' 'normal': normal or intermediate quality on the printer
5878 '5' 'high': highest quality available on the printer
5882 Hastings, et al. Standards Track [Page 105]
5884 RFC 2911 IPP/1.1: Model and Semantics September 2000
5887 4.3 Job Description Attributes
5889 The attributes in this section form the attribute group called "job-
5890 description". The following table summarizes these attributes. The
5891 third column indicates whether the attribute is a REQUIRED attribute
5892 that MUST be supported by Printer objects. If it is not indicated as
5893 REQUIRED, then it is OPTIONAL. The maximum size in octets for 'text'
5894 and 'name' attributes is indicated in parenthesizes.
5896 +----------------------------+----------------------+--------------+
5897 | Attribute | Syntax | REQUIRED? |
5898 +----------------------------+----------------------+--------------+
5899 | job-uri | uri | REQUIRED |
5900 +----------------------------+----------------------+--------------+
5901 | job-id | integer(1:MAX) | REQUIRED |
5902 +----------------------------+----------------------+--------------+
5903 | job-printer-uri | uri | REQUIRED |
5904 +----------------------------+----------------------+--------------+
5905 | job-more-info | uri | |
5906 +----------------------------+----------------------+--------------+
5907 | job-name | name (MAX) | REQUIRED |
5908 +----------------------------+----------------------+--------------+
5909 | job-originating-user-name | name (MAX) | REQUIRED |
5910 +----------------------------+----------------------+--------------+
5911 | job-state | type1 enum | REQUIRED |
5912 +----------------------------+----------------------+--------------+
5913 | job-state-reasons | 1setOf type2 keyword | REQUIRED |
5914 +----------------------------+----------------------+--------------+
5915 | job-state-message | text (MAX) | |
5916 +----------------------------+----------------------+--------------+
5917 | job-detailed-status- | 1setOf text (MAX) | |
5919 +----------------------------+----------------------+--------------+
5920 | job-document-access-errors | 1setOf text (MAX) | |
5921 +----------------------------+----------------------+--------------+
5922 | number-of-documents | integer (0:MAX) | |
5923 +----------------------------+----------------------+--------------+
5924 | output-device-assigned | name (127) | |
5925 +----------------------------+----------------------+--------------+
5926 | time-at-creation | integer (MIN:MAX) | REQUIRED |
5927 +----------------------------+----------------------+--------------+
5928 | time-at-processing | integer (MIN:MAX) | REQUIRED |
5929 +----------------------------+----------------------+--------------+
5930 | time-at-completed | integer (MIN:MAX) | REQUIRED |
5931 +----------------------------+----------------------+--------------+
5932 | job-printer-up-time | integer (1:MAX) | REQUIRED |
5933 +----------------------------+----------------------+--------------+
5934 | date-time-at-creation | dateTime | |
5938 Hastings, et al. Standards Track [Page 106]
5940 RFC 2911 IPP/1.1: Model and Semantics September 2000
5943 +----------------------------+----------------------+--------------+
5944 | date-time-at-processing | dateTime | |
5945 +----------------------------+----------------------+--------------+
5946 | date-time-at-completed | dateTime | |
5947 +----------------------------+----------------------+--------------+
5948 | number-of-intervening-jobs | integer (0:MAX) | |
5949 +----------------------------+----------------------+--------------+
5950 | job-message-from-operator | text (127) | |
5951 +----------------------------+----------------------+--------------+
5952 | job-k-octets | integer (0:MAX) | |
5953 +----------------------------+----------------------+--------------+
5954 | job-impressions | integer (0:MAX) | |
5955 +----------------------------+----------------------+--------------+
5956 | job-media-sheets | integer (0:MAX) | |
5957 +----------------------------+----------------------+--------------+
5958 | job-k-octets-processed | integer (0:MAX) | |
5959 +----------------------------+----------------------+--------------+
5960 | job-impressions-completed | integer (0:MAX) | |
5961 +----------------------------+----------------------+--------------+
5962 | job-media-sheets-completed | integer (0:MAX) | |
5963 +----------------------------+----------------------+--------------+
5964 | attributes-charset | charset | REQUIRED |
5965 +----------------------------+----------------------+--------------+
5966 | attributes-natural-language| naturalLanguage | REQUIRED |
5967 +----------------------------+----------------------+--------------+
5971 This REQUIRED attribute contains the URI for the job. The Printer
5972 object, on receipt of a new job, generates a URI which identifies the
5973 new Job. The Printer object returns the value of the "job-uri"
5974 attribute as part of the response to a create request. The precise
5975 format of a Job URI is implementation dependent. If the Printer
5976 object supports more than one URI and there is some relationship
5977 between the newly formed Job URI and the Printer object's URI, the
5978 Printer object uses the Printer URI supplied by the client in the
5979 create request. For example, if the create request comes in over a
5980 secure channel, the new Job URI MUST use the same secure channel.
5981 This can be guaranteed because the Printer object is responsible for
5982 generating the Job URI and the Printer object is aware of its
5983 security configuration and policy as well as the Printer URI used in
5986 For a description of this attribute and its relationship to "job-id"
5987 and "job-printer-uri" attribute, see the discussion in section 2.4 on
5994 Hastings, et al. Standards Track [Page 107]
5996 RFC 2911 IPP/1.1: Model and Semantics September 2000
5999 4.3.2 job-id (integer(1:MAX))
6001 This REQUIRED attribute contains the ID of the job. The Printer, on
6002 receipt of a new job, generates an ID which identifies the new Job on
6003 that Printer. The Printer returns the value of the "job-id"
6004 attribute as part of the response to a create request. The 0 value
6005 is not included to allow for compatibility with SNMP index values
6006 which also cannot be 0.
6008 For a description of this attribute and its relationship to "job-uri"
6009 and "job-printer-uri" attribute, see the discussion in section 2.4 on
6012 4.3.3 job-printer-uri (uri)
6014 This REQUIRED attribute identifies the Printer object that created
6015 this Job object. When a Printer object creates a Job object, it
6016 populates this attribute with the Printer object URI that was used in
6017 the create request. This attribute permits a client to identify the
6018 Printer object that created this Job object when only the Job
6019 object's URI is available to the client. The client queries the
6020 creating Printer object to determine which languages, charsets,
6021 operations, are supported for this Job.
6023 For a description of this attribute and its relationship to "job-uri"
6024 and "job-id" attribute, see the discussion in section 2.4 on "Object
6027 4.3.4 job-more-info (uri)
6029 Similar to "printer-more-info", this attribute contains the URI
6030 referencing some resource with more information about this Job
6031 object, perhaps an HTML page containing information about the Job.
6033 4.3.5 job-name (name(MAX))
6035 This REQUIRED attribute is the name of the job. It is a name that is
6036 more user friendly than the "job-uri" attribute value. It does not
6037 need to be unique between Jobs. The Job's "job-name" attribute is
6038 set to the value supplied by the client in the "job-name" operation
6039 attribute in the create request (see Section 3.2.1.1). If, however,
6040 the "job-name" operation attribute is not supplied by the client in
6041 the create request, the Printer object, on creation of the Job, MUST
6042 generate a name. The printer SHOULD generate the value of the Job's
6043 "job-name" attribute from the first of the following sources that
6044 produces a value: 1) the "document-name" operation attribute of the
6050 Hastings, et al. Standards Track [Page 108]
6052 RFC 2911 IPP/1.1: Model and Semantics September 2000
6055 first (or only) document, 2) the "document-URI" attribute of the
6056 first (or only) document, or 3) any other piece of Job specific
6057 and/or Document Content information.
6059 4.3.6 job-originating-user-name (name(MAX))
6061 This REQUIRED attribute contains the name of the end user that
6062 submitted the print job. The Printer object sets this attribute to
6063 the most authenticated printable name that it can obtain from the
6064 authentication service over which the IPP operation was received.
6065 Only if such is not available, does the Printer object use the value
6066 supplied by the client in the "requesting-user-name" operation
6067 attribute of the create operation (see Sections 4.4.2, 4.4.3, and 8).
6069 Note: The Printer object needs to keep an internal originating user
6070 id of some form, typically as a credential of a principal, with the
6071 Job object. Since such an internal attribute is implementation-
6072 dependent and not of interest to clients, it is not specified as a
6073 Job Description attribute. This originating user id is used for
6074 authorization checks (if any) on all subsequent operations.
6076 4.3.7 job-state (type1 enum)
6078 This REQUIRED attribute identifies the current state of the job.
6079 Even though the IPP protocol defines seven values for job states
6080 (plus the out-of-band 'unknown' value - see Section 4.1),
6081 implementations only need to support those states which are
6082 appropriate for the particular implementation. In other words, a
6083 Printer supports only those job states implemented by the output
6084 device and available to the Printer object implementation.
6086 Standard enum values are:
6088 Values Symbolic Name and Description
6090 '3' 'pending': The job is a candidate to start processing, but is
6093 '4' 'pending-held': The job is not a candidate for processing for
6094 any number of reasons but will return to the 'pending'
6095 state as soon as the reasons are no longer present. The
6096 job's "job-state-reason" attribute MUST indicate why the
6097 job is no longer a candidate for processing.
6106 Hastings, et al. Standards Track [Page 109]
6108 RFC 2911 IPP/1.1: Model and Semantics September 2000
6111 '5' 'processing': One or more of:
6113 1. the job is using, or is attempting to use, one or
6114 more purely software processes that are analyzing,
6115 creating, or interpreting a PDL, etc.,
6116 2. the job is using, or is attempting to use, one or
6117 more hardware devices that are interpreting a PDL, making
6118 marks on a medium, and/or performing finishing, such as
6120 3. the Printer object has made the job ready for
6121 printing, but the output device is not yet printing it,
6122 either because the job hasn't reached the output device
6123 or because the job is queued in the output device or some
6124 other spooler, awaiting the output device to print it.
6126 When the job is in the 'processing' state, the entire job
6127 state includes the detailed status represented in the
6128 Printer object's "printer-state", "printer-state-
6129 reasons", and "printer-state-message" attributes.
6131 Implementations MAY, though they NEED NOT, include
6132 additional values in the job's "job-state-reasons"
6133 attribute to indicate the progress of the job, such as
6134 adding the 'job-printing' value to indicate when the
6135 output device is actually making marks on paper and/or
6136 the 'processing-to-stop-point' value to indicate that the
6137 IPP object is in the process of canceling or aborting the
6138 job. Most implementations won't bother with this nuance.
6140 '6' 'processing-stopped': The job has stopped while processing
6141 for any number of reasons and will return to the
6142 'processing' state as soon as the reasons are no longer
6145 The job's "job-state-reason" attribute MAY indicate why
6146 the job has stopped processing. For example, if the
6147 output device is stopped, the 'printer-stopped' value MAY
6148 be included in the job's "job-state-reasons" attribute.
6150 Note: When an output device is stopped, the device
6151 usually indicates its condition in human readable form
6152 locally at the device. A client can obtain more complete
6153 device status remotely by querying the Printer object's
6154 "printer-state", "printer-state-reasons" and "printer-
6155 state-message" attributes.
6157 '7' 'canceled': The job has been canceled by a Cancel-Job
6158 operation and the Printer object has completed canceling
6162 Hastings, et al. Standards Track [Page 110]
6164 RFC 2911 IPP/1.1: Model and Semantics September 2000
6167 the job and all job status attributes have reached their
6168 final values for the job. While the Printer object is
6169 canceling the job, the job remains in its current state,
6170 but the job's "job-state-reasons" attribute SHOULD
6171 contain the 'processing-to-stop-point' value and one of
6172 the 'canceled-by-user', 'canceled-by-operator', or
6173 'canceled-at-device' value. When the job moves to the
6174 'canceled' state, the 'processing-to-stop-point' value,
6175 if present, MUST be removed, but the 'canceled-by-xxx',
6176 if present, MUST remain.
6178 '8' 'aborted': The job has been aborted by the system, usually
6179 while the job was in the 'processing' or 'processing-
6180 stopped' state and the Printer has completed aborting the
6181 job and all job status attributes have reached their
6182 final values for the job. While the Printer object is
6183 aborting the job, the job remains in its current state,
6184 but the job's "job-state-reasons" attribute SHOULD
6185 contain the 'processing-to-stop-point' and 'aborted-by-
6186 system' values. When the job moves to the 'aborted'
6187 state, the 'processing-to-stop-point' value, if present,
6188 MUST be removed, but the 'aborted-by-system' value, if
6189 present, MUST remain.
6191 '9' 'completed': The job has completed successfully or with
6192 warnings or errors after processing and all of the job
6193 media sheets have been successfully stacked in the
6194 appropriate output bin(s) and all job status attributes
6195 have reached their final values for the job. The job's
6196 "job-state-reasons" attribute SHOULD contain one of:
6197 'completed-successfully', 'completed-with-warnings', or
6198 'completed-with-errors' values.
6200 The final value for this attribute MUST be one of: 'completed',
6201 'canceled', or 'aborted' before the Printer removes the job
6202 altogether. The length of time that jobs remain in the 'canceled',
6203 'aborted', and 'completed' states depends on implementation. See
6206 The following figure shows the normal job state transitions.
6210 +----> pending --------> processing ---------+------> completed
6212 --->+ | | +----> aborted
6214 +----> pending-held processing-stopped ---+
6218 Hastings, et al. Standards Track [Page 111]
6220 RFC 2911 IPP/1.1: Model and Semantics September 2000
6223 Normally a job progresses from left to right. Other state
6224 transitions are unlikely, but are not forbidden. Not shown are the
6225 transitions to the 'canceled' state from the 'pending', 'pending-
6226 held', and 'processing-stopped' states.
6228 Jobs reach one of the three terminal states: 'completed', 'canceled',
6229 or 'aborted', after the jobs have completed all activity, including
6230 stacking output media, after the jobs have completed all activity,
6231 and all job status attributes have reached their final values for the
6234 4.3.7.1 Forwarding Servers
6236 As with all other IPP attributes, if the implementation cannot
6237 determine the correct value for this attribute, it SHOULD respond
6238 with the out-of-band value 'unknown' (see section 4.1) rather than
6239 try to guess at some possibly incorrect value and give the end user
6240 the wrong impression about the state of the Job object. For example,
6241 if the implementation is just a gateway into some printing system
6242 from which it can normally get status, but temporarily is unable,
6243 then the implementation should return the 'unknown' value. However,
6244 if the implementation is a gateway to a printing system that never
6245 provides detailed status about the print job, the implementation MAY
6246 set the IPP Job object's state to 'completed', provided that it also
6247 sets the 'queued-in-device' value in the job's "job-state-reasons"
6248 attribute (see section 4.3.8).
6250 4.3.7.2 Partitioning of Job States
6252 This section partitions the 7 job states into phases: Job Not
6253 Completed, Job Retention, Job History, and Job Removal. This section
6254 also explains the 'job-restartable' value of the "job-state-reasons"
6255 Job Description attribute for use with the Restart-Job operation.
6257 Job Not Completed: When a job is in the 'pending', 'pending-held',
6258 'processing', or 'processing-stopped' states, the job is not
6261 Job Retention: When a job enters one of the three terminal job
6262 states: 'completed', 'canceled', or 'aborted', the IPP Printer
6263 object MAY "retain" the job in a restartable condition for an
6264 implementation-defined time period. This time period MAY be zero
6265 seconds and MAY depend on the terminal job state. This phase is
6266 called Job Retention. While in the Job Retention phase, the job's
6267 document data is retained and a client may restart the job using the
6268 Restart-Job operation. If the IPP object supports the Restart-Job
6274 Hastings, et al. Standards Track [Page 112]
6276 RFC 2911 IPP/1.1: Model and Semantics September 2000
6279 operation, then it SHOULD indicate that the job is restartable by
6280 adding the 'job-restartable' value to the job's "job-state-reasons"
6281 attribute (see Section 4.3.8) during the Job Retention phase.
6283 Job History: After the Job Retention phase expires for a job, the
6284 Printer object deletes the document data for the job and the job
6285 becomes part of the Job History. The Printer object MAY also delete
6286 any number of the job attributes. Since the job is no longer
6287 restartable, the Printer object MUST remove the 'job-restartable'
6288 value from the job's "job-state-reasons" attribute, if present.
6290 Job Removal: After the job has remained in the Job History for an
6291 implementation-defined time, such as when the number of jobs exceeds
6292 a fixed number or after a fixed time period (which MAY be zero
6293 seconds), the IPP Printer removes the job from the system.
6295 Using the Get-Jobs operation and supplying the 'not-completed' value
6296 for the "which-jobs" operation attribute, a client is requesting jobs
6297 in the Job Not Completed phase. Using the Get-Jobs operation and
6298 supplying the 'completed' value for the "which-jobs" operation
6299 attribute, a client is requesting jobs in the Job Retention and Job
6300 History phases. Using the Get-Job-Attributes operation, a client is
6301 requesting a job in any phase except Job Removal. After Job Removal,
6302 the Get-Job-Attributes and Get-Jobs operations no longer are capable
6303 of returning any information about a job.
6305 4.3.8 job-state-reasons (1setOf type2 keyword)
6307 This REQUIRED attribute provides additional information about the
6308 job's current state, i.e., information that augments the value of the
6309 job's "job-state" attribute.
6311 These values MAY be used with any job state or states for which the
6312 reason makes sense. Some of these value definitions indicate
6313 conformance requirements; the rest are OPTIONAL. Furthermore, when
6314 implemented, the Printer MUST return these values when the reason
6315 applies and MUST NOT return them when the reason no longer applies
6316 whether the value of the Job's "job-state" attribute changed or not.
6317 When the Job does not have any reasons for being in its current
6318 state, the value of the Job's "job-state-reasons" attribute MUST be
6321 Note: While values cannot be added to the 'job-state' attribute
6322 without impacting deployed clients that take actions upon receiving
6323 "job-state" values, it is the intent that additional "job-state-
6324 reasons" values can be defined and registered without impacting such
6325 deployed clients. In other words, the "job-state-reasons" attribute
6326 is intended to be extensible.
6330 Hastings, et al. Standards Track [Page 113]
6332 RFC 2911 IPP/1.1: Model and Semantics September 2000
6335 The following standard keyword values are defined. For ease of
6336 understanding, the values are presented in the order in which the
6337 reasons are likely to occur (if implemented), starting with the
6338 'job-incoming' value:
6340 'none': There are no reasons for the job's current state. This
6341 state reason is semantically equivalent to "job-state-reasons"
6342 without any value and MUST be used when there is no other
6343 value, since the 1setOf attribute syntax requires at least one
6345 'job-incoming': Either (1) the Printer has accepted the Create-
6346 Job operation and is expecting additional Send-Document and/or
6347 Send-URI operations, or (2) the Printer is retrieving/accepting
6348 document data as a result of a Print-Job, Print-URI, Send-
6349 Document or Send-URI operation.
6350 'job-data-insufficient': The Create-Job operation has been
6351 accepted by the Printer, but the Printer is expecting
6352 additional document data before it can move the job into the
6353 'processing' state. If a Printer starts processing before it
6354 has received all data, the Printer removes the 'job-data-
6355 insufficient' reason, but the 'job-incoming' remains. If a
6356 Printer starts processing after it has received all data, the
6357 Printer removes the 'job-data-insufficient' reason and the
6358 'job-incoming' at the same time.
6359 'document-access-error': After accepting a Print-URI or Send-URI
6360 request, the Printer could not access one or more documents
6361 passed by reference. This reason is intended to cover any file
6362 access problem, including file does not exist and access denied
6363 because of an access control problem. The Printer MAY also
6364 indicate the document access error using the "job-document-
6365 access-errors" Job Description attribute (see section 4.3.11).
6366 Whether the Printer aborts the job and moves the job to the
6367 'aborted' job state or prints all documents that are accessible
6368 and moves the job to the 'completed' job state and adds the
6369 'completed-with-errors' value in the job's "job-state-reasons"
6370 attribute depends on implementation and/or site policy. This
6371 value SHOULD be supported if the Print-URI or Send-URI
6372 operations are supported.
6373 'submission-interrupted': The job was not completely submitted
6374 for some unforeseen reason, such as: (1) the Printer has
6375 crashed before the job was closed by the client, (2) the
6376 Printer or the document transfer method has crashed in some
6377 non-recoverable way before the document data was entirely
6378 transferred to the Printer, (3) the client crashed or failed to
6379 close the job before the time-out period. See section 4.4.31.
6380 'job-outgoing': The Printer is transmitting the job to the output
6386 Hastings, et al. Standards Track [Page 114]
6388 RFC 2911 IPP/1.1: Model and Semantics September 2000
6391 'job-hold-until-specified': The value of the job's "job-hold-
6392 until" attribute was specified with a time period that is still
6393 in the future. The job MUST NOT be a candidate for processing
6394 until this reason is removed and there are no other reasons to
6395 hold the job. This value SHOULD be supported if the "job-
6396 hold-until" Job Template attribute is supported.
6397 'resources-are-not-ready': At least one of the resources needed
6398 by the job, such as media, fonts, resource objects, etc., is
6399 not ready on any of the physical printer's for which the job is
6400 a candidate. This condition MAY be detected when the job is
6401 accepted, or subsequently while the job is pending or
6402 processing, depending on implementation. The job may remain in
6403 its current state or be moved to the 'pending-held' state,
6404 depending on implementation and/or job scheduling policy.
6405 'printer-stopped-partly': The value of the Printer's "printer-
6406 state-reasons" attribute contains the value 'stopped-partly'.
6407 'printer-stopped': The value of the Printer's "printer-state"
6408 attribute is 'stopped'.
6409 'job-interpreting': Job is in the 'processing' state, but more
6410 specifically, the Printer is interpreting the document data.
6411 'job-queued': Job is in the 'processing' state, but more
6412 specifically, the Printer has queued the document data.
6413 'job-transforming': Job is in the 'processing' state, but more
6414 specifically, the Printer is interpreting document data and
6415 producing another electronic representation.
6416 'job-queued-for-marker': Job is in any of the 'pending-held',
6417 'pending', or 'processing' states, but more specifically, the
6418 Printer has completed enough processing of the document to be
6419 able to start marking and the job is waiting for the marker.
6420 Systems that require human intervention to release jobs using
6421 the Release-Job operation, put the job into the 'pending-held'
6422 job state. Systems that automatically select a job to use the
6423 marker put the job into the 'pending' job state or keep the
6424 job in the 'processing' job state while waiting for the marker,
6425 depending on implementation. All implementations put the job
6426 into (or back into) the 'processing' state when marking does
6428 'job-printing': The output device is marking media. This value is
6429 useful for Printers which spend a great deal of time processing
6430 (1) when no marking is happening and then want to show that
6431 marking is now happening or (2) when the job is in the process
6432 of being canceled or aborted while the job remains in the
6433 'processing' state, but the marking has not yet stopped so that
6434 impression or sheet counts are still increasing for the job.
6442 Hastings, et al. Standards Track [Page 115]
6444 RFC 2911 IPP/1.1: Model and Semantics September 2000
6447 'job-canceled-by-user': The job was canceled by the owner of the
6448 job using the Cancel-Job request, i.e., by a user whose
6449 authenticated identity is the same as the value of the
6450 originating user that created the Job object, or by some other
6451 authorized end-user, such as a member of the job owner's
6452 security group. This value SHOULD be supported.
6453 'job-canceled-by-operator': The job was canceled by the operator
6454 using the Cancel-Job request, i.e., by a user who has been
6455 authenticated as having operator privileges (whether local or
6456 remote). If the security policy is to allow anyone to cancel
6457 anyone's job, then this value may be used when the job is
6458 canceled by other than the owner of the job. For such a
6459 security policy, in effect, everyone is an operator as far as
6460 canceling jobs with IPP is concerned. This value SHOULD be
6461 supported if the implementation permits canceling by other than
6462 the owner of the job.
6463 'job-canceled-at-device': The job was canceled by an unidentified
6464 local user, i.e., a user at a console at the device. This
6465 value SHOULD be supported if the implementation supports
6466 canceling jobs at the console.
6467 'aborted-by-system': The job (1) is in the process of being
6468 aborted, (2) has been aborted by the system and placed in the
6469 'aborted' state, or (3) has been aborted by the system and
6470 placed in the 'pending-held' state, so that a user or operator
6471 can manually try the job again. This value SHOULD be
6473 'unsupported-compression': The job was aborted by the system
6474 because the Printer determined while attempting to decompress
6475 the document-data's that the compression is actually not among
6476 those supported by the Printer. This value MUST be supported,
6477 since "compressions is a REQUIRED operation attribute.
6478 'compression-error': The job was aborted by the system because the
6479 Printer encountered an error in the document-data while
6480 decompressing it. If the Printer posts this reason, the
6481 document-data has already passed any tests that would have led
6482 to the 'unsupported-compression' job-state-reason.
6483 'unsupported-document-format': The job was aborted by the system
6484 because the document-data's document-format is not among those
6485 supported by the Printer. If the client specifies the
6486 document-format as 'application/octet-stream', the printer MAY
6487 abort the job and post this reason even though the format is a
6488 member of the "document-format-supported" printer attribute,
6489 but not among the auto-sensed document-formats. This value
6490 MUST be supported, since "document-format" is a REQUIRED
6491 operation attribute.
6498 Hastings, et al. Standards Track [Page 116]
6500 RFC 2911 IPP/1.1: Model and Semantics September 2000
6503 'document-format-error': The job was aborted by the system because
6504 the Printer encountered an error in the document-data while
6505 processing it. If the Printer posts this reason, the
6506 document-data has already passed any tests that would have led
6507 to the 'unsupported-document-format' job-state-reason.
6508 'processing-to-stop-point': The requester has issued a Cancel-Job
6509 operation or the Printer object has aborted the job, but is
6510 still performing some actions on the job until a specified stop
6511 point occurs or job termination/cleanup is completed.
6513 If the implementation requires some measurable time to cancel
6514 the job in the 'processing' or 'processing-stopped' job states,
6515 the IPP object MUST use this value to indicate that the Printer
6516 object is still performing some actions on the job while the
6517 job remains in the 'processing' or 'processing-stopped' state.
6518 After all the job's job description attributes have stopped
6519 incrementing, the Printer object moves the job from the
6520 'processing' state to the 'canceled' or
6521 'aborted' job states.
6523 'service-off-line': The Printer is off-line and accepting no
6524 jobs. All 'pending' jobs are put into the 'pending-held'
6525 state. This situation could be true if the service's or
6526 document transform's input is impaired or broken.
6527 'job-completed-successfully': The job completed successfully.
6528 This value SHOULD be supported.
6529 'job-completed-with-warnings': The job completed with warnings.
6530 This value SHOULD be supported if the implementation detects
6532 'job-completed-with-errors': The job completed with errors (and
6533 possibly warnings too). This value SHOULD be supported if the
6534 implementation detects errors.
6535 'job-restartable' - This job is retained (see section 4.3.7.2) and
6536 is currently able to be restarted using the Restart-Job
6537 operation (see section 3.3.7). If 'job-restartable' is a value
6538 of the job's 'job-state-reasons' attribute, then the IPP object
6539 MUST accept a Restart-Job operation for that job. This value
6540 SHOULD be supported if the Restart-Job operation is supported.
6541 'queued-in-device': The job has been forwarded to a device or
6542 print system that is unable to send back status. The Printer
6543 sets the job's "job-state " attribute to 'completed' and adds
6544 the 'queued-in-device' value to the job's "job-state-reasons"
6545 attribute to indicate that the Printer has no additional
6546 information about the job and never will have any better
6547 information. See section 4.3.7.1.
6554 Hastings, et al. Standards Track [Page 117]
6556 RFC 2911 IPP/1.1: Model and Semantics September 2000
6559 4.3.9 job-state-message (text(MAX))
6561 This attribute specifies information about the "job-state" and "job-
6562 state-reasons" attributes in human readable text. If the Printer
6563 object supports this attribute, the Printer object MUST be able to
6564 generate this message in any of the natural languages identified by
6565 the Printer's "generated-natural-language-supported" attribute (see
6566 the "attributes-natural-language" operation attribute specified in
6569 The value SHOULD NOT contain additional information not contained in
6570 the values of the "job-state" and "job-states-reasons" attributes,
6571 such as interpreter error information. Otherwise, application
6572 programs might attempt to parse the (localized text). For such
6573 additional information such as interpreter errors for application
6574 program consumption or specific document access errors, new
6575 attributes with keyword values, needs to be developed and registered.
6577 4.3.10 job-detailed-status-messages (1setOf text(MAX))
6579 This attribute specifies additional detailed and technical
6580 information about the job. The Printer NEED NOT localize the
6581 message(s), since they are intended for use by the system
6582 administrator or other experienced technical persons. Localization
6583 might obscure the technical meaning of such messages. Clients MUST
6584 NOT attempt to parse the value of this attribute. See "job-
6585 document-access-errors" (section 4.3.11) for additional errors that a
6586 program can process.
6588 4.3.11 job-document-access-errors (1setOf text(MAX))
6590 This attribute provides additional information about each document
6591 access error for this job encountered by the Printer after it
6592 returned a response to the Print-URI or Send-URI operation and
6593 subsequently attempted to access document(s) supplied in the Print-
6594 URI or Send-URI operation. For errors in the protocol that is
6595 identified by the URI scheme in the "document-uri" operation
6596 attribute, such as 'http:' or 'ftp:', the error code is returned in
6597 parentheses, followed by the URI. For example:
6599 (404) http://ftp.pwg.org/pub/pwg/ipp/new_MOD/ipp-model-v11.pdf
6601 Most Internet protocols use decimal error codes (unlike IPP), so the
6602 ASCII error code representation is in decimal.
6610 Hastings, et al. Standards Track [Page 118]
6612 RFC 2911 IPP/1.1: Model and Semantics September 2000
6615 4.3.12 number-of-documents (integer(0:MAX))
6617 This attribute indicates the number of documents in the job, i.e.,
6618 the number of Send-Document, Send-URI, Print-Job, or Print-URI
6619 operations that the Printer has accepted for this job, regardless of
6620 whether the document data has reached the Printer object or not.
6622 Implementations supporting the OPTIONAL Create-Job/Send-
6623 Document/Send-URI operations SHOULD support this attribute so that
6624 clients can query the number of documents in each job.
6626 4.3.13 output-device-assigned (name(127))
6628 This attribute identifies the output device to which the Printer
6629 object has assigned this job. If an output device implements an
6630 embedded Printer object, the Printer object NEED NOT set this
6631 attribute. If a print server implements a Printer object, the value
6632 MAY be empty (zero- length string) or not returned until the Printer
6633 object assigns an output device to the job. This attribute is
6634 particularly useful when a single Printer object supports multiple
6635 devices (so called "fan-out" - see section 2.1).
6637 4.3.14 Event Time Job Description Attributes
6639 This section defines the Job Description attributes that indicate the
6640 time at which certain events occur for a job. If the job event has
6641 not yet occurred, then the IPP object MUST return the 'no-value'
6642 out-of-band value (see the beginning of Section 4.1). The "time-at-
6643 xxx(integer)" attributes represent time as an 'integer' representing
6644 the number of seconds since the device was powered up (informally
6645 called "time ticks"). The "date-time-at-xxx(dateTime)" attributes
6646 represent time as 'dateTime' representing date and time (including an
6649 In order to populate these attributes, the Printer object copies the
6650 value(s) of the following Printer Description attributes at the time
6653 1. the value in the Printer's "printer-up-time" attribute for the
6654 "time-at-xxx(integer)" attributes
6656 2. the value in the Printer's "printer-current-time" attribute for
6657 the "date-time-at-xxx(dateTime)" attributes.
6659 If the Printer resets its "printer-up-time" attribute to 1 on power-
6660 up (see section 4.4.29) and has persistent jobs, then it MUST change
6661 all of jobs' "time-at-xxx(integer)" (time tick) job attributes whose
6662 events have occurred either to:
6666 Hastings, et al. Standards Track [Page 119]
6668 RFC 2911 IPP/1.1: Model and Semantics September 2000
6671 1. 0 to indicate that the event happened before the most recent
6674 2. the negative of the number of seconds before the most recent
6675 power-up that the event took place, though the negative number
6676 NEED NOT reflect the exact number of seconds.
6678 If a client queries a "time-at-xxx(integer)" time tick Job attribute
6679 and finds the value to be 0 or negative, the client MUST assume that
6680 the event occurred in some life other than the Printer's current
6683 Note: A Printer does not change the values of any "date-time-at-
6684 xxx(dateTime)" job attributes on power-up.
6686 4.3.14.1 time-at-creation (integer(MIN:MAX))
6688 This REQUIRED attribute indicates the time at which the Job object
6691 4.3.14.2 time-at-processing (integer(MIN:MAX))
6693 This REQUIRED attribute indicates the time at which the Job object
6694 first began processing after the create operation or the most recent
6695 Restart-Job operation. The out-of-band 'no-value' value is returned
6696 if the job has not yet been in the 'processing' state (see the
6697 beginning of Section 4.1).
6699 4.3.14.3 time-at-completed (integer(MIN:MAX))
6701 This REQUIRED attribute indicates the time at which the Job object
6702 completed (or was canceled or aborted). The out-of-band 'no-value'
6703 value is returned if the job has not yet completed, been canceled, or
6704 aborted (see the beginning of Section 4.1).
6706 4.3.14.4 job-printer-up-time (integer(1:MAX))
6708 This REQUIRED Job Description attribute indicates the amount of time
6709 (in seconds) that the Printer implementation has been up and running.
6710 This attribute is an alias for the "printer-up-time" Printer
6711 Description attribute (see Section 4.4.29).
6713 A client MAY request this attribute in a Get-Job-Attributes or Get-
6714 Jobs request and use the value returned in combination with other
6715 requested Event Time Job Description Attributes in order to display
6716 time attributes to a user. The difference between this attribute and
6717 the 'integer' value of a "time-at-xxx" attribute is the number of
6722 Hastings, et al. Standards Track [Page 120]
6724 RFC 2911 IPP/1.1: Model and Semantics September 2000
6727 seconds ago that the "time-at-xxx" event occurred. A client can
6728 compute the wall-clock time at which the "time-at-xxx" event occurred
6729 by subtracting this difference from the client's wall-clock time.
6731 4.3.14.5 date-time-at-creation (dateTime)
6733 This attribute indicates the date and time at which the Job object
6736 4.3.14.6 date-time-at-processing (dateTime)
6738 This attribute indicates the date and time at which the Job object
6739 first began processing after the create operation or the most recent
6740 Restart-Job operation.
6742 4.3.14.7 date-time-at-completed (dateTime)
6744 This attribute indicates the date and time at which the Job object
6745 completed (or was canceled or aborted).
6747 4.3.15 number-of-intervening-jobs (integer(0:MAX))
6749 This attribute indicates the number of jobs that are "ahead" of this
6750 job in the relative chronological order of expected time to complete
6751 (i.e., the current scheduled order). For efficiency, it is only
6752 necessary to calculate this value when an operation is performed that
6753 requests this attribute.
6755 4.3.16 job-message-from-operator (text(127))
6757 This attribute provides a message from an operator, system
6758 administrator or "intelligent" process to indicate to the end user
6759 the reasons for modification or other management action taken on a
6762 4.3.17 Job Size Attributes
6764 This sub-section defines job attributes that describe the size of the
6765 job. These attributes are not intended to be counters; they are
6766 intended to be useful routing and scheduling information if known.
6767 For these attributes, the Printer object may try to compute the value
6768 if it is not supplied in the create request. Even if the client does
6769 supply a value for these three attributes in the create request, the
6770 Printer object MAY choose to change the value if the Printer object
6771 is able to compute a value which is more accurate than the client
6772 supplied value. The Printer object may be able to determine the
6773 correct value for these attributes either right at job submission
6774 time or at any later point in time.
6778 Hastings, et al. Standards Track [Page 121]
6780 RFC 2911 IPP/1.1: Model and Semantics September 2000
6783 4.3.17.1 job-k-octets (integer(0:MAX))
6785 This attribute specifies the total size of the document(s) in K
6786 octets, i.e., in units of 1024 octets requested to be processed in
6787 the job. The value MUST be rounded up, so that a job between 1 and
6788 1024 octets MUST be indicated as being 1, 1025 to 2048 MUST be 2,
6791 This value MUST NOT include the multiplicative factors contributed by
6792 the number of copies specified by the "copies" attribute, independent
6793 of whether the device can process multiple copies without making
6794 multiple passes over the job or document data and independent of
6795 whether the output is collated or not. Thus the value is independent
6796 of the implementation and indicates the size of the document(s)
6797 measured in K octets independent of the number of copies.
6799 This value MUST also not include the multiplicative factor due to a
6800 copies instruction embedded in the document data. If the document
6801 data actually includes replications of the document data, this value
6802 will include such replication. In other words, this value is always
6803 the size of the source document data, rather than a measure of the
6804 hardcopy output to be produced.
6806 4.3.17.2 job-impressions (integer(0:MAX))
6808 This attribute specifies the total size in number of impressions of
6809 the document(s) being submitted (see the definition of impression in
6812 As with "job-k-octets", this value MUST NOT include the
6813 multiplicative factors contributed by the number of copies specified
6814 by the "copies" attribute, independent of whether the device can
6815 process multiple copies without making multiple passes over the job
6816 or document data and independent of whether the output is collated or
6817 not. Thus the value is independent of the implementation and
6818 reflects the size of the document(s) measured in impressions
6819 independent of the number of copies.
6821 As with "job-k-octets", this value MUST also not include the
6822 multiplicative factor due to a copies instruction embedded in the
6823 document data. If the document data actually includes replications
6824 of the document data, this value will include such replication. In
6825 other words, this value is always the number of impressions in the
6826 source document data, rather than a measure of the number of
6827 impressions to be produced by the job.
6834 Hastings, et al. Standards Track [Page 122]
6836 RFC 2911 IPP/1.1: Model and Semantics September 2000
6839 4.3.17.3 job-media-sheets (integer(0:MAX))
6841 This attribute specifies the total number of media sheets to be
6842 produced for this job.
6844 Unlike the "job-k-octets" and the "job-impressions" attributes, this
6845 value MUST include the multiplicative factors contributed by the
6846 number of copies specified by the "copies" attribute and a 'number of
6847 copies' instruction embedded in the document data, if any. This
6848 difference allows the system administrator to control the lower and
6849 upper bounds of both (1) the size of the document(s) with "job-k-
6850 octets-supported" and "job-impressions-supported" and (2) the size of
6851 the job with "job-media-sheets-supported".
6853 4.3.18 Job Progress Attributes
6855 This sub-section defines job attributes that describe the progress of
6856 the job. These attributes are intended to be counters. That is, the
6857 value for a job that has not started processing MUST be 0. When the
6858 job's "job-state" is 'processing' or 'processing-stopped', this value
6859 is intended to contain the amount of the job that has been processed
6860 to the time at which the attributes are requested. When the job
6861 enters the 'completed', 'canceled', or 'aborted' states, these values
6862 are the final values for the job.
6864 4.3.18.1 job-k-octets-processed (integer(0:MAX))
6866 This attribute specifies the total number of octets processed in K
6867 octets, i.e., in units of 1024 octets so far. The value MUST be
6868 rounded up, so that a job between 1 and 1024 octets inclusive MUST be
6869 indicated as being 1, 1025 to 2048 inclusive MUST be 2, etc.
6871 For implementations where multiple copies are produced by the
6872 interpreter with only a single pass over the data, the final value
6873 MUST be equal to the value of the "job-k-octets" attribute. For
6874 implementations where multiple copies are produced by the interpreter
6875 by processing the data for each copy, the final value MUST be a
6876 multiple of the value of the "job-k-octets" attribute.
6878 4.3.18.2 job-impressions-completed (integer(0:MAX))
6880 This job attribute specifies the number of impressions completed for
6881 the job so far. For printing devices, the impressions completed
6882 includes interpreting, marking, and stacking the output.
6890 Hastings, et al. Standards Track [Page 123]
6892 RFC 2911 IPP/1.1: Model and Semantics September 2000
6895 4.3.18.3 job-media-sheets-completed (integer(0:MAX))
6897 This job attribute specifies the media-sheets completed marking and
6898 stacking for the entire job so far whether those sheets have been
6899 processed on one side or on both.
6901 4.3.19 attributes-charset (charset)
6903 This REQUIRED attribute is populated using the value in the client
6904 supplied "attributes-charset" attribute in the create request. It
6905 identifies the charset (coded character set and encoding method) used
6906 by any Job attributes with attribute syntax 'text' and 'name' that
6907 were supplied by the client in the create request. See Section 3.1.4
6908 for a complete description of the "attributes-charset" operation
6911 This attribute does not indicate the charset in which the 'text' and
6912 'name' values are stored internally in the Job object. The internal
6913 charset is implementation-defined. The IPP object MUST convert from
6914 whatever the internal charset is to that being requested in an
6915 operation as specified in Section 3.1.4.
6917 4.3.20 attributes-natural-language (naturalLanguage)
6919 This REQUIRED attribute is populated using the value in the client
6920 supplied "attributes-natural-language" attribute in the create
6921 request. It identifies the natural language used for any Job
6922 attributes with attribute syntax 'text' and 'name' that were supplied
6923 by the client in the create request. See Section 3.1.4 for a
6924 complete description of the "attributes-natural-language" operation
6925 attribute. See Sections 4.1.1.2 and 4.1.2.2 for how a Natural
6926 Language Override may be supplied explicitly for each 'text' and
6927 'name' attribute value that differs from the value identified by the
6928 "attributes-natural-language" attribute.
6930 4.4 Printer Description Attributes
6932 These attributes form the attribute group called "printer-
6933 description". The following table summarizes these attributes, their
6934 syntax, and whether or not they are REQUIRED for a Printer object to
6935 support. If they are not indicated as REQUIRED, they are OPTIONAL.
6936 The maximum size in octets for 'text' and 'name' attributes is
6937 indicated in parenthesizes.
6939 Note: How these attributes are set by an Administrator is outside the
6940 scope of this IPP/1.1 document.
6946 Hastings, et al. Standards Track [Page 124]
6948 RFC 2911 IPP/1.1: Model and Semantics September 2000
6951 +----------------------------+---------------------------+-----------+
6952 | Attribute | Syntax | REQUIRED? |
6953 +----------------------------+---------------------------+-----------+
6954 | printer-uri-supported | 1setOf uri | REQUIRED |
6955 +----------------------------+---------------------------+-----------+
6956 | uri-security-supported | 1setOf type2 keyword | REQUIRED |
6957 +----------------------------+---------------------------+-----------+
6958 | uri-authentication- | 1setOf type2 keyword | REQUIRED |
6960 +----------------------------+---------------------------+-----------+
6961 | printer-name | name (127) | REQUIRED |
6962 +----------------------------+---------------------------+-----------+
6963 | printer-location | text (127) | |
6964 +----------------------------+---------------------------+-----------+
6965 | printer-info | text (127) | |
6966 +----------------------------+---------------------------+-----------+
6967 | printer-more-info | uri | |
6968 +----------------------------+---------------------------+-----------+
6969 | printer-driver-installer | uri | |
6970 +----------------------------+---------------------------+-----------+
6971 | printer-make-and-model | text (127) | |
6972 +----------------------------+---------------------------+-----------+
6973 | printer-more-info- | uri | |
6974 | manufacturer | | |
6975 +----------------------------+---------------------------+-----------+
6976 | printer-state | type1 enum | REQUIRED |
6977 +----------------------------+---------------------------+-----------+
6978 | printer-state-reasons | 1setOf type2 keyword | REQUIRED |
6979 +----------------------------+---------------------------+-----------+
6980 | printer-state-message | text (MAX) | |
6981 +----------------------------+---------------------------+-----------+
6982 | ipp-versions-supported | 1setOf type2 keyword | REQUIRED |
6983 +----------------------------+---------------------------+-----------+
6984 | operations-supported | 1setOf type2 enum | REQUIRED |
6985 +----------------------------+---------------------------+-----------+
6986 | multiple-document-jobs- | boolean | |
6988 +----------------------------+---------------------------+-----------+
6989 | charset-configured | charset | REQUIRED |
6990 +----------------------------+---------------------------+-----------+
6991 | charset-supported | 1setOf charset | REQUIRED |
6992 +----------------------------+---------------------------+-----------+
6993 | natural-language-configured| naturalLanguage | REQUIRED |
6994 +----------------------------+---------------------------+-----------+
6995 | generated-natural-language-| 1setOf naturalLanguage | REQUIRED |
6997 +----------------------------+---------------------------+-----------+
6998 | document-format-default | mimeMediaType | REQUIRED |
7002 Hastings, et al. Standards Track [Page 125]
7004 RFC 2911 IPP/1.1: Model and Semantics September 2000
7007 +----------------------------+---------------------------+-----------+
7008 | document-format-supported | 1setOf mimeMediaType | REQUIRED |
7009 +----------------------------+---------------------------+-----------+
7010 | printer-is-accepting-jobs | boolean | REQUIRED |
7011 +----------------------------+---------------------------+-----------+
7012 | queued-job-count | integer (0:MAX) | REQUIRED |
7013 +----------------------------+---------------------------+-----------+
7014 | printer-message-from- | text (127) | |
7016 +----------------------------+---------------------------+-----------+
7017 | color-supported | boolean | |
7018 +----------------------------+---------------------------+-----------+
7019 | reference-uri-schemes- | 1setOf uriScheme | |
7021 +----------------------------+---------------------------+-----------+
7022 | pdl-override-supported | type2 keyword | REQUIRED |
7023 +----------------------------+---------------------------+-----------+
7024 | printer-up-time | integer (1:MAX) | REQUIRED |
7025 +----------------------------+---------------------------+-----------+
7026 | printer-current-time | dateTime | |
7027 +----------------------------+---------------------------+-----------+
7028 | multiple-operation-time-out| integer (1:MAX) | |
7029 +----------------------------+---------------------------+-----------+
7030 | compression-supported | 1setOf type3 keyword | REQUIRED |
7031 +----------------------------+---------------------------+-----------+
7032 | job-k-octets-supported | rangeOfInteger (0:MAX) | |
7033 +----------------------------+---------------------------+-----------+
7034 | job-impressions-supported | rangeOfInteger (0:MAX) | |
7035 +----------------------------+---------------------------+-----------+
7036 | job-media-sheets-supported | rangeOfInteger (0:MAX) | |
7037 +----------------------------+---------------------------+-----------+
7038 | pages-per-minute | integer(0:MAX) | |
7039 +----------------------------+---------------------------+-----------+
7040 | pages-per-minute-color | integer(0:MAX) | |
7041 +----------------------------+---------------------------+-----------+
7043 4.4.1 printer-uri-supported (1setOf uri)
7045 This REQUIRED Printer attribute contains at least one URI for the
7046 Printer object. It OPTIONALLY contains more than one URI for the
7047 Printer object. An administrator determines a Printer object's
7048 URI(s) and configures this attribute to contain those URIs by some
7049 means outside the scope of this IPP/1.1 document. The precise format
7050 of this URI is implementation dependent and depends on the protocol.
7051 See the next two sections for a description of the "uri-security-
7052 supported" and "uri-authentication-supported" attributes, both of
7058 Hastings, et al. Standards Track [Page 126]
7060 RFC 2911 IPP/1.1: Model and Semantics September 2000
7063 which are the REQUIRED companion attributes to this "printer-uri-
7064 supported" attribute. See section 2.4 on Printer object identity and
7065 section 8.2 on security and URIs for more information.
7067 4.4.2 uri-authentication-supported (1setOf type2 keyword)
7069 This REQUIRED Printer attribute MUST have the same cardinality
7070 (contain the same number of values) as the "printer-uri-supported"
7071 attribute. This attribute identifies the Client Authentication
7072 mechanism associated with each URI listed in the "printer-uri-
7073 supported" attribute. The Printer object uses the specified mechanism
7074 to identify the authenticated user (see section 8.3). The "i th"
7075 value in "uri-authentication-supported" corresponds to the "i th"
7076 value in "printer-uri-supported" and it describes the authentication
7077 mechanisms used by the Printer when accessed via that URI. See
7078 [RFC2910] for more details on Client Authentication.
7080 The following standard keyword values are defined:
7082 'none': There is no authentication mechanism associated with the
7083 URI. The Printer object assumes that the authenticated user is
7085 'requesting-user-name': When a client performs an operation whose
7086 target is the associated URI, the Printer object assumes that
7087 the authenticated user is specified by the "requesting-user-
7088 name" Operation attribute (see section 8.3). If the
7089 "requesting-user-name" attribute is absent in a request, the
7090 Printer object assumes that the authenticated user is
7092 'basic': When a client performs an operation whose target is the
7093 associated URI, the Printer object challenges the client with
7094 HTTP basic authentication [RFC2617]. The Printer object assumes
7095 that the authenticated user is the name received via the basic
7096 authentication mechanism.
7097 'digest': When a client performs an operation whose target is the
7098 associated URI, the Printer object challenges the client with
7099 HTTP digest authentication [RFC2617]. The Printer object
7100 assumes that the authenticated user is the name received via
7101 the digest authentication mechanism.
7102 'certificate': When a client performs an operation whose target is
7103 the associated URI, the Printer object expects the client to
7104 provide a certificate. The Printer object assumes that the
7105 authenticated user is the textual name contained within the
7114 Hastings, et al. Standards Track [Page 127]
7116 RFC 2911 IPP/1.1: Model and Semantics September 2000
7119 4.4.3 uri-security-supported (1setOf type2 keyword)
7121 This REQUIRED Printer attribute MUST have the same cardinality
7122 (contain the same number of values) as the "printer-uri-supported"
7123 attribute. This attribute identifies the security mechanisms used
7124 for each URI listed in the "printer-uri-supported" attribute. The "i
7125 th" value in "uri-security-supported" corresponds to the "i th" value
7126 in "printer-uri-supported" and it describes the security mechanisms
7127 used for accessing the Printer object via that URI. See [RFC2910]
7128 for more details on security mechanisms.
7130 The following standard keyword values are defined:
7132 'none': There are no secure communication channel protocols in use
7134 'ssl3': SSL3 [SSL] is the secure communications channel protocol
7135 in use for the given URI.
7136 'tls': TLS [RFC2246] is the secure communications channel
7137 protocol in use for the given URI.
7139 This attribute is orthogonal to the definition of a Client
7140 Authentication mechanism. Specifically, 'none' does not exclude
7141 Client Authentication. See section 4.4.2.
7143 Consider the following example. For a single Printer object, an
7144 administrator configures the "printer-uri-supported", "uri-
7145 authentication-supported" and "uri-security-supported" attributes as
7148 "printer-uri-supported": 'xxx://acme.com/open-use-printer',
7149 'xxx://acme.com/restricted-use-printer',
7150 'xxx://acme.com/private-printer'
7151 "uri-authentication-supported": 'none', 'digest', 'basic'
7152 "uri-security-supported": 'none', 'none', 'tls'
7154 Note: 'xxx' is not a valid scheme. See the IPP/1.1 "Transport and
7155 Encoding" document [RFC2910] for the actual URI schemes to be used in
7156 object target attributes.
7158 In this case, one Printer object has three URIs.
7160 - For the first URI, 'xxx://acme.com/open-use-printer', the value
7161 'none' in "uri-security-supported" indicates that there is no
7162 secure channel protocol configured to run under HTTP. The value
7163 of 'none' in "uri-authentication-supported" indicates that all
7164 users are 'anonymous'. There will be no challenge and the
7165 Printer will ignore "requesting-user-name".
7170 Hastings, et al. Standards Track [Page 128]
7172 RFC 2911 IPP/1.1: Model and Semantics September 2000
7175 - For the second URI, 'xxx://acme.com/restricted-use-printer', the
7176 value 'none' in "uri-security-supported" indicates that there is
7177 no secure channel protocol configured to run under HTTP. The
7178 value of 'digest' in "uri-authentication-supported" indicates
7179 that the Printer will issue a challenge and that the Printer
7180 will use the name supplied by the digest mechanism to determine
7181 the authenticated user (see section 8.3).
7182 - For the third URI, 'xxx://acme.com/private-printer', the value
7183 'tls' in "uri-security-supported" indicates that TLS is being
7184 used to secure the channel. The client SHOULD be prepared to
7185 use TLS framing to negotiate an acceptable ciphersuite to use
7186 while communicating with the Printer object. In this case, the
7187 name implies the use of a secure communications channel, but the
7188 fact is made explicit by the presence of the 'tls' value in
7189 "uri-security-supported". The client does not need to resort to
7190 understanding which security it must use by following naming
7191 conventions or by parsing the URI to determine which security
7192 mechanisms are implied. The value of 'basic' in "uri-
7193 authentication-supported" indicates that the Printer will issue
7194 a challenge and that the Printer will use the name supplied by
7195 the digest mechanism to determine the authenticated user (see
7196 section 8.3). Because this challenge occurs in a tls session,
7197 the channel is secure.
7199 It is expected that many IPP Printer objects will be configured to
7200 support only one channel (either configured to use TLS access or not)
7201 and only one authentication mechanism. Such Printer objects only have
7202 one URI listed in the "printer-uri-supported" attribute. No matter
7203 the configuration of the Printer object (whether it has only one URI
7204 or more than one URI), a client MUST supply only one URI in the
7205 target "printer-uri" operation attribute.
7207 4.4.4 printer-name (name(127))
7209 This REQUIRED Printer attribute contains the name of the Printer
7210 object. It is a name that is more end-user friendly than a URI. An
7211 administrator determines a printer's name and sets this attribute to
7212 that name. This name may be the last part of the printer's URI or it
7213 may be unrelated. In non-US-English locales, a name may contain
7214 characters that are not allowed in a URI.
7216 4.4.5 printer-location (text(127))
7218 This Printer attribute identifies the location of the device. This
7219 could include things like: "in Room 123A, second floor of building
7226 Hastings, et al. Standards Track [Page 129]
7228 RFC 2911 IPP/1.1: Model and Semantics September 2000
7231 4.4.6 printer-info (text(127))
7233 This Printer attribute identifies the descriptive information about
7234 this Printer object. This could include things like: "This printer
7235 can be used for printing color transparencies for HR presentations",
7236 or "Out of courtesy for others, please print only small (1-5 page)
7237 jobs at this printer", or even "This printer is going away on July 1,
7238 1997, please find a new printer".
7240 4.4.7 printer-more-info (uri)
7242 This Printer attribute contains a URI used to obtain more information
7243 about this specific Printer object. For example, this could be an
7244 HTTP type URI referencing an HTML page accessible to a Web Browser.
7245 The information obtained from this URI is intended for end user
7246 consumption. Features outside the scope of IPP can be accessed from
7247 this URI. The information is intended to be specific to this printer
7248 instance and site specific services (e.g. job pricing, services
7249 offered, end user assistance). The device manufacturer may initially
7250 populate this attribute.
7252 4.4.8 printer-driver-installer (uri)
7254 This Printer attribute contains a URI to use to locate the driver
7255 installer for this Printer object. This attribute is intended for
7256 consumption by automata. The mechanics of print driver installation
7257 is outside the scope of this IPP/1.1 document. The device
7258 manufacturer may initially populate this attribute.
7260 4.4.9 printer-make-and-model (text(127))
7262 This Printer attribute identifies the make and model of the device.
7263 The device manufacturer may initially populate this attribute.
7265 4.4.10 printer-more-info-manufacturer (uri)
7267 This Printer attribute contains a URI used to obtain more information
7268 about this type of device. The information obtained from this URI is
7269 intended for end user consumption. Features outside the scope of IPP
7270 can be accessed from this URI (e.g., latest firmware, upgrades, print
7271 drivers, optional features available, details on color support). The
7272 information is intended to be germane to this printer without regard
7273 to site specific modifications or services. The device manufacturer
7274 may initially populate this attribute.
7282 Hastings, et al. Standards Track [Page 130]
7284 RFC 2911 IPP/1.1: Model and Semantics September 2000
7287 4.4.11 printer-state (type1 enum)
7289 This REQUIRED Printer attribute identifies the current state of the
7290 device. The "printer-state reasons" attribute augments the
7291 "printer-state" attribute to give more detailed information about the
7292 Printer in the given printer state.
7294 A Printer object need only update this attribute before responding to
7295 an operation which requests the attribute; the Printer object NEED
7296 NOT update this attribute continually, since asynchronous event
7297 notification is not part of IPP/1.1. A Printer NEED NOT implement
7298 all values if they are not applicable to a given implementation.
7300 The following standard enum values are defined:
7302 Value Symbolic Name and Description
7304 '3' 'idle': Indicates that new jobs can start processing without
7306 '4' 'processing': Indicates that jobs are processing; new jobs
7307 will wait before processing.
7308 '5' 'stopped': Indicates that no jobs can be processed and
7309 intervention is required.
7311 Values of "printer-state-reasons", such as 'spool-area-full' and
7312 'stopped-partly', MAY be used to provide further information.
7314 4.4.12 printer-state-reasons (1setOf type2 keyword)
7316 This REQUIRED Printer attribute supplies additional detail about the
7317 device's state. Some of the these value definitions indicate
7318 conformance requirements; the rest are OPTIONAL.
7320 Each keyword value MAY have a suffix to indicate its level of
7321 severity. The three levels are: report (least severe), warning, and
7322 error (most severe).
7324 - '-report': This suffix indicates that the reason is a "report".
7325 An implementation may choose to omit some or all reports. Some
7326 reports specify finer granularity about the printer state;
7327 others serve as a precursor to a warning. A report MUST contain
7328 nothing that could affect the printed output.
7329 - '-warning': This suffix indicates that the reason is a
7330 "warning". An implementation may choose to omit some or all
7331 warnings. Warnings serve as a precursor to an error. A warning
7332 MUST contain nothing that prevents a job from completing, though
7333 in some cases the output may be of lower quality.
7338 Hastings, et al. Standards Track [Page 131]
7340 RFC 2911 IPP/1.1: Model and Semantics September 2000
7343 - '-error': This suffix indicates that the reason is an "error".
7344 An implementation MUST include all errors. If this attribute
7345 contains one or more errors, printer MUST be in the stopped
7348 If the implementation does not add any one of the three suffixes, all
7349 parties MUST assume that the reason is an "error".
7351 If a Printer object controls more than one output device, each value
7352 of this attribute MAY apply to one or more of the output devices. An
7353 error on one output device that does not stop the Printer object as a
7354 whole MAY appear as a warning in the Printer's "printer-state-reasons
7355 attribute". If the "printer-state" for such a Printer has a value of
7356 'stopped', then there MUST be an error reason among the values in the
7357 "printer-state-reasons" attribute.
7359 The following standard keyword values are defined:
7361 'other': The device has detected an error other than one listed in
7363 'none': There are not reasons. This state reason is semantically
7364 equivalent to "printer-state-reasons" without any value and
7365 MUST be used, since the 1setOf attribute syntax requires at
7367 'media-needed': A tray has run out of media.
7368 'media-jam': The device has a media jam.
7369 'moving-to-paused': Someone has paused the Printer object using
7370 the Pause-Printer operation (see section 3.2.7) or other means,
7371 but the device(s) are taking an appreciable time to stop.
7372 Later, when all output has stopped, the "printer-state" becomes
7373 'stopped', and the 'paused' value replaces the 'moving-to-
7374 paused' value in the "printer-state-reasons" attribute. This
7375 value MUST be supported, if the Pause-Printer operation is
7376 supported and the implementation takes significant time to
7377 pause a device in certain circumstances.
7378 'paused': Someone has paused the Printer object using the Pause-
7379 Printer operation (see section 3.2.7) or other means and the
7380 Printer object's "printer-state" is 'stopped'. In this state,
7381 a Printer MUST NOT produce printed output, but it MUST perform
7382 other operations requested by a client. If a Printer had been
7383 printing a job when the Printer was paused, the Printer MUST
7384 resume printing that job when the Printer is no longer paused
7385 and leave no evidence in the printed output of such a pause.
7386 This value MUST be supported, if the Pause-Printer operation is
7388 'shutdown': Someone has removed a Printer object from service, and
7389 the device may be powered down or physically removed. In this
7390 state, a Printer object MUST NOT produce printed output, and
7394 Hastings, et al. Standards Track [Page 132]
7396 RFC 2911 IPP/1.1: Model and Semantics September 2000
7399 unless the Printer object is realized by a print server that is
7400 still active, the Printer object MUST perform no other
7401 operations requested by a client, including returning this
7402 value. If a Printer object had been printing a job when it was
7403 shutdown, the Printer NEED NOT resume printing that job when
7404 the Printer is no longer shutdown. If the Printer resumes
7405 printing such a job, it may leave evidence in the printed
7406 output of such a shutdown, e.g. the part printed before the
7407 shutdown may be printed a second time after the shutdown.
7408 'connecting-to-device': The Printer object has scheduled a job on
7409 the output device and is in the process of connecting to a
7410 shared network output device (and might not be able to actually
7411 start printing the job for an arbitrarily long time depending
7412 on the usage of the output device by other servers on the
7414 'timed-out': The server was able to connect to the output device
7415 (or is always connected), but was unable to get a response from
7417 'stopping': The Printer object is in the process of stopping the
7418 device and will be stopped in a while. When the device is
7419 stopped, the Printer object will change the Printer object's
7420 state to 'stopped'. The 'stopping-warning' reason is never an
7421 error, even for a Printer with a single output device. When an
7422 output-device ceases accepting jobs, the Printer will have this
7423 reason while the output device completes printing.
7424 'stopped-partly': When a Printer object controls more than one
7425 output device, this reason indicates that one or more output
7426 devices are stopped. If the reason is a report, fewer than
7427 half of the output devices are stopped. If the reason is a
7428 warning, fewer than all of the output devices are stopped.
7429 'toner-low': The device is low on toner.
7430 'toner-empty': The device is out of toner.
7431 'spool-area-full': The limit of persistent storage allocated for
7432 spooling has been reached. The Printer is temporarily unable
7433 to accept more jobs. The Printer will remove this value when
7434 it is able to accept more jobs. This value SHOULD be used by a
7435 non-spooling Printer that only accepts one or a small number
7436 jobs at a time or a spooling Printer that has filled the spool
7438 'cover-open': One or more covers on the device are open.
7439 'interlock-open': One or more interlock devices on the printer are
7441 'door-open': One or more doors on the device are open.
7442 'input-tray-missing': One or more input trays are not in the
7444 'media-low': At least one input tray is low on media.
7445 'media-empty': At least one input tray is empty.
7450 Hastings, et al. Standards Track [Page 133]
7452 RFC 2911 IPP/1.1: Model and Semantics September 2000
7455 'output-tray-missing': One or more output trays are not in the
7457 'output-area-almost-full': One or more output area is almost full
7458 (e.g. tray, stacker, collator).
7459 'output-area-full': One or more output area is full. (e.g. tray,
7461 'marker-supply-low': The device is low on at least one marker
7462 supply. (e.g. toner, ink, ribbon)
7463 'marker-supply-empty: The device is out of at least one marker
7464 supply. (e.g. toner, ink, ribbon)
7465 'marker-waste-almost-full': The device marker supply waste
7466 receptacle is almost full.
7467 'marker-waste-full': The device marker supply waste receptacle is
7469 'fuser-over-temp': The fuser temperature is above normal.
7470 'fuser-under-temp': The fuser temperature is below normal.
7471 'opc-near-eol': The optical photo conductor is near end of life.
7472 'opc-life-over': The optical photo conductor is no longer
7474 'developer-low': The device is low on developer.
7475 'developer-empty: The device is out of developer.
7476 'interpreter-resource-unavailable': An interpreter resource is
7477 unavailable (i.e. font, form)
7479 4.4.13 printer-state-message (text(MAX))
7481 This Printer attribute specifies information about the "printer-
7482 state" and "printer-state-reasons" attributes in human readable text.
7483 If the Printer object supports this attribute, the Printer object
7484 MUST be able to generate this message in any of the natural languages
7485 identified by the Printer's "generated-natural-language-supported"
7486 attribute (see the "attributes-natural-language" operation attribute
7487 specified in Section 3.1.4.1).
7489 4.4.14 ipp-versions-supported (1setOf type2 keyword)
7491 This REQUIRED attribute identifies the IPP protocol version(s) that
7492 this Printer supports, including major and minor versions, i.e., the
7493 version numbers for which this Printer implementation meets the
7494 conformance requirements. For version number validation, the Printer
7495 matches the (two-octet binary) "version-number" parameter supplied by
7496 the client in each request (see sections 3.1.1 and 3.1.8) with the
7497 (US-ASCII) keyword values of this attribute.
7506 Hastings, et al. Standards Track [Page 134]
7508 RFC 2911 IPP/1.1: Model and Semantics September 2000
7511 The following standard keyword values are defined:
7513 '1.0': Meets the conformance requirement of IPP version 1.0 as
7514 specified in RFC 2566 [RFC2566] and RFC 2565 [RFC2565]
7515 including any extensions registered according to Section 6 and
7516 any extension defined in this version or any future version of
7517 the IPP "Model and Semantics" document or the IPP "Encoding and
7518 Transport" document following the rules, if any, when the
7519 "version-number" parameter is '1.0'.
7520 '1.1': Meets the conformance requirement of IPP version 1.1 as
7521 specified in this document and [RFC2910] including any
7522 extensions registered according to Section 6 and any extension
7523 defined in any future versions of the IPP "Model and Semantics"
7524 document or the IPP Encoding and Transport document following
7525 the rules, if any, when the "version-number" parameter is
7528 4.4.15 operations-supported (1setOf type2 enum)
7530 This REQUIRED Printer attribute specifies the set of supported
7531 operations for this Printer object and contained Job objects.
7533 This attribute is encoded as any other enum attribute syntax
7534 according to [RFC2910] as 32-bits. However, all 32-bit enum values
7535 for this attribute MUST NOT exceed 0x00008FFF, since these same
7536 values are also passed in two octets in the "operation-id" parameter
7537 (see section 3.1.1) in each Protocol request with the two high order
7538 octets omitted in order to indicate the operation being performed
7541 The following standard enum and "operation-id" (see section 3.1.2)
7562 Hastings, et al. Standards Track [Page 135]
7564 RFC 2911 IPP/1.1: Model and Semantics September 2000
7567 Value Operation Name
7568 ----------------- -------------------------------------
7570 0x0000 reserved, not used
7571 0x0001 reserved, not used
7576 0x0006 Send-Document
7579 0x0009 Get-Job-Attributes
7581 0x000B Get-Printer-Attributes
7585 0x000F reserved for a future operation
7586 0x0010 Pause-Printer
7587 0x0011 Resume-Printer
7589 0x0013-0x3FFF reserved for future IETF standards track
7590 operations (see section 6.4)
7591 0x4000-0x8FFF reserved for vendor extensions (see section 6.4)
7593 4.4.16 multiple-document-jobs-supported (boolean)
7595 This Printer attribute indicates whether or not the Printer supports
7596 more than one document per job, i.e., more than one Send-Document or
7597 Send-Data operation with document data. If the Printer supports the
7598 Create-Job and Send-Document operations (see section 3.2.4 and
7599 3.3.1), it MUST support this attribute.
7601 4.4.17 charset-configured (charset)
7603 This REQUIRED Printer attribute identifies the charset that the
7604 Printer object has been configured to represent 'text' and 'name'
7605 Printer attributes that are set by the operator, system
7606 administrator, or manufacturer, i.e., for "printer-name" (name),
7607 "printer-location" (text), "printer-info" (text), and "printer-make-
7608 and-model" (text). Therefore, the value of the Printer object's
7609 "charset-configured" attribute MUST also be among the values of the
7610 Printer object's "charset-supported" attribute.
7618 Hastings, et al. Standards Track [Page 136]
7620 RFC 2911 IPP/1.1: Model and Semantics September 2000
7623 4.4.18 charset-supported (1setOf charset)
7625 This REQUIRED Printer attribute identifies the set of charsets that
7626 the Printer and contained Job objects support in attributes with
7627 attribute syntax 'text' and 'name'. At least the value 'utf-8' MUST
7628 be present, since IPP objects MUST support the UTF-8 [RFC2279]
7629 charset. If a Printer object supports a charset, it means that for
7630 all attributes of syntax 'text' and 'name' the IPP object MUST (1)
7631 accept the charset in requests and return the charset in responses as
7634 If more charsets than UTF-8 are supported, the IPP object MUST
7635 perform charset conversion between the charsets as described in
7638 4.4.19 natural-language-configured (naturalLanguage)
7640 This REQUIRED Printer attribute identifies the natural language that
7641 the Printer object has been configured to represent 'text' and 'name'
7642 Printer attributes that are set by the operator, system
7643 administrator, or manufacturer, i.e., for "printer-name" (name),
7644 "printer-location" (text), "printer-info" (text), and "printer-make-
7645 and-model" (text). When returning these Printer attributes, the
7646 Printer object MAY return them in the configured natural language
7647 specified by this attribute, instead of the natural language
7648 requested by the client in the "attributes-natural-language"
7649 operation attribute. See Section 3.1.4.1 for the specification of
7650 the OPTIONAL multiple natural language support. Therefore, the value
7651 of the Printer object's "natural-language-configured" attribute MUST
7652 also be among the values of the Printer object's "generated-natural-
7653 language-supported" attribute.
7655 4.4.20 generated-natural-language-supported (1setOf naturalLanguage)
7657 This REQUIRED Printer attribute identifies the natural language(s)
7658 that the Printer object and contained Job objects support in
7659 attributes with attribute syntax 'text' and 'name'. The natural
7660 language(s) supported depends on implementation and/or configuration.
7661 Unlike charsets, IPP objects MUST accept requests with any natural
7662 language or any Natural Language Override whether the natural
7663 language is supported or not.
7665 If a Printer object supports a natural language, it means that for
7666 any of the attributes for which the Printer or Job object generates
7667 messages, i.e., for the "job-state-message" and "printer-state-
7668 message" attributes and Operation Messages (see Section 3.1.5) in
7669 operation responses, the Printer and Job objects MUST be able to
7674 Hastings, et al. Standards Track [Page 137]
7676 RFC 2911 IPP/1.1: Model and Semantics September 2000
7679 generate messages in any of the Printer's supported natural
7680 languages. See section 3.1.4 for the definition of 'text' and 'name'
7681 attributes in operation requests and responses.
7683 Note: A Printer object that supports multiple natural languages,
7684 often has separate catalogs of messages, one for each natural
7687 4.4.21 document-format-default (mimeMediaType)
7689 This REQUIRED Printer attribute identifies the document format that
7690 the Printer object has been configured to assume if the client does
7691 not supply a "document-format" operation attribute in any of the
7692 operation requests that supply document data. The standard values
7693 for this attribute are Internet Media types (sometimes called MIME
7694 types). For further details see the description of the
7695 'mimeMediaType' attribute syntax in Section 4.1.9.
7697 4.4.22 document-format-supported (1setOf mimeMediaType)
7699 This REQUIRED Printer attribute identifies the set of document
7700 formats that the Printer object and contained Job objects can
7701 support. For further details see the description of the
7702 'mimeMediaType' attribute syntax in Section 4.1.9.
7704 4.4.23 printer-is-accepting-jobs (boolean)
7706 This REQUIRED Printer attribute indicates whether the printer is
7707 currently able to accept jobs, i.e., is accepting Print-Job, Print-
7708 URI, and Create-Job requests. If the value is 'true', the printer is
7709 accepting jobs. If the value is 'false', the Printer object is
7710 currently rejecting any jobs submitted to it. In this case, the
7711 Printer object returns the 'server-error-not-accepting-jobs' status
7714 This value is independent of the "printer-state" and "printer-state-
7715 reasons" attributes because its value does not affect the current
7716 job; rather it affects future jobs. This attribute, when 'false',
7717 causes the Printer to reject jobs even when the "printer-state" is
7718 'idle' or, when 'true', causes the Printer object to accepts jobs
7719 even when the "printer-state" is 'stopped'.
7721 4.4.24 queued-job-count (integer(0:MAX))
7723 This REQUIRED Printer attribute contains a count of the number of
7724 jobs that are either 'pending', 'processing', 'pending-held', or
7725 'processing-stopped' and is set by the Printer object.
7730 Hastings, et al. Standards Track [Page 138]
7732 RFC 2911 IPP/1.1: Model and Semantics September 2000
7735 4.4.25 printer-message-from-operator (text(127))
7737 This Printer attribute provides a message from an operator, system
7738 administrator or "intelligent" process to indicate to the end user
7739 information or status of the printer, such as why it is unavailable
7740 or when it is expected to be available.
7742 4.4.26 color-supported (boolean)
7744 This Printer attribute identifies whether the device is capable of
7745 any type of color printing at all, including highlight color. All
7746 document instructions having to do with color are embedded within the
7747 document PDL (none are external IPP attributes in IPP/1.1).
7749 Note: end-users are able to determine the nature and details of the
7750 color support by querying the "printer-more-info-manufacturer"
7753 4.4.27 reference-uri-schemes-supported (1setOf uriScheme)
7755 This Printer attribute specifies which URI schemes are supported for
7756 use in the "document-uri" operation attribute of the Print-URI or
7757 Send-URI operation. If a Printer object supports these optional
7758 operations, it MUST support the "reference-uri-schemes-supported"
7759 Printer attribute with at least the following schemed URI value:
7761 'ftp': The Printer object will use an FTP 'get' operation as
7762 defined in RFC 2228 [RFC2228] using FTP URLs as defined by
7763 [RFC2396] and [RFC2316].
7765 The Printer object MAY OPTIONALLY support other URI schemes (see
7768 4.4.28 pdl-override-supported (type2 keyword)
7770 This REQUIRED Printer attribute expresses the ability for a
7771 particular Printer implementation to either attempt to override
7772 document data instructions with IPP attributes or not.
7774 This attribute takes on the following keyword values:
7776 - 'attempted': This value indicates that the Printer object
7777 attempts to make the IPP attribute values take precedence over
7778 embedded instructions in the document data, however there is no
7780 - 'not-attempted': This value indicates that the Printer object
7781 makes no attempt to make the IPP attribute values take
7782 precedence over embedded instructions in the document data.
7786 Hastings, et al. Standards Track [Page 139]
7788 RFC 2911 IPP/1.1: Model and Semantics September 2000
7791 Section 15 contains a full description of how this attribute
7792 interacts with and affects other IPP attributes, especially the
7793 "ipp-attribute-fidelity" attribute.
7795 4.4.29 printer-up-time (integer(1:MAX))
7797 This REQUIRED Printer attribute indicates the amount of time (in
7798 seconds) that this Printer instance has been up and running. The
7799 value is a monotonically increasing value starting from 1 when the
7800 Printer object is started-up (initialized, booted, etc.). This value
7801 is used to populate the Event Time Job Description Job attributes
7802 "time-at-creation", "time-at-processing", and "time-at-completed"
7803 (see section 4.3.14).
7805 If the Printer object goes down at some value 'n', and comes back up,
7806 the implementation MAY:
7808 1. Know how long it has been down, and resume at some value
7809 greater than 'n', or
7812 In other words, if the device or devices that the Printer object is
7813 representing are restarted or power cycled, the Printer object MAY
7814 continue counting this value or MAY reset this value to 1 depending
7815 on implementation. However, if the Printer object software ceases
7816 running, and restarts without knowing the last value for "printer-
7817 up-time", the implementation MUST reset this value to 1. If this
7818 value is reset and the Printer has persistent jobs, the Printer MUST
7819 reset the "time-at-xxx(integer) Event Time Job Description attributes
7820 according to Section 4.3.14. An implementation MAY use both
7821 implementation alternatives, depending on warm versus cold start,
7824 4.4.30 printer-current-time (dateTime)
7826 This Printer attribute indicates the current date and time. This
7827 value is used to populate the Event Time Job Description attributes:
7828 "date-time-at-creation", "date-time-at-processing", and "date-time-
7829 at-completed" (see Section 4.3.14).
7831 The date and time is obtained on a "best efforts basis" and does not
7832 have to be that precise in order to work in practice. A Printer
7833 implementation sets the value of this attribute by obtaining the date
7834 and time via some implementation-dependent means, such as getting the
7835 value from a network time server, initialization at time of
7836 manufacture, or setting by an administrator. See [IPP-IIG] for
7837 examples. If an implementation supports this attribute and the
7838 implementation knows that it has not yet been set, then the
7842 Hastings, et al. Standards Track [Page 140]
7844 RFC 2911 IPP/1.1: Model and Semantics September 2000
7847 implementation MUST return the value of this attribute using the
7848 out-of-band 'no-value' meaning not configured. See the beginning of
7851 The time zone of this attribute NEED NOT be the time zone used by
7852 people located near the Printer object or device. The client MUST
7853 NOT expect that the time zone of any received 'dateTime' value to be
7854 in the time zone of the client or in the time zone of the people
7855 located near the printer.
7857 The client SHOULD display any dateTime attributes to the user in
7858 client local time by converting the 'dateTime' value returned by the
7859 server to the time zone of the client, rather than using the time
7860 zone returned by the Printer in attributes that use the 'dateTime'
7863 4.4.31 multiple-operation-time-out (integer(1:MAX))
7865 This Printer attributes identifies the minimum time (in seconds) that
7866 the Printer object waits for additional Send-Document or Send-URI
7867 operations to follow a still-open Job object before taking any
7868 recovery actions, such as the ones indicated in section 3.3.1. If
7869 the Printer object supports the Create-Job and Send-Document
7870 operations (see section 3.2.4 and 3.3.1), it MUST support this
7873 It is RECOMMENDED that vendors supply a value for this attribute that
7874 is between 60 and 240 seconds. An implementation MAY allow a system
7875 administrator to set this attribute (by means outside this IPP/1.1
7876 document). If so, the system administrator MAY be able to set values
7879 4.4.32 compression-supported (1setOf type3 keyword)
7881 This REQUIRED Printer attribute identifies the set of supported
7882 compression algorithms for document data. Compression only applies
7883 to the document data; compression does not apply to the encoding of
7884 the IPP operation itself. The supported values are used to validate
7885 the client supplied "compression" operation attributes in Print-Job,
7886 Send-Document, and Send-URI requests.
7888 Standard keyword values are :
7890 'none': no compression is used.
7891 'deflate': ZIP public domain inflate/deflate) compression technology
7892 in RFC 1951 [RFC1951]
7893 'gzip' GNU zip compression technology described in RFC 1952
7898 Hastings, et al. Standards Track [Page 141]
7900 RFC 2911 IPP/1.1: Model and Semantics September 2000
7903 'compress': UNIX compression technology in RFC 1977 [RFC1977]
7905 4.4.33 job-k-octets-supported (rangeOfInteger(0:MAX))
7907 This Printer attribute specifies the upper and lower bounds of total
7908 sizes of jobs in K octets, i.e., in units of 1024 octets. The
7909 supported values are used to validate the client supplied "job-k-
7910 octets" operation attributes in create requests. The corresponding
7911 job description attribute "job-k-octets" is defined in section
7914 4.4.34 job-impressions-supported (rangeOfInteger(0:MAX))
7916 This Printer attribute specifies the upper and lower bounds for the
7917 number of impressions per job. The supported values are used to
7918 validate the client supplied "job-impressions" operation attributes
7919 in create requests. The corresponding job description attribute
7920 "job-impressions" is defined in section 4.3.17.2.
7922 4.4.35 job-media-sheets-supported (rangeOfInteger(0:MAX))
7924 This Printer attribute specifies the upper and lower bounds for the
7925 number of media sheets per job. The supported values are used to
7926 validate the client supplied "job-media-sheets" operation attributes
7927 in create requests. The corresponding Job attribute "job-media-
7928 sheets" is defined in section 4.3.17.3.
7930 4.4.36 pages-per-minute (integer(0:MAX))
7932 This Printer attributes specifies the nominal number of pages per
7933 minute to the nearest whole number which may be generated by this
7934 printer (e.g., simplex, black-and-white). This attribute is
7935 informative, not a service guarantee. Generally, it is the value
7936 used in the marketing literature to describe the device.
7938 A value of 0 indicates a device that takes more than two minutes to
7941 4.4.37 pages-per-minute-color (integer(0:MAX))
7943 This Printer attributes specifies the nominal number of pages per
7944 minute to the nearest whole number which may be generated by this
7945 printer when printing color (e.g., simplex, color). For purposes of
7946 this attribute, "color" means the same as for the "color-supported"
7947 attribute, namely, the device is capable of any type of color
7948 printing at all, including highlight color. This attribute is
7954 Hastings, et al. Standards Track [Page 142]
7956 RFC 2911 IPP/1.1: Model and Semantics September 2000
7959 informative, not a service guarantee. Generally, it is the value
7960 used in the marketing literature to describe the color capabilities
7963 A value of 0 indicates a device that takes more than two minutes to
7966 If a color device has several color modes, it MAY use the pages-per-
7967 minute value for this attribute that corresponds to the mode that
7968 produces the highest number.
7970 Black and white only printers MUST NOT support this attribute. If
7971 this attribute is present, then the "color-supported" Printer
7972 description attribute MUST be present and have a 'true' value.
7974 The values of these two attributes returned by the Get-Printer-
7975 Attributes operation MAY be affected by the "document-format"
7976 attribute supplied by the client in the Get-Printer-Attributes
7977 request. In other words, the implementation MAY have different
7978 speeds depending on the document format being processed. See section
7979 3.2.5.1 Get-Printer-Attributes.
7983 This section describes conformance issues and requirements. This
7984 document introduces model entities such as objects, operations,
7985 attributes, attribute syntaxes, and attribute values. These
7986 conformance sections describe the conformance requirements which
7987 apply to these model entities.
7989 5.1 Client Conformance Requirements
7991 This section describes the conformance requirements for a client (see
7992 section 2.1), whether it be:
7994 1. contained within software controlled by an end user, e.g.
7995 activated by the "Print" menu item in an application that sends
7998 2. the print server component that sends IPP requests to either an
7999 output device or another "downstream" print server.
8001 A conforming client MUST support all REQUIRED operations as defined
8002 in this document. For each attribute included in an operation
8003 request, a conforming client MUST supply a value whose type and value
8004 syntax conforms to the requirements of the Model document as
8005 specified in Sections 3 and 4. A conforming client MAY supply any
8010 Hastings, et al. Standards Track [Page 143]
8012 RFC 2911 IPP/1.1: Model and Semantics September 2000
8015 IETF standards track extensions and/or vendor extensions in an
8016 operation request, as long as the extensions meet the requirements in
8019 Otherwise, there are no conformance requirements placed on the user
8020 interfaces provided by IPP clients or their applications. For
8021 example, one application might not allow an end user to submit
8022 multiple documents per job, while another does. One application
8023 might first query a Printer object in order to supply a graphical
8024 user interface (GUI) dialogue box with supported and default values
8025 whereas a different implementation might not.
8027 When sending a request, an IPP client NEED NOT supply any attributes
8028 that are indicated as OPTIONALLY supplied by the client.
8030 A client MUST be able to accept any of the attribute syntaxes defined
8031 in Section 4.1, including their full range, that may be returned to
8032 it in a response from a Printer object. In particular for each
8033 attribute that the client supports whose attribute syntax is 'text',
8034 the client MUST accept and process both the 'textWithoutLanguage' and
8035 'textWithLanguage' forms. Similarly, for each attribute that the
8036 client supports whose attribute syntax is 'name', the client MUST
8037 accept and process both the 'nameWithoutLanguage' and
8038 'nameWithLanguage' forms. For presentation purposes, truncation of
8039 long attribute values is not recommended. A recommended approach
8040 would be for the client implementation to allow the user to scroll
8041 through long attribute values.
8043 A response MAY contain attribute groups, attributes, attribute
8044 syntaxes, values, and status codes that the client does not expect.
8045 Therefore, a client implementation MUST gracefully handle such
8046 responses and not refuse to inter-operate with a conforming Printer
8047 that is returning IETF standards track extension or vendor
8048 extensions, including attribute groups, attributes, attribute
8049 syntaxes, attribute values, status codes, and out-of-band attribute
8050 values that conform to Section 6. Clients may choose to ignore any
8051 parameters, attribute groups, attributes, attribute syntaxes, or
8052 values that they do not understand.
8054 While a client is sending data to a printer, it SHOULD do its best to
8055 prevent a channel from being closed by a lower layer when the channel
8056 is blocked (i.e. flow-controlled off) for whatever reason, e.g. 'out
8057 of paper' or 'job ahead hasn't freed up enough memory'. However, the
8058 layer that launched the print submission (e.g. an end user) MAY close
8059 the channel in order to cancel the job. When a client closes a
8060 channel, a Printer MAY print all or part of the received portion of
8061 the document. See the "Encoding and Transport" document [RFC2910]
8066 Hastings, et al. Standards Track [Page 144]
8068 RFC 2911 IPP/1.1: Model and Semantics September 2000
8071 A client MUST support Client Authentication as defined in the IPP/1.1
8072 Encoding and Transport document [RFC2910]. A client SHOULD support
8073 Operation Privacy and Server Authentication as defined in the IPP/1.1
8074 Encoding and Transport document [RFC2910]. See also section 8 of
8077 5.2 IPP Object Conformance Requirements
8079 This section specifies the conformance requirements for conforming
8080 implementations of IPP objects (see section 2). These requirements
8081 apply to an IPP object whether it is:
8083 (1) an (embedded) device component that accepts IPP requests and
8084 controls the device or
8086 (2) a component of a print server that accepts IPP requests (where
8087 the print server control one or more networked devices using IPP or
8092 Conforming implementations MUST implement all of the model objects as
8093 defined in this document in the indicated sections:
8095 Section 2.1 - Printer Object
8096 Section 2.2 - Job Object
8100 Conforming IPP object implementations MUST implement all of the
8101 REQUIRED model operations, including REQUIRED responses, as defined
8102 in this document in the indicated sections:
8104 For a Printer object:
8105 Print-Job (section 3.2.1) REQUIRED
8106 Print-URI (section 3.2.2) OPTIONAL
8107 Validate-Job (section 3.2.3) REQUIRED
8108 Create-Job (section 3.2.4) OPTIONAL
8109 Get-Printer-Attributes (section 3.2.5) REQUIRED
8110 Get-Jobs (section 3.2.6) REQUIRED
8111 Pause-Printer (section 3.2.7) OPTIONAL
8112 Resume-Printer (section 3.2.8) OPTIONAL
8113 Purge-Jobs (section 3.2.9) OPTIONAL
8122 Hastings, et al. Standards Track [Page 145]
8124 RFC 2911 IPP/1.1: Model and Semantics September 2000
8128 Send-Document (section 3.3.1) OPTIONAL
8129 Send-URI (section 3.3.2) OPTIONAL
8130 Cancel-Job (section 3.3.3) REQUIRED
8131 Get-Job-Attributes (section 3.3.4) REQUIRED
8132 Hold-Job (section 3.3.5) OPTIONAL
8133 Release-Job (section 3.3.6) OPTIONAL
8134 Restart-Job (section 3.3.7) OPTIONAL
8136 Conforming IPP objects MUST support all REQUIRED operation attributes
8137 and all values of such attributes if so indicated in the description.
8138 Conforming IPP objects MUST ignore all unsupported or unknown
8139 operation attributes or operation attribute groups received in a
8140 request, but MUST reject a request that contains a supported
8141 operation attribute that contains an unsupported value.
8143 Conforming IPP objects MAY return operation responses that contain
8144 attributes groups, attributes names, attribute syntaxes, attribute
8145 values, and status codes that are extensions to this standard. The
8146 additional attribute groups MAY occur in any order.
8148 The following section on object attributes specifies the support
8149 required for object attributes.
8151 5.2.3 IPP Object Attributes
8153 Conforming IPP objects MUST support all of the REQUIRED object
8154 attributes, as defined in this document in the indicated sections.
8156 If an object supports an attribute, it MUST support only those values
8157 specified in this document or through the extension mechanism
8158 described in section 5.2.4. It MAY support any non-empty subset of
8159 these values. That is, it MUST support at least one of the specified
8160 values and at most all of them.
8164 IPP/1.1 clients MUST meet the conformance requirements for clients
8165 specified in this document and [RFC2910]. IPP/1.1 clients MUST send
8166 requests containing a "version-number" parameter with a '1.1' value.
8168 IPP/1.1 Printer and Job objects MUST meet the conformance
8169 requirements for IPP objects specified in this document and
8170 [RFC2910]. IPP/1.1 objects MUST accept requests containing a
8171 "version-number" parameter with a '1.1' value (or reject the request
8172 if the operation is not supported).
8178 Hastings, et al. Standards Track [Page 146]
8180 RFC 2911 IPP/1.1: Model and Semantics September 2000
8183 It is beyond the scope of this specification to mandate conformance
8184 with previous versions. IPP/1.1 was deliberately designed, however,
8185 to make supporting previous versions easy. It is worth noting that,
8186 at the time of composing this specification (1999), we would expect
8187 IPP/1.1 Printer implementations to:
8189 understand any valid request in the format of IPP/1.0, or 1.1;
8191 respond appropriately with a response containing the same
8192 "version-number" parameter value used by the client in the request.
8194 And we would expect IPP/1.1 clients to:
8196 understand any valid response in the format of IPP/1.0, or 1.1.
8198 It is recommended that IPP/1.1 clients try supplying alternate
8199 version numbers if they receive a 'server-error-version-not-
8200 supported' error return in a response.
8204 A conforming IPP object MAY support IETF standards track extensions
8205 and vendor extensions, as long as the extensions meet the
8206 requirements specified in Section 6.
8208 For each attribute included in an operation response, a conforming
8209 IPP object MUST return a value whose type and value syntax conforms
8210 to the requirement of the Model document as specified in Sections 3
8213 5.2.6 Attribute Syntaxes
8215 An IPP object MUST be able to accept any of the attribute syntaxes
8216 defined in Section 4.1, including their full range, in any operation
8217 in which a client may supply attributes or the system administrator
8218 may configure attributes (by means outside the scope of this IPP/1.1
8219 document). In particular for each attribute that the IPP object
8220 supports whose attribute syntax is 'text', the IPP object MUST accept
8221 and process both the 'textWithoutLanguage' and 'textWithLanguage'
8222 forms. Similarly, for each attribute that the IPP object supports
8223 whose attribute syntax is 'name', the IPP object MUST accept and
8224 process both the 'nameWithoutLanguage' and 'nameWithLanguage' forms.
8225 Furthermore, an IPP object MUST return attributes to the client in
8226 operation responses that conform to the syntax specified in Section
8227 4.1, including their full range if supplied previously by a client.
8234 Hastings, et al. Standards Track [Page 147]
8236 RFC 2911 IPP/1.1: Model and Semantics September 2000
8241 An IPP Printer implementation SHOULD contain support for Client
8242 Authentication as defined in the IPP/1.1 Encoding and Transport
8243 document [RFC2910]. A Printer implementation MAY allow an
8244 administrator to configure the Printer so that all, some, or none of
8245 the users are authenticated. See also section 8 of this document.
8247 An IPP Printer implementation SHOULD contain support for Operation
8248 Privacy and Server Authentication as defined in the IPP/1.1 Encoding
8249 and Transport document [RFC2910]. A Printer implementation MAY allow
8250 an administrator to configure the degree of support for Operation
8251 Privacy and Server Authentication. See also section 8 of this
8254 Security MUST NOT be compromised when a client supplies a lower
8255 "version-number" parameter in a request. For example, if an IPP/1.1
8256 conforming Printer object accepts version '1.0' requests and is
8257 configured to enforce Digest Authentication, it MUST do the same for
8258 a version '1.0' request.
8260 5.3 Charset and Natural Language Requirements
8262 All clients and IPP objects MUST support the 'utf-8' charset as
8263 defined in section 4.1.7.
8265 IPP objects MUST be able to accept any client request which correctly
8266 uses the "attributes-natural-language" operation attribute or the
8267 Natural Language Override mechanism on any individual attribute
8268 whether or not the natural language is supported by the IPP object.
8269 If an IPP object supports a natural language, then it MUST be able to
8270 translate (perhaps by table lookup) all generated 'text' or 'name'
8271 attribute values into one of the supported languages (see section
8272 3.1.4). That is, the IPP object that supports a natural language
8273 NEED NOT be a general purpose translator of any arbitrary 'text' or
8274 'name' value supplied by the client into that natural language.
8275 However, the object MUST be able to translate (automatically
8276 generate) any of its own attribute values and messages into that
8279 6. IANA Considerations
8281 This section describes the procedures for defining semantics for the
8282 following IETF standards track extensions and vendor extensions to
8283 the IPP/1.1 Model and Semantics document:
8285 1. keyword attribute values
8286 2. enum attribute values
8290 Hastings, et al. Standards Track [Page 148]
8292 RFC 2911 IPP/1.1: Model and Semantics September 2000
8296 4. attribute syntaxes
8300 8. out-of-band attribute values
8302 Extensions registered for use with IPP/1.1 are OPTIONAL for client
8303 and IPP object conformance to the IPP/1.1 "Model and Semantics"
8304 document (this document).
8306 These extension procedures are aligned with the guidelines as set
8307 forth by the IESG [IANA-CON]. Section 11 describes how to propose
8308 new registrations for consideration. IANA will reject registration
8309 proposals that leave out required information or do not follow the
8310 appropriate format described in Section 11. The IPP/1.1 Model and
8311 Semantics document may also be extended by an appropriate RFC that
8312 specifies any of the above extensions.
8314 6.1 Typed 'keyword' and 'enum' Extensions
8316 IPP allows for 'keyword' and 'enum' extensions (see sections 4.1.2.3
8317 and 4.1.4). This document uses prefixes to the 'keyword' and 'enum'
8318 basic attribute syntax type in order to communicate extra information
8319 to the reader through its name. This extra information is not
8320 represented in the protocol because it is unimportant to a client or
8321 Printer object. The list below describes the prefixes and their
8324 "type1": This IPP specification document must be revised (or
8325 another IETF standards track document which augments this
8326 document) to add a new keyword or a new enum. No vendor
8327 defined keywords or enums are allowed.
8329 "type2": Implementers can, at any time, add new keyword or enum
8330 values by proposing the complete specification to IANA:
8334 IANA will forward the registration proposal to the IPP
8335 Designated Expert who will review the proposal with a mailing
8336 list that the Designated Expert keeps for this purpose.
8337 Initially, that list will be the mailing list used by the IPP
8342 even after the IPP WG is disbanded as permitted by [IANA-CON].
8346 Hastings, et al. Standards Track [Page 149]
8348 RFC 2911 IPP/1.1: Model and Semantics September 2000
8351 The IPP Designated Expert is appointed by the IESG Area
8352 Director responsible for IPP, according to [IANA-CON].
8354 When a type2 keyword or enum is approved, the IPP Designated
8355 Expert becomes the point of contact for any future maintenance
8356 that might be required for that registration.
8358 "type3": Implementers can, at any time, add new keyword and enum
8359 values by submitting the complete specification to IANA as for
8360 type2 who will forward the proposal to the IPP Designated
8361 Expert. While no additional technical review is required, the
8362 IPP Designated Expert may, at his/her discretion, forward the
8363 proposal to the same mailing list as for type2 registrations
8364 for advice and comment.
8366 When a type3 keyword or enum is approved by the IPP Designated
8367 Expert, the original proposer becomes the point of contact for
8368 any future maintenance that might be required for that
8371 For type2 and type3 keywords, the proposer includes the name of the
8372 keyword in the registration proposal and the name is part of the
8375 After type2 and type3 enums specifications are approved, the IPP
8376 Designated Expert in consultation with IANA assigns the next
8377 available enum number for each enum value.
8379 IANA will publish approved type2 and type3 keyword and enum
8380 attributes value registration specifications in:
8382 ftp.isi.edu/iana/assignments/ipp/attribute-values/xxx/yyy.txt
8384 where xxx is the attribute name that specifies the initial values and
8385 yyy.txt is a descriptive file name that contains one or more enums or
8386 keywords approved at the same time. For example, if several
8387 additional enums for stapling are approved for use with the
8388 "finishings" attribute (and "finishings-default" and "finishings-
8389 supported" attributes), IANA will publish the additional values in
8392 ftp.isi.edu/iana/assignments/ipp/attribute-
8393 values/finishings/stapling.txt
8395 Note: Some attributes are defined to be: 'type3 keywords' | 'name'
8396 which allows for attribute values to be extended by a site
8397 administrator with administrator defined names. Such names are not
8398 registered with IANA.
8402 Hastings, et al. Standards Track [Page 150]
8404 RFC 2911 IPP/1.1: Model and Semantics September 2000
8407 By definition, each of the three types above assert some sort of
8408 registry or review process in order for extensions to be considered
8409 valid. Each higher numbered level (1, 2, 3) tends to be decreasingly
8410 less stringent than the previous level. Therefore, any typeN value
8411 MAY be registered using a process for some typeM where M is less than
8412 N, however such registration is NOT REQUIRED. For example, a type3
8413 value MAY be registered in a type 1 manner (by being included in a
8414 future version of an IPP specification), however, it is NOT REQUIRED.
8416 This document defines keyword and enum values for all of the above
8417 types, including type3 keywords.
8419 For vendor keyword extensions, implementers SHOULD use keywords with
8420 a suitable distinguishing prefix, such as "xxx-" where xxx follows
8421 the syntax rules for keywords (see section 4.1.3) and is the
8422 (lowercase) fully qualified company name registered with IANA for use
8423 in domain names [RFC1035]. For example, if the company XYZ Corp. had
8424 obtained the domain name "XYZ.com", then a vendor keyword 'abc' would
8427 Note: RFC 1035 [RFC1035] indicates that while upper and lower case
8428 letters are allowed in domain names, no significance is attached to
8429 the case. That is, two names with the same spelling but different
8430 case are to be treated as if identical. Also, the labels in a domain
8431 name must follow the rules for ARPANET host names: They must start
8432 with a letter, end with a letter or digit, and have as interior
8433 characters only letters, digits, and hyphen. Labels must be 63
8434 characters or less. Labels are separated by the "." character.
8436 For vendor enum extensions, implementers MUST use values in the
8437 reserved integer range which is 2**30 to 2**31-1.
8439 6.2 Attribute Extensibility
8441 Attribute names (see section 4.1.3) are type2 keywords. Therefore,
8442 new attributes may be registered and have the same status as
8443 attributes in this document by following the type2 extension rules.
8444 For vendor attribute extensions, implementers SHOULD use keywords
8445 with a suitable distinguishing prefix as described in Section 6.1.
8447 IANA will publish approved attribute registration specifications as
8450 ftp.isi.edu/iana/assignments/ipp/attributes/xxx-yyy.txt
8452 where "xxx-yyy" is the new attribute name.
8458 Hastings, et al. Standards Track [Page 151]
8460 RFC 2911 IPP/1.1: Model and Semantics September 2000
8463 If a new Printer object attribute is defined and its values can be
8464 affected by a specific document format, its specification needs to
8465 contain the following sentence:
8467 "The value of this attribute returned in a Get-Printer-
8468 Attributes response MAY depend on the "document-format"
8469 attribute supplied (see Section 3.2.5.1)."
8471 If the specification does not, then its value in the Get-Printer-
8472 Attributes response MUST NOT depend on the "document-format" supplied
8473 in the request. When a new Job Template attribute is registered, the
8474 value of the Printer attributes MAY vary with "document-format"
8475 supplied in the request without the specification having to indicate
8478 6.3 Attribute Syntax Extensibility
8480 Attribute syntaxes (see section 4.1) are like type2 enums.
8481 Therefore, new attribute syntaxes may be registered and have the same
8482 status as attribute syntaxes in this document by following the type2
8483 extension rules described in Section 6.1. The initial set of value
8484 codes that identify each of the attribute syntaxes have been assigned
8485 in the "Encoding and Transport" document [RFC2910], including a
8486 designated range for vendor extension.
8488 For attribute syntaxes, the IPP Designated Expert in consultation
8489 with IANA assigns the next attribute syntax code in the appropriate
8490 range as specified in [RFC2910]. IANA will publish approved
8491 attribute syntax registration specifications as separate files:
8493 ftp.isi.edu/iana/assignments/ipp/attribute-syntaxes/xxx-yyy.txt
8495 where 'xxx-yyy' is the new attribute syntax name.
8497 6.4 Operation Extensibility
8499 Operations (see section 3) may also be registered following the type2
8500 procedures described in Section 6.1, though major new operations will
8501 usually be done by a new standards track RFC that augments this
8502 document. For vendor operation extensions, implementers MUST use the
8503 range for the "operation-id" in requests specified in Section 4.4.15
8504 "operations-supported" Printer attribute.
8506 For operations, the IPP Designated Expert in consultation with IANA
8507 assigns the next operation-id code as specified in Section 4.4.15.
8508 IANA will publish approved operation registration specifications as
8514 Hastings, et al. Standards Track [Page 152]
8516 RFC 2911 IPP/1.1: Model and Semantics September 2000
8519 ftp.isi.edu/iana/assignments/ipp/operations/Xxx-Yyy.txt
8521 where "Xxx-Yyy" is the new operation name.
8523 6.5 Attribute Group Extensibility
8525 Attribute groups (see section 3.1.3) passed in requests and responses
8526 may be registered following the type2 procedures described in Section
8527 6.1. The initial set of attribute group tags have been assigned in
8528 the "Encoding and Transport" document [RFC2910], including a
8529 designated range for vendor extension.
8531 For attribute groups, the IPP Designated Expert in consultation with
8532 IANA assigns the next attribute group tag code in the appropriate
8533 range as specified in [RFC2910]. IANA will publish approved
8534 attribute group registration specifications as separate files:
8536 ftp.isi.edu/iana/assignments/ipp/attribute-group-tags/xxx-yyy-
8539 where 'xxx-yyy-tag' is the new attribute group tag name.
8541 6.6 Status Code Extensibility
8543 Operation status codes (see section 3.1.6.1) may also be registered
8544 following the type2 procedures described in Section 6.1. The values
8545 for status codes are allocated in ranges as specified in Section 14
8546 for each status code class:
8548 "informational" - Request received, continuing process
8549 "successful" - The action was successfully received, understood, and
8551 "redirection" - Further action must be taken in order to complete the
8553 "client-error" - The request contains bad syntax or cannot be
8555 "server-error" - The IPP object failed to fulfill an apparently
8558 For vendor operation status code extensions, implementers MUST use
8559 the top of each range as specified in Section 13.
8561 For operation status codes, the IPP Designated Expert in consultation
8562 with IANA assigns the next status code in the appropriate class range
8563 as specified in Section 13. IANA will publish approved status code
8564 registration specifications as separate files:
8566 ftp.isi.edu/iana/assignments/ipp/status-codes/xxx-yyy.txt
8570 Hastings, et al. Standards Track [Page 153]
8572 RFC 2911 IPP/1.1: Model and Semantics September 2000
8575 where "xxx-yyy" is the new operation status code keyword.
8577 6.7 Out-of-band Attribute Value Extensibility
8579 Out-of-band attribute values (see the beginning of section 4.1)
8580 passed in requests and responses may be registered following the
8581 type2 procedures described in Section 6.1. The initial set of out-
8582 of-band attribute value tags have been assigned in the "Encoding and
8583 Transport" document [RFC2910].
8585 For out-of-band attribute value tags, the IPP Designated Expert in
8586 consultation with IANA assigns the next out-of-band attribute value
8587 tag code in the appropriate range as specified in [RFC2910]. IANA
8588 will publish approved out-of-band attribute value tags registration
8589 specifications as separate files:
8591 ftp.isi.edu/iana/assignments/ipp/out-of-band-attribute-value-
8592 tags/xxx-yyy-tag.txt
8594 where 'xxx-yyy-tag' is the new out-of-band attribute value tag name.
8596 6.8 Registration of MIME types/sub-types for document-formats
8598 The "document-format" attribute's syntax is 'mimeMediaType'. This
8599 means that valid values are Internet Media Types (see Section 4.1.9).
8600 RFC 2045 [RFC2045] defines the syntax for valid Internet media types.
8601 IANA is the registry for all Internet media types.
8603 6.9 Registration of charsets for use in 'charset' attribute values
8605 The "attributes-charset" attribute's syntax is 'charset'. This means
8606 that valid values are charsets names. When a charset in the IANA
8607 registry has more than one name (alias), the name labeled as
8608 "(preferred MIME name)", if present, MUST be used (see Section
8609 4.1.7). IANA is the registry for charsets following the procedures
8612 7. Internationalization Considerations
8614 Some of the attributes have values that are text strings and names
8615 which are intended for human understanding rather than machine
8616 understanding (see the 'text' and 'name' attribute syntaxes in
8617 Sections 4.1.1 and 4.1.2).
8619 In each operation request, the client
8621 - identifies the charset and natural language of the request which
8622 affects each supplied 'text' and 'name' attribute value, and
8626 Hastings, et al. Standards Track [Page 154]
8628 RFC 2911 IPP/1.1: Model and Semantics September 2000
8631 - requests the charset and natural language for attributes
8632 returned by the IPP object in operation responses (as described
8633 in Section 3.1.4.1).
8635 In addition, the client MAY separately and individually identify the
8636 Natural Language Override of a supplied 'text' or 'name' attribute
8637 using the 'textWithLanguage' and 'nameWithLanguage' technique
8638 described section 4.1.1.2 and 4.1.2.2 respectively.
8640 All IPP objects MUST support the UTF-8 [RFC2279] charset in all
8641 'text' and 'name' attributes supported. If an IPP object supports
8642 more than the UTF-8 charset, the object MUST convert between them in
8643 order to return the requested charset to the client according to
8644 Section 3.1.4.2. If an IPP object supports more than one natural
8645 language, the object SHOULD return 'text' and 'name' values in the
8646 natural language requested where those values are generated by the
8647 Printer (see Section 3.1.4.1).
8649 For Printers that support multiple charsets and/or multiple natural
8650 languages in 'text' and 'name' attributes, different jobs may have
8651 been submitted in differing charsets and/or natural languages. All
8652 responses MUST be returned in the charset requested by the client.
8653 However, the Get-Jobs operation uses the 'textWithLanguage' and
8654 'nameWithLanguage' mechanism to identify the differing natural
8655 languages with each job attribute returned.
8657 The Printer object also has configured charset and natural language
8658 attributes. The client can query the Printer object to determine
8659 the list of charsets and natural languages supported by the Printer
8660 object and what the Printer object's configured values are. See the
8661 "charset-configured", "charset-supported", "natural-language-
8662 configured", and "generated-natural-language-supported" Printer
8663 description attributes for more details.
8665 The "charset-supported" attributed identifies the supported charsets.
8666 If a charset is supported, the IPP object MUST be capable of
8667 converting to and from that charset into any other supported charset.
8668 In many cases, an IPP object will support only one charset and it
8669 MUST be the UTF-8 charset.
8671 The "charset-configured" attribute identifies the one supported
8672 charset which is the native charset given the current configuration
8673 of the IPP object (administrator defined).
8675 The "generated-natural-language-supported" attribute identifies the
8676 set of supported natural languages for generated messages; it is not
8677 related to the set of natural languages that must be accepted for
8678 client supplied 'text' and 'name' attributes. For client supplied
8682 Hastings, et al. Standards Track [Page 155]
8684 RFC 2911 IPP/1.1: Model and Semantics September 2000
8687 'text' and 'name' attributes, an IPP object MUST accept ALL supplied
8688 natural languages. Just because a Printer object is currently
8689 configured to support 'en-us' natural language does not mean that the
8690 Printer object should reject a job if the client supplies a job name
8693 The "natural-language-configured" attribute identifies the one
8694 supported natural language for generated messages which is the native
8695 natural language given the current configuration of the IPP object
8696 (administrator defined).
8698 Attributes of type 'text' and 'name' are populated from different
8699 sources. These attributes can be categorized into following groups
8700 (depending on the source of the attribute):
8702 1. Some attributes are supplied by the client (e.g., the client
8703 supplied "job-name", "document-name", and "requesting-user-
8704 name" operation attributes along with the corresponding Job
8705 object's "job-name" and "job-originating-user-name"
8706 attributes). The IPP object MUST accept these attributes in
8707 any natural language no matter what the set of supported
8708 languages for generated messages
8709 2. Some attributes are supplied by the system administrator (e.g.,
8710 the Printer object's "printer-name" and "printer-location"
8711 attributes). These too can be in any natural language. If the
8712 natural language for these attributes is different than what a
8713 client requests, then they must be reported using the Natural
8714 Language Override mechanism.
8715 3. Some attributes are supplied by the device manufacturer (e.g.,
8716 the Printer object's "printer-make-and-model" attribute).
8717 These too can be in any natural language. If the natural
8718 language for these attributes is different than what a client
8719 requests, then they must be reported using the Natural Language
8721 4. Some attributes are supplied by the operator (e.g., the Job
8722 object's "job-message-from-operator" attribute). These too can
8723 be in any natural language. If the natural language for these
8724 attributes is different than what a client requests, then they
8725 must be reported using the Natural Language Override mechanism.
8726 5. Some attributes are generated by the IPP object (e.g., the Job
8727 object's "job-state-message" attribute, the Printer object's
8728 "printer-state-message" attribute, and the "status-message"
8729 operation attribute). These attributes can only be in one of
8730 the "generated-natural-language-supported" natural languages.
8731 If a client requests some natural language for these attributes
8732 other than one of the supported values, the IPP object SHOULD
8738 Hastings, et al. Standards Track [Page 156]
8740 RFC 2911 IPP/1.1: Model and Semantics September 2000
8743 respond using the value of the "natural-language-configured"
8744 attribute (using the Natural Language Override mechanism if
8747 The 'text' and 'name' attributes specified in this version of this
8748 document (additional ones will be registered according to the
8749 procedures in Section 6) are:
8753 Operation Attributes:
8754 job-name (name) client
8755 document-name (name) client
8756 requesting-user-name (name) client
8757 status-message (text) Job or Printer object
8758 detailed-status-message (text) Job or Printer object -
8760 document-access-error (text) Job or Printer object -
8763 Job Template Attributes:
8764 job-hold-until (keyword | name) client matches
8765 administrator-configured
8766 job-hold-until-default (keyword | name) client matches
8767 administrator-configured
8768 job-hold-until-supported (keyword | client matches
8769 name) administrator-configured
8770 job-sheets (keyword | name) client matches
8771 administrator-configured
8772 job-sheets-default (keyword | name) client matches
8773 administrator-configured
8774 job-sheets-supported (keyword | name) client matches
8775 administrator-configured
8776 media (keyword | name) client matches
8777 administrator-configured
8778 media-default (keyword | name) client matches
8779 administrator-configured
8780 media-supported (keyword | name) client matches
8781 administrator-configured
8782 media-ready (keyword | name) client matches
8783 administrator-configured
8785 Job Description Attributes:
8786 job-name (name) client or Printer object
8787 job-originating-user-name (name) Printer object
8788 job-state-message (text) Job or Printer object
8789 output-device-assigned (name(127)) administrator
8790 job-message-from-operator (text(127)) operator
8794 Hastings, et al. Standards Track [Page 157]
8796 RFC 2911 IPP/1.1: Model and Semantics September 2000
8799 job-detailed-status-messages (1setOf Job or Printer object -
8801 job-document-access-errors (1setOf Job or Printer object -
8804 Printer Description Attributes:
8805 printer-name (name(127)) administrator
8806 printer-location (text(127)) administrator
8807 printer-info (text(127)) administrator
8808 printer-make-and-model (text(127)) administrator or
8810 printer-state-message (text) Printer object
8811 printer-message-from-operator operator
8814 Rule 1 - Neither the Printer nor the client localizes these message
8815 attributes, since they are intended for use by the system
8816 administrator or other experienced technical persons.
8818 8. Security Considerations
8820 It is difficult to anticipate the security risks that might exist in
8821 any given IPP environment. For example, if IPP is used within a given
8822 corporation over a private network, the risks of exposing document
8823 data may be low enough that the corporation will choose not to use
8824 encryption on that data. However, if the connection between the
8825 client and the IPP object is over a public network, the client may
8826 wish to protect the content of the information during transmission
8827 through the network with encryption.
8829 Furthermore, the value of the information being printed may vary from
8830 one IPP environment to the next. Printing payroll checks, for
8831 example, would have a different value than printing public
8832 information from a file. There is also the possibly of denial-of-
8833 service attacks, but denial-of-service attacks against printing
8834 resources are not well understood and there is no published
8835 precedents regarding this scenario.
8837 Once the authenticated identity of the requester has been supplied to
8838 the IPP object, the object uses that identity to enforce any
8839 authorization policy that might be in place. For example, one site's
8840 policy might be that only the job owner is allowed to cancel a job.
8841 The details and mechanisms to set up a particular access control
8842 policy are not part of IPP/1.1, and must be established via some
8843 other type of administrative or access control framework. However,
8844 there are operation status codes that allow an IPP server to return
8845 information back to a client about any potential access control
8846 violations for an IPP object.
8850 Hastings, et al. Standards Track [Page 158]
8852 RFC 2911 IPP/1.1: Model and Semantics September 2000
8855 During a create operation, the client's identity is recorded in the
8856 Job object in an implementation-defined attribute. This information
8857 can be used to verify a client's identity for subsequent operations
8858 on that Job object in order to enforce any access control policy that
8859 might be in effect. See section 8.3 below for more details.
8861 Since the security levels or the specific threats that an IPP system
8862 administrator may be concerned with cannot be anticipated, IPP MUST
8863 be capable of operating with different security mechanisms and
8864 security policies as required by the individual installation.
8865 Security policies might vary from very strong, to very weak, to none
8866 at all, and corresponding security mechanisms will be required.
8868 8.1 Security Scenarios
8870 The following sections describe specific security attacks for IPP
8871 environments. Where examples are provided they should be considered
8872 illustrative of the environment and not an exhaustive set. Not all of
8873 these environments will necessarily be addressed in initial
8874 implementations of IPP.
8876 8.1.1 Client and Server in the Same Security Domain
8878 This environment is typical of internal networks where traditional
8879 office workers print the output of personal productivity applications
8880 on shared work-group printers, or where batch applications print
8881 their output on large production printers. Although the identity of
8882 the user may be trusted in this environment, a user might want to
8883 protect the content of a document against such attacks as
8884 eavesdropping, replaying or tampering.
8886 8.1.2 Client and Server in Different Security Domains
8888 Examples of this environment include printing a document created by
8889 the client on a publicly available printer, such as at a commercial
8890 print shop; or printing a document remotely on a business associate's
8891 printer. This latter operation is functionally equivalent to sending
8892 the document to the business associate as a facsimile. Printing
8893 sensitive information on a Printer in a different security domain
8894 requires strong security measures. In this environment authentication
8895 of the printer is required as well as protection against unauthorized
8896 use of print resources. Since the document crosses security domains,
8897 protection against eavesdropping and document tampering are also
8898 required. It will also be important in this environment to protect
8899 Printers against "spamming" and malicious document content.
8906 Hastings, et al. Standards Track [Page 159]
8908 RFC 2911 IPP/1.1: Model and Semantics September 2000
8911 8.1.3 Print by Reference
8913 When the document is not stored on the client, printing can be done
8914 by reference. That is, the print request can contain a reference, or
8915 pointer, to the document instead of the actual document itself (see
8916 sections 3.2.2 and 3.3.2). Standard methods currently do not exist
8917 for remote entities to "assume" the credentials of a client for
8918 forwarding requests to a 3rd party. It is anticipated that Print-By-
8919 Reference will be used to access "public" documents and that
8920 sophisticated methods for authenticating "proxies" is not specified
8923 8.2 URIs in Operation, Job, and Printer attributes
8925 The "printer-uri-supported" attribute contains the Printer object's
8926 URI(s). Its companion attribute, "uri-security-supported",
8927 identifies the security mechanism used for each URI listed in the
8928 "printer-uri-supported" attribute. For each Printer operation
8929 request, a client MUST supply only one URI in the "printer-uri"
8930 operation attribute. In other words, even though the Printer
8931 supports more than one URI, the client only interacts with the
8932 Printer object using one if its URIs. This duality is not needed for
8933 Job objects, since the Printer objects is the factory for Job
8934 objects, and the Printer object will generate the correct URI for new
8935 Job objects depending on the Printer object's security configuration.
8937 8.3 URIs for each authentication mechanisms
8939 Each URI has an authentication mechanism associated with it. If the
8940 URI is the i'th element of "printer-uri-supported", then
8941 authentication mechanism is the "i th" element of "uri-
8942 authentication-supported". For a list of possible authentication
8943 mechanisms, see section 4.4.2.
8945 The Printer object uses an authentication mechanism to determine the
8946 name of the user performing an operation. This user is called the
8947 "authenticated user". The credibility of authentication depends on
8948 the mechanism that the Printer uses to obtain the user's name. When
8949 the authentication mechanism is 'none', all authenticated users are
8952 During job creation operations, the Printer initializes the value of
8953 the "job-originating-user-name" attribute (see section 4.3.6) to be
8954 the authenticated user. The authenticated user is this case is called
8962 Hastings, et al. Standards Track [Page 160]
8964 RFC 2911 IPP/1.1: Model and Semantics September 2000
8967 If an implementation can be configured to support more than one
8968 authentication mechanism (see section 4.4.2), then it MUST implement
8969 rules for determining equality of authenticated user names which have
8970 been authenticated via different authentication mechanisms. One
8971 possible policy is that identical names that are authenticated via
8972 different mechanisms are different. For example, a user can cancel
8973 his job only if he uses the same authentication mechanism for both
8974 Cancel-Job and Print-Job. Another policy is that identical names
8975 that are authenticated via different mechanism are the same if the
8976 authentication mechanism for the later operation is not less strong
8977 than the authentication mechanism for the earlier job creation
8978 operation. For example, a user can cancel his job only if he uses
8979 the same or stronger authentication mechanism for Cancel-Job and
8980 Print-Job. With this second policy a job submitted via 'requesting-
8981 user-name' authentication could be canceled via 'digest'
8982 authentication. With the first policy, the job could not be canceled
8985 A client is able to determine the authentication mechanism used to
8986 create a job. It is the i'th value of the Printer's "uri-
8987 authentication-supported" attribute (see section 4.4.2), where i is
8988 the index of the element of the Printer's "printer-uri-supported"
8989 attribute (see section 4.4.1) equal to the job's "job-printer-uri"
8990 attribute (see section 4.3.3).
8992 8.4 Restricted Queries
8994 In many IPP operations, a client supplies a list of attributes to be
8995 returned in the response. For security reasons, an IPP object may be
8996 configured not to return all attributes (or all values) that a client
8997 requests. The job attributes returned MAY depend on whether the
8998 requesting user is the same as the user that submitted the job. The
8999 IPP object MAY even return none of the requested attributes. In such
9000 cases, the status returned is the same as if the object had returned
9001 all requested attributes. The client cannot tell by such a response
9002 whether the requested attribute was present or absent on the object.
9004 8.5 Operations performed by operators and system administrators
9006 For the three printer operations Pause-Printer, Resume-Printer, and
9007 Purge-Jobs (see sections 3.2.7, 3.2.8 and 3.2.9), the requesting user
9008 is intended to be an operator or administrator of the Printer object
9009 (see section 1). Otherwise, the IPP Printer MUST reject the
9010 operation and return: 'client-error-forbidden', 'client-error-not-
9011 authenticated', or 'client-error-not-authorized' as appropriate. For
9012 operations on jobs, the requesting user is intended to be the job
9018 Hastings, et al. Standards Track [Page 161]
9020 RFC 2911 IPP/1.1: Model and Semantics September 2000
9023 owner or may be an operator or administrator of the Printer object.
9024 The means for authorizing an operator or administrator of the Printer
9025 object are not specified in this document.
9027 8.6 Queries on jobs submitted using non-IPP protocols
9029 If the device that an IPP Printer is representing is able to accept
9030 jobs using other job submission protocols in addition to IPP, it is
9031 RECOMMENDED that such an implementation at least allow such "foreign"
9032 jobs to be queried using Get-Jobs returning "job-id" and "job-uri" as
9033 'unknown'. Such an implementation NEED NOT support all of the same
9034 IPP job attributes as for IPP jobs. The IPP object returns the
9035 'unknown' out-of-band value for any requested attribute of a foreign
9036 job that is supported for IPP jobs, but not for foreign jobs.
9038 It is further RECOMMENDED, that the IPP Printer generate "job-id" and
9039 "job-uri" values for such "foreign jobs", if possible, so that they
9040 may be targets of other IPP operations, such as Get-Job-Attributes
9041 and Cancel-Job. Such an implementation also needs to deal with the
9042 problem of authentication of such foreign jobs. One approach would
9043 be to treat all such foreign jobs as belonging to users other than
9044 the user of the IPP client. Another approach would be for the
9045 foreign job to belong to 'anonymous'. Only if the IPP client has
9046 been authenticated as an operator or administrator of the IPP Printer
9047 object, could the foreign jobs be queried by an IPP request.
9048 Alternatively, if the security policy is to allow users to query
9049 other users' jobs, then the foreign jobs would also be visible to an
9050 end-user IPP client using Get-Jobs and Get-Job-Attributes.
9054 [ASME-Y14.1M] Metric Drawing Sheet Size and Format, ASME Y14.1M-1995.
9055 This standard defines metric sheet sizes and formats
9056 for engineering drawings.
9058 [ASCII] Coded Character Set - 7-bit American Standard Code for
9059 Information Interchange (ASCII), ANSI X3.4-1986. This
9060 standard is the specification of the US-ASCII charset.
9062 [BCP-11] Bradner S. and R. Hovey, "The Organizations Involved in
9063 the IETF Standards Process", BCP 11, RFC 2028, October
9066 [HTPP] J. Barnett, K. Carter, R. DeBry, "Initial Draft -
9067 Hypertext Printing Protocol - HTPP/1.0", October 1996,
9068 ftp://ftp.pwg.org/pub/pwg/ipp/historic/htpp/overview.ps.gz
9074 Hastings, et al. Standards Track [Page 162]
9076 RFC 2911 IPP/1.1: Model and Semantics September 2000
9079 [IANA-CON] Narten, T. and H. Alvestrand, "Guidelines for Writing
9080 an IANA Considerations Section in RFCs", BCP 26, RFC
9083 [IANA-CS] IANA Registry of Coded Character Sets:
9084 ftp://ftp.isi.edu/in-notes/iana/assignments/character-
9087 [IANA-MT] IANA Registry of Media Types: ftp://ftp.isi.edu/in-
9088 notes/iana/assignments/media-types/
9090 [IPP-IIG] Hastings, T., Manros, C., Kugler, C., Holst, H., and P.
9091 Zehler, "Internet Printing Protocol/1.1: draft-ietf-
9092 ipp-implementers-guide-v11-01.txt, work in progress,
9095 [ISO10646-1] ISO/IEC 10646-1:1993, "Information technology --
9096 Universal Multiple-Octet Coded Character Set (UCS) -
9097 Part 1: Architecture and Basic Multilingual Plane,
9100 [ISO8859-1] ISO/IEC 8859-1:1987, "Information technology -- 8-bit
9101 One-Byte Coded Character Set - Part 1: Latin Alphabet
9102 Nr 1", 1987, JTC1/SC2.
9104 [ISO10175] ISO/IEC 10175 Document Printing Application (DPA), June
9107 [LDPA] T. Hastings, S. Isaacson, M. MacKay, C. Manros, D.
9108 Taylor, P. Zehler, "LDPA - Lightweight Document
9109 Printing Application", October 1996,
9110 ftp://ftp.pwg.org/pub/pwg/ipp/historic/ldpa/ldpa8.pdf.gz
9112 [P1387.4] Kirk, M. (editor), POSIX System Administration - Part
9113 4: Printing Interfaces, POSIX 1387.4 D8, 1994.
9115 [PSIS] Herriot, R. (editor), X/Open A Printing System
9116 Interoperability Specification (PSIS), August 1995.
9118 [PWG] Printer Working Group, http://www.pwg.org.
9120 [RFC1035] Mockapetris, P., "Domain Names - Implementation and
9121 Specification", STD 13, RFC 1035, November 1987.
9123 [RFC1179] McLaughlin, L., "Line Printer Daemon Protocol", RFC
9130 Hastings, et al. Standards Track [Page 163]
9132 RFC 2911 IPP/1.1: Model and Semantics September 2000
9135 [RFC1759] Smith, R., Wright, F., Hastings, T., Zilles, S. and J.
9136 Gyllenskog, "Printer MIB", RFC 1759, March 1995.
9138 [RFC1766] Alvestrand, H., "Tags for the Identification of
9139 Languages", RFC 1766, March 1995.
9141 [RFC1951] Deutsch, P., "DEFLATE Compressed Data Format
9142 Specification version 1.3 ", RFC 1951, May 1996.
9144 [RFC1952] Deutsch, P., "GZIP file format specification version
9145 4.3", RFC 1952, May 1996.
9147 [RFC1977] Schryver, V., "PPP BSD Compression Protocol", RFC 1977,
9150 [RFC2026] Bradner, S., "The Internet Standards Process --
9151 Revision 3", BCP 9, RFC 2026, October 1996.
9153 [RFC2045] Freed, N. and N. Borenstein, ", Multipurpose Internet
9154 Mail Extensions (MIME) Part One: Format of Internet
9155 Message Bodies", RFC 2045, November 1996.
9157 [RFC2046] Freed, N. and N. Borenstein, "Multipurpose Internet
9158 Mail Extensions (MIME) Part Two: Media Types", RFC
9159 2046, November 1996.
9161 [RFC2048] Freed, N., Klensin, J. and J. Postel, "Multipurpose
9162 Internet Mail Extension (MIME) Part Four: Registration
9163 Procedures", RFC 2048, November 1996.
9165 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
9166 Requirement Levels", BCP 14, RFC 2119, March 1997.
9168 [RFC2228] Horowitz, M. and S. Lunt, "FTP Security Extensions",
9169 RFC 2228, October 1997.
9171 [RFC2246] Dierks, T. and C. Allen, "The TLS Protocol Version
9172 1.0", RFC 2246, January 1999.
9174 [RFC2277] Alvestrand, H., "IETF Policy on Character Sets and
9175 Languages" BCP 18, RFC 2277, January 1998.
9177 [RFC2278] Freed, N. and J. Postel: "IANA CharSet Registration
9178 Procedures", BCP 19, RFC 2278, January 1998.
9180 [RFC2279] Yergeau, F., "UTF-8, a transformation format of ISO
9181 10646", RFC 2279, January 1998.
9186 Hastings, et al. Standards Track [Page 164]
9188 RFC 2911 IPP/1.1: Model and Semantics September 2000
9191 [RFC2316] Bellovin, S., "Report of the IAB Security Architecture
9192 Workshop", RFC 2316, April 1998.
9194 [RFC2396] Berners-Lee, T., Fielding, R. and L. Masinter, "Uniform
9195 Resource Identifiers (URI): Generic Syntax", RFC 2396,
9198 [RFC2565] Herriot, R., Butler, S., Moore, P. and R. Turner,
9199 "Internet Printing Protocol/1.0: Encoding and
9200 Transport", RFC 2565, April 1999.
9202 [RFC2566] deBry, R., Hastings, T., Herriot, R., Isaacson, S. and
9203 P. Powell, "Internet Printing Protocol/1.0: Model and
9204 Semantics", RFC 2566, April 1999.
9206 [RFC2567] Wright, D., "Design Goals for an Internet Printing
9207 Protocol", RFC 2567, April 1999.
9209 [RFC2568] Zilles, S., "Rationale for the Structure and Model and
9210 Protocol for the Internet Printing Protocol", RFC 2568,
9213 [RFC2569] Herriot, R., Hastings, T., Jacobs, N. and J. Martin,
9214 "Mapping between LPD and IPP Protocols", RFC 2569,
9217 [RFC2579] McCloghrie, K., Perkins, D. and J. Schoenwaelder,
9218 "Textual Conventions for SMIv2", STD 58, RFC 2579,
9221 [RFC2616] Fielding, R., Gettys, J., Mogul, J., Frystyk, H.,
9222 Masinter, L., Leach, P. and T. Berners-Lee, "Hypertext
9223 Transfer Protocol - HTTP/1.1", RFC 2616, June 1999.
9225 [RFC2617] Franks, J., Hallam-Baker, P., Hostetler, J., Lawrence,
9226 S., Leach, P., Luotonen, A. and L. Stewart, "HTTP
9227 Authentication: Basic and Digest Access
9228 Authentication", RFC 2617, June 1999.
9230 [RFC2639] Hastings, T. and C. Manros, "Internet Printing
9231 Protocol/1.0: Encoding and Transport", RFC 2639, July
9234 [RFC2910] Herriot, R., Butler, S., Moore, P., Turner, R. and J.
9235 Wenn, "Internet Printing Protocol/1.1: Encoding and
9236 Transport", RFC 2910, September 2000.
9242 Hastings, et al. Standards Track [Page 165]
9244 RFC 2911 IPP/1.1: Model and Semantics September 2000
9247 [SSL] Netscape, The SSL Protocol, Version 3, (Text version
9248 3.02), November 1996.
9250 [SWP] P. Moore, B. Jahromi, S. Butler, "Simple Web Printing
9251 SWP/1.0", May 7, 1997,
9252 ftp://ftp.pwg.org/pub/pwg/ipp/new_PRO/swp9705.pdf
9254 10. Authors' Addresses
9256 Scott A. Isaacson, Editor
9263 EMail: sisaacson@novell.com
9268 737 Hawaii St. ESAE 231
9269 El Segundo, CA 90245
9273 EMail: hastings@cp10.es.xerox.com
9278 3400 Hill View Ave, Building 1
9283 EMail: robert.herriot@pahv.xerox.com
9287 Utah Valley State College
9290 Phone: (801) 222-8000
9291 EMail: debryro@uvsc.edu
9298 Hastings, et al. Standards Track [Page 166]
9300 RFC 2911 IPP/1.1: Model and Semantics September 2000
9305 9475 Chesapeake Dr., Suite D
9308 Phone: (619) 874-6543
9310 EMail: papowell@astart.com
9312 IPP Web Page: http://www.pwg.org/ipp/
9313 IPP Mailing List: ipp@pwg.org
9315 To subscribe to the ipp mailing list, send the following email:
9316 1) send it to majordomo@pwg.org
9317 2) leave the subject line blank
9318 3) put the following two lines in the message body:
9322 Implementers of this specification document are encouraged to join
9323 IPP Mailing List in order to participate in any discussions of
9324 clarification issues and review of registration proposals for
9325 additional attributes and values.
9329 Chuck Adams - Tektronix Shivaun Albright - HP
9330 Stefan Andersson - Axis Jeff Barnett - IBM
9331 Ron Bergman - Hitachi Koki Imaging Dennis Carney - IBM
9333 Keith Carter - IBM Angelo Caruso - Xerox
9334 Rajesh Chawla - TR Computing Nancy Chen - Okidata
9336 Josh Cohen - Microsoft Jeff Copeland - QMS
9337 Andy Davidson - Tektronix Roger deBry - IBM
9338 Maulik Desai - Auco Mabry Dozier - QMS
9339 Lee Farrell - Canon Information Satoshi Fujitami - Ricoh
9341 Steve Gebert - IBM Sue Gleeson - Digital
9342 Charles Gordon - Osicom Brian Grimshaw - Apple
9343 Jerry Hadsell - IBM Richard Hart - Digital
9344 Tom Hastings - Xerox Henrik Holst - I-data
9345 Stephen Holmstead Zhi-Hong Huang - Zenographics
9346 Scott Isaacson - Novell Babek Jahromi - Microsoft
9347 Swen Johnson - Xerox David Kellerman - Northlake
9349 Robert Kline - TrueSpectra Charles Kong - Panasonic
9350 Carl Kugler - IBM Dave Kuntz - Hewlett-Packard
9354 Hastings, et al. Standards Track [Page 167]
9356 RFC 2911 IPP/1.1: Model and Semantics September 2000
9359 Takami Kurono - Brother Rick Landau - Digital
9360 Scott Lawrence - Agranot Systems Greg LeClair - Epson
9361 Dwight Lewis - Lexmark Harry Lewis - IBM
9362 Tony Liao - Vivid Image Roy Lomicka - Digital
9363 Pete Loya - HP Ray Lutz - Cognisys
9364 Mike MacKay - Novell, Inc. David Manchala - Xerox
9365 Carl-Uno Manros - Xerox Jay Martin - Underscore
9366 Stan McConnell - Xerox Larry Masinter - Xerox
9367 Sandra Matts - Hewlett Packard Peter Michalek - Shinesoft
9368 Ira McDonald - High North Inc. Mike Moldovan - G3 Nova
9369 Tetsuya Morita - Ricoh Yuichi Niwa - Ricoh
9370 Pat Nogay - IBM Ron Norton - Printronics
9371 Hugo Parra, Novell Bob Pentecost - Hewlett-Packard
9372 Patrick Powell - Astart Jeff Rackowitz - Intermec
9374 Eric Random - Peerless Rob Rhoads - Intel
9375 Xavier Riley - Xerox Gary Roberts - Ricoh
9376 David Roach - Unisys Stuart Rowley - Kyocera
9377 Yuji Sasaki - Japan Computer Richard Schneider - Epson
9379 Kris Schoff - HP Katsuaki Sekiguchi - Canon
9380 Bob Setterbo - Adobe Gail Songer - Peerless
9381 Hideki Tanaka - Cannon Devon Taylor - Novell
9382 Mike Timperman - Lexmark Atsushi Uchino - Epson
9383 Shigeru Ueda - Canon Bob Von Andel - Allegro Software
9384 William Wagner - NetSilicon/DPI Jim Walker - DAZEL
9385 Chris Wellens - Interworking Labs Trevor Wells - Hewlett Packard
9386 Craig Whittle - Sharp Labs Rob Whittle - Novell, Inc.
9387 Jasper Wong - Xionics Don Wright - Lexmark
9388 Michael Wu - Heidelberg Digital Rick Yardumian - Xerox
9389 Michael Yeung - Toshiba Lloyd Young - Lexmark
9390 Atsushi Yuki - Kyocera Peter Zehler - Xerox
9391 William Zhang- Canon Information Frank Zhao - Panasonic
9393 Steve Zilles - Adobe Rob Zirnstein - Canon Information
9396 11. Formats for IPP Registration Proposals
9398 In order to propose an IPP extension for registration, the proposer
9399 must submit an application to IANA by email to "iana@iana.org" or by
9400 filling out the appropriate form on the IANA web pages
9401 (http://www.iana.org). This section specifies the required
9402 information and the formats for proposing registrations of extensions
9403 to IPP as provided in Section 6 for:
9410 Hastings, et al. Standards Track [Page 168]
9412 RFC 2911 IPP/1.1: Model and Semantics September 2000
9415 1. type2 'keyword' attribute values
9416 2. type3 'keyword' attribute values
9417 3. type2 'enum' attribute values
9418 4. type3 'enum' attribute values
9420 6. attribute syntaxes
9423 9. out-of-band attribute values
9425 11.1 Type2 keyword attribute values registration,
9427 Type of registration: type2 keyword attribute value
9428 Name of attribute to which this keyword specification is to be added:
9429 Proposed keyword name of this keyword value:
9430 Specification of this keyword value (follow the style of IPP Model
9433 Address of proposer:
9434 Email address of proposer:
9436 Note: For type2 keywords, the Designated Expert will be the point of
9437 contact for the approved registration specification, if any
9438 maintenance of the registration specification is needed.
9440 11.2 Type3 keyword attribute values registration
9442 Type of registration: type3 keyword attribute value
9443 Name of attribute to which this keyword specification is to be added:
9444 Proposed keyword name of this keyword value:
9445 Specification of this keyword value (follow the style of IPP Model
9448 Address of proposer:
9449 Email address of proposer:
9451 Note: For type3 keywords, the proposer will be the point of contact
9452 for the approved registration specification, if any maintenance of
9453 the registration specification is needed.
9455 11.3 Type2 enum attribute values registration
9457 Type of registration: type2 enum attribute value
9458 Name of attribute to which this enum specification is to be added:
9459 Keyword symbolic name of this enum value:
9460 Numeric value (to be assigned by the IPP Designated Expert in
9461 consultation with IANA):
9466 Hastings, et al. Standards Track [Page 169]
9468 RFC 2911 IPP/1.1: Model and Semantics September 2000
9471 Specification of this enum value (follow the style of IPP Model
9474 Address of proposer:
9475 Email address of proposer:
9477 Note: For type2 enums, the Designated Expert will be the point of
9478 contact for the approved registration specification, if any
9479 maintenance of the registration specification is needed.
9481 11.4 Type3 enum attribute values registration
9483 Type of registration: type3 enum attribute value
9484 Name of attribute to which this enum specification is to be added:
9485 Keyword symbolic name of this enum value:
9486 Numeric value (to be assigned by the IPP Designated Expert in
9487 consultation with IANA):
9488 Specification of this enum value (follow the style of IPP Model
9491 Address of proposer:
9492 Email address of proposer:
9494 Note: For type3 enums, the proposer will be the point of contact for
9495 the approved registration specification, if any maintenance of the
9496 registration specification is needed.
9498 11.5 Attribute registration
9500 Type of registration: attribute
9501 Proposed keyword name of this attribute:
9502 Types of attribute (Operation, Job Template, Job Description, Printer
9504 Operations to be used with if the attribute is an operation attribute:
9505 Object (Job, Printer, etc. if bound to an object):
9506 Attribute syntax(es) (include 1setOf and range as in Section 4.2):
9507 If attribute syntax is 'keyword' or 'enum', is it type2 or type3:
9508 If this is a Printer attribute, MAY the value returned depend on
9509 "document-format" (See Section 6.2):
9510 If this is a Job Template attribute, how does its specification depend
9511 on the value of the "multiple-document-handling" attribute:
9512 Specification of this attribute (follow the style of IPP Model Section
9515 Address of proposer:
9516 Email address of proposer:
9522 Hastings, et al. Standards Track [Page 170]
9524 RFC 2911 IPP/1.1: Model and Semantics September 2000
9527 Note: For attributes, the IPP Designated Expert will be the point of
9528 contact for the approved registration specification, if any
9529 maintenance of the registration specification is needed.
9531 11.6 Attribute Syntax registration
9533 Type of registration: attribute syntax
9534 Proposed name of this attribute syntax:
9535 Type of attribute syntax (integer, octetString, character-string, see
9537 Numeric tag according to [RFC2910] (to be assigned by the IPP
9538 Designated Expert in consultation with IANA):
9539 Specification of this attribute (follow the style of IPP Model Section
9542 Address of proposer:
9543 Email address of proposer:
9545 Note: For attribute syntaxes, the IPP Designated Expert will be the
9546 point of contact for the approved registration specification, if any
9547 maintenance of the registration specification is needed.
9549 11.7 Operation registration
9551 Type of registration: operation
9552 Proposed name of this operation:
9553 Numeric operation-id value according to section 4.4.15 (to be assigned
9554 by the IPP Designated Expert in consultation with IANA):
9555 Object Target (Job, Printer, etc. that operation is upon):
9556 Specification of this operation (follow the style of IPP Model Section
9559 Address of proposer:
9560 Email address of proposer:
9562 Note: For operations, the IPP Designated Expert will be the point of
9563 contact for the approved registration specification, if any
9564 maintenance of the registration specification is needed.
9566 11.8 Attribute Group registration
9568 Type of registration: attribute group
9569 Proposed name of this attribute group:
9570 Numeric tag according to [RFC2910] (to be assigned by the IPP
9571 Designated Expert in consultation with IANA):
9572 Operation requests and group number for each operation in which the
9573 attribute group occurs:
9578 Hastings, et al. Standards Track [Page 171]
9580 RFC 2911 IPP/1.1: Model and Semantics September 2000
9583 Operation responses and group number for each operation in which the
9584 attribute group occurs:
9585 Specification of this attribute group (follow the style of IPP Model
9588 Address of proposer:
9589 Email address of proposer:
9591 Note: For attribute groups, the IPP Designated Expert will be the
9592 point of contact for the approved registration specification, if any
9593 maintenance of the registration specification is needed.
9595 11.9 Status code registration
9597 Type of registration: status code
9598 Keyword symbolic name of this status code value:
9599 Numeric value (to be assigned by the IPP Designated Expert in
9600 consultation with IANA):
9601 Operations that this status code may be used with:
9602 Specification of this status code (follow the style of IPP Model
9603 Section 13 APPENDIX B: Status Codes and Suggested Status Code
9606 Address of proposer:
9607 Email address of proposer:
9609 Note: For status codes, the Designated Expert will be the point of
9610 contact for the approved registration specification, if any
9611 maintenance of the registration specification is needed.
9613 11.10 Out-of-band Attribute Value registration
9615 Type of registration: out-of-band attribute value
9616 Proposed name of this out-of-band attribute value:
9617 Numeric tag according to [RFC2910] (to be assigned by the IPP Designated
9618 Expert in consultation with IANA):
9619 Operations that this out-of-band attribute value may be used with:
9620 Attributes that this out-of-band attribute value may be used with:
9621 Specification of this out-of-band attribute value (follow the style of
9622 the beginning of IPP Model Section 4.1):
9624 Address of proposer:
9625 Email address of proposer:
9627 Note: For out-of-band attribute values, the IPP Designated Expert
9628 will be the point of contact for the approved registration
9629 specification, if any maintenance of the registration specification
9634 Hastings, et al. Standards Track [Page 172]
9636 RFC 2911 IPP/1.1: Model and Semantics September 2000
9639 12. APPENDIX A: Terminology
9641 This specification document uses the terminology defined in this
9644 12.1 Conformance Terminology
9646 The key words "MUST", "MUST NOT", "REQUIRED", "SHOULD", "SHOULD NOT",
9647 "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be
9648 interpreted as described in RFC 2119 [RFC2119].
9652 This term is not included in RFC 2119. The verb "NEED NOT" indicates
9653 an action that the subject of the sentence does not have to implement
9654 in order to claim conformance to the standard. The verb "NEED NOT"
9655 is used instead of "MAY NOT" since "MAY NOT" sounds like a
9658 12.2 Model Terminology
9662 Keywords are used within this document as identifiers of semantic
9663 entities within the abstract model (see section 4.1.2.3). Attribute
9664 names, some attribute values, attribute syntaxes, and attribute group
9665 names are represented as keywords.
9669 An attribute is an item of information that is associated with an
9670 instance of an IPP object. An attribute consists of an attribute
9671 name and one or more attribute values. Each attribute has a specific
9672 attribute syntax. All object attributes are defined in section 4 and
9673 all operation attributes are defined in section 3.
9675 Job Template Attributes are described in section 4.2. The client
9676 optionally supplies Job Template attributes in a create request
9677 (operation requests that create Job objects). The Printer object has
9678 associated attributes which define supported and default values for
9681 12.2.2.1 Attribute Name
9683 Each attribute is uniquely identified in this document by its
9684 attribute name. An attribute name is a keyword. The keyword
9685 attribute name is given in the section header describing that
9690 Hastings, et al. Standards Track [Page 173]
9692 RFC 2911 IPP/1.1: Model and Semantics September 2000
9695 attribute. In running text in this document, attribute names are
9696 indicated inside double quotation marks (") where the quotation marks
9697 are not part of the keyword itself.
9699 12.2.2.2 Attribute Group Name
9701 Related attributes are grouped into named groups. The name of the
9702 group is a keyword. The group name may be used in place of naming
9703 all the attributes in the group explicitly. Attribute groups are
9704 defined in section 3.
9706 12.2.2.3 Attribute Value
9708 Each attribute has one or more values. Attribute values are
9709 represented in the syntax type specified for that attribute. In
9710 running text in this document, attribute values are indicated inside
9711 single quotation marks ('), whether their attribute syntax is
9712 keyword, integer, text, etc. where the quotation marks are not part
9713 of the value itself.
9715 12.2.2.4 Attribute Syntax
9717 Each attribute is defined using an explicit syntax type. In this
9718 document, each syntax type is defined as a keyword with specific
9719 meaning. The "Encoding and Transport" document [RFC2910] indicates
9720 the actual "on-the-wire" encoding rules for each syntax type.
9721 Attribute syntax types are defined in section 4.1.
9725 By definition, a Printer object supports an attribute only if that
9726 Printer object responds with the corresponding attribute populated
9727 with some value(s) in a response to a query for that attribute. A
9728 Printer object supports an attribute value if the value is one of the
9729 Printer object's "supported values" attributes. The device behind a
9730 Printer object may exhibit a behavior that corresponds to some IPP
9731 attribute, but if the Printer object, when queried for that
9732 attribute, doesn't respond with the attribute, then as far as IPP is
9733 concerned, that implementation does not support that feature. If the
9734 Printer object's "xxx-supported" attribute is not populated with a
9735 particular value (even if that value is a legal value for that
9736 attribute), then that Printer object does not support that particular
9746 Hastings, et al. Standards Track [Page 174]
9748 RFC 2911 IPP/1.1: Model and Semantics September 2000
9751 A conforming implementation MUST support all REQUIRED attributes.
9752 However, even for REQUIRED attributes, conformance to IPP does not
9753 mandate that all implementations support all possible values
9754 representing all possible job processing behaviors and features. For
9755 example, if a given instance of a Printer supports only certain
9756 document formats, then that Printer responds with the "document-
9757 format-supported" attribute populated with a set of values, possibly
9758 only one, taken from the entire set of possible values defined for
9759 that attribute. This limited set of values represents the Printer's
9760 set of supported document formats. Supporting an attribute and some
9761 set of values for that attribute enables IPP end users to be aware of
9762 and make use of those features associated with that attribute and
9763 those values. If an implementation chooses to not support an
9764 attribute or some specific value, then IPP end users would have no
9765 ability to make use of that feature within the context of IPP itself.
9766 However, due to existing practice and legacy systems which are not
9767 IPP aware, there might be some other mechanism outside the scope of
9768 IPP to control or request the "unsupported" feature (such as embedded
9769 instructions within the document data itself).
9771 For example, consider the "finishings-supported" attribute.
9773 1) If a Printer object is not physically capable of stapling, the
9774 "finishings-supported" attribute MUST NOT be populated with the
9776 2) A Printer object is physically capable of stapling, however an
9777 implementation chooses not to support stapling in the IPP
9778 "finishings" attribute. In this case, 'staple' MUST NOT be a
9779 value in the "finishings-supported" Printer object attribute.
9780 Without support for the value 'staple', an IPP end user would
9781 have no means within the protocol itself to request that a Job
9782 be stapled. However, an existing document data formatter might
9783 be able to request that the document be stapled directly with
9784 an embedded instruction within the document data. In this
9785 case, the IPP implementation does not "support" stapling,
9786 however the end user is still able to have some control over
9787 the stapling of the completed job.
9788 3) A Printer object is physically capable of stapling, and an
9789 implementation chooses to support stapling in the IPP
9790 "finishings" attribute. In this case, 'staple' MUST be a value
9791 in the "finishings-supported" Printer object attribute. Doing
9792 so, would enable end users to be aware of and make use of the
9793 stapling feature using IPP attributes.
9802 Hastings, et al. Standards Track [Page 175]
9804 RFC 2911 IPP/1.1: Model and Semantics September 2000
9807 Even though support for Job Template attributes by a Printer object
9808 is OPTIONAL, it is RECOMMENDED that if the device behind a Printer
9809 object is capable of realizing any feature or function that
9810 corresponds to an IPP attribute and some associated value, then that
9811 implementation SHOULD support that IPP attribute and value.
9813 The set of values in any of the supported value attributes is set
9814 (populated) by some administrative process or automatic sensing
9815 mechanism that is outside the scope of this IPP/1.1 document. For
9816 administrative policy and control reasons, an administrator may
9817 choose to make only a subset of possible values visible to the end
9818 user. In this case, the real output device behind the IPP Printer
9819 abstraction may be capable of a certain feature, however an
9820 administrator is specifying that access to that feature not be
9821 exposed to the end user through the IPP protocol. Also, since a
9822 Printer object may represent a logical print device (not just a
9823 physical device) the actual process for supporting a value is
9824 undefined and left up to the implementation. However, if a Printer
9825 object supports a value, some manual human action may be needed to
9826 realize the semantic action associated with the value, but no end
9827 user action is required.
9829 For example, if one of the values in the "finishings-supported"
9830 attribute is 'staple', the actual process might be an automatic
9831 staple action by a physical device controlled by some command sent to
9832 the device. Or, the actual process of stapling might be a manual
9833 action by an operator at an operator attended Printer object.
9835 For another example of how supported attributes function, consider a
9836 system administrator who desires to control all print jobs so that no
9837 job sheets are printed in order to conserve paper. To force no job
9838 sheets, the system administrator sets the only supported value for
9839 the "job-sheets-supported" attribute to 'none'. In this case, if a
9840 client requests anything except 'none', the create request is
9841 rejected or the "job-sheets" value is ignored (depending on the value
9842 of "ipp-attribute-fidelity"). To force the use of job start/end
9843 sheets on all jobs, the administrator does not include the value
9844 'none' in the "job-sheets- supported" attribute. In this case, if a
9845 client requests 'none', the create request is rejected or the "job-
9846 sheets" value is ignored (again depending on the value of "ipp-
9847 attribute-fidelity").
9849 12.2.4 print-stream page
9851 A "print-stream page" is a page according to the definition of pages
9852 in the language used to express the document data.
9858 Hastings, et al. Standards Track [Page 176]
9860 RFC 2911 IPP/1.1: Model and Semantics September 2000
9865 An "impression" is the image (possibly many print-stream pages in
9866 different configurations) imposed onto a single media page.
9868 13. APPENDIX B: Status Codes and Suggested Status Code Messages
9870 This section defines status code enum keywords and values that are
9871 used to provide semantic information on the results of an operation
9872 request. Each operation response MUST include a status code. The
9873 response MAY also contain a status message that provides a short
9874 textual description of the status. The status code is intended for
9875 use by automata, and the status message is intended for the human end
9876 user. Since the status message is an OPTIONAL component of the
9877 operation response, an IPP application (i.e., a browser, GUI, print
9878 driver or gateway) is NOT REQUIRED to examine or display the status
9879 message, since it MAY not be returned to the application.
9881 The prefix of the status keyword defines the class of response as
9884 "informational" - Request received, continuing process
9885 "successful" - The action was successfully received, understood,
9887 "redirection" - Further action must be taken in order to complete
9889 "client-error" - The request contains bad syntax or cannot be
9891 "server-error" - The IPP object failed to fulfill an apparently
9894 As with type2 enums, IPP status codes are extensible. IPP clients
9895 are NOT REQUIRED to understand the meaning of all registered status
9896 codes, though such understanding is obviously desirable. However,
9897 IPP clients MUST understand the class of any status code, as
9898 indicated by the prefix, and treat any unrecognized response as being
9899 equivalent to the first status code of that class, with the exception
9900 that an unrecognized response MUST NOT be cached. For example, if an
9901 unrecognized status code of "client-error-xxx-yyy" is received by the
9902 client, it can safely assume that there was something wrong with its
9903 request and treat the response as if it had received a "client-
9904 error-bad-request" status code. In such cases, IPP applications
9905 SHOULD present the OPTIONAL message (if present) to the end user
9906 since the message is likely to contain human readable information
9907 which will help to explain the unusual status. The name of the enum
9908 is the suggested status message for US English.
9914 Hastings, et al. Standards Track [Page 177]
9916 RFC 2911 IPP/1.1: Model and Semantics September 2000
9919 The status code values range from 0x0000 to 0x7FFF. The value ranges
9920 for each status code class are as follows:
9922 "successful" - 0x0000 to 0x00FF
9923 "informational" - 0x0100 to 0x01FF
9924 "redirection" - 0x0200 to 0x02FF
9925 "client-error" - 0x0400 to 0x04FF
9926 "server-error" - 0x0500 to 0x05FF
9928 The top half (128 values) of each range (0x0n40 to 0x0nFF, for n = 0
9929 to 5) is reserved for vendor use within each status code class.
9930 Values 0x0600 to 0x7FFF are reserved for future assignment by IETF
9931 standards track documents and MUST NOT be used.
9935 Each status code is described below. Section 13.1.5.9 contains a
9936 table that indicates which status codes apply to which operations.
9937 The Implementer's Guide [IPP-IIG] describe the suggested steps for
9938 processing IPP attributes for all operations, including returning
9941 13.1.1 Informational
9943 This class of status code indicates a provisional response and is to
9944 be used for informational purposes only.
9946 There are no status codes defined in IPP/1.1 for this class of status
9949 13.1.2 Successful Status Codes
9951 This class of status code indicates that the client's request was
9952 successfully received, understood, and accepted.
9954 13.1.2.1 successful-ok (0x0000)
9956 The request has succeeded and no request attributes were substituted
9957 or ignored. In the case of a response to a create request, the
9958 'successful-ok' status code indicates that the request was
9959 successfully received and validated, and that the Job object has been
9960 created; it does not indicate that the job has been processed. The
9961 transition of the Job object into the 'completed' state is the only
9962 indicator that the job has been printed.
9970 Hastings, et al. Standards Track [Page 178]
9972 RFC 2911 IPP/1.1: Model and Semantics September 2000
9975 13.1.2.2 successful-ok-ignored-or-substituted-attributes (0x0001)
9977 The request has succeeded, but some supplied (1) attributes were
9978 ignored or (2) unsupported values were substituted with supported
9979 values or were ignored in order to perform the operation without
9980 rejecting it. Unsupported attributes, attribute syntaxes, or values
9981 MUST be returned in the Unsupported Attributes group of the response
9982 for all operations. There is an exception to this rule for the query
9983 operations: Get-Printer-Attributes, Get-Jobs, and Get-Job-Attributes
9984 for the "requested-attributes" operation attribute only. When the
9985 supplied values of the "requested-attributes" operation attribute are
9986 requesting attributes that are not supported, the IPP object MAY, but
9987 is NOT REQUIRED to, return the "requested-attributes" attribute in
9988 the Unsupported Attribute response group (with the unsupported values
9989 only). See sections 3.1.7 and 3.2.1.2.
9991 13.1.2.3 successful-ok-conflicting-attributes (0x0002)
9993 The request has succeeded, but some supplied attribute values
9994 conflicted with the values of other supplied attributes. These
9995 conflicting values were either (1) substituted with (supported)
9996 values or (2) the attributes were removed in order to process the job
9997 without rejecting it. Attributes or values which conflict with other
9998 attributes and have been substituted or ignored MUST be returned in
9999 the Unsupported Attributes group of the response for all operations
10000 as supplied by the client. See sections 3.1.7 and 3.2.1.2.
10002 13.1.3 Redirection Status Codes
10004 This class of status code indicates that further action needs to be
10005 taken to fulfill the request.
10007 There are no status codes defined in IPP/1.1 for this class of status
10010 13.1.4 Client Error Status Codes
10012 This class of status code is intended for cases in which the client
10013 seems to have erred. The IPP object SHOULD return a message
10014 containing an explanation of the error situation and whether it is a
10015 temporary or permanent condition.
10026 Hastings, et al. Standards Track [Page 179]
10028 RFC 2911 IPP/1.1: Model and Semantics September 2000
10031 13.1.4.1 client-error-bad-request (0x0400)
10033 The request could not be understood by the IPP object due to
10034 malformed syntax (such as the value of a fixed length attribute whose
10035 length does not match the prescribed length for that attribute - see
10036 the Implementer's Guide [IPP-IIG] ). The IPP application SHOULD NOT
10037 repeat the request without modifications.
10039 13.1.4.2 client-error-forbidden (0x0401)
10041 The IPP object understood the request, but is refusing to fulfill it.
10042 Additional authentication information or authorization credentials
10043 will not help and the request SHOULD NOT be repeated. This status
10044 code is commonly used when the IPP object does not wish to reveal
10045 exactly why the request has been refused or when no other response is
10048 13.1.4.3 client-error-not-authenticated (0x0402)
10050 The request requires user authentication. The IPP client may repeat
10051 the request with suitable authentication information. If the request
10052 already included authentication information, then this status code
10053 indicates that authorization has been refused for those credentials.
10054 If this response contains the same challenge as the prior response,
10055 and the user agent has already attempted authentication at least
10056 once, then the response message may contain relevant diagnostic
10057 information. This status codes reveals more information than
10058 "client-error-forbidden".
10060 13.1.4.4 client-error-not-authorized (0x0403)
10062 The requester is not authorized to perform the request. Additional
10063 authentication information or authorization credentials will not help
10064 and the request SHOULD NOT be repeated. This status code is used
10065 when the IPP object wishes to reveal that the authentication
10066 information is understandable, however, the requester is explicitly
10067 not authorized to perform the request. This status codes reveals
10068 more information than "client-error-forbidden" and "client-error-
10069 not-authenticated".
10071 13.1.4.5 client-error-not-possible (0x0404)
10073 This status code is used when the request is for something that can
10074 not happen. For example, there might be a request to cancel a job
10075 that has already been canceled or aborted by the system. The IPP
10076 client SHOULD NOT repeat the request.
10082 Hastings, et al. Standards Track [Page 180]
10084 RFC 2911 IPP/1.1: Model and Semantics September 2000
10087 13.1.4.6 client-error-timeout (0x0405)
10089 The client did not produce a request within the time that the IPP
10090 object was prepared to wait. For example, a client issued a Create-
10091 Job operation and then, after a long period of time, issued a Send-
10092 Document operation and this error status code was returned in
10093 response to the Send-Document request (see section 3.3.1). The IPP
10094 object might have been forced to clean up resources that had been
10095 held for the waiting additional Documents. The IPP object was forced
10096 to close the Job since the client took too long. The client SHOULD
10097 NOT repeat the request without modifications.
10099 13.1.4.7 client-error-not-found (0x0406)
10101 The IPP object has not found anything matching the request URI. No
10102 indication is given of whether the condition is temporary or
10103 permanent. For example, a client with an old reference to a Job (a
10104 URI) tries to cancel the Job, however in the mean time the Job might
10105 have been completed and all record of it at the Printer has been
10106 deleted. This status code, 'client-error-not-found' is returned
10107 indicating that the referenced Job can not be found. This error
10108 status code is also used when a client supplies a URI as a reference
10109 to the document data in either a Print-URI or Send-URI operation, but
10110 the document can not be found.
10112 In practice, an IPP application should avoid a not found situation by
10113 first querying and presenting a list of valid Printer URIs and Job
10114 URIs to the end-user.
10116 13.1.4.8 client-error-gone (0x0407)
10118 The requested object is no longer available and no forwarding address
10119 is known. This condition should be considered permanent. Clients
10120 with link editing capabilities should delete references to the
10121 request URI after user approval. If the IPP object does not know or
10122 has no facility to determine, whether or not the condition is
10123 permanent, the status code "client-error-not-found" should be used
10126 This response is primarily intended to assist the task of maintenance
10127 by notifying the recipient that the resource is intentionally
10128 unavailable and that the IPP object administrator desires that remote
10129 links to that resource be removed. It is not necessary to mark all
10130 permanently unavailable resources as "gone" or to keep the mark for
10131 any length of time -- that is left to the discretion of the IPP
10132 object administrator and/or Printer implementation.
10138 Hastings, et al. Standards Track [Page 181]
10140 RFC 2911 IPP/1.1: Model and Semantics September 2000
10143 13.1.4.9 client-error-request-entity-too-large (0x0408)
10145 The IPP object is refusing to process a request because the request
10146 entity is larger than the IPP object is willing or able to process.
10147 An IPP Printer returns this status code when it limits the size of
10148 print jobs and it receives a print job that exceeds that limit or
10149 when the attributes are so many that their encoding causes the
10150 request entity to exceed IPP object capacity.
10152 13.1.4.10 client-error-request-value-too-long (0x0409)
10154 The IPP object is refusing to service the request because one or more
10155 of the client-supplied attributes has a variable length value that is
10156 longer than the maximum length specified for that attribute. The IPP
10157 object might not have sufficient resources (memory, buffers, etc.) to
10158 process (even temporarily), interpret, and/or ignore a value larger
10159 than the maximum length. Another use of this error code is when the
10160 IPP object supports the processing of a large value that is less than
10161 the maximum length, but during the processing of the request as a
10162 whole, the object may pass the value onto some other system component
10163 which is not able to accept the large value. For more details, see
10164 the Implementer's Guide [IPP-IIG] .
10166 Note: For attribute values that are URIs, this rare condition is
10167 only likely to occur when a client has improperly submitted a request
10168 with long query information (e.g. an IPP application allows an end-
10169 user to enter an invalid URI), when the client has descended into a
10170 URI "black hole" of redirection (e.g., a redirected URI prefix that
10171 points to a suffix of itself), or when the IPP object is under attack
10172 by a client attempting to exploit security holes present in some IPP
10173 objects using fixed-length buffers for reading or manipulating the
10176 13.1.4.11 client-error-document-format-not-supported (0x040A)
10178 The IPP object is refusing to service the request because the
10179 document data is in a format, as specified in the "document-format"
10180 operation attribute, that is not supported by the Printer object.
10181 This error is returned independent of the client-supplied "ipp-
10182 attribute-fidelity". The Printer object MUST return this status
10183 code, even if there are other Job Template attributes that are not
10184 supported as well, since this error is a bigger problem than with Job
10185 Template attributes. See sections 3.1.6.1, 3.1.7, and 3.2.1.1.
10194 Hastings, et al. Standards Track [Page 182]
10196 RFC 2911 IPP/1.1: Model and Semantics September 2000
10199 13.1.4.12 client-error-attributes-or-values-not-supported (0x040B)
10201 In a create request, if the Printer object does not support one or
10202 more attributes, attribute syntaxes, or attribute values supplied in
10203 the request and the client supplied the "ipp-attribute-fidelity"
10204 operation attribute with the 'true' value, the Printer object MUST
10205 return this status code. The Printer object MUST also return in the
10206 Unsupported Attributes Group all the attributes and/or values
10207 supplied by the client that are not supported. See section 3.1.7.
10208 For example, if the request indicates 'iso-a4' media, but that media
10209 type is not supported by the Printer object. Or, if the client
10210 supplies a Job Template attribute and the attribute itself is not
10211 even supported by the Printer. If the "ipp-attribute-fidelity"
10212 attribute is 'false', the Printer MUST ignore or substitute values
10213 for unsupported Job Template attributes and values rather than reject
10214 the request and return this status code.
10216 For any operation where a client requests attributes (such as a Get-
10217 Jobs, Get-Printer-Attributes, or Get-Job-Attributes operation), if
10218 the IPP object does not support one or more of the requested
10219 attributes, the IPP object simply ignores the unsupported requested
10220 attributes and processes the request as if they had not been
10221 supplied, rather than returning this status code. In this case, the
10222 IPP object MUST return the 'successful-ok-ignored-or-substituted-
10223 attributes' status code and MAY return the unsupported attributes as
10224 values of the "requested-attributes" in the Unsupported Attributes
10225 Group (see section 13.1.2.2).
10227 13.1.4.13 client-error-uri-scheme-not-supported (0x040C)
10229 The scheme of the client-supplied URI in a Print-URI or a Send-URI
10230 operation is not supported. See sections 3.1.6.1 and 3.1.7.
10232 13.1.4.14 client-error-charset-not-supported (0x040D)
10234 For any operation, if the IPP Printer does not support the charset
10235 supplied by the client in the "attributes-charset" operation
10236 attribute, the Printer MUST reject the operation and return this
10237 status and any 'text' or 'name' attributes using the 'utf-8' charset
10238 (see Section 3.1.4.1). See sections 3.1.6.1 and 3.1.7.
10240 13.1.4.15 client-error-conflicting-attributes (0x040E)
10242 The request is rejected because some attribute values conflicted with
10243 the values of other attributes which this document does not permit to
10244 be substituted or ignored. The Printer object MUST also return in
10245 the Unsupported Attributes Group the conflicting attributes supplied
10246 by the client. See sections 3.1.7 and 3.2.1.2.
10250 Hastings, et al. Standards Track [Page 183]
10252 RFC 2911 IPP/1.1: Model and Semantics September 2000
10255 13.1.4.16 client-error-compression-not-supported (0x040F)
10257 The IPP object is refusing to service the request because the
10258 document data, as specified in the "compression" operation attribute,
10259 is compressed in a way that is not supported by the Printer object.
10260 This error is returned independent of the client-supplied "ipp-
10261 attribute-fidelity". The Printer object MUST return this status
10262 code, even if there are other Job Template attributes that are not
10263 supported as well, since this error is a bigger problem than with Job
10264 Template attributes. See sections 3.1.6.1, 3.1.7, and 3.2.1.1.
10266 13.1.4.17 client-error-compression-error (0x0410)
10268 The IPP object is refusing to service the request because the
10269 document data cannot be decompressed when using the algorithm
10270 specified by the "compression" operation attribute. This error is
10271 returned independent of the client-supplied "ipp-attribute-fidelity".
10272 The Printer object MUST return this status code, even if there are
10273 Job Template attributes that are not supported as well, since this
10274 error is a bigger problem than with Job Template attributes. See
10275 sections 3.1.7 and 3.2.1.1.
10277 13.1.4.18 client-error-document-format-error (0x0411)
10279 The IPP object is refusing to service the request because Printer
10280 encountered an error in the document data while interpreting it.
10281 This error is returned independent of the client-supplied "ipp-
10282 attribute-fidelity". The Printer object MUST return this status
10283 code, even if there are Job Template attributes that are not
10284 supported as well, since this error is a bigger problem than with Job
10285 Template attributes. See sections 3.1.7 and 3.2.1.1.
10287 13.1.4.19 client-error-document-access-error (0x0412)
10289 The IPP object is refusing to service the Print-URI or Send-URI
10290 request because Printer encountered an access error while attempting
10291 to validate the accessibility or access the document data specified
10292 in the "document-uri" operation attribute. The Printer MAY also
10293 return a specific document access error code using the "document-
10294 access-error" operation attribute (see section 3.1.6.4). This error
10295 is returned independent of the client-supplied "ipp-attribute-
10296 fidelity". The Printer object MUST return this status code, even if
10297 there are Job Template attributes that are not supported as well,
10298 since this error is a bigger problem than with Job Template
10299 attributes. See sections 3.1.6.1 and 3.1.7.
10306 Hastings, et al. Standards Track [Page 184]
10308 RFC 2911 IPP/1.1: Model and Semantics September 2000
10311 13.1.5 Server Error Status Codes
10313 This class of status codes indicates cases in which the IPP object is
10314 aware that it has erred or is incapable of performing the request.
10315 The IPP object SHOULD include a message containing an explanation of
10316 the error situation, and whether it is a temporary or permanent
10319 13.1.5.1 server-error-internal-error (0x0500)
10321 The IPP object encountered an unexpected condition that prevented it
10322 from fulfilling the request. This error status code differs from
10323 "server-error-temporary-error" in that it implies a more permanent
10324 type of internal error. It also differs from "server-error-device-
10325 error" in that it implies an unexpected condition (unlike a paper-jam
10326 or out-of-toner problem which is undesirable but expected). This
10327 error status code indicates that probably some knowledgeable human
10328 intervention is required.
10330 13.1.5.2 server-error-operation-not-supported (0x0501)
10332 The IPP object does not support the functionality required to fulfill
10333 the request. This is the appropriate response when the IPP object
10334 does not recognize an operation or is not capable of supporting it.
10335 See sections 3.1.6.1 and 3.1.7.
10337 13.1.5.3 server-error-service-unavailable (0x0502)
10339 The IPP object is currently unable to handle the request due to a
10340 temporary overloading or maintenance of the IPP object. The
10341 implication is that this is a temporary condition which will be
10342 alleviated after some delay. If known, the length of the delay may be
10343 indicated in the message. If no delay is given, the IPP application
10344 should handle the response as it would for a "server-error-
10345 temporary-error" response. If the condition is more permanent, the
10346 error status codes "client-error-gone" or "client-error-not-found"
10349 13.1.5.4 server-error-version-not-supported (0x0503)
10351 The IPP object does not support, or refuses to support, the IPP
10352 protocol version that was supplied as the value of the "version-
10353 number" operation parameter in the request. The IPP object is
10354 indicating that it is unable or unwilling to complete the request
10355 using the same major and minor version number as supplied in the
10356 request other than with this error message. The error response SHOULD
10357 contain a "status-message" attribute (see section 3.1.6.2) describing
10362 Hastings, et al. Standards Track [Page 185]
10364 RFC 2911 IPP/1.1: Model and Semantics September 2000
10367 why that version is not supported and what other versions are
10368 supported by that IPP object. See sections 3.1.6.1, 3.1.7, and
10371 The error response MUST identify in the "version-number" operation
10372 parameter the closest version number that the IPP object does
10373 support. For example, if a client supplies version '1.0' and an
10374 IPP/1.1 object supports version '1.0', then it responds with version
10375 '1.0' in all responses to such a request. If the IPP/1.1 object does
10376 not support version '1.0', then it should accept the request and
10377 respond with version '1.1' or may reject the request and respond with
10378 this error code and version
10379 '1.1'. If a client supplies a version '1.2', the IPP/1.1 object
10380 should accept the request and return version '1.1' or may reject the
10381 request and respond with this error code and version '1.1'. See
10382 sections 3.1.8 and 4.4.14.
10384 13.1.5.5 server-error-device-error (0x0504)
10386 A printer error, such as a paper jam, occurs while the IPP object
10387 processes a Print or Send operation. The response contains the true
10388 Job Status (the values of the "job-state" and "job-state-reasons"
10389 attributes). Additional information can be returned in the OPTIONAL
10390 "job-state-message" attribute value or in the OPTIONAL status message
10391 that describes the error in more detail. This error status code is
10392 only returned in situations where the Printer is unable to accept the
10393 create request because of such a device error. For example, if the
10394 Printer is unable to spool, and can only accept one job at a time,
10395 the reason it might reject a create request is that the printer
10396 currently has a paper jam. In many cases however, where the Printer
10397 object can accept the request even though the Printer has some error
10398 condition, the 'successful-ok' status code will be returned. In such
10399 a case, the client would look at the returned Job Object Attributes
10400 or later query the Printer to determine its state and state reasons.
10402 13.1.5.6 server-error-temporary-error (0x0505)
10404 A temporary error such as a buffer full write error, a memory
10405 overflow (i.e. the document data exceeds the memory of the Printer),
10406 or a disk full condition, occurs while the IPP Printer processes an
10407 operation. The client MAY try the unmodified request again at some
10408 later point in time with an expectation that the temporary internal
10409 error condition may have been cleared. Alternatively, as an
10410 implementation option, a Printer object MAY delay the response until
10411 the temporary condition is cleared so that no error is returned.
10418 Hastings, et al. Standards Track [Page 186]
10420 RFC 2911 IPP/1.1: Model and Semantics September 2000
10423 13.1.5.7 server-error-not-accepting-jobs (0x0506)
10425 A temporary error indicating that the Printer is not currently
10426 accepting jobs, because the administrator has set the value of the
10427 Printer's "printer-is-accepting-jobs" attribute to 'false' (by means
10428 outside the scope of this IPP/1.1 document).
10430 13.1.5.8 server-error-busy (0x0507)
10432 A temporary error indicating that the Printer is too busy processing
10433 jobs and/or other requests. The client SHOULD try the unmodified
10434 request again at some later point in time with an expectation that
10435 the temporary busy condition will have been cleared.
10437 13.1.5.9 server-error-job-canceled (0x0508)
10439 An error indicating that the job has been canceled by an operator or
10440 the system while the client was transmitting the data to the IPP
10441 Printer. If a job-id and job-uri had been created, then they are
10442 returned in the Print-Job, Send-Document, or Send-URI response as
10443 usual; otherwise, no job-id and job-uri are returned in the response.
10445 13.1.5.10 server-error-multiple-document-jobs-not-supported (0x0509)
10447 The IPP object does not support multiple documents per job and a
10448 client attempted to supply document data with a second Send-Document
10449 or Send-URI operation.
10451 13.2 Status Codes for IPP Operations
10453 PJ = Print-Job, PU = Print-URI, CJ = Create-Job, SD = Send-Document
10454 SU = Send-URI, V = Validate-Job, GA = Get-Job-Attributes and
10455 Get-Printer-Attributes, GJ = Get-Jobs, C = Cancel-Job
10474 Hastings, et al. Standards Track [Page 187]
10476 RFC 2911 IPP/1.1: Model and Semantics September 2000
10480 IPP Status Keyword PJ PU CJ SD SU V GA GJ C
10481 ------------------ -- -- -- -- -- - -- -- -
10482 successful-ok x x x x x x x x x
10483 successful-ok-ignored-or-substituted- x x x x x x x x x
10485 successful-ok-conflicting-attributes x x x x x x x x x
10486 client-error-bad-request x x x x x x x x x
10487 client-error-forbidden x x x x x x x x x
10488 client-error-not-authenticated x x x x x x x x x
10489 client-error-not-authorized x x x x x x x x x
10490 client-error-not-possible x x x x x x x x x
10491 client-error-timeout x x
10492 client-error-not-found x x x x x x x x x
10493 client-error-gone x x x x x x x x x
10494 client-error-request-entity-too-large x x x x x x x x x
10495 client-error-request-value-too-long x x x x x x x x x
10496 client-error-document-format-not- x x x x x x
10498 client-error-attributes-or-values-not- x x x x x x x x x
10500 client-error-uri-scheme-not-supported x x
10501 client-error-charset-not-supported x x x x x x x x x
10502 client-error-conflicting-attributes x x x x x x x x x
10503 client-error-compression-not-supported x x x x x
10504 client-error-compression-error x x x x
10505 client-error-document-format-error x x x x
10506 client-error-document-access-error x x
10507 server-error-internal-error x x x x x x x x x
10508 server-error-operation-not-supported x x x x
10509 server-error-service-unavailable x x x x x x x x x
10510 server-error-version-not-supported x x x x x x x x x
10511 server-error-device-error x x x x x
10512 server-error-temporary-error x x x x x
10513 server-error-not-accepting-jobs x x x x
10514 server-error-busy x x x x x x x x x
10515 server-error-job-canceled x x x
10516 server-error-multiple-document-jobs- x x
10519 HJ = Hold-Job, RJ = Release-Job, RS = Restart-Job
10520 PP = Pause-Printer, RP = Resume-Printer, PJ = Purge-Jobs
10530 Hastings, et al. Standards Track [Page 188]
10532 RFC 2911 IPP/1.1: Model and Semantics September 2000
10535 IPP Operations (cont.)
10536 IPP Status Keyword HJ RJ RS PP RP PJ
10537 ------------------ -- -- -- -- -- --
10538 successful-ok x x x x x x
10539 successful-ok-ignored-or-substituted- x x x x x x
10541 successful-ok-conflicting-attributes x x x x x x
10542 client-error-bad-request x x x x x x
10543 client-error-forbidden x x x x x x
10544 client-error-not-authenticated x x x x x x
10545 client-error-not-authorized x x x x x x
10546 client-error-not-possible x x x x x x
10547 client-error-timeout
10548 client-error-not-found x x x x x x
10549 client-error-gone x x x x x x
10550 client-error-request-entity-too-large x x x x x x
10551 client-error-request-value-too-long x x x x x x
10552 client-error-document-format-not-
10554 client-error-attributes-or-values-not- x x x x x x
10556 client-error-uri-scheme-not-supported
10557 client-error-charset-not-supported x x x x x x
10558 client-error-conflicting-attributes x x x x x x
10559 client-error-compression-not-supported
10560 client-error-compression-error
10561 client-error-document-format-error
10562 client-error-document-access-error
10563 server-error-internal-error x x x x x x
10564 server-error-operation-not-supported x x x x x x
10565 server-error-service-unavailable x x x x x x
10566 server-error-version-not-supported x x x x x x
10567 server-error-device-error
10568 server-error-temporary-error x x x x x x
10569 server-error-not-accepting-jobs
10570 server-error-busy x x x x x x
10571 server-error-job-canceled
10572 server-error-multiple-document-jobs-
10586 Hastings, et al. Standards Track [Page 189]
10588 RFC 2911 IPP/1.1: Model and Semantics September 2000
10591 14. APPENDIX C: "media" keyword values
10593 Standard keyword values are taken from several sources.
10595 Standard values are defined (taken from DPA[ISO10175] and the Printer
10598 'default': The default medium for the output device
10599 'iso-a4-white': Specifies the ISO A4 white medium: 210 mm x 297 mm
10600 'iso-a4-colored': Specifies the ISO A4 colored medium: 210 mm x 297
10602 'iso-a4-transparent' Specifies the ISO A4 transparent medium: 210 mm
10604 'iso-a3-white': Specifies the ISO A3 white medium: 297 mm x 420 mm
10605 'iso-a3-colored': Specifies the ISO A3 colored medium: 297 mm x 420
10607 'iso-a5-white': Specifies the ISO A5 white medium: 148 mm x 210 mm
10608 'iso-a5-colored': Specifies the ISO A5 colored medium: 148 mm x 210
10610 'iso-b4-white': Specifies the ISO B4 white medium: 250 mm x 353 mm
10611 'iso-b4-colored': Specifies the ISO B4 colored medium: 250 mm x 353
10613 'iso-b5-white': Specifies the ISO B5 white medium: 176 mm x 250 mm
10614 'iso-b5-colored': Specifies the ISO B5 colored medium: 176 mm x 250
10616 'jis-b4-white': Specifies the JIS B4 white medium: 257 mm x 364 mm
10617 'jis-b4-colored': Specifies the JIS B4 colored medium: 257 mm x 364
10619 'jis-b5-white': Specifies the JIS B5 white medium: 182 mm x 257 mm
10620 'jis-b5-colored': Specifies the JIS B5 colored medium: 182 mm x 257
10623 The following standard values are defined for North American media:
10625 'na-letter-white': Specifies the North American letter white medium
10626 'na-letter-colored': Specifies the North American letter colored
10628 'na-letter-transparent': Specifies the North American letter
10630 'na-legal-white': Specifies the North American legal white medium
10631 'na-legal-colored': Specifies the North American legal colored
10642 Hastings, et al. Standards Track [Page 190]
10644 RFC 2911 IPP/1.1: Model and Semantics September 2000
10647 The following standard values are defined for envelopes:
10649 'iso-b4-envelope': Specifies the ISO B4 envelope medium
10650 'iso-b5-envelope': Specifies the ISO B5 envelope medium
10651 'iso-c3-envelope': Specifies the ISO C3 envelope medium
10652 'iso-c4-envelope': Specifies the ISO C4 envelope medium
10653 'iso-c5-envelope': Specifies the ISO C5 envelope medium
10654 'iso-c6-envelope': Specifies the ISO C6 envelope medium
10655 'iso-designated-long-envelope': Specifies the ISO Designated Long
10657 'na-10x13-envelope': Specifies the North American 10x13 envelope
10659 'na-9x12-envelope': Specifies the North American 9x12 envelope
10661 'monarch-envelope': Specifies the Monarch envelope
10662 'na-number-10-envelope': Specifies the North American number 10
10663 business envelope medium
10664 'na-7x9-envelope': Specifies the North American 7x9 inch envelope
10665 'na-9x11-envelope': Specifies the North American 9x11 inch
10667 'na-10x14-envelope': Specifies the North American 10x14 inch
10669 'na-number-9-envelope': Specifies the North American number 9
10671 'na-6x9-envelope': Specifies the North American 6x9 inch envelope
10672 'na-10x15-envelope': Specifies the North American 10x15 inch
10675 The following standard values are defined for the less commonly used
10678 'executive-white': Specifies the white executive medium
10679 'folio-white': Specifies the folio white medium
10680 'invoice-white': Specifies the white invoice medium
10681 'ledger-white': Specifies the white ledger medium
10682 'quarto-white': Specified the white quarto medium
10683 'iso-a0-white': Specifies the ISO A0 white medium: 841 mm x 1189 mm
10684 'iso-a0-transparent': Specifies the ISO A0 transparent medium: 841 mm
10686 'iso-a0-translucent': Specifies the ISO A0 translucent medium: 841 mm
10688 'iso-a1-white': Specifies the ISO A1 white medium: 594 mm x 841 mm
10689 'iso-a1-transparent': Specifies the ISO A1 transparent medium: 594 mm
10691 'iso-a1-translucent': Specifies the ISO A1 translucent medium: 594 mm
10693 'iso-a2-white': Specifies the ISO A2 white medium: 420 mm x 594 mm
10698 Hastings, et al. Standards Track [Page 191]
10700 RFC 2911 IPP/1.1: Model and Semantics September 2000
10703 'iso-a2-transparent': Specifies the ISO A2 transparent medium: 420 mm
10705 'iso-a2-translucent': Specifies the ISO A2 translucent medium: 420 mm
10707 'iso-a3-transparent': Specifies the ISO A3 transparent medium: 297 mm
10709 'iso-a3-translucent': Specifies the ISO A3 translucent medium: 297 mm
10711 'iso-a4-translucent': Specifies the ISO A4 translucent medium: 210 mm
10713 'iso-a5-transparent': Specifies the ISO A5 transparent medium: 148 mm
10715 'iso-a5-translucent': Specifies the ISO A5 translucent medium: 148 mm
10717 'iso-a6-white': Specifies the ISO A6 white medium: 105 mm x 148 mm
10718 'iso-a7-white': Specifies the ISO A7 white medium: 74 mm x 105 mm
10719 'iso-a8-white': Specifies the ISO A8 white medium: 52 mm x 74 mm
10720 'iso-a9-white': Specifies the ISO A9 white medium: 37 mm x 52 mm
10721 'iso-a10-white': Specifies the ISO A10 white medium: 26 mm x 37 mm
10722 'iso-b0-white': Specifies the ISO B0 white medium: 1000 mm x 1414 mm
10723 'iso-b1-white': Specifies the ISO B1 white medium: 707 mm x 1000 mm
10724 'iso-b2-white': Specifies the ISO B2 white medium: 500 mm x 707 mm
10725 'iso-b3-white': Specifies the ISO B3 white medium: 353 mm x 500 mm
10726 'iso-b6-white': Specifies the ISO B6 white medium: 125 mm x 176 mm
10727 'iso-b7-white': Specifies the ISO B7 white medium: 88 mm x 125 mm
10728 'iso-b8-white': Specifies the ISO B8 white medium: 62 mm x 88 mm
10729 'iso-b9-white': Specifies the ISO B9 white medium: 44 mm x 62 mm
10730 'iso-b10-white': Specifies the ISO B10 white medium: 31 mm x 44 mm
10731 'jis-b0-white': Specifies the JIS B0 white medium: 1030 mm x 1456 mm
10732 'jis-b0-transparent': Specifies the JIS B0 transparent medium: 1030
10734 'jis-b0-translucent': Specifies the JIS B0 translucent medium: 1030
10736 'jis-b1-white': Specifies the JIS B1 white medium: 728 mm x 1030 mm
10737 'jis-b1-transparent': Specifies the JIS B1 transparent medium: 728 mm
10739 'jis-b1-translucent': Specifies the JIS B1 translucent medium: 728 mm
10741 'jis-b2-white': Specifies the JIS B2 white medium: 515 mm x 728 mm
10742 'jis-b2-transparent': Specifies the JIS B2 transparent medium: 515 mm
10744 'jis-b2-translucent': Specifies the JIS B2 translucent medium: 515 mm
10746 'jis-b3-white': Specifies the JIS B3 white medium: 364 mm x 515 mm
10747 'jis-b3-transparent': Specifies the JIS B3 transparent medium: 364 mm
10749 'jis-b3-translucent': Specifies the JIS B3 translucent medium: 364 mm
10754 Hastings, et al. Standards Track [Page 192]
10756 RFC 2911 IPP/1.1: Model and Semantics September 2000
10759 'jis-b4-transparent': Specifies the JIS B4 transparent medium: 257 mm
10761 'jis-b4-translucent': Specifies the JIS B4 translucent medium: 257 mm
10763 'jis-b5-transparent': Specifies the JIS B5 transparent medium: 182 mm
10765 'jis-b5-translucent': Specifies the JIS B5 translucent medium: 182 mm
10767 'jis-b6-white': Specifies the JIS B6 white medium: 128 mm x 182 mm
10768 'jis-b7-white': Specifies the JIS B7 white medium: 91 mm x 128 mm
10769 'jis-b8-white': Specifies the JIS B8 white medium: 64 mm x 91 mm
10770 'jis-b9-white': Specifies the JIS B9 white medium: 45 mm x 64 mm
10771 'jis-b10-white': Specifies the JIS B10 white medium: 32 mm x 45 mm
10773 The following standard values are defined for American Standard (i.e.
10774 ANSI) engineering media:
10776 'a-white': Specifies the engineering ANSI A size white medium: 8.5
10778 'a-transparent': Specifies the engineering ANSI A size transparent
10779 medium: 8.5 inches x 11 inches
10780 'a-translucent': Specifies the engineering ANSI A size translucent
10781 medium: 8.5 inches x 11 inches
10782 'b-white': Specifies the engineering ANSI B size white medium: 11
10784 'b-transparent': Specifies the engineering ANSI B size transparent
10785 medium: 11 inches x 17 inches)
10786 'b-translucent': Specifies the engineering ANSI B size translucent
10787 medium: 11 inches x 17 inches
10788 'c-white': Specifies the engineering ANSI C size white medium: 17
10790 'c-transparent': Specifies the engineering ANSI C size transparent
10791 medium: 17 inches x 22 inches
10792 'c-translucent': Specifies the engineering ANSI C size translucent
10793 medium: 17 inches x 22 inches
10794 'd-white': Specifies the engineering ANSI D size white medium: 22
10796 'd-transparent': Specifies the engineering ANSI D size transparent
10797 medium: 22 inches x 34 inches
10798 'd-translucent': Specifies the engineering ANSI D size translucent
10799 medium: 22 inches x 34 inches
10800 'e-white': Specifies the engineering ANSI E size white medium: 34
10802 'e-transparent': Specifies the engineering ANSI E size transparent
10803 medium: 34 inches x 44 inches
10804 'e-translucent': Specifies the engineering ANSI E size translucent
10805 medium: 34 inches x 44 inches
10810 Hastings, et al. Standards Track [Page 193]
10812 RFC 2911 IPP/1.1: Model and Semantics September 2000
10815 The following standard values are defined for American Standard (i.e.
10816 ANSI) engineering media for devices that provide the "synchro-cut"
10817 feature (see section 14.1):
10819 'axsynchro-white': Specifies the roll paper having the width of the
10820 longer edge (11 inches) of the engineering ANSI A size white medium
10821 and cuts synchronizing with data.
10822 'axsynchro-transparent': Specifies the roll paper having the width of
10823 the longer edge (11 inches) of the engineering ANSI A size
10824 transparent medium and cuts synchronizing with data.
10825 'axsynchro-translucent': Specifies the roll paper having the width of
10826 the longer edge (11 inches) of the engineering ANSI A size
10827 translucent medium and cuts synchronizing with data.
10828 'bxsynchro-white': Specifies the roll paper having the width of the
10829 longer edge (17 inches) of the engineering ANSI B size white medium
10830 and cuts synchronizing with data.
10831 'bxsynchro-transparent': Specifies the roll paper having the width of
10832 the longer edge (17 inches) of the engineering ANSI B size
10833 transparent medium and cuts synchronizing with data.
10834 'bxsynchro-translucent': Specifies the roll paper having the width of
10835 the longer edge (17 inches) of the engineering ANSI B size
10836 translucent medium and cuts synchronizing with data.
10837 'cxsynchro-white': Specifies the roll paper having the width of the
10838 longer edge (22 inches) of the engineering ANSI C size white medium
10839 and cuts synchronizing with data.
10840 'cxsynchro-transparent': Specifies the roll paper having the width of
10841 the longer edge (22 inches) of the engineering ANSI C size
10842 transparent medium and cuts synchronizing with data.
10843 'cxsynchro-translucent': Specifies the roll paper having the width of
10844 the longer edge (22 inches) of the engineering ANSI C size
10845 translucent medium and cuts synchronizing with data.
10846 'dxsynchro-white': Specifies the roll paper having the width of the
10847 longer edge (34 inches) of the engineering ANSI D size white medium
10848 and cuts synchronizing with data.
10849 'dxsynchro-transparent': Specifies the roll paper having the width of
10850 the longer edge (34 inches) of the engineering ANSI D size
10851 transparent medium and cuts synchronizing with data.
10852 'dxsynchro-translucent': Specifies the roll paper having the width of
10853 the longer edge (34 inches) of the engineering ANSI D size
10854 translucent medium and cuts synchronizing with data.
10855 'exsynchro-white': Specifies the roll paper having the width of the
10856 longer edge (44 inches) of the engineering ANSI E size white medium
10857 and cuts synchronizing with data.
10858 'exsynchro-transparent': Specifies the roll paper having the width of
10859 the longer edge (44 inches) of the engineering ANSI E size
10860 transparent medium and cuts synchronizing with data.
10866 Hastings, et al. Standards Track [Page 194]
10868 RFC 2911 IPP/1.1: Model and Semantics September 2000
10871 'exsynchro-translucent': Specifies the roll paper having the width of
10872 the longer edge (44 inches) of the engineering ANSI E size
10873 translucent medium and cuts synchronizing with data.
10875 The following standard values are defined for American Architectural
10878 'arch-a-white': Specifies the Architectural A size white medium: 9
10880 'arch-a-transparent': Specifies the Architectural A size transparent
10881 medium: 9 inches x 12 inches
10882 'arch-a-translucent': Specifies the Architectural A size translucent
10883 medium: 9 inches x 12 inches
10884 'arch-b-white': Specifies the Architectural B size white medium: 12
10886 'arch-b-transparent': Specifies the Architectural B size transparent
10887 medium: 12 inches x 18 inches
10888 'arch-b-translucent': Specifies the Architectural B size translucent
10889 medium: 12 inches x 18 inches
10890 'arch-c-white': Specifies the Architectural C size white medium: 18
10892 'arch-c-transparent': Specifies the Architectural C size transparent
10893 medium: 18 inches x 24 inches
10894 'arch-c-translucent': Specifies the Architectural C size translucent
10895 medium: 18 inches x 24 inches
10896 'arch-d-white': Specifies the Architectural D size white medium: 24
10898 'arch-d-transparent': Specifies the Architectural D size transparent
10899 medium: 24 inches x 36 inches
10900 'arch-d-translucent': Specifies the Architectural D size translucent
10901 medium: 24 inches x 36 inches
10902 'arch-e-white': Specifies the Architectural E size white medium: 36
10904 'arch-e-transparent': Specifies the Architectural E size transparent
10905 medium: 36 inches x 48 inches
10906 'arch-e-translucent': Specifies the Architectural E size translucent
10907 medium: 36 inches x 48 inches
10909 The following standard values are defined for American Architectural
10910 engineering media for devices that provide the "synchro-cut" feature
10911 (see section 14.1):
10913 'arch-axsynchro-white': Specifies the roll paper having the width of
10914 the longer edge (12 inches) of the Architectural A size white
10915 medium and cuts synchronizing with data.
10916 'arch-axsynchro-transparent': Specifies the roll paper having the
10917 width of the longer edge (12 inches) of the Architectural A size
10918 transparent medium and cuts synchronizing with data.
10922 Hastings, et al. Standards Track [Page 195]
10924 RFC 2911 IPP/1.1: Model and Semantics September 2000
10927 'arch-axsynchro-translucent': Specifies the roll paper having the
10928 width of the longer edge (12 inches) of the Architectural A size
10929 translucent medium and cuts synchronizing with data.
10930 'arch-bxsynchro-white': Specifies the roll paper having the width of
10931 the longer edge (18 inches) of the Architectural B size white
10932 medium and cuts synchronizing with data.
10933 'arch-bxsynchro-transparent': Specifies the roll paper having the
10934 width of the longer edge (18 inches) of the Architectural B size
10935 transparent medium and cuts synchronizing with data.
10936 'arch-bxsynchro-translucent': Specifies the roll paper having the
10937 width of the longer edge (18 inches) of the Architectural B size
10938 translucent medium and cuts synchronizing with data.
10939 'arch-cxsynchro-white': Specifies the roll paper having the width of
10940 the longer edge (24 inches) of the Architectural C size white
10941 medium and cuts synchronizing with data.
10942 'arch-cxsynchro-transparent': Specifies the roll paper having the
10943 width of the longer edge (24 inches) of the Architectural C size
10944 transparent medium and cuts synchronizing with data.
10945 'arch-cxsynchro-translucent': Specifies the roll paper having the
10946 width of the longer edge (24 inches) of the Architectural C size
10947 translucent medium and cuts synchronizing with data.
10948 'arch-dxsynchro-white': Specifies the roll paper having the width of
10949 the longer edge (36 inches) of the Architectural D size white
10950 medium and cuts synchronizing with data.
10951 'arch-dxsynchro-transparent': Specifies the roll paper having the
10952 width of the longer edge (36 inches) of the Architectural D size
10953 transparent medium and cuts synchronizing with data.
10954 'arch-dxsynchro-translucent': Specifies the roll paper having the
10955 width of the longer edge (36 inches) of the Architectural D size
10956 translucent medium and cuts synchronizing with data.
10957 'arch-exsynchro-white': Specifies the roll paper having the width of
10958 the longer edge (48 inches) of the Architectural E size white
10959 medium and cuts synchronizing with data.
10960 'arch-exsynchro-transparent': Specifies the roll paper having the
10961 width of the longer edge (48 inches) of the Architectural E size
10962 transparent medium and cuts synchronizing with data.
10963 'arch-exsynchro-translucent': Specifies the roll paper having the
10964 width of the longer edge (48 inches) of the Architectural E size
10965 translucent medium and cuts synchronizing with data.
10967 The following standard values are defined for Japanese and European
10968 Standard (i.e. ISO) engineering media, which are of a long fixed size
10971 'iso-a1x3-white': Specifies the ISO A1X3 white medium having the
10972 width of the longer edge (841 mm) of the ISO A1 medium
10978 Hastings, et al. Standards Track [Page 196]
10980 RFC 2911 IPP/1.1: Model and Semantics September 2000
10983 'iso-a1x3-transparent': Specifies the ISO A1X3 transparent medium
10984 having the width of the longer edge (841 mm) of the ISO A1
10986 'iso-a1x3-translucent': Specifies the ISO A1X3 translucent medium
10987 having the width of the longer edge (841 mm) of the ISO A1
10989 'iso-a1x4-white': Specifies the ISO A1X4 white medium having the
10990 width of the longer edge (841 mm) of the ISO A1 medium
10991 'iso-a1x4-transparent': Specifies the ISO A1X4 transparent medium
10992 having the width of the longer edge (841 mm) of the ISO A1
10994 'iso-a1x4- translucent': Specifies the ISO A1X4 translucent medium
10995 having the width of the longer edge (841 mm) of the ISO A1
10997 'iso-a2x3-white': Specifies the ISO A2X3 white medium having the
10998 width of the longer edge (594 mm) of the ISO A2 medium
10999 'iso-a2x3-transparent': Specifies the ISO A2X3 transparent medium
11000 having the width of the longer edge (594 mm) of the ISO A2
11002 'iso-a2x3-translucent': Specifies the ISO A2X3 translucent medium
11003 having the width of the longer edge (594 mm) of the ISO A2
11005 'iso-a2x4-white': Specifies the ISO A2X4 white medium having the
11006 width of the longer edge (594 mm) of the ISO A2 medium
11007 'iso-a2x4-transparent': Specifies the ISO A2X4 transparent medium
11008 having the width of the longer edge (594 mm) of the ISO A2
11010 'iso-a2x4-translucent': Specifies the ISO A2X4 translucent medium
11011 having the width of the longer edge (594 mm) of the ISO A2
11013 'iso-a2x5-white': Specifies the ISO A2X5 white medium having the
11014 width of the longer edge (594 mm) of the ISO A2 medium
11015 'iso-a2x5-transparent': Specifies the ISO A2X5 transparent medium
11016 having the width of the longer edge (594 mm) of the ISO A2
11018 'iso-a2x5-translucent': Specifies the ISO A2X5 translucent medium
11019 having the width of the longer edge (594 mm) of the ISO A2
11021 'iso-a3x3-white': Specifies the ISO A3X3 white medium having the
11022 width of the longer edge (420 mm) of the ISO A3 medium
11023 'iso-a3x3-transparent': Specifies the ISO A3X3 transparent medium
11024 having the width of the longer edge (420 mm) of the ISO A3
11026 'iso-a3x3-translucent': Specifies the ISO A3X3 translucent medium
11027 having the width of the longer edge (420 mm) of the ISO A3
11029 'iso-a3x4-white': Specifies the ISO A3X4 white medium having the
11030 width of the longer edge (420 mm) of the ISO A3 medium
11034 Hastings, et al. Standards Track [Page 197]
11036 RFC 2911 IPP/1.1: Model and Semantics September 2000
11039 'iso-a3x4-transparent': Specifies the ISO A3X4 transparent medium
11040 having the width of the longer edge (420 mm) of the ISO A3
11042 'iso-a3x4-translucent': Specifies the ISO A3X4 translucent medium
11043 having the width of the longer edge (420 mm) of the ISO A3
11045 'iso-a3x5-white': Specifies the ISO A3X5 white medium having the
11046 width of the longer edge (420 mm) of the ISO A3 medium
11047 'iso-a3x5-transparent': Specifies the ISO A3X5 transparent medium
11048 having the width of the longer edge (420 mm) of the ISO A3
11050 'iso-a3x5-translucent': Specifies the ISO A3X5 translucent medium
11051 having the width of the longer edge (420 mm) of the ISO A3
11053 'iso-a3x6-white': Specifies the ISO A3X6 white medium having the
11054 width of the longer edge (420 mm) of the ISO A3 medium
11055 'iso-a3x6-transparent': Specifies the ISO A3X6 transparent medium
11056 having the width of the longer edge (420 mm) of the ISO A3
11058 'iso-a3x6-translucent': Specifies the ISO A3X6 translucent medium
11059 having the width of the longer edge (420 mm) of the ISO A3
11061 'iso-a3x7-white': Specifies the ISO A3X7 white medium having the
11062 width of the longer edge (420 mm) of the ISO A3 medium
11063 'iso-a3x7-transparent': Specifies the ISO A3X7 transparent medium
11064 having the width of the longer edge (420 mm) of the ISO A3
11066 'iso-a3x7-translucent'': Specifies the ISO A3X7 translucent' medium
11067 having the width of the longer edge (420 mm) of the ISO A3
11069 'iso-a4x3-white': Specifies the ISO A4X3 white medium having the
11070 width of the longer edge (297 mm) of the ISO A4 medium
11071 'iso-a4x3-transparent': Specifies the ISO A4X3 transparent medium
11072 having the width of the longer edge (297 mm) of the ISO A4
11074 'iso-a4x3-translucent'': Specifies the ISO A4X3 translucent' medium
11075 having the width of the longer edge (297 mm) of the ISO A4
11077 'iso-a4x4-white': Specifies the ISO A4X4 white medium having the
11078 width of the longer edge (297 mm) of the ISO A4 medium
11079 'iso-a4x4-transparent': Specifies the ISO A4X4 transparent medium
11080 having the width of the longer edge (297 mm) of the ISO A4
11082 'iso-a4x4-translucent': Specifies the ISO A4X4 translucent medium
11083 having the width of the longer edge (297 mm) of the ISO A4
11085 'iso-a4x5-white': Specifies the ISO A4X5 white medium having the
11086 width of the longer edge (297 mm) of the ISO A4 medium
11090 Hastings, et al. Standards Track [Page 198]
11092 RFC 2911 IPP/1.1: Model and Semantics September 2000
11095 'iso-a4x5-transparent': Specifies the ISO A4X5 transparent medium
11096 having the width of the longer edge (297 mm) of the ISO A4
11098 'iso-a4x5-translucent': Specifies the ISO A4X5 translucent medium
11099 having the width of the longer edge (297 mm) of the ISO A4
11101 'iso-a4x6-white': Specifies the ISO A4X6 white medium having the
11102 width of the longer edge (297 mm) of the ISO A4 medium
11103 'iso-a4x6-transparent': Specifies the ISO A4X6 transparent medium
11104 having the width of the longer edge (297 mm) of the ISO A4
11106 'iso-a4x6-translucent': Specifies the ISO A4X6 translucent medium
11107 having the width of the longer edge (297 mm) of the ISO A4
11109 'iso-a4x7-white': Specifies the ISO A4X7 white medium having the
11110 width of the longer edge (297 mm) of the ISO A4 medium
11111 'iso-a4x7-transparent': Specifies the ISO A4X7 transparent medium
11112 having the width of the longer edge (297 mm) of the ISO A4
11114 'iso-a4x7-translucent': Specifies the ISO A4X7 translucent medium
11115 having the width of the longer edge (297 mm) of the ISO A4
11117 'iso-a4x8-white': Specifies the ISO A4X8 white medium having the
11118 width of the longer edge (297 mm) of the ISO A4 medium
11119 'iso-a4x8-transparent': Specifies the ISO A4X8 transparent medium
11120 having the width of the longer edge (297 mm) of the ISO A4
11122 'iso-a4x8-translucent': Specifies the ISO A4X8 translucent medium
11123 having the width of the longer edge (297 mm) of the ISO A4
11125 'iso-a4x9-white': Specifies the ISO A4X9 white medium having the
11126 width of the longer edge (297 mm) of the ISO A4 medium
11127 'iso-a4x9-transparent': Specifies the ISO A4X9 transparent medium
11128 having the width of the longer edge (297 mm) of the ISO A4
11130 'iso-a4x9-translucent': Specifies the ISO A4X9 translucent medium
11131 having the width of the longer edge (297 mm) of the ISO A4
11134 The following standard values are defined for Japanese and European
11135 Standard (i.e. ISO) engineering media, which are either a long fixed
11136 size [ASME-Y14.1M] or roll feed, for devices that provide the
11137 "synchro-cut" feature (see section 14.1):
11139 'iso-a0xsynchro-white': Specifies the paper having the width of the
11140 longer edge (1189 mm) of the ISO A0 white medium and cuts
11141 synchronizing with data.
11146 Hastings, et al. Standards Track [Page 199]
11148 RFC 2911 IPP/1.1: Model and Semantics September 2000
11151 'iso-a0xsynchro-transparent': Specifies the paper having the width of
11152 the longer edge (1189 mm) of the ISO A0 transparent medium and
11153 cuts synchronizing with data.
11154 'iso-a0xsynchro-translucent': Specifies the paper having the width of
11155 the longer edge (1189 mm) of the ISO A0 translucent medium and
11156 cuts synchronizing with data.
11157 'iso-a1xsynchro-white': Specifies the paper having the width of the
11158 longer edge (841 mm) of the ISO A1 white medium and cuts
11159 synchronizing with data.
11160 'iso-a1xsynchro-transparent': Specifies the paper having the width of
11161 the longer edge (841 mm) of the ISO A1 transparent medium and
11162 cuts synchronizing with data.
11163 'iso-a1xsynchro-translucent': Specifies the paper having the width of
11164 the longer edge (841 mm) of the ISO A1 translucent medium and
11165 cuts synchronizing with data.
11166 'iso-a2xsynchro-white': Specifies the paper having the width of the
11167 longer edge (594 mm) of the ISO A2 white medium and cuts
11168 synchronizing with data.
11169 'iso-a2xsynchro-transparent': Specifies the paper having the width of
11170 the longer edge (594 mm) of the ISO A2 transparent medium and
11171 cuts synchronizing with data.
11172 'iso-a2xsynchro-translucent': Specifies the paper having the width of
11173 the longer edge (594 mm) of the ISO A2 translucent medium and
11174 cuts synchronizing with data.
11175 'iso-a3xsynchro-white': Specifies the paper having the width of the
11176 longer edge (420 mm) of the ISO A3 white medium and cuts
11177 synchronizing with data.
11178 'iso-a3xsynchro-transparent': Specifies the paper having the width of
11179 the longer edge (420 mm) of the ISO A3 transparent medium and
11180 cuts synchronizing with data.
11181 'iso-a3xsynchro-translucent': Specifies the paper having the width of
11182 the longer edge (420 mm) of the ISO A3 translucent medium and
11183 cuts synchronizing with data.
11184 'iso-a4xsynchro-white': Specifies the paper having the width of the
11185 longer edge (297 mm) of the ISO A4 white medium and cuts
11186 synchronizing with data.
11187 'iso-a4xsynchro-transparent': Specifies the paper having the width of
11188 the longer edge (297 mm) of the ISO A4 transparent medium and
11189 cuts synchronizing with data.
11190 'iso-a4xsynchro-translucent': Specifies the paper having the width of
11191 the longer edge (297 mm) of the ISO A4 transparent medium and
11192 cuts synchronizing with data.
11194 The following standard values are defined for American Standard (i.e.
11195 ANSI) engineering media, American Architectural engineering media,
11196 and Japanese and European Standard (i.e. ISO) engineering media,
11202 Hastings, et al. Standards Track [Page 200]
11204 RFC 2911 IPP/1.1: Model and Semantics September 2000
11207 which are either a long fixed size [ASME-Y14.1M] or roll feed, for
11208 devices that provide the "synchro-cut" feature and/or the "auto-
11209 select" feature (see section 14.1):
11211 'auto-white': Specifies that the printer selects the white medium
11212 with the appropriate fixed size (e.g. a1, a2, etc.) or data-
11213 synchro size, and the selection is implementation-defined.
11214 'auto-transparent': Specifies that the printer selects the
11215 transparent medium with the appropriate fixed size (e.g. a1, a2,
11216 etc.) or data-synchro size, and the selection is implementation-
11218 'auto-translucent': Specifies that the printer selects the
11219 translucent medium with the appropriate fixed size (e.g. a1, a2,
11220 etc.) or data-synchro size, and the selection is implementation-
11222 'auto-fixed-size-white': Specifies that the printer selects the white
11223 medium with the appropriate fixed size (e.g. a1, a2, etc.) or
11224 the appropriate long fixed size listed above.
11225 'auto-fixed-size-transparent': Specifies that the printer selects the
11226 transparent medium with the appropriate fixed size (e.g. a1, a2,
11227 etc.) or the appropriate long fixed size listed above.
11228 'auto-fixed-size-translucent': Specifies that the printer selects the
11229 translucent medium with the appropriate fixed size (e.g. a1, a2,
11230 etc.) or the appropriate long fixed size listed above.
11231 'auto-synchro-white': Specifies that the printer selects the white
11232 paper with the appropriate width and cuts it synchronizing with
11234 'auto-synchro-transparent': Specifies that the printer selects the
11235 transparent paper with the appropriate width and cuts it
11236 synchronizing with data.
11237 'auto-synchro-translucent': Specifies that the printer selects the
11238 translucent paper with the appropriate width and cuts it
11239 synchronizing with data.
11241 The following standard values are defined for input-trays (from ISO
11242 DPA and the Printer MIB):
11244 'top': The top input tray in the printer.
11245 'middle': The middle input tray in the printer.
11246 'bottom': The bottom input tray in the printer.
11247 'envelope': The envelope input tray in the printer.
11248 'manual': The manual feed input tray in the printer.
11249 'large-capacity': The large capacity input tray in the printer.
11250 'main': The main input tray
11251 'side': The side input tray
11258 Hastings, et al. Standards Track [Page 201]
11260 RFC 2911 IPP/1.1: Model and Semantics September 2000
11263 The following standard values are defined for media sizes (from ISO
11266 'iso-a0': Specifies the ISO A0 size: 841 mm by 1189 mm as defined in
11268 'iso-a1': Specifies the ISO A1 size: 594 mm by 841 mm as defined in
11270 'iso-a2': Specifies the ISO A2 size: 420 mm by 594 mm as defined in
11272 'iso-a3': Specifies the ISO A3 size: 297 mm by 420 mm as defined in
11274 'iso-a4': Specifies the ISO A4 size: 210 mm by 297 mm as defined in
11276 'iso-a5': Specifies the ISO A5 size: 148 mm by 210 mm as defined in
11278 'iso-a6': Specifies the ISO A6 size: 105 mm by 148 mm as defined in
11280 'iso-a7': Specifies the ISO A7 size: 74 mm by 105 mm as defined in
11282 'iso-a8': Specifies the ISO A8 size: 52 mm by 74 mm as defined in ISO
11284 'iso-a9': Specifies the ISO A9 size: 37 mm by 52 mm as defined in ISO
11286 'iso-a10': Specifies the ISO A10 size: 26 mm by 37 mm as defined in
11288 'iso-b0': Specifies the ISO B0 size: 1000 mm by 1414 mm as defined in
11290 'iso-b1': Specifies the ISO B1 size: 707 mm by 1000 mm as defined in
11292 'iso-b2': Specifies the ISO B2 size: 500 mm by 707 mm as defined in
11294 'iso-b3': Specifies the ISO B3 size: 353 mm by 500 mm as defined in
11296 'iso-b4': Specifies the ISO B4 size: 250 mm by 353 mm as defined in
11298 'iso-b5': Specifies the ISO B5 size: 176 mm by 250 mm as defined in
11300 'iso-b6': Specifies the ISO B6 size: 125 mm by 176 mm as defined in
11302 'iso-b7': Specifies the ISO B7 size: 88 mm by 125 mm as defined in
11304 'iso-b8': Specifies the ISO B8 size: 62 mm by 88 mm as defined in ISO
11306 'iso-b9': Specifies the ISO B9 size: 44 mm by 62 mm as defined in ISO
11308 'iso-b10': Specifies the ISO B10 size: 31 mm by 44 mm as defined in
11314 Hastings, et al. Standards Track [Page 202]
11316 RFC 2911 IPP/1.1: Model and Semantics September 2000
11319 'na-letter': Specifies the North American letter size: 8.5 inches by
11321 'na-legal': Specifies the North American legal size: 8.5 inches by 14
11323 'na-8x10': Specifies the North American 8 inches by 10 inches
11324 'na-5x7': Specifies the North American 5 inches by 7 inches
11325 'executive': Specifies the executive size (7.25 X 10.5 in)
11326 'folio': Specifies the folio size (8.5 X 13 in)
11327 'invoice': Specifies the invoice size (5.5 X 8.5 in)
11328 'ledger': Specifies the ledger size (11 X 17 in)
11329 'quarto': Specifies the quarto size (8.5 X 10.83 in)
11330 'iso-c3': Specifies the ISO C3 size: 324 mm by 458 mm as defined in
11332 'iso-c4': Specifies the ISO C4 size: 229 mm by 324 mm as defined in
11334 'iso-c5': Specifies the ISO C5 size: 162 mm by 229 mm as defined in
11336 'iso-c6': Specifies the ISO C6 size: 114 mm by 162 mm as defined in
11338 'iso-designated-long': Specifies the ISO Designated Long size: 110 mm
11339 by 220 mm as defined in ISO 269
11340 'na-10x13-envelope': Specifies the North American 10x13 size: 10
11341 inches by 13 inches
11342 'na-9x12-envelope': Specifies the North American 9x12 size: 9 inches
11344 'na-number-10-envelope': Specifies the North American number 10
11345 business envelope size: 4.125 inches by 9.5 inches
11346 'na-7x9-envelope': Specifies the North American 7x9 inch envelope
11348 'na-9x11-envelope': Specifies the North American 9x11 inch envelope
11350 'na-10x14-envelope': Specifies the North American 10x14 inch envelope
11352 'na-number-9-envelope': Specifies the North American number 9
11353 business envelope size
11354 'na-6x9-envelope': Specifies the North American 6x9 envelope size
11355 'na-10x15-envelope': Specifies the North American 10x15 envelope size
11356 'monarch-envelope': Specifies the Monarch envelope size (3.87 x 7.5
11358 'jis-b0': Specifies the JIS B0 size: 1030mm x 1456mm
11359 'jis-b1': Specifies the JIS B1 size: 728mm x 1030mm
11360 'jis-b2': Specifies the JIS B2 size: 515mm x 728mm
11361 'jis-b3': Specifies the JIS B3 size: 364mm x 515mm
11362 'jis-b4': Specifies the JIS B4 size: 257mm x 364mm
11363 'jis-b5': Specifies the JIS B5 size: 182mm x 257mm
11364 'jis-b6': Specifies the JIS B6 size: 128mm x 182mm
11365 'jis-b7': Specifies the JIS B7 size: 91mm x 128mm
11366 'jis-b8': Specifies the JIS B8 size: 64mm x 91mm
11370 Hastings, et al. Standards Track [Page 203]
11372 RFC 2911 IPP/1.1: Model and Semantics September 2000
11375 'jis-b9': Specifies the JIS B9 size: 45mm x 64mm
11376 'jis-b10': Specifies the JIS B10 size: 32mm x 45mm
11378 The following standard values are defined for American Standard (i.e.
11379 ANSI) engineering media sizes:
11381 'a': Specifies the engineering ANSI A size medium: 8.5 inches x 11
11383 'b': Specifies the engineering ANSI B size medium: 11 inches x 17
11385 'c': Specifies the engineering ANSI C size medium: 17 inches x 22
11387 'd': Specifies the engineering ANSI D size medium: 22 inches x 34
11389 'e': Specifies the engineering ANSI E size medium: 34 inches x 44
11392 The following standard values are defined for American Architectural
11393 engineering media sizes:
11395 'arch-a': Specifies the Architectural A size medium: 9 inches x 12
11397 'arch-b': Specifies the Architectural B size medium: 12 inches x 18
11399 'arch-c': Specifies the Architectural C size medium: 18 inches x 24
11401 'arch-d': Specifies the Architectural D size medium: 24 inches x 36
11403 'arch-e': Specifies the Architectural E size medium: 36 inches x 48
11426 Hastings, et al. Standards Track [Page 204]
11428 RFC 2911 IPP/1.1: Model and Semantics September 2000
11433 Below are examples to supplement the engineering media value
11436 Example 1: "Synchro-Cut", a device cutting the roll paper in
11437 synchronization with the data
11439 data height: A1 height
11440 data width (shaded): A1 width < data width < (A1 width) x 2
11441 specified value: 'iso-a1xsynchro-white'
11444 |<--- data width --->|
11447 |<- A1 width ->|<- A1 width ->|
11450 feed | +--------------------------------------------/
11451 direction | |//////////////|/////| | ^ /
11452 | |//////////////|/////| | | /
11453 | |//////////////|/////| | | /
11454 | |//////////////|/////| | | \
11455 <-----------+- |//////////////|/////| | A1 \ roll
11456 feed | |//////////////|/////| | height \ paper
11457 direction |//////////////|/////| | | \
11458 |//////////////|/////| | | /
11459 |//////////////|/////| | v /
11460 +------------------------------------------/
11463 |<------ CUT HERE (to synchronize
11482 Hastings, et al. Standards Track [Page 205]
11484 RFC 2911 IPP/1.1: Model and Semantics September 2000
11487 Example 2: "Auto-Cut", a device cutting the roll paper at multiples
11488 of fixed-size media width
11490 data height: A1 height
11491 data width (shaded): A1 width < data width < (A1 width) x 2
11492 specified value: 'auto-fixed-size-white'
11495 |<--- data width --->|
11498 |<- A1 width ->|<- A1 width ->|
11501 feed | +--------------------------------------------/
11502 direction | |//////////////|/////| | ^ /
11503 | |//////////////|/////| | | /
11504 | |//////////////|/////| | | /
11505 | |//////////////|/////| | | \
11506 <-----------+- |//////////////|/////| | A1 \ roll
11507 feed | |//////////////|/////| | height \ paper
11508 direction |//////////////|/////| | | \
11509 |//////////////|/////| | | /
11510 |//////////////|/////| | v /
11511 +------------------------------------------/
11538 Hastings, et al. Standards Track [Page 206]
11540 RFC 2911 IPP/1.1: Model and Semantics September 2000
11543 Example 3: the 'iso-a4x4-white' fixed size paper
11545 paper height: A4 height
11546 paper width: (A4 width) x 4
11547 specified value: 'iso-a4x4-white'
11550 |<- A4 width ->|<- A4 width ->|<- A4 width ->|<- A4 width ->|
11553 +-----------------------------------------------------------+
11563 +-----------------------------------------------------------+
11594 Hastings, et al. Standards Track [Page 207]
11596 RFC 2911 IPP/1.1: Model and Semantics September 2000
11599 Example 4: "Synchro-Cut", a device cutting the fixed size paper in
11600 synchronization with the data
11602 data height: A4 height
11603 data width (shaded): (A4 width) x 2 < data width < (A4 width) x 3
11604 specified value: 'iso-a4xsynchro-white'
11607 |<---------- data width ----------->|
11610 |<- A4 width ->|<- A4 width ->|<- A4 width ->|
11613 feed | +--------------------------------------------+
11614 direction | |//////////////|//////////////|/////| ^ |
11615 | |//////////////|//////////////|/////| | |
11616 | |//////////////|//////////////|/////| | |
11617 | |//////////////|//////////////|/////| | |
11618 <-----------+- |//////////////|//////////////|/////| A4 |
11619 feed | |//////////////|//////////////|/////| height |
11620 direction |//////////////|//////////////|/////| | |
11621 |//////////////|//////////////|/////| | |
11622 |//////////////|//////////////|/////| v |
11623 +--------------------------------------------+
11629 15. APPENDIX D: Processing IPP Attributes
11631 When submitting a print job to a Printer object, the IPP model allows
11632 a client to supply operation and Job Template attributes along with
11633 the document data. These Job Template attributes in the create
11634 request affect the rendering, production and finishing of the
11635 documents in the job. Similar types of instructions may also be
11636 contained in the document to be printed, that is, embedded within the
11637 print data itself. In addition, the Printer has a set of attributes
11638 that describe what rendering and finishing options which are
11639 supported by that Printer. This model, which allows for flexibility
11640 and power, also introduces the potential that at job submission time,
11641 these client-supplied attributes may conflict with either:
11643 - what the implementation is capable of realizing (i.e., what the
11644 Printer supports), as well as
11645 - the instructions embedded within the print data itself.
11650 Hastings, et al. Standards Track [Page 208]
11652 RFC 2911 IPP/1.1: Model and Semantics September 2000
11655 The following sections describe how these two types of conflicts are
11656 handled in the IPP model.
11660 If there is a conflict between what the client requests and what a
11661 Printer object supports, the client may request one of two possible
11662 conflict handling mechanisms:
11664 1) either reject the job since the job can not be processed
11665 exactly as specified, or
11666 2) allow the Printer to make any changes necessary to proceed with
11667 processing the Job the best it can.
11669 In the first case the client is indicating to the Printer object:
11670 "Print the job exactly as specified with no exceptions, and if that
11671 can't be done, don't even bother printing the job at all." In the
11672 second case, the client is indicating to the Printer object: "It is
11673 more important to make sure the job is printed rather than be
11674 processed exactly as specified; just make sure the job is printed
11675 even if some client-supplied attributes need to be changed or
11678 The IPP model accounts for this situation by introducing an "ipp-
11679 attribute-fidelity" attribute.
11681 In a create request, "ipp-attribute-fidelity" is a boolean operation
11682 attribute that is OPTIONALLY supplied by the client. The value
11683 'true' indicates that total fidelity to client supplied Job Template
11684 attributes and values is required. The client is requesting that the
11685 Job be printed exactly as specified, and if that is not possible then
11686 the job MUST be rejected rather than processed incorrectly. The
11687 value 'false' indicates that a reasonable attempt to print the Job is
11688 acceptable. If a Printer does not support some of the client
11689 supplied Job Template attributes or values, the Printer MUST ignore
11690 them or substitute any supported value for unsupported values,
11691 respectively. The Printer may choose to substitute the default value
11692 associated with that attribute, or use some other supported value
11693 that is similar to the unsupported requested value. For example, if
11694 a client supplies a "media" value of 'na-letter', the Printer may
11695 choose to substitute 'iso-a4' rather than a default value of
11696 'envelope'. If the client does not supply the "ipp-attribute-
11697 fidelity" attribute, the Printer assumes a value of 'false'.
11699 Each Printer implementation MUST support both types of "fidelity"
11700 printing (that is whether the client supplies a value of 'true' or
11706 Hastings, et al. Standards Track [Page 209]
11708 RFC 2911 IPP/1.1: Model and Semantics September 2000
11711 - If the client supplies 'false' or does not supply the attribute,
11712 the Printer object MUST always accept the request by ignoring
11713 unsupported Job Template attributes and by substituting
11714 unsupported values of supported Job Template attributes with
11716 - If the client supplies 'true', the Printer object MUST reject
11717 the request if the client supplies unsupported Job Template
11720 Since a client can always query a Printer to find out exactly what is
11721 and is not supported, "ipp-attribute-fidelity" set to 'false' is
11724 1) The End-User uses a command line interface to request
11725 attributes that might not be supported.
11726 2) In a GUI context, if the End User expects the job might be
11727 moved to another printer and prefers a sub-optimal result to
11729 3) The End User just wants something reasonable in lieu of nothing
11732 15.2 Page Description Language (PDL) Override
11734 If there is a conflict between the value of an IPP Job Template
11735 attribute and a corresponding instruction in the document data, the
11736 value of the IPP attribute SHOULD take precedence over the document
11737 instruction. Consider the case where a previously formatted file of
11738 document data is sent to an IPP Printer. In this case, if the client
11739 supplies any attributes at job submission time, the client desires
11740 that those attributes override the embedded instructions. Consider
11741 the case were a previously formatted document has embedded in it
11742 commands to load 'iso-a4' media. However, the document is passed to
11743 an end user that only has access to a printer with 'na-letter' media
11744 loaded. That end user most likely wants to submit that document to
11745 an IPP Printer with the "media" Job Template attribute set to 'na-
11746 letter'. The job submission attribute should take precedence over
11747 the embedded PDL instruction. However, until companies that supply
11748 document data interpreters allow a way for external IPP attributes to
11749 take precedence over embedded job production instructions, a Printer
11750 might not be able to support the semantics that IPP attributes
11751 override the embedded instructions.
11753 The IPP model accounts for this situation by introducing a "pdl-
11754 override-supported" attribute that describes the Printer objects
11755 capabilities to override instructions embedded in the PDL data
11756 stream. The value of the "pdl-override-supported" attribute is
11757 configured by means outside the scope of this IPP/1.1 document.
11762 Hastings, et al. Standards Track [Page 210]
11764 RFC 2911 IPP/1.1: Model and Semantics September 2000
11767 This REQUIRED Printer attribute takes on the following values:
11769 - 'attempted': This value indicates that the Printer object
11770 attempts to make the IPP attribute values take precedence over
11771 embedded instructions in the document data, however there is no
11773 - 'not-attempted': This value indicates that the Printer object
11774 makes no attempt to make the IPP attribute values take
11775 precedence over embedded instructions in the document data.
11777 At job processing time, an implementation that supports the value of
11778 'attempted' might do one of several different actions:
11780 1) Generate an output device specific command sequence to realize
11781 the feature represented by the IPP attribute value.
11782 2) Parse the document data itself and replace the conflicting
11783 embedded instruction with a new embedded instruction that
11784 matches the intent of the IPP attribute value.
11785 3) Indicate to the Printer that external supplied attributes take
11786 precedence over embedded instructions and then pass the
11787 external IPP attribute values to the document data interpreter.
11788 4) Anything else that allows for the semantics that IPP attributes
11789 override embedded document data instructions.
11791 Since 'attempted' does not offer any type of guarantee, even though a
11792 given Printer object might not do a very "good" job of attempting to
11793 ensure that IPP attributes take a higher precedence over instructions
11794 embedded in the document data, it would still be a conforming
11797 At job processing time, an implementation that supports the value of
11798 'not-attempted' might do one of the following actions:
11800 1) Simply pre-pend the document data with the PDL instruction that
11801 corresponds to the client-supplied PDL attribute, such that if
11802 the document data also has the same PDL instruction, it will
11803 override what the Printer object pre-pended. In other words,
11804 this implementation is using the same implementation semantics
11805 for the client-supplied IPP attributes as for the Printer
11808 2) Parse the document data and replace the conflicting embedded
11809 instruction with a new embedded instruction that approximates,
11810 but does not match, the semantic intent of the IPP attribute
11813 Note: The "ipp-attribute-fidelity" attribute applies to the
11814 Printer's ability to either accept or reject other unsupported Job
11818 Hastings, et al. Standards Track [Page 211]
11820 RFC 2911 IPP/1.1: Model and Semantics September 2000
11823 Template attributes. In other words, if "ipp-attribute-fidelity" is
11824 set to 'true', a Job is accepted if and only if the client supplied
11825 Job Template attributes and values are supported by the Printer.
11826 Whether these attributes actually affect the processing of the Job
11827 when the document data contains embedded instructions depends on the
11828 ability of the Printer to override the instructions embedded in the
11829 document data with the semantics of the IPP attributes. If the
11830 document data attributes can be overridden ("pdl-override-supported"
11831 set to 'attempted'), the Printer makes an attempt to use the IPP
11832 attributes when processing the Job. If the document data attributes
11833 can not be overridden ("pdl-override-supported" set to 'not-
11834 attempted'), the Printer makes no attempt to override the embedded
11835 document data instructions with the IPP attributes when processing
11836 the Job, and hence, the IPP attributes may fail to affect the Job
11837 processing and output when the corresponding instruction is embedded
11838 in the document data.
11840 15.3 Using Job Template Attributes During Document Processing.
11842 The Printer object uses some of the Job object's Job Template
11843 attributes during the processing of the document data associated with
11844 that job. These include, but are not limited to, "orientation-
11845 requested", "number-up", "sides", "media", and "copies". The
11846 processing of each document in a Job Object MUST follow the steps
11847 below. These steps are intended only to identify when and how
11848 attributes are to be used in processing document data and any
11849 alternative steps that accomplishes the same effect can be used to
11850 implement this specification document.
11852 1. Using the client supplied "document-format" attribute or some
11853 form of document format detection algorithm (if the value of
11854 "document-format" is not specific enough), determine whether or
11855 not the document data has already been formatted for printing.
11856 If the document data has been formatted, then go to step 2.
11857 Otherwise, the document data MUST be formatted. The formatting
11858 detection algorithm is implementation defined and is not
11859 specified by this document. The formatting of the document
11860 data uses the "orientation-requested" attribute to determine
11861 how the formatted print data should be placed on a print-stream
11862 page, see section 4.2.10 for the details.
11864 2. The document data is in the form of a print-stream in a known
11865 media type. The "page-ranges" attribute is used to select, as
11866 specified in section 4.2.7, a sub-sequence of the pages in the
11867 print-stream that are to be processed and images.
11869 3. The input to this step is a sequence of print-stream pages.
11870 This step is controlled by the "number-up" attribute. If the
11874 Hastings, et al. Standards Track [Page 212]
11876 RFC 2911 IPP/1.1: Model and Semantics September 2000
11879 value of "number-up" is N, then during the processing of the
11880 print-stream pages, each N print-stream pages are positioned,
11881 as specified in section 4.2.9, to create a single impression.
11882 If a given document does not have N more print-stream pages,
11883 then the completion of the impression is controlled by the
11884 "multiple-document-handling" attribute as described in section
11885 4.2.4; when the value of this attribute is 'single-document' or
11886 'single-document-new-sheet', the print-stream pages of document
11887 data from subsequent documents is used to complete the
11890 The size(scaling), position(translation) and rotation of the
11891 print-stream pages on the impression is implementation defined.
11892 Note that during this process the print-stream pages may be
11893 rendered to a form suitable for placing on the impression; this
11894 rendering is controlled by the values of the "printer-
11895 resolution" and "print-quality" attributes as described in
11896 sections 4.2.12 and 4.2.13. In the case N=1, the impression is
11897 nearly the same as the print-stream page; the differences would
11898 only be in the size, position and rotation of the print-stream
11899 page and/or any decoration, such as a frame to the page, that
11900 is added by the implementation.
11902 4. The collection of impressions is placed, in sequence, onto
11903 sides of the media sheets. This placement is controlled by the
11904 "sides" attribute and the orientation of the print-stream page,
11905 as described in section 4.2.8. The orientation of the print-
11906 stream pages affects the orientation of the impression; for
11907 example, if "number-up" equals 2, then, typically, two portrait
11908 print-stream pages become one landscape impression. Note that
11909 the placement of impressions onto media sheets is also
11910 controlled by the "multiple-document-handling" attribute as
11911 described in section 4.2.4.
11913 5. The "copies" and "multiple-document-handling" attributes are
11914 used to determine how many copies of each media instance are
11915 created and in what order. See sections 4.2.5 and 4.2.4 for the
11918 6. When the correct number of copies are created, the media
11919 instances are finished according to the values of the
11920 "finishings" attribute as described in 4.2.6. Note that
11921 sometimes finishing operations may require manual intervention
11922 to perform the finishing operations on the copies, especially
11923 uncollated copies. This document allows any or all of the
11924 processing steps to be performed automatically or manually at
11925 the discretion of the Printer object.
11930 Hastings, et al. Standards Track [Page 213]
11932 RFC 2911 IPP/1.1: Model and Semantics September 2000
11935 16. APPENDIX E: Generic Directory Schema
11937 This section defines a generic schema for an entry in a directory
11938 service. A directory service is a means by which service users can
11939 locate service providers. In IPP environments, this means that IPP
11940 Printers can be registered (either automatically or with the help of
11941 an administrator) as entries of type printer in the directory using
11942 an implementation specific mechanism such as entry attributes, entry
11943 type fields, specific branches, etc. Directory clients can search or
11944 browse for entries of type printer. Clients use the directory
11945 service to find entries based on naming, organizational contexts, or
11946 filtered searches on attribute values of entries. For example, a
11947 client can find all printers in the "Local Department" context.
11948 Authentication and authorization are also often part of a directory
11949 service so that an administrator can place limits on end users so
11950 that they are only allowed to find entries to which they have certain
11951 access rights. IPP itself does not require any specific directory
11952 service protocol or provider.
11954 Note: Some directory implementations allow for the notion of
11955 "aliasing". That is, one directory entry object can appear as
11956 multiple directory entry object with different names for each object.
11957 In each case, each alias refers to the same directory entry object
11958 which refers to a single IPP Printer object.
11960 The generic schema is a subset of IPP Printer Job Template and
11961 Printer Description attributes (sections 4.2 and 4.4). These
11962 attributes are identified as either RECOMMENDED or OPTIONAL for the
11963 directory entry itself. This conformance labeling is NOT the same
11964 conformance labeling applied to the attributes of IPP Printers
11965 objects. The conformance labeling in this Appendix is intended to
11966 apply to directory templates and to IPP Printer implementations that
11967 subscribe by adding one or more entries to a directory. RECOMMENDED
11968 attributes SHOULD be associated with each directory entry. OPTIONAL
11969 attributes MAY be associated with the directory entry (if known or
11970 supported). In addition, all directory entry attributes SHOULD
11971 reflect the current attribute values for the corresponding Printer
11974 The names of attributes in directory schema and entries SHOULD be the
11975 same as the IPP Printer attribute names as shown, as much as
11978 In order to bridge between the directory service and the IPP Printer
11979 object, one of the RECOMMENDED directory entry attributes is the
11980 Printer object's "printer-uri-supported" attribute. The directory
11981 client queries the "printer-uri-supported" attribute (or its
11982 equivalent) in the directory entry and then the IPP client addresses
11986 Hastings, et al. Standards Track [Page 214]
11988 RFC 2911 IPP/1.1: Model and Semantics September 2000
11991 the IPP Printer object using one of its URIs. The "uri-security-
11992 supported" attribute identifies the protocol (if any) used to secure
11995 The following attributes define the generic schema for directory
11996 entries of type PRINTER:
11998 printer-uri-supported RECOMMENDED Section 4.4.1
11999 uri-authentication-supported RECOMMENDED Section 4.4.2
12000 uri-security-supported RECOMMENDED Section 4.4.3
12001 printer-name RECOMMENDED Section 4.4.4
12002 printer-location RECOMMENDED Section 4.4.5
12003 printer-info OPTIONAL Section 4.4.6
12004 printer-more-info OPTIONAL Section 4.4.7
12005 printer-make-and-model RECOMMENDED Section 4.4.9
12006 ipp-versions-supported RECOMMENDED Section 4.4.14
12007 multiple-document-jobs-supported OPTIONAL Section 4.4.16
12008 charset-supported OPTIONAL Section 4.4.18
12010 generated-natural-language-
12011 supported OPTIONAL Section 4.4.20
12012 document-format-supported RECOMMENDED Section 4.4.22
12013 color-supported RECOMMENDED Section 4.4.26
12014 compression-supported RECOMMENDED Section 4.4.32
12015 pages-per-minute OPTIONAL Section 4.4.36
12016 pages-per-minute-color OPTIONAL Section 4.4.37
12018 finishings-supported OPTIONAL Section 4.2.6
12019 number-up-supported OPTIONAL Section 4.2.7
12020 sides-supported RECOMMENDED Section 4.2.8
12021 media-supported RECOMMENDED Section 4.2.11
12022 printer-resolution-supported OPTIONAL Section 4.2.12
12023 print-quality-supported OPTIONAL Section 4.2.13
12025 17. APPENDIX F: Differences between the IPP/1.0 and IPP/1.1 "Model and
12026 Semantics" Documents
12028 This Appendix is divided into two lists that summarize the
12029 differences between IPP/1.1 (this document) and IPP/1.0 [RFC2566].
12030 The section numbers refer to the numbers in this document which in
12031 some cases have changed from RFC 2566. When a change affects
12032 multiple sections, the item is listed once in the order of the first
12033 section affected and the remaining affected section numbers are
12042 Hastings, et al. Standards Track [Page 215]
12044 RFC 2911 IPP/1.1: Model and Semantics September 2000
12047 The first list contains extensions and clarifications and the second
12048 list contains changes in semantics or conformance. However, client
12049 and IPP object implementations of IPP/1.0 MAY implement any of the
12050 extensions and clarifications in this document.
12052 The following extensions and clarifications have been incorporated
12053 into this document:
12055 1. Section 2.1 - clarified that the term "client" can be either
12056 contained in software controlled by an end user or a part of a
12057 print server that controls devices.
12058 2. Section 2 - clarified that the term "IPP object" and "Printer
12059 object" can either be embedded in a device object or part of a
12060 print server that accepts IPP requests.
12061 3. Section 2.4 - added the description of the new "uri-
12062 authentication-supported" Printer Description attribute.
12063 4. Section 3.1.3, 3.1.6, 3.2.5.2, and 3.2.6.2 - clarified the
12064 error handling for operation attributes that have their own
12066 5. Section 3.1.3 - clarified that multiple occurrences of the
12067 same attribute in an attribute group is mal-formed. An IPP
12068 Printer MAY reject the request or choose one of the
12070 6. Section 3.1.6 - reorganized this section into sub-sections to
12071 separately describe "status-code", "status-message",
12072 "detailed-status-message", and "document-access-error"
12074 7. Section 3.1.6.1 - clarified the error status codes and their
12075 relationship to operation attributes.
12076 8. Section 3.1.6.3 - Added the OPTIONAL "detailed-status-message
12077 (text(MAX))" operation attribute to provide additional more
12078 detailed information about a response.
12079 9. Section 3.1.6.4 and 3.2.2 - Added the OPTIONAL "document-
12080 access-error (text(MAX))" operation attribute for use with
12081 Print-URI and Send-URI responses.
12082 10. Sections 3.1.7 - Added this new section to clarify returning
12083 Unsupported Attributes for all operations, including only
12084 returning attributes that were in the request. Moved the text
12085 from section 3.2.1.2 Unsupported Attributes to this section.
12086 11. Sections 3.1.7 and 4.1 - clarified the encoding of the "out-
12087 of-band" 'unsupported' and 'unknown' values.
12088 12. Section 3.1.8 - clarified that only the version number
12089 parameter will be carried forward into future major or minor
12090 versions of the protocol.
12091 13. Section 3.1.8 - relaxed the requirements to increment the
12092 major version number in future versions of the Model and
12093 Semantics document.
12098 Hastings, et al. Standards Track [Page 216]
12100 RFC 2911 IPP/1.1: Model and Semantics September 2000
12103 14. Section 3.1.9, and 3.2.5 - added the 'processing' state to the
12104 list of job states that a job can be in after a Create-Job
12106 15. Section 3.1.9 - clarified that a non-spooling Printer MAY
12107 accept zero or more subsequent jobs while processing a job and
12108 flow control them down. Subsequent create requests are
12109 rejected with the 'server-error-busy' error status.
12110 16. Section 3.2.1.1 - clarified the validation of the
12111 "compression" operation attribute and its relationship to the
12112 validation of the "document-format" attribute and returning
12113 Unsupported Attributes.
12114 17. Sections 3.2.1.1, 4.3.8, 13.1.4.16, and 13.1.4.17 - added the
12115 'client-error-compression-not-supported', 'client-error-
12116 compression-error' status codes and the 'unsupported-
12117 compression' and 'compression-error' job-state-reasons.
12118 18. Sections 3.2.1.1 and 4.3.8 - added 'unsupported-document-
12119 format' and 'document-format-error' job-state-reasons.
12120 19. Sections 3.2.2, 4.3.8 and 13.1.4.19 - added 'client-error-
12121 document-access-error' status code and 'document-access-error'
12123 20. Section 3.2.5.2 and 3.2.6.2 - clarified that the Unsupported
12124 Attributes group MUST NOT include attributes not requested in
12125 the Get-Printer-Attributes request.
12126 21. Section 3.2.6 - clarified that "limit" takes precedence over
12127 "which-jobs" and "my-jobs'.
12128 22. Section 3.2.6.2 - clarified that Get-Jobs returns
12129 'successful-ok' when no jobs to return.
12130 23. Sections 3.2.7, 3.2.8, and 3.2.9 - added the OPTIONAL Pause-
12131 Printer, Resume-Printer, and Purge-Jobs operations
12132 24. Section 3.3.1 - clarified that the authorization required for
12133 a Send-Document request MUST be the same user as the Create-
12134 Job or an operator.
12135 25. Section 3.3.1.1 - clarified that a Create-Job Send-Document
12136 with "last-document" = 'true' and no data is not an error; its
12137 a job with no documents.
12138 26. Sections 3.3.5, 3.3.6, and 3.3.7 - added the OPTIONAL Hold-
12139 Job, Release-Job, and Restart-Job operations. Clarified the
12140 Restart-Job operation so that the Printer MUST re-fetch any
12141 documents passed by-reference (Print-URI or Send-URI).
12142 27. Section 4.1 - clarified that the encoding of the out-of-band
12143 values are specified in the Encoding and Transport" document.
12144 28. Section 4.1 - Clarified that the requirement that clients MUST
12145 NOT send "out-of-band" values in requests applies only to
12146 operations defined in this document. Other operations are
12147 allowed to define "out-of-band" values that clients can
12154 Hastings, et al. Standards Track [Page 217]
12156 RFC 2911 IPP/1.1: Model and Semantics September 2000
12159 29. Sections 4.1.1 and 4.1.2 - clarified that the maximum 'text'
12160 and 'name' values of 1023 and 255 are for the
12161 'textWithoutLanguage' portion of the 'textWithLanguage' form,
12162 so that the maximum number of octets for the actual text and
12163 name data is the same for the without and with language forms;
12164 the 'naturalLanguage' part is in addition.
12165 30. Section 4.1.9 - clarified that 'mimeMediaType' values can
12166 include any parameters from the IANA Registry, not just
12167 charset parameters.
12168 31. Section 4.1.9.1 - clarified that 'application/octet-stream'
12169 auto-sensing can happen at create request time and/or
12170 job/document processing time.
12171 32. Section 4.1.9.1 - clarified that auto-sensing involves the
12172 Printer examining some number of octets of document data using
12173 an implementation-dependent method.
12174 33. Section 4.1.14 - clarified that the localization of dateTime
12175 by the client includes the time zone.
12176 34. Section 4.2 - clarified that xxx-supported have multiple
12177 keywords and/or names by adding parentheses to the table to
12178 give: (1setOf (type3 keyword | name))
12179 35. Section 4.2.2 - added the 'indefinite' keyword value to the
12180 "job-hold-until" attribute for use with the create operations
12181 and Hold-Job and Restart-Job operations.
12182 36. Section 4.2.6 - added more enum values to the "finishings" Job
12183 Template attribute.
12184 37. Section 4.2.6 - clarified that the landscape definition is a
12185 rotation of the image with respect to the medium.
12186 38. Section 4.3.7 - added that a forwarding server that cannot get
12187 any job state MAY return the job's state as 'completed',
12188 provided that it also return the new 'queued-in-device' job
12190 39. Section 4.3.7.2 - added the Partitioning of Job States section
12191 to clarify the concepts of Job Retention, Job History, and Job
12193 40. Section 4.3.8 - added 'job-data-insufficient' job state reason
12194 to indicate whether sufficient data has arrived for the
12195 document to start to be processed.
12196 41. Section 4.3.8 - added 'document-access-error' job state reason
12197 to indicate an access error of any kind.
12198 42. Section 4.3.8 - added 'job-queued-for-marker' job state reason
12199 to indicate whether the job has completed some processing and
12200 is waiting for the marker.
12201 43. Section 4.3.8 - added 'unsupported-compression' and
12202 'compression-error' job state reasons to indicate compression
12203 not supported or compression processing error after the create
12210 Hastings, et al. Standards Track [Page 218]
12212 RFC 2911 IPP/1.1: Model and Semantics September 2000
12215 44. Section 4.3.8 - added 'unsupported-document-format' and
12216 'document-format-error' job state reasons to indicate document
12217 not supported or document format processing error after the
12218 create has been accepted.
12219 45. Section 4.3.8 - added 'queued-in-device' job state reason to
12220 indicate that a job as been forwarded to a print system or
12221 device that does not provide any job status.
12222 46. Section 4.3.10 - added "job-detailed-status-messages (1setOf
12223 text(MAX)) for returning detailed error messages.
12224 47. Section 4.3.11 - added the "job-document-access-errors (1setOf
12226 48. Section 4.3.14.2 - clarified that the time recorded is the
12227 first time processing since the create operation or the
12228 Restart-Job operation.
12229 49. Section 4.3.14.2 and 4.3.14.3 - clarified that the out-of-band
12230 value 'no-value' is returned if the job has not started
12231 processing or has not completed, respectively.
12232 50. Section 4.3.14 - Added the OPTIONAL "date-time-at-creation",
12233 "date-time-at-processing", and "date-time-at-completed" Event
12234 Time Job Description attributes
12235 51. Section 4.4.3 - added the 'tls' value to "uri-security-
12236 supported" attribute.
12237 52. Section 4.4.3 - clarified "uri-security-supported" is
12238 orthogonal to Client Authentication so that 'none' does not
12239 exclude Client Authentication.
12240 53. Section 4.4.11 - simplified the "printer-state" descriptions
12241 while generalizing to allow high end devices that interpret
12242 one or more jobs while marking another. Indicated that
12243 'spool-area-full' and 'stopped-partly' "printer-state-reasons"
12244 may be used to provide further state information.
12245 54. Section 4.4.12 - added the 'moving-to-paused' keyword value to
12246 the "printer-state-reasons" attribute for use with the Pause-
12248 55. Section 4.4.12 - replaced the duplicate 'marker-supply-low'
12249 keyword with the missing 'toner-empty' keyword for the
12250 "printer-state-reasons" attribute. (This correction was also
12251 made before RFC 2566 was published).
12252 56. Section 4.4.12 - clarified 'spool-area-full' "printer-state-
12253 reasons" to include non-spooling printers to indicate when it
12254 can and cannot accept another job.
12255 57. Section 4.4.15 - added the enum values to the "operations-
12256 supported" attribute for the new operations. Clarified that
12257 the values of this attribute are encoded as any enum, namely
12259 58. Section 4.4.30 - clarified that the dateTime value of
12260 "printer-current-time" is on a "best efforts basis". If a
12261 proper date-time cannot be obtained, the implementation
12262 returns the 'no-value' out-of-band value. Also clarified that
12266 Hastings, et al. Standards Track [Page 219]
12268 RFC 2911 IPP/1.1: Model and Semantics September 2000
12271 the time zone NEED NOT be the time zone that the people near
12272 the device use and that the client SHOULD display the dateTime
12273 attributes in the user's local time.
12274 59. Sections 4.4.36 and 4.4.37 - added the OPTIONAL "pages-per-
12275 minute" and "pages-per-minute-color" Printer Description
12277 60. Section 5.1 - clarified that the client conformance
12278 requirements apply to clients controlled by an end user and
12279 clients in servers.
12280 61. Section 5.1 - clarified that any response MAY contain
12281 additional attribute groups, attributes, attribute syntaxes,
12282 or attribute values.
12283 62. Section 5.1 - clarified that a client SHOULD do its best to
12284 prevent a channel from being closed by a lower layer when the
12285 channel is flow controlled off by the IPP Printer.
12286 63. Section 5.2 - clarified that the IPP object requirements apply
12287 to objects embedded in devices or that are parts of servers.
12288 64. Section 5.2.2 - clarified that IPP objects MAY return
12289 operation responses that contain attribute groups, attribute
12290 names, attribute syntaxes, attribute values, and status codes
12291 that are extensions to this standard.
12292 65. Section 6 - changed the terminology of "private extensions" to
12293 "vendor extensions" and indicated that they are registered
12294 with IANA along with IETF standards track extensions.
12295 66. Section 6.7 - inserted this section on registering out-of-band
12296 attribute values with IANA as extensions.
12297 67. Section 8.3 - clarified the use of URIs for each Client
12298 Authentication mechanism.
12299 68. Section 8.5 - added the security discussion around the new
12300 operator/administrator operations.
12301 69. Section 13.1.4.16 - added client-error-compression-not-
12303 70. Section 13.1.4.17 - added client-error-compression-error
12305 71. Section 13.1.4.18 - added client-error-document-format-error
12307 72. Section 13.1.4.19 - added client-error-document-access-error
12309 73. Section 13.1.5.10 - added server-error-multiple-document-
12310 jobs-not-supported (0x0509)
12311 74. Section 14 - added 'a-white', 'b-white', 'c-white', 'd-white',
12312 and 'e-white' and clarified that the existing 'a', 'b', 'c',
12313 'd', and 'e' values are size values. Added American,
12314 Japanese, and European Engineering sizes, filled out
12315 -transparent and - translucent media names and drawings for
12316 the synchro cut sizes.
12322 Hastings, et al. Standards Track [Page 220]
12324 RFC 2911 IPP/1.1: Model and Semantics September 2000
12327 75. Section 16 - softened the RECOMMENDATION for IPP Printer
12328 attributes in a Directory schema so that they can have
12330 76. Section 16 - added the OPTIONAL "pages-per-minute" and
12331 "pages-per-minute-color" Printer attributes to the Directory
12333 77. Section 16 - added OPTIONAL "multiple-document-jobs-supported"
12334 to the Directory schema.
12335 78. Section 16 - added RECOMMENDED "uri-authentication-supported",
12336 "ipp-versions-supported", and "compression-supported" to the
12339 The following changes in semantics and/or conformance have been
12340 incorporated into this document:
12342 1. Section 3.1.6.3 - allowed a Printer to localize the
12343 "detailed-status-message" operation response attribute, but
12344 indicated that such localization might obscure the technical
12345 meaning of such messages.
12346 2. Section 3.1.8, 5.2.4, and 13.1.5.4 - Clients and IPP objects
12347 MUST support version 1.1 conformance requirements. It is
12348 recommended that they interoperate with 1.0. Also clarified
12349 that IPP Printers MUST accept '1.1' requests. It is
12350 recommended that they also accept '1.x' requests.
12352 3. Section 3.2.1.1 and section 4.4.32 - changed the "compression"
12353 operation and the "compression-supported" Printer Description
12354 attribute from OPTIONAL to REQUIRED.
12355 4. Sections 3.2.1.2 and 4.3.8 - changed "job-state-reasons" from
12356 RECOMMENDED to REQUIRED, so that "job-state-reasons" MUST be
12357 returned in create operation responses.
12358 5. Sections 3.2.4, 3.3.1, 4.4.16, and 16 - changed Create-
12359 Job/Send-Document so that they MAY be implemented while only
12360 supporting one document jobs. Added the "multiple-document-
12361 jobs-supported" boolean Printer Description attribute to
12362 indicate whether Create-Job/Send-Document support multiple
12363 document jobs or not. Added to the Directory schema.
12364 6. Section 4.1.9 - deleted 'text/plain; charset=iso-10646-ucs-2',
12365 since binary is not legal with the 'text' type.
12366 7. Section 4.1.9.1 - added the RECOMMENDATION that a Printer
12367 indicate by printing on the job's job-start-sheet that auto-
12368 sensing has occurred and what document format was auto-sensed.
12369 8. Section 4.2.4 - indicated that the "multiple-document-
12370 handling" Job Template attribute MUST be supported with at
12371 least one value if the Printer supports multiple documents per
12378 Hastings, et al. Standards Track [Page 221]
12380 RFC 2911 IPP/1.1: Model and Semantics September 2000
12383 9. Section 4.3.7.2 - indicated that the 'job-restartable' job
12384 state reason SHOULD be supported if the Restart-Job operation
12386 10. Section 4.3.8 - changed "job-state-reasons" from RECOMMENDED
12388 11. Section 4.3.8 - clarified the conformance of the values of the
12389 "job-state-reasons" attribute by copying conformance
12390 requirements from other sections of the document so that it is
12391 clear from reading the definition of "job-state-reasons" which
12392 values MUST or SHOULD be supported. The 'none',
12393 'unsupported-compression', and 'unsupported-document-format'
12394 values MUST be supported. The 'job-hold-until-specified'
12395 SHOULD be specified if the "job-hold-until" Job Template is
12396 supported. The following values SHOULD be supported: 'job-
12397 canceled-by-user', 'aborted-by-system', and 'job-completed-
12399 'job-canceled-by-operator' SHOULD be supported if the
12400 implementation permits canceling by other than the job owner.
12401 The 'job-canceled-at-device' SHOULD be supported if the device
12402 supports canceling jobs at the console. The 'job-completed-
12403 with-warnings' SHOULD be supported, if the implementation
12404 detects warnings. The 'job-completed-with-errors' SHOULD be
12405 supported if the implementation detects errors. The 'job-
12406 restartable' SHOULD be supported if the Restart-Job operation
12408 12. Section 4.3.10 - allowed a Printer to localize the "job-
12409 detailed-status-message" Job Description attribute, but
12410 indicated that such localization might obscure the technical
12411 meaning of such messages.
12412 13. Section 4.3.14 - changed the "time-at-creation", "time-at-
12413 processing", and "time-at-completed" Event Time Job
12414 Description attributes from OPTIONAL to REQUIRED.
12415 14. Section 4.3.14.4 - added the REQUIRED "job-printer-up-time
12416 (integer(1:MAX))" Job Description attribute as an alias for
12417 "printer-up-time" to reduce number of operations to get job
12419 15. Section 4.4.2 - added the REQUIRED "uri-authentication-
12420 supported (1setOf type2 keyword)" Printer Description
12421 attribute to describe the Client Authentication used by each
12423 16. Section 4.4.12 - changed "printer-state-reasons" Printer
12424 Description attribute from OPTIONAL to REQUIRED.
12425 17. Section 4.4.12 - changed 'paused' value of "printer-state-
12426 reasons" to MUST if Pause-Printer operation is supported.
12434 Hastings, et al. Standards Track [Page 222]
12436 RFC 2911 IPP/1.1: Model and Semantics September 2000
12439 18. Section 4.4.14 - added the REQUIRED "ipp-versions-supported
12440 (1setOf keyword)" Printer Description attribute, since IPP/1.1
12441 Printers do not have to support version '1.0' conformance
12442 requirements. Section 4.4.16 - added the "multiple-document-
12443 jobs-supported (boolean)" Printer Description attribute so
12444 that a client can tell whether a Printer that supports
12445 Create-Job/Send-Document supports multiple document jobs or
12446 not. This attribute is REQUIRED if the Create-Job operation
12448 19. Section 4.4.24 - changed the "queued-job-count" Printer
12449 Description attribute from RECOMMENDED to REQUIRED.
12450 20. Section 4.4.32 - changed "compression-supported (1setOf type3
12451 keyword)" Printer Description attribute from OPTIONAL to
12453 21. Section 5.1 - changed the client security requirements from
12454 RECOMMENDED non-standards track SSL3 to MUST support Client
12455 Authentication as defined in the IPP/1.1 Encoding and
12456 Transport document [RFC2910]. A client SHOULD support
12457 Operation Privacy and Server Authentication as defined in the
12458 IPP/1.1 Encoding and Transport document [RFC2910].
12459 22. Section 5.2.7 - changed the IPP object security requirements
12460 from OPTIONAL non-standards track SSL3 to SHOULD contain
12461 support for Client Authentication as defined in the IPP/1.1
12462 Encoding and Transport document [RFC2910]. A Printer
12463 implementation MAY allow an administrator to configure the
12464 Printer so that all, some, or none of the users are
12465 authenticated. An IPP Printer implementation SHOULD contain
12466 support for Operation Privacy and Server Authentication as
12467 defined in the IPP/1.1 Encoding and Transport document
12468 [RFC2910]. A Printer implementation MAY allow an
12469 administrator to configure the degree of support for Operation
12470 Privacy and Server Authentication. Security MUST NOT be
12471 compromised when the client supplies a lower version-number in
12473 23. Section 14 (Appendix C): Corrected typo, changing the keyword
12474 'iso-10-white' to 'iso-a10-white'.
12476 See also the "IPP/1.1 Encoding and Transport" [RFC2910] document for
12477 differences between IPP/1.0 [RFC2565] and IPP/1.1 [RFC2910].
12490 Hastings, et al. Standards Track [Page 223]
12492 RFC 2911 IPP/1.1: Model and Semantics September 2000
12495 18. Full Copyright Statement
12497 Copyright (C) The Internet Society (2000). All Rights Reserved.
12499 This document and translations of it may be copied and furnished to
12500 others, and derivative works that comment on or otherwise explain it
12501 or assist in its implementation may be prepared, copied, published
12502 and distributed, in whole or in part, without restriction of any
12503 kind, provided that the above copyright notice and this paragraph are
12504 included on all such copies and derivative works. However, this
12505 document itself may not be modified in any way, such as by removing
12506 the copyright notice or references to the Internet Society or other
12507 Internet organizations, except as needed for the purpose of
12508 developing Internet standards in which case the procedures for
12509 copyrights defined in the Internet Standards process must be
12510 followed, or as required to translate it into languages other than
12513 The limited permissions granted above are perpetual and will not be
12514 revoked by the Internet Society or its successors or assigns.
12516 This document and the information contained herein is provided on an
12517 "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING
12518 TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING
12519 BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION
12520 HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF
12521 MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
12525 Funding for the RFC Editor function is currently provided by the
12546 Hastings, et al. Standards Track [Page 224]