the printer working groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · the printer...

127
® The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer Working Group. All rights reserved. IPP System Service v1.0 (SYSTEM) Status: Interim Abstract: This document defines an IPP System Service binding of the PWG Semantic Model root System object and associated System Control Service that are defined in (PWG 5108.06) and the PWG Resource Service that is defined in (PWG 5108.03). This document defines IPP objects, operations, and attributes to support management and status monitoring of all configured Services, Subunits, and Resources on an Imaging System. This document also defines IPP operations and attributes to support registration of an IPP System, through its IPP Proxy, with one or more Cloud Imaging Systems. This document is technically aligned with the abstract PWG Cloud Imaging Requirements and Model (PWG 5109.1) and concrete PWG IPP Shared Infrastructure Extensions (PWG 5100.18). This document is a PWG Working Draft. For a definition of a "PWG Working Draft", see: http://ftp.pwg.org/pub/pwg/general/pwg-process30.pdf This document is available electronically at: http://ftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-2016112901 .pdf Field Code Changed

Upload: others

Post on 23-Jun-2020

2 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

®

The Printer Working Group

29 November 2016 Working Draft

Copyright © 2014-2016 The Printer Working Group. All rights reserved.

IPP System Service v1.0 (SYSTEM)

Status: Interim

Abstract: This document defines an IPP System Service binding of the PWG Semantic Model root System object and associated System Control Service that are defined in (PWG 5108.06) and the PWG Resource Service that is defined in (PWG 5108.03). This document defines IPP objects, operations, and attributes to support management and status monitoring of all configured Services, Subunits, and Resources on an Imaging System. This document also defines IPP operations and attributes to support registration of an IPP System, through its IPP Proxy, with one or more Cloud Imaging Systems. This document is technically aligned with the abstract PWG Cloud Imaging Requirements and Model (PWG 5109.1) and concrete PWG IPP Shared Infrastructure Extensions (PWG 5100.18).

This document is a PWG Working Draft. For a definition of a "PWG Working Draft", see:

http://ftp.pwg.org/pub/pwg/general/pwg-process30.pdf

This document is available electronically at:

http://ftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-2016112901.pdfField Code Changed

Page 2: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 2 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

Copyright © 2014-2016 The Printer Working Group. All rights reserved. 1

This document may be copied and furnished to others, and derivative works that comment 2 on, or otherwise explain it or assist in its implementation may be prepared, copied, 3 published and distributed, in whole or in part, without restriction of any kind, provided that 4 the above copyright notice, this paragraph and the title of the Document as referenced 5 below are included on all such copies and derivative works. However, this document itself 6 may not be modified in any way, such as by removing the copyright notice or references to 7 the IEEE-ISTO and the Printer Working Group, a program of the IEEE-ISTO. 8

Title: IPP System Service v1.0 (SYSTEM) 9

The IEEE-ISTO and the Printer Working Group DISCLAIM ANY AND ALL WARRANTIES, 10 WHETHER EXPRESS OR IMPLIED INCLUDING (WITHOUT LIMITATION) ANY IMPLIED 11 WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. 12

The Printer Working Group, a program of the IEEE-ISTO, reserves the right to make 13 changes to the document without further notice. The document may be updated, replaced 14 or made obsolete by other documents at any time. 15

The IEEE-ISTO takes no position regarding the validity or scope of any intellectual 16 property or other rights that might be claimed to pertain to the implementation or use of the 17 technology described in this document or the extent to which any license under such rights 18 might or might not be available; neither does it represent that it has made any effort to 19 identify any such rights. 20

The IEEE-ISTO invites any interested party to bring to its attention any copyrights, patents, 21 or patent applications, or other proprietary rights which may cover technology that may be 22 required to implement the contents of this document. The IEEE-ISTO and its programs 23 shall not be responsible for identifying patents for which a license may be required by a 24 document and/or IEEE-ISTO Industry Group Standard or for conducting inquiries into the 25 legal validity or scope of those patents that are brought to its attention. Inquiries may be 26 submitted to the IEEE-ISTO by e-mail at: [email protected]. 27

The Printer Working Group acknowledges that the IEEE-ISTO (acting itself or through its 28 designees) is, and shall at all times, be the sole entity that may authorize the use of 29 certification marks, trademarks, or other special designations to indicate compliance with 30 these materials. 31

Use of this document is wholly voluntary. The existence of this document does not imply 32 that there are no other ways to produce, test, measure, purchase, market, or provide other 33 goods and services related to its scope. 34 35

Page 3: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 3 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

About the IEEE-ISTO 36

The IEEE-ISTO is a not-for-profit corporation offering industry groups an innovative and 37 flexible operational forum and support services. The IEEE-ISTO provides a forum not only 38 to develop standards, but also to facilitate activities that support the implementation and 39 acceptance of standards in the marketplace. The organization is affiliated with the IEEE 40 (http://www.ieee.org/) and the IEEE Standards Association (http://standards.ieee.org/). 41

For additional information regarding the IEEE-ISTO and its industry programs visit: 42

http://www.ieee-isto.org 43

About the IEEE-ISTO PWG 44

The Printer Working Group (or PWG) is a Program of the IEEE Industry Standards and 45 Technology Organization (ISTO) with member organizations including printer 46 manufacturers, print server developers, operating system providers, network operating 47 system providers, network connectivity vendors, and print management application 48 developers. The group is chartered to make printers and the applications and operating 49 systems supporting them work together better. All references to the PWG in this 50 document implicitly mean “The Printer Working Group, a Program of the IEEE ISTO.” In 51 order to meet this objective, the PWG will document the results of their work as open 52 standards that define print related protocols, interfaces, procedures and conventions. 53 Printer manufacturers and vendors of printer related software will benefit from the 54 interoperability provided by voluntary conformance to these standards. 55

In general, a PWG standard is a specification that is stable, well understood, and is 56 technically competent, has multiple, independent and interoperable implementations with 57 substantial operational experience, and enjoys significant public support. 58

For additional information regarding the Printer Working Group visit: 59

http://www.pwg.org 60

Contact information: 61

The Printer Working Group 62 c/o The IEEE Industry Standards and Technology Organization 63 445 Hoes Lane 64 Piscataway, NJ 08854 65 USA 66

67

Page 4: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 4 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

About the Internet Printing Protocol Work Group 68

The Internet Printing Protocol (IPP) working group has developed a modern, full-featured 69 network printing protocol, which is the industry standard. IPP allows a print client to query 70 a printer for its supported capabilities, features, and parameters to allow the selection of an 71 appropriate printer for each print job. IPP also provides job information prior to, during, and 72 at the end of job processing. 73

For additional information regarding IPP visit: 74

http://www.pwg.org/ipp/ 75

Implementers of this specification are encouraged to join the IPP mailing list in order to 76 participate in any discussions of the specification. Suggested additions, changes, or 77 clarification to this specification, should be sent to the IPP mailing list for consideration. 78

79

Page 5: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 5 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

Table of Contents 80

1. Introduction .................................................................................................................... 11 81 1.1 Rationale for two IPP Protocol Endpoints ................................................................. 11 82 1.2 Get-Printer-Attributes Extension ............................................................................... 11 83 1.3 Printer Identifier Extension ....................................................................................... 11 84

2. Terminology ................................................................................................................... 12 85 2.1 Conformance Terminology ....................................................................................... 12 86 2.2 Protocol Role Terminology ....................................................................................... 13 87 2.3 Printing Terminology................................................................................................. 14 88 2.4 Abbreviations ............................................................................................................ 17 89

3. Requirements for the IPP System Service ..................................................................... 18 90 3.1 Rationale for the IPP System Service....................................................................... 18 91 3.2 Use Cases ................................................................................................................ 19 92

3.2.1 Imaging System Service Enumeration ............................................................... 19 93 3.2.2 Imaging System Monitoring ............................................................................... 19 94 3.2.3 Imaging System Management ........................................................................... 19 95 3.2.4 Resource Management ...................................................................................... 20 96 3.2.5 Bootstrap Client Access to Default Print Service ............................................... 20 97

3.3 Exceptions ................................................................................................................ 20 98 3.4 Out of Scope ............................................................................................................ 20 99 3.5 Design Requirements ............................................................................................... 20 100

4. IPP Object Model ........................................................................................................... 21 101 4.1 System Object .......................................................................................................... 21 102 4.2 Subunit Object .......................................................................................................... 21 103 4.3 Printer Object ........................................................................................................... 21 104 4.4 Job Object ................................................................................................................ 21 105 4.5 Document Object ...................................................................................................... 22 106 4.6 Resource Object ....................................................................................................... 22 107

4.6.1 Resource History ............................................................................................... 23 108 4.7 Subscription Object .................................................................................................. 23 109

5. IPP Objects and Operations Summary .......................................................................... 24 110 5.1 System Attribute Group ............................................................................................ 25 111 5.2 System Description Attributes .................................................................................. 25 112 5.3 System Status Attributes .......................................................................................... 26 113 5.4 System Operations ................................................................................................... 27 114 5.5 Resource Attribute Group ......................................................................................... 30 115 5.6 Resource Description Attributes ............................................................................... 30 116 5.7 Resource Status Attributes ....................................................................................... 30 117 5.8 Printer Description Attributes .................................................................................... 32 118 5.9 Printer Status Attributes ............................................................................................ 32 119 5.10 Job Status Attributes .............................................................................................. 33 120

6. IPP Operations ............................................................................................................... 34 121 6.1 Printer Operations .................................................................................................... 34 122

6.1.1 Allocate-Printer-Resources ................................................................................ 34 123 6.1.2 Create-Printer .................................................................................................... 34 124 6.1.3 Deallocate-Printer-Resources ............................................................................ 37 125

Page 6: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 6 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

6.1.4 Delete-Printer ..................................................................................................... 37 126 6.1.5 Get-Printers ....................................................................................................... 38 127 6.1.6 Get-Printer-Attributes ......................................................................................... 40 128 6.1.7 Shutdown-One-Printer ....................................................................................... 43 129 6.1.8 Startup-One-Printer ............................................................................................ 44 130

6.2 Resource Operations................................................................................................ 45 131 6.2.1 Cancel-Resource ............................................................................................... 45 132 6.2.2 Create-Resource................................................................................................ 47 133 6.2.3 Get-Resources ................................................................................................... 50 134 6.2.4 Get-Resource-Attributes .................................................................................... 50 135 6.2.5 Install-Resource ................................................................................................. 50 136 6.2.6 Send-Resource-Data ......................................................................................... 51 137 6.2.7 Set-Resource-Attributes ..................................................................................... 51 138

6.3 Subscription Operations ........................................................................................... 52 139 6.3.1 Create-Resource-Subscriptions ......................................................................... 52 140 6.3.2 Create-System-Subscriptions ............................................................................ 53 141

6.4 System Operations ................................................................................................... 54 142 6.4.1 Disable-All-Printers ............................................................................................ 54 143 6.4.2 Enable-All-Printers ............................................................................................. 55 144 6.4.3 Get-System-Attributes ........................................................................................ 56 145 6.4.4 Get-System-Supported-Values .......................................................................... 56 146 6.4.5 Pause-All-Printers .............................................................................................. 56 147 6.4.6 Pause-All-Printers-After-Current-Job ................................................................. 57 148 6.4.7 Register-Output-Device ..................................................................................... 57 149 6.4.8 Restart-System .................................................................................................. 57 150 6.4.9 Resume-All-Printers ........................................................................................... 57 151 6.4.10 Set-System-Attributes ...................................................................................... 58 152 6.4.11 Shutdown-All-Printers ...................................................................................... 58 153 6.4.12 Startup-All-Printers ........................................................................................... 59 154

7. IPP Attributes ................................................................................................................. 61 155 7.1 IPP Operation Attributes ........................................................................................... 61 156

7.1.1 printer-id (integer(1:MAX)) ................................................................................. 61 157 7.1.2 printer-ids (1setOf (integer(1:MAX))) .................................................................. 61 158 7.1.3 printer-geo-location (uri) ..................................................................................... 61 159 7.1.4 printer-location (text(127)) .................................................................................. 61 160 7.1.5 printer-service-type (1setOf (type2 keyword)) .................................................... 61 161 7.1.6 requesting-user-vcard (1setOf text(1023)) ......................................................... 62 162 7.1.7 resource-format (1setOf (mimeMediaType)) ...................................................... 62 163 7.1.8 resource-id (integer(1:MAX)).............................................................................. 62 164 7.1.9 resource-ids (1setOf integer(1:MAX)) ................................................................ 62 165 7.1.10 resource-k-octets (integer(0:MAX)) .................................................................. 62 166 7.1.11 resource-state (type1 enum) ............................................................................ 63 167 7.1.12 resource-type (type2 keyword)......................................................................... 63 168 7.1.13 system-uri (uri) ................................................................................................. 63 169 7.1.14 which-printers (type2 keyword): ....................................................................... 63 170

7.2 System Description Attributes .................................................................................. 64 171

Page 7: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 7 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

7.2.1 Power States and Policies ................................................................................. 64 172 7.2.2 charset-configured (charset) .............................................................................. 68 173 7.2.3 charset-supported (1setOf charset) ................................................................... 68 174 7.2.4 ipp-versions-supported (1setOf type2 keyword)................................................. 68 175 7.2.5 natural-language-configured (naturalLanguage) ................................................ 68 176 7.2.6 generated-natural-language-supported (1setOf naturalLanguage) .................... 68 177 7.2.7 operations-supported (1setOf type2 enum) ....................................................... 69 178 7.2.8 power-calendar-policy-col (1setOf collection) .................................................... 69 179 7.2.9 power-event-policy-col (1setOf collection) ......................................................... 71 180 7.2.10 power-timeout-policy-col (1setOf collection) .................................................... 72 181 7.2.11 printer-creation-attributes-supported (1setOf type2 keyword) .......................... 73 182 7.2.12 resource-settable-attributes-supported (1setOf type2 keyword) ...................... 73 183 7.2.13 system-current-time (dateTime) ....................................................................... 73 184 7.2.14 system-default-printer-id (integer (1:MAX) | no-value) ..................................... 73 185 7.2.15 system-device-id (text(1023))........................................................................... 74 186 7.2.16 system-geo-location (uri | unknown) ................................................................ 74 187 7.2.17 system-info (text(127)) ..................................................................................... 74 188 7.2.18 system-location (text(127)) .............................................................................. 74 189 7.2.19 system-mandatory-printer-attributes (1setOf type2 keyword) .......................... 74 190 7.2.20 system-make-and-model (text(127)) ................................................................ 75 191 7.2.21 system-message-from-operator (text(127)) ..................................................... 75 192 7.2.22 system-name (name(127)) ............................................................................... 75 193 7.2.23 system-owner-col (collection)........................................................................... 75 194 7.2.24 system-settable-attributes-supported (1setOf type2 keyword) ......................... 76 195 7.2.25 system-strings-languages-supported (1setOf naturalLanguage) ..................... 76 196 7.2.26 system-strings-uri (uri | no-value) ..................................................................... 76 197 7.2.27 system-xri-supported (1setOf collection) .......................................................... 76 198

7.3 System Status Attributes .......................................................................................... 78 199 7.3.1 power-log-col (1setOf collection)........................................................................ 78 200 7.3.2 power-state-capabilities-col (1setOf collection) .................................................. 79 201 7.3.3 power-state-counters-col (1setOf collection) ...................................................... 80 202 7.3.4 power-state-monitor-col (collection) ................................................................... 80 203 7.3.5 power-state-transitions-col (1setOf collection) ................................................... 82 204 7.3.6 system-config-change-date-time (dateTime) ..................................................... 82 205 7.3.7 system-config-change-time (integer(0:MAX)) .................................................... 83 206 7.3.8 system-config-changes (integer(0:MAX)) ........................................................... 83 207 7.3.9 system-configured-printers (1setOf collection) ................................................... 83 208 7.3.10 system-configured-resources (1setOf collection) ............................................. 84 209 7.3.11 system-serial-number (text(255)) ..................................................................... 86 210 7.3.12 system-state (type1 enum) .............................................................................. 86 211 7.3.13 system-state-change-date-time (dateTime) ..................................................... 86 212 7.3.14 system-state-change-time (integer(0:MAX)) .................................................... 86 213 7.3.15 system-state-message (1setOf (text(MAX))) .................................................... 86 214 7.3.16 system-state-reasons (1setOf type2 keyword) ................................................ 86 215 7.3.17 system-up-time (integer(1:MAX)) ..................................................................... 87 216 7.3.18 system-uuid (uri(45)) ........................................................................................ 87 217

Page 8: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 8 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

7.4 Printer Description Attributes .................................................................................... 87 218 7.4.1 printer-owner-col (collection) .............................................................................. 87 219

7.5 Printer Status Attributes ............................................................................................ 87 220 7.5.1 printer-config-changes (integer(0:MAX)) ............................................................ 87 221 7.5.2 printer-id (integer(1:MAX)) ................................................................................. 88 222 7.5.3 printer-service-type (type2 keyword) .................................................................. 88 223

7.6 Resource Description Attributes ............................................................................... 88 224 7.6.1 resource-info (text(127)) .................................................................................... 88 225 7.6.2 resource-name (name(127)) .............................................................................. 89 226 7.6.3 resource-owner-col (collection) .......................................................................... 89 227

7.7 Resource Status Attributes ....................................................................................... 89 228 7.7.1 date-time-at-canceled (dateTime) ...................................................................... 89 229 7.7.2 date-time-at-creation (dateTime)........................................................................ 89 230 7.7.3 date-time-at-installed (dateTime) ....................................................................... 90 231 7.7.4 resource-data-uri (uri | no-value)) ...................................................................... 90 232 7.7.5 resource-format (mimeMediaType) .................................................................... 90 233 7.7.6 resource-id (integer(1:MAX)).............................................................................. 90 234 7.7.7 resource-k-octets (integer(0:MAX)) .................................................................... 90 235 7.7.8 resource-state (type1 enum) .............................................................................. 90 236 7.7.9 resource-state-message (text(MAX)) ................................................................. 92 237 7.7.10 resource-state-reasons (1setOf type2 keyword) .............................................. 92 238 7.7.11 resource-string-version (text(127)) ................................................................... 92 239 7.7.12 resource-type (type2 keyword)......................................................................... 92 240 7.7.13 resource-use-count (integer(0:MAX)) ............................................................... 93 241 7.7.14 resource-uuid (uri(45)) ..................................................................................... 93 242 7.7.15 resource-version (octetString(16)) ................................................................... 93 243 7.7.16 time-at-canceled (integer(MIN:MAX)) .............................................................. 93 244 7.7.17 time-at-creation (integer(MIN:MAX)) ................................................................ 94 245 7.7.18 time-at-installed (integer(MIN:MAX)) ................................................................ 94 246

7.8 Job Status Attributes ................................................................................................ 94 247 7.8.1 job-owner-col (collection) ................................................................................... 94 248

8. Additional Semantics for Existing Operations ................................................................ 95 249 8.1 Cancel-Subscription, Get-Notifications, and Renew-Subscription: system-uri (uri) and 250 resource-id (integer(1:MAX)) .......................................................................................... 95 251 8.2 Get-Printer-Attributes: printer-resource-ids (1setOf integer(1:MAX)) ........................ 95 252 8.3 Create-Job, Get-Job-Attributes: job-resource-ids (1setOf integer(1:MAX)) .............. 95 253

9. Additional Values for Existing Attributes......................................................................... 95 254 9.1 notify-events (1setOf type2 keyword) ....................................................................... 95 255

10. Conformance Requirements ........................................................................................ 96 256 10.1 Conformance Requirements for Clients .................................................................. 96 257 10.2 Conformance Requirements for Infrastructure Systems ......................................... 96 258 10.3 Conformance Requirements for Systems ............................................................... 96 259

11. Internationalization Considerations .............................................................................. 96 260 12. Security Considerations ............................................................................................... 97 261 13. IANA and PWG Considerations ................................................................................... 97 262 14. References ................................................................................................................... 97 263

Page 9: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 9 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

14.1 Normative References ............................................................................................ 97 264 14.2 Informative References ........................................................................................ 101 265

15. Authors' Addresses .................................................................................................... 102 266 16. Appendix A – Rationale for Design Choices .............................................................. 103 267

16.1 Resource Object ................................................................................................... 103 268 16.1.1 Move Resource Service operations into System Service ............................... 103 269 16.1.2 Remove some Resource operations .............................................................. 103 270 16.1.3 Decompose some Resource operations ........................................................ 103 271 16.1.4 Replace Resource lease with Resource state................................................ 104 272

17. Change History .......................................................................................................... 105 273 17.1 29 November 2016 ............................................................................................... 105 274 17.2 1 November 2016 ................................................................................................. 106 275 17.3 18 October 2016 ................................................................................................... 107 276 17.4 4 October 2016 ..................................................................................................... 107 277 17.5 15 September 2016 .............................................................................................. 107 278 17.6 18 August 2016 .................................................................................................... 110 279 17.7 10 August 2016 .................................................................................................... 111 280 17.8 20 July 2016 ......................................................................................................... 112 281 17.9 6 July 2016 ........................................................................................................... 112 282 17.10 23 June 2016 ...................................................................................................... 114 283 17.11 12 June 2016 ...................................................................................................... 115 284 17.12 9 May 2016 ......................................................................................................... 116 285 17.13 8 May 2016 ......................................................................................................... 116 286 17.14 25 April 2016 ...................................................................................................... 117 287 17.15 28 February 2016 ............................................................................................... 118 288 17.16 17 January 2016 ................................................................................................. 118 289 17.17 6 December 2015 ............................................................................................... 119 290 17.18 2 November 2015 ............................................................................................... 119 291 17.19 18 October 2015 ................................................................................................. 120 292 17.20 20 September 2015 ............................................................................................ 120 293 17.21 31 August 2015 .................................................................................................. 121 294 17.22 10 August 2015 .................................................................................................. 122 295 17.23 28 April 2015 ...................................................................................................... 123 296 17.24 15 March 2015.................................................................................................... 124 297 17.25 2 November 2014 ............................................................................................... 125 298 17.26 24 August 2014 .................................................................................................. 126 299 17.27 11 August 2014 .................................................................................................. 127 300

301

Page 10: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 10 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

List of Figures 302

Figure 1 – IPP Resource Object Life Cycle ........................................................................ 91 303

304

305

List of Tables 306

Table 1 – IPP System Description Attributes ..................................................................... 25 307 Table 2 – IPP System Status Attributes ............................................................................. 26 308 Table 3 – IPP System Service Operations ......................................................................... 28 309 Table 4 – IPP Resource Description Attributes .................................................................. 30 310 Table 5 – IPP Resource Status Attributes .......................................................................... 31 311 Table 6 – IPP Printer Description Attributes ....................................................................... 32 312 Table 7 – IPP Printer Status Attributes .............................................................................. 32 313 Table 8 – IPP Job Status Attributes ................................................................................... 33 314 Table 9 – Recommended-to-Supply Printer Creation Attributes ........................................ 74 315 Table 10 – Member Attributes of system-configured-printers............................................. 83 316 Table 11 – Member attributes of system-configured-resources ......................................... 84 317 318

319

Page 11: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 11 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

1. Introduction 320

This document defines an IPP System Service binding of the PWG Semantic Model root 321 System object and associated System Control Service that are defined in [PWG 5108.06] 322 and the PWG Resource Service that is defined in [PWG5108.03]. This document defines 323 IPP objects, operations, and attributes to support management and status monitoring of all 324 configured Services, Subunits, and Resources on an Imaging System. This document 325 also defines IPP operations and attributes to support registration of an IPP System, 326 through its IPP Proxy, with one or more Cloud Imaging Systems. This document is 327 technically aligned with the abstract PWG Cloud Imaging Requirements and Model 328 [PWG5109.1] and concrete PWG IPP Shared Infrastructure Extensions [PWG5100.18]. 329

1.1 Rationale for two IPP Protocol Endpoints 330

This document defines the IPP System object that represents the IPP System Service. 331 The IPP operations on this System object and the IPP attributes defined for this System 332 object are disjoint from those defined for the Printer object in [RFC2911]. An IPP Imaging 333 System that conforms to this document supports both an IPP System object and (via a 334 System response to the Get-Printers operation) one or more IPP Printer objects, each of 335 which has a separate IPP Protocol Endpoint – i.e., separate values of IPP URI [RFC3510] 336 or IPPS URI [RFC7472]. 337

1.2 Get-Printer-Attributes Extension 338

For the convenience of existing IPP Clients, this document also includes the original Get-339 Printer-Attributes operation defined in IPP/1.1 Model and Semantics [RFC2911] with an 340 extension to automatically select the implementation-defined or site-defined “default” IPP 341 Printer object, unless the IPP Client explicitly specifies a given target Printer object in the 342 Get-Printer-Attributes request. 343

1.3 Printer Identifier Extension 344

This document defines a new IPP attribute “printer-id” that contains an integer unique 345 identifier for each Printer object within the IPP Imaging System. This extension simplifies 346 references to Printer objects, each of which can potentially support multiple Protocol 347 Endpoints in “printer-xri-supported” with different Client authentication and Printer security 348 policies. The use of a “printer-uri” operation attribute to identify a Printer object therefore 349 has some ambiguity about available operations and attributes via a specific Protocol 350 Endpoint. 351 352

Page 12: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 12 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

2. Terminology 353

2.1 Conformance Terminology 354

Capitalized terms, such as MUST, MUST NOT, RECOMMENDED, REQUIRED, SHOULD, 355 SHOULD NOT, MAY, and OPTIONAL, have special meaning relating to conformance as 356 defined in Key words for use in RFCs to Indicate Requirement Levels [RFC2119]. The 357 term CONDITIONALLY REQUIRED is additionally defined for a conformance requirement 358 that applies to a particular capability or feature. 359

360

Page 13: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 13 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

2.2 Protocol Role Terminology 361

This document defines the following protocol roles in order to specify unambiguous 362 conformance requirements: 363

Client: Initiator of outgoing IPP session requests and sender of outgoing IPP operation 364 requests (Hypertext Transfer Protocol -- HTTP/1.1 [RFC7230] User Agent). 365

Endpoint: Any computing device that can be connected to a network. Such devices 366 normally are associated with a particular link layer address before joining the network and 367 potentially an IP address once on the network. This includes: laptops, desktops, servers, 368 cell phones, or any device that may have an IP address (or any other network layer 369 address) [RFC5209]. 370

Infrastructure Printer: A Printer that represents a Logical Device associated with both a 371 Client and Proxy [PWG5100.18]. For Cloud-based implementations, the Infrastructure 372 Printer corresponds to a Cloud Imaging Service [PWG5019.1]. 373

Infrastructure System: A System that represents an entire Imaging System and accepts 374 incoming requests and connections from both Clients and Proxies and contains zero or 375 more Infrastructure Printers [PWG5100.18]. For Cloud-based implementations, the 376 Infrastructure System corresponds to a Cloud Imaging System [PWG5019.1]. 377

Printer: Listener for incoming IPP session requests and receiver of incoming IPP 378 operation requests (Hypertext Transfer Protocol -- HTTP/1.1 [RFC7230] Server) that 379 exposes a Printer object and implements an Imaging Service. 380

Protocol Endpoint: An application interface, typically at the transport layer or session 381 layer, that supports: a) initiating outgoing connection requests and operation requests; b) 382 listening for incoming connection requests and operation requests; or c) both initiating and 383 listening. Every Client, Printer, Proxy, and System supports at least one Protocol 384 Endpoint. 385

Proxy: A Client that sends configuration and status information to and retrieves and 386 manages Jobs and Documents from an Infrastructure Printer [PWG5100.18] on behalf of 387 one or more Output Devices and also communicates internally with an Infrastructure 388 System to register the local System and get back Infrastructure Printer URIs. 389

System: Listener for incoming IPP session requests and receiver of incoming IPP 390 operation requests (Hypertext Transfer Protocol -- HTTP/1.1 [RFC7230] Server) that 391 exposes a System object and implements a System Service. 392

393

Page 14: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 14 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

2.3 Printing Terminology 394

Normative definitions and semantics of printing terms are imported from IETF Design 395 Goals for an Internet Printing Protocol [RFC2567], IETF Printer MIB v2 [RFC3805], IETF 396 Printer Finishing MIB [RFC3806], IETF Internet Printing Protocol: Event Notifications and 397 Subscriptions [RFC3995], PWG IPP FaxOut Service [PWG5100.15], PWG IPP Scan 398 Service [PWG5100.17], PWG IPP Shared Infrastructure Extensions (INFRA) 399 [PWG5100.18], PWG MFD Model and Common Semantics [PWG5108.01], PWG Network 400 Resource Service Semantic Model and Service Interface [PWG5108.03], PWG System 401 Object and System Control Service Semantics [PWG5108.06], and IETF Internet Printing 402 Protocol/1.1: Model and Semantics [RFC2911]. 403

Administrator: An End User who is also authorized to manage all aspects of an Output 404 Device or Printer, including creating the printer instances and controlling the authorization 405 of other End Users and Operators [RFC2567]. 406

Delivery Method: The mechanism by which a System or Printer delivers an Event 407 Notification [RFC3995]. 408

Document: An object created and managed by an Imaging Service that contains the 409 description, processing, and status information. A Document object may have attached 410 data and is bound to a single Job object [RFC2911]. 411

End User: A person or software process that is authorized to perform basic printing 412 functions, including finding/locating a printer, creating a local instance of a printer, viewing 413 printer status, viewing printer capabilities, submitting a print job, viewing print job status, 414 and altering the attributes of a print job [RFC2567]. 415

Event: An occurrence (either expected or unexpected) within a System of a change of 416 state, condition, or configuration of a System, Printer, or Job. An Event occurs only at one 417 instant in time and does not span the time the physical Event takes place [RFC3995]. 418

Event Notification: The information about an Event that the Printer delivers when an Event 419 occurs [RFC3995]. 420

FaxOut Job: An object created and managed by a FaxOut Service that contains 421 description, processing, and status information. The FaxOut Job also contains zero or 422 more Document objects [PWG5100.15]. 423

FaxOut Service: An Imaging Service that accepts incoming IPP operation requests for 424 creation of FaxOut Jobs and management of FaxOut Jobs and the service itself 425 [PWG5100.15]. 426

IPP Binding: The Internet Printing Protocol implementation of an abstract information 427 model and associated set of abstract operations and data elements [RFC2911]. 428

Page 15: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 15 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

Imaging Device: A physical hardware entity (stand-alone) or logical software entity (hosted 429 on a network server) that supports one or more Imaging Services (e.g., Print, Scan, 430 FaxOut, etc.) [PWG5108.01]. 431

Imaging Service: A software entity that supports document or image processing (e.g., 432 Print, Scan, FaxOut, etc.) [PWG5108.01]. 433

Imaging System: A logical or physical system supports a System object and a System 434 Service for monitoring and management of one or more Imaging Services (e.g., Print, 435 Scan, FaxOut, etc.) [PWG5108.01]. 436

ith: Referring to a specific IPP ‘1setOf’ value - the first value, the second value, and so 437 forth. 438

Job: An object created and managed by an Imaging Service that contains the description, 439 processing, and status information. A Job object also contains zero or more Document 440 objects [RFC2911]. 441

Logical Device: a print server, software service, or gateway that processes jobs and either 442 forwards or stores the processed job or uses one or more Physical Devices to render 443 output [RFC2911]. 444

Notification: Synonym for Event Notification [RFC3995]. 445

Operator: An End User that also has special rights on the Output Device or Printer. The 446 Operator typically monitors the status of the Printer and manages and controls the Jobs at 447 the Output Device [RFC2567]. The Operator is allowed to query and control the Printer, 448 Jobs, and Documents based on site policy. 449

Output Device: a single Logical or Physical Device [PWG5100.18]. 450

Owner: The End User or Administrator who owns and manages (and typically created) a 451 Job, Printer, Resource, Subscription, or System [PWG5108.06]. 452

Physical Device: a hardware implementation of an endpoint device, e.g., a marking engine, 453 a fax modem, etc [RFC2911]. 454

Print Job: An object created and managed by a Print Service that contains description, 455 processing, and status information. The Print Job also contains zero or more Document 456 objects [RFC2911]. 457

Print Service: An Imaging Service that accepts incoming IPP operation requests for 458 creation of Print Jobs and management of Print Jobs and the service itself [PWG5108.01]. 459

Printer: Synonym for Imaging Service – an object that accepts incoming IPP operation 460 requests for creation of Imaging Jobs and management of Imaging Jobs [RFC2911]. 461

Page 16: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 16 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

Resource: A data object (e.g., firmware, font, logo, etc.) that can be configured on an 462 Imaging System for use by one or more Imaging Services and has a System, Printer, or 463 Job scope [PWG5108.01]. 464

Scan Job: An object created and managed by a Scan Service that contains description, 465 processing, and status information. The Scan Job also contains zero or more Document 466 objects [PWG5100.17]. 467

Scan Service: An Imaging Service that accepts incoming IPP operation requests for 468 creation of Scan Jobs and management of Scan Jobs and the service itself 469 [PWG5100.17]. 470

Spooling Service: An Imaging Service that stores all of a Job's document data so that it 471 can be reprocessed as needed [PWG5100.18]. 472

Streaming Service: An Imaging Service that stores some of a Job's document data as it is 473 processed, output, and/or delivered [PWG5100.18]. 474

Subscription: An object containing a set of attributes that indicate: the Notification 475 Recipient (for Push Delivery Method only), the Delivery Method, the Subscribed Events 476 that cause the Printer to deliver an Event Notification, and the information to include in an 477 Event Notification [RFC3995]. 478

Subunit: A hardware component (e.g., input tray or marker) or software component (e.g., 479 input channel or interpreter) of an Imaging System [RFC3995] [PWG5108.01]. 480

System Service: A software entity that supports management of all hardware and software 481 components of an Imaging System and the System object defined in this specification 482 [PWG5108.06]. 483

Transform Job: An object created and managed by a Transform Service that contains 484 description, processing, and status information. The Transform Job also contains zero or 485 more Document objects [PWG5108.01]. 486

Transform Service: An Imaging Service that accepts incoming IPP operation requests for 487 creation of Transform Jobs and management of Transform Jobs and the service itself 488 [PWG5108.01]. 489

490

491

Page 17: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 17 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

2.4 Abbreviations 492

IANA: Internet Assigned Numbers Authority, http://www.iana.org/ 493

IETF: Internet Engineering Task Force, http://www.ietf.org/ 494

ISO: International Organization for Standardization, http://www.iso.org/ 495

PWG: Printer Working Group, http://www.pwg.org/ 496

497

Page 18: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 18 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

3. Requirements for the IPP System Service 498

3.1 Rationale for the IPP System Service 499

Existing IPP specifications define the following features and functionality: 500

1) IPP Version 2.0, 2.1, and 2.2 [PWG5100.12] defines: 501 (a) Three profiles that cover all previous IETF and PWG IPP specifications; 502 (b) Existing Printer and Job operations and attributes required for each profile; 503 (c) Standard IPP version numbers for each profile (2.0, 2.1, and 2.2); and 504 (d) Specific interoperability requirements, such as HTTP/1.1 support with chunking 505 and IPP collection attribute support; 506

2) IPP: Job and Printer Extensions – Set 3 [PWG5100.13] defines operations and 507 attributes required for mobile printing and printing with generic drivers; 508

3) IPP Everywhere [PWG5100.14] defines an IPP extension to support network 509 printing without vendor-specific driver software, including transport protocols, 510 various discovery protocols, and standard document formats; 511

4) IPP FaxOut Service [PWG5100.15] defines an IPP extension to support the PWG 512 Semantic Model FaxOut Service [PWG5108.05] over IPP; 513

5) IPP Scan Service [PWG5100.17] defines an IPP extension to support the PWG 514 Semantic Model Scan Service [PWG5108.02] over IPP; and 515

6) IPP Shared Infrastructure Extensions [PWG5100.18] defines operations and 516 attributes required to allow IPP Printers to interface with shared services based in 517 the network infrastructure, i.e., software-defined networks, and/or through Cloud-518 based solutions to remotely obtain and process Jobs and Documents, and provide 519 state and configuration changes to those services. 520

521

Existing PWG Semantic Model specifications define the following features and 522 functionality: 523

1) PWG MFD Model and Common Semantics [PWG5801.01] defines: 524 (a) A PWG System object as the root of the PWG Semantic Model (including the 525 associated XML Schema); and 526 (b) An extension of the original PWG Semantic Model [PWG5105.1] (abstract print 527 service) to support all of the typical multifunction services (Print, Scan, FaxOut, 528 etc.); 529

2) PWG System object and System Control Service [PWG5108.05] defines the 530 elements of the PWG System object and system operations of the PWG System 531 Control Service; 532

Page 19: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 19 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

3) PWG Resource Service [PWG5108.3] defines the elements of the PWG Resource 533 object and resource operations of the PWG Resource Service; and 534

4) PWG Cloud Imaging Requirements and Model [PWG5109.1] defines an abstract 535 model to support Imaging Services using the Cloud, based on the PWG Semantic 536 Model. The IPP Binding for this abstract model is described in IPP Shared 537 Infrastructure Extensions [PWG5100.18]. 538

539

Therefore, this IPP System Service specification should define: 540

1) An IPP binding of the PWG System object; 541

2) An IPP binding of the PWG System Control Service to support management and 542 monitoring of Imaging Systems and their configured Imaging Services; and 543

3) An IPP binding of the PWG Resource object and the PWG Resource Service. 544

3.2 Use Cases 545

3.2.1 Imaging System Service Enumeration 546

Jane wants to determine what services are available on an Imaging System and their 547 capabilities. After Jane initiates service enumeration by using the IPP Client on her laptop 548 to send a query to the Imaging System for the list of available services. After receiving the 549 response from the Imaging System, the IPP Client sends further queries to each Imaging 550 Service for its capabilities and configuration. Finally, the IPP Client displays the list of 551 available Imaging Services and their capabilities. 552

3.2.2 Imaging System Monitoring 553

Jane wants to monitor the usage and supply levels of an Imaging System. She uses the 554 IPP Client on her laptop to periodically query the input trays and the supply levels of 555 relevant components on the Imaging System and the usage counters for each Imaging 556 Service supported by the Imaging System. 557

3.2.3 Imaging System Management 558

Jane needs to periodically pause and resume all of the services supported by an Imaging 559 System in order to perform maintenance. She uses the IPP Client on her laptop to send 560 pause and resume requests to the Imaging System as needed. 561

Page 20: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 20 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

3.2.4 Resource Management 562

Jane wants to install a resource (firmware, font, logo, etc.) on an Imaging System in order 563 to extend the functionality of the Imaging System. She uses the IPP Client on her laptop to 564 create and upload the desired resource to the Imaging System. 565

3.2.5 Bootstrap Client Access to Default Print Service 566

Jane sees that there’s a new network printer installed in the hall near her office that has an 567 IPv4 address written on the top (e.g., “10.1.2.3”). She wants to use that network printer, 568 but doesn’t know how to find the specific URI of a running print service on that machine. 569 She uses the IPP Client on her laptop to query the IPP System Service that listens on the 570 standard IPP port (e.g., “ipp://10.1.2.3:631”) on that machine to find the default print 571 service URI on that machine (e.g., “ipp://printer12.example.com/ipp/print”). 572

3.3 Exceptions 573

There are no exceptions to the use cases defined in section 3.2. 574

3.4 Out of Scope 575

The out-of-scope requirements for this IPP System Service specification are: 576

1) Configuration of Imaging Services directly through the System Service (e.g., 577 defaults or assigned Subunits). 578

2) Pause/Resume or Enable/Disable of a sparse list of specific Imaging Services on an 579 Imaging System (because the resulting operation status would be complicated 580 and/or ambiguous). 581

3) Migration of Imaging Services and/or Jobs to another Imaging System. 582 4) Support for any non-IPP Cloud Imaging System. 583

3.5 Design Requirements 584

The design requirements for this IPP System Service specification are: 585

1) Follow the naming conventions defined in IPP/1.1: Model and Semantics 586 [RFC2911], including keyword value case (lower) and hyphenation requirements. 587

2) Define objects, attribute groups, attributes, and values to support the System object, 588 Resource object, and System Service. 589

3) Define operations to support the System Service and the use cases defined in 590 section 3.2. 591

592

Page 21: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 21 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

4. IPP Object Model 593

This specification extends the original IPP Model defined in section 2 of IETF IPP/1.1 594 Model and Semantics [RFC2911] from the original print service scope to include all 595 Imaging Services on a managed Imaging System. 596

4.1 System Object 597

This specification defines a root object called a “System” that is an IPP binding of the 598 System object defined in PWG System object and System Control Service [PWG5108.06]. 599

This object contains: (a) description (e.g., name and manufacturer) including summaries 600 of configured services, subunits, and resources; and (b) overall status (e.g., state and 601 counters). 602

Note: Since Systems are typically long-lived objects, System Owners are mutable (i.e., 603 System Description attributes). 604

4.2 Subunit Object 605

This specification identifiesdefines a component object called a “Subunit” that is an IPP 606 binding of the Subunit object defined in PWG MFD Model and Common Semantics 607 [PWG5801.01] and is based on the Subunit (hardware or software component) defined in 608 IETF Printer MIB v2 [RFC3805]. This specification does not define any explicit System 609 object attributes to refer to Subunit objects. Instead, existing IPP Printer object attributes 610 (e.g., “printer-input-tray” defined in [PWG 5100.13]) can be used to convey information 611 about Subunit objects. 612

This object contains: (a) capabilities (e.g., max tray capacity); (b) description (e.g., name); 613 and (c) component status (e.g., state and counters). 614

4.3 Printer Object 615

This specification extends the original IPP Printer object defined in IETF IPP/1.1 Model 616 and Semantics [RFC2911] to represent any Imaging Service (print, scan, etc.), in order to 617 reuse existing IPP Printer operations and attributes in the individual Imaging Services, but 618 NOT directly in this specification. 619

Note: Since Printers are typically long-lived objects, Printer Owners are mutable (i.e., 620 Printer Description attributes). 621

4.4 Job Object 622

This specification extends the original IPP Job object defined in IETF IPP/1.1 Model and 623 Semantics [RFC2911] to represent a Job on any Imaging Service (Print, Scan, etc.), in 624

Page 22: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 22 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

order to reuse existing IPP Job operations and attributes in the individual Imaging 625 Services, but NOT directly in this specification. 626

Note: Since Jobs are typically short-lived objects, Job Owners are immutable (i.e., Job 627 Status attributes). 628

4.5 Document Object 629

This specification extends the original IPP Document object defined in IETF IPP/1.1 Model 630 and Semantics [RFC2911] to represent a Document contained in a Job on any Imaging 631 Service (Print, Scan, etc.), in order to reuse existing IPP Document operations and 632 attributes in the individual Imaging Services, but NOT directly in this specification. 633

4.6 Resource Object 634

This specification extends the original Resource object defined in PWG Network Resource 635 Service [PWG5108.03], in order to incorporate Resource operations directly into the IPP 636 System Service. Resources are managed by the System and each Resource has a 637 system-wide unique status attribute “resource-id”. Resource persistence is determined 638 directly by the System: (a) System scope Resources persist for the life of the System; (b) 639 single Printer (service) scope Resources persist for the life of the Printer; (c) single Job 640 scope Resources persist for the life of the Job document data.Resources are persistent 641 until they are explicitly canceled by an Administrator or aborted by the System. Creation of 642 a new Resources is supported via the Create-Resource operation and “resource-use-643 count” will be set to zero. Upload of Resource data is supported via the Send-Resource-644 Data operation. Subsequent installation of a Resources (for use) is supported via the 645 Install-Resource operation. For a System-scope Resource, “resource-use-count” will be 646 set to one after the Resource is successfully installed. For a Printer-scope or Job-scope 647 Resource, “resource-use-count” will be incremented by one each time that the Resource is 648 allocated to a Printer or a Job (e.g., via Allocate-Printer-Resource or a Create-Job 649 operation that includes a “resource-ids” operation attribute. When an allocated Resource 650 is busy at the time of a Cancel-Resource request, ‘cancel-requested’ will be added to the 651 “resource-state-reasons” and the Resource will not transition to a “resource-state” of 652 ‘canceled’ until the allocated Resource is no longer busy, as indicated by a “resource-use-653 count” value of zero. 654

See Figure 1 in section 0 resource-state for a diagram of normal Resource state 655 transitions. Resources in this specification do not have leases and expiration times (as 656 they formerly did in the original Resource object defined in [PWG5108.03]). 657

IPP System Service implementations SHOULD support System-scope executable 658 resources (e.g., for firmware update). System Service implementations MAY support 659 Printer-scope and/or Job-scope executable resources in an implementation-defined 660 manner. 661

Page 23: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 23 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

Note: Since Resources are typically long-lived objects, Resource Owners are mutable 662 (i.e., Resource Description attributes). 663

4.6.1 Resource History 664

The System MUST support an implementation-defined Resource History phase of at least 665 300 seconds, to preserved the integrity of system log files. The System SHOULD “age” 666 out (i.e., delete) Resource objects with “resource-state” of ‘canceled’ or ‘aborted’ from the 667 Resource History when they have exceeded the implementation-defined Resource History 668 period. This is analogous to the handling of Job objects in a terminal state as discussed in 669 the section “Partitioning of Job States” in [RFC2911]. However, unlike Job objects, the 670 Resource object associated data referenced by “resource-data-uri” SHOULD be discarded 671 as soon as “resource-state”the Resource transitions to the ‘canceled’ or ‘aborted’ terminal 672 state (instead of at the end of the Resource History phase). 673

4.7 Subscription Object 674

This specification extends the original IPP Subscription object defined in IPP Event 675 Notifications and Subscriptions [RFC3995] to allow subscriptions to the IPP System object 676 for event notifications. 677

Note: Since Subscriptions are typically short-lived objects, Subscription Owners are 678 immutable (i.e., Subscription Status attributes). 679

Page 24: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 24 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

5. IPP Objects and Operations Summary 680

This specification combines and maps the PWG SM System and PWG System Control 681 Service objects [PWG5801.01] into the IPP System object, which is the target of all IPP 682 system-level and resource-level operations. This is consistent with Print Service 683 operations targeted at original IPP Printer object. 684

This specification maps the PWG SM Resource object [PWG5108.03] into the IPP 685 Resource object and defines a set of resource-level operations. 686

This specification defines additional attributes for the Printer and Job objects [RFC2911]. 687

Note: All tables in this section list only top-level attributes. Collection member attributes 688 are not listed here and are described in detail in section 7 IPP Attributes below their 689 enclosing collection attributes. 690

691

Page 25: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 25 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

5.1 System Attribute Group 692

This document defines the system-attributes-tag (0x0A) for a System attribute group. 693

5.2 System Description Attributes 694

The potentially READ-WRITE attributes in the IPP System Description group are listed in 695 Table 1. 696

Table 1 – IPP System Description Attributes 697

Conformance IPP Attribute Name SM Element Name Reference

REQUIRED charset-configured CharsetConfigured[1] [PWG5108.06] REQUIRED charset-supported CharsetSupported[1] [PWG5108.06] REQUIRED generated-natural-language-

supported NaturalLanguageSupported[1] [PWG5108.06]

REQUIRED ipp-versions-supported VersionsSupported[1] [PWG5108.06] REQUIRED natural-language-configured NaturalLanguageConfigured[1] [PWG5108.06] REQUIRED operations-supported OperationsSupported[1] [PWG5108.06] OPTIONAL power-calendar-policy-col PowerCalendar [PWG5108.06] OPTIONAL power-event-policy-col PowerEvent [PWG5108.06] RECOMMENDED power-timeout-policy-col PowerTimeout[3] [PWG5108.06] REQUIRED printer-creation-attributes-

supported <none>[8] <none>

REQUIRED resource-settable-attributes-supported

<none>[7] <none>

REQUIRED system-current-time CurrentTime[2] [PWG5108.06] REQUIRED system-default-printer-id <none>[5] <none> REQUIRED system-device-id DeviceId[2] [PWG5108.06] REQUIRED system-geo-location SystemGeoLocation[2] [PWG5108.06] REQUIRED system-info SystemInfo[2] [PWG5108.06] REQUIRED system-location SystemLocation[2] [PWG5108.06] REQUIRED system-make-and-model MakeAndModel[2] [PWG5108.06] OPTIONAL system-message-from-operator MessageFromOperator [PWG5108.06] REQUIRED system-name SystemName[2] [PWG5108.06] REQUIRED system-owner-col OwnerUri, OwnerVCard[4] [PWG5108.06] REQUIRED system-settable-attributes-

supported <none>[6] <none>

REQUIRED system-xri-supported XriSupported [PWG5108.06]

Notes: 698

1) REQUIRED for a Printer per IETF IPP/1.1 Model and Semantics [RFC2911]. 699

2) REQUIRED for a Printer per PWG IPP Everywhere [PWG5100.14]. 700

3) REQUIRED or RECOMMENDED for a System per PWG Power Management 701 Model [PWG5106.4]. 702

Page 26: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 26 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

4) REQUIRED for all Systems since they MUST support the Set-System-Attributes 703 operation – also “owner-uri” and “owner-vcard” MUST be updated simultaneously if 704 specified in a Set-System-Attributes operation (to preserve consistency). 705

5) REQUIRED for a System to support the Get-Printer-Attributes operation which can 706 use the implementation-defined or administratively-configured “default” Printer 707 object as a target. 708

6) REQUIRED for System support of the REQUIRED Set-System-Attributes operation 709 and semantically analogous to the “printer-settable-attributes-supported” Printer 710 Description attribute defined in Internet Printing Protocol (IPP): Job and Printer Set 711 Operations [RFC3380]. 712

7) REQUIRED for System support of the REQUIRED Set-Resource-Attributes 713 operation and semantically analogous to the “printer-settable-attributes-supported” 714 Printer Description attribute defined in Internet Printing Protocol (IPP): Job and 715 Printer Set Operations [RFC3380]. 716

7)8) REQUIRED for System support of the REQUIRED Create-Printer operation 717 and semantically analogous to the “job-creation-attributes-supported” Printer 718 Description attribute defined in Internet Printing Protocol (IPP): Job and Printer 719 Extensions – Set 2 [PWG5100.11]. 720

5.3 System Status Attributes 721

The READ-ONLY attributes in the IPP System Status group are listed in Table 2. These 722 attributes are inherently READ-ONLY and can only be modified indirectly as a side effect 723 of one or more IPP System Service operations, but NOT by a Set-System-Attributes 724 operation. 725

Table 2 – IPP System Status Attributes 726

Conformance IPP Attribute Name SM Element Name Reference RECOMMENDED power-log-col PowerLog[3] [PWG5108.06] OPTIONAL power-state-capabilities-col PowerSupport [PWG5108.06] OPTIONAL power-state-counters-col PowerCounters [PWG5108.06] RECOMMENDED power-state-monitor-col PowerMonitor[3] [PWG5108.06] OPTIONAL power-state-transitions-col PowerTransition [PWG5108.06] REQUIRED system-config-change-date-

time <none>[8] <none>

REQUIRED system-config-change-time <none>[8] <none> REQUIRED system-config-changes SystemConfigChangeNumber[5] [PWG5108.06] REQUIRED system-configured-printers ConfiguredServices [PWG5108.06] REQUIRED system-configured-resources ConfiguredResources [PWG5108.06] OPTIONAL system-serial-number SerialNumber[5] [PWG5108.06] REQUIRED system-state State[1] [PWG5108.06] REQUIRED system-state-change-date-

time <none>[8] <none>

REQUIRED system-state-change-time <none>[8] <none>

Page 27: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 27 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

REQUIRED system-state-message StateMessages[2] [PWG5108.06] REQUIRED system-state-reasons StateReasons[2] [PWG5108.06] RECOMMENDED system-strings-languages-

supported <none>[9] <none>

RECOMMENDED system-strings-uri <none>[9] <none> RECOMMENDED system-totals SystemTotals[6] [PWG5108.06] REQUIRED system-up-time UpTime[2] [PWG5108.06] REQUIRED system-uuid ServiceUuid[2] [7] [PWG5108.01]

Notes: 727

1) REQUIRED for a Printer per IETF IPP/1.1 Model and Semantics [RFC2911]. 728

2) REQUIRED for a Printer per PWG IPP Everywhere [PWG5100.14]. 729

3) REQUIRED or RECOMMENDED for a System per PWG Power Management 730 Model [PWG5106.4] – Power General, Meters, and Monitor groups have been 731 combined into the “power-state-monitor-col” System attribute. 732

4) Summary of SystemConfiguration group (subunits) – similar to ConfiguredServices 733 in [PWG5108.06]. 734

5) REQUIRED for a Printer per IETF Printer MIB v2 [RFC3805]. 735

6) REQUIRED for a System per PWG Imaging System Counters [PWG5106.1]. 736

7) The System object “system-uuid” attribute identifies the System Serviceand is 737 semantically analogous to the Printer object “printer-uuid” defined in IPP Job and 738 Printer Extensions – Set 3 (JPS3) [PWG5100.13] that identifies a specific Imaging 739 Service (e.g., Print, Scan, FaxOut, etc.). 740

8) The System object “system-config-change-[date-time|time]” and “system-state-741 change-[date-time|time] attributes are necessary to support System event 742 notifications per IPP: Events Notifications and Subscriptions [RFC3995] and are 743 semantically analogous to the Printer object “printer-config-change-[date-time|time]” 744 attributes defined in [PWG5100.13] and “printer-state-change-[date-time|time]” 745 attributes defined in [RFC3995]. 746

9) The System object “system-strings-languages-supported” and “system-strings-uri” 747 attributes are necessary to support Client-side localizations and are semantically 748 analogous to the Printer object “printer-strings-languages-supported” and “printer-749 strings-uri” attributes defined in IPP Job and Printer Extensions – Set 3 (JPS3) 750 [PWG5100.13]. 751

5.4 System Operations 752

The operations for an IPP System Service conforming to this specification are listed in 753 Table 3. 754

Page 28: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 28 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

Table 3 – IPP System Service Operations 755

Code IPP Operation Name SM Operation Name Reference 0x00nn Allocate-Printer-Resources <none> <none> 0x00nn Cancel-Resource DeleteResource [PWG5108.03] 0x00nn Cancel-

Subscription <none>[8] <none>

0x00nn Create-Printer <none>[5] <none> 0x00nn Create-Resource StoreResource[3] [PWG5108.03] 0x00nn Create-Resource-

Subscriptions <none>[8] <none>

0x00nn Create-System- Subscriptions

<none>[8] <none>

0x00nn Deallocate-Printer-Resources

<none> <none>

0x00nn Delete-Printer DeleteService [PWG5108.06] 0x00nn Disable-All-Printers DisableAllServices[2] [PWG5108.06] 0x00nn Enable-All-Printers EnableAllServices[2] [PWG5108.06] 0x00nn Get-Notifications <none>[8] <none> 0x00nn Get-Printers ListAllServices [PWG5108.06] 0x00nn Get-Printer-Attributes GetServiceElements[4] [PWG5108.06] 0x00nn Get-Resources ListResources [PWG5108.03] 0x00nn Get-Resource-Attributes GetResourceElements [PWG5108.03] 0x00nn Get-Subscriptions <none>[8] <none> 0x00nn Get-Subscription-Attributes <none>[8] <none> 0x00nn Get-System-Attributes GetSystemElements [PWG5108.06] 0x00nn Get-System-Supported-

Values <none>[7] <none>

0x00nn Install-Resource <none>[3][4] <none> 0x00nn Pause-All-Printers PauseAllServices [PWG5108.06] 0x00nn Pause-All-Printers-After-

Current-Job PauseAllServices AfterCurrentJob[1]

[PWG5108.06]

0x00nn Register-Output-Device <none>[6] <none> 0x00nn Renew-Subscription <none>[8] <none> 0x00nn Restart-System <none>[9] <none> 0x00nn Resume-All-Printers ResumeAllServices [PWG5108.06] 0x00nn Send-Resource-Data StoreResource[3] [PWG5108.03] <none> Set-Resource-Attributes SetResourceElements [PWG5108.03] <none> Set-System-Attributes SetSystemElements [PWG5108.06] 0x00nn Shutdown-All-Printers ShutdownAllServices [PWG5108.06] <none> Shutdown-One-Printer ShutdownService [PWG5108.06] 0x00nn Startup-All-Printers StartupAllServices [PWG5108.06] <none> Startup-One-Printer StartupService [PWG5108.06]

Notes: 756

1) Pause-All-Printers-After-Current-Job is a useful operation for graceful stopping of all 757 Printers (Imaging Services) on an Imaging System, but it can be an arbitrarily long 758 duration operation. 759

2) [Enable/Disable]-Printer and [Pause/Resume]-Printer are intentionally left out of this 760 specification – they should be directed to the specific Imaging Service that is 761

Page 29: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 29 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

enumerated in the “system-configured-printers” attribute defined in section 5.x 762 above. 763

3) Create-Resource, Send-Resource-Data, and Install-Resource are intentionally 764 decomposed from the original ambiguously scoped StoreResource operation 765 specified in PWG Resource Service [PWG5108.03]. Create-Resource is 766 semantically equivalent to Create (for a Resource object) defined in ISO Document 767 Printing Application (DPA) Part 3: Management Abstract Service Definition and 768 Procedures [ISO10175-3] where a newly created Resource object has the special 769 initial state of ‘unknown’ (which is NOT defined or used in this specification). 770

4) Install-Resource is used to install (for subsequent use) a Resource for use after 771 Create-Resource (metadata) and Send-Resource-Data (upload data) have 772 completed. 773

5) Create-Printer is semantically equivalent to Create (for a Printer object) defined in 774 ISO Document Printing Application (DPA) Part 3: Management Abstract Service 775 Definition and Procedures [ISO10175-3] (where a newly created Printer object had 776 the special initial state of ‘unknown’, which is NOT defined or used in this 777 specification). 778

6) Register-Output-Device is semantically equivalent to Register-System defined in 779 PWG Cloud Imaging Model [PWG5109.1] with the difference that the System itself 780 is not registered, but rather the associated Output Devices are registered. 781

7) Get-System-Supported-Values is semantically equivalent to Get-Printer-Supported-782 Values in IPP: Job and Printer Set Operations [RFC3380] and is necessary for 783 support of the REQUIRED Set-System-Attributes operation. 784

8) REQUIRED for a System and/or Resource and analogous to the operations defined 785 in IPP: Event Notifications and Subscriptions [RFC3995]. 786

9) REQUIRED for a System and analogous to the Restart-Printer operation defined in 787 IPP: Job and Printer Administrative Operations [RFC3998]. 788

789

Page 30: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 30 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

5.5 Resource Attribute Group 790

This document defines the resource-attributes-tag (0x08) for a Resource attribute group. 791

5.6 Resource Description Attributes 792

The potentially READ-WRITE attributes in the IPP Resource Description group are listed in 793 Table 4. 794

Note: Printer-scope Resource objects MAY be: 795

1) Created before the related Create-Printer operation and then associated with a 796 given Printer using a Create-Printer operation via the “resource-ids” operation 797 attribute to update the “printer-resource-ids” Printer Status attribute; 798

2) Created after the related Create-Printer operation and then associated with a given 799 Printer using an Allocate-Printer-Resources operation via the “resource-ids” 800 operation attribute to update the “printer-resource-ids” Printer Status attribute; or 801

3) Created after the related Create-Printer operation and then associated with a given 802 Printer using an HTTP PUT request [RFC7230] as defined in section 4.1.9 803 Resources of IPP Shared Infrastructure Extensions [PWG5100.18] to update the 804 “printer-resource-ids” Printer Status attribute. 805

Note: Job-scope Resource objects MUST be created before the Job creation operation 806 and then associated with a given Job via the “resource-ids” Job creation operation attribute 807 to update the “job-resource-ids” Job Status attribute. 808

Table 4 – IPP Resource Description Attributes 809

Conformance IPP Attribute Name SM Element Name Reference REQUIRED resource-info ResourceInfo [PWG5108.03] REQUIRED resource-name ResourceName [PWG5108.03] REQUIRED resource-owner-col OwnerUri, OwnerVCard[1] [PWG5108.06]

810 Notes: 811

1) REQUIRED for a Resource by analogy to “system-owner-col” in System. 812

5.7 Resource Status Attributes 813

The READ-ONLY attributes in the IPP Resource Status group are listed in Table 5. These 814 attributes are inherently READ-ONLY and can only be modified indirectly as a side effect 815 of one or more IPP System Service operations, but NOT by a Set-Resource-Attributes 816 operation. See Figure 1 in section 0 resource-state for a diagram of normal Resource 817 state transitions. 818

Page 31: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 31 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

Table 5 – IPP Resource Status Attributes 819

Conformance IPP Attribute Name SM Element Name Reference REQUIRED date-time-at-canceled DateTimeOfExpiration[1] [PWG5108.03] REQUIRED date-time-at-creation DateTimeAtCreation[1] [PWG5108.03] REQUIRED date-time-at-installed <none>[7] <none> REQUIRED resource-data-uri <none> <none> REQUIRED resource-format ResourceFormat [PWG5108.03] REQUIRED resource-id ResourceId[4] [PWG5108.03] REQUIRED resource-k-octets <none>[2][5] <none> REQUIRED resource-state <none>[2] <none> REQUIRED resource-state-reasons <none>[2] <none> REQUIRED resource-string-version XxxStringVersion[7] [PWG5110.1] REQUIRED resource-type ResourceType [PWG5108.03] REQUIRED resource-use-count <none> <none> REQUIRED resource-uuid <none>[3] [PWG5100.13] REQUIRED resource-version XxxVersion[7] [PWG5110.1] REQUIRED time-at-canceled <none>[2] <none> REQUIRED time-at-creation <none>[2] <none> REQUIRED time-at-installed <none>[6] <none>

Notes: 820

1) REQUIRED for a Resource by analogy to PWG Network Resource Service 821 Semantic Model and Service Interface [PWG5108.03]. 822

2) REQUIRED for a Resource by analogy to a Job in IETF IPP/1.1 Model and 823 Semantics [RFC2911]. 824

3) REQUIRED for a Resource by analogy to a Job in PWG IPP: Job and Printer 825 Extensions – Set 3 (JPS3) [PWG5100.13]. 826

4) REQUIRED for a Resource by analogy to a Job in IETF IPP/1.1 Model and 827 Semantics [RFC2911]. See section 7.6 of this specification for details of the 828 “resource-id” attribute which MUST be monotonically increasing (as is “job-id”) to 829 avoid re-use of a “resource-id” values and resulting ambiguity in log files. 830

5) REQUIRED for a Resource by analogy to a “job-k-octets” in a Job in IETF IPP/1.1 831 Model and Semantics [RFC2911]. 832

6) REQUIRED for a Resource by analogy to ”date-time-at-creation” and “time-creation” 833 and set by System during an Install-Resource operation and analogous to “date-834 time-at-processing” and “time-at-Processing” Job attributes defined in [RFC2911]. 835

7) REQUIRED for a Resource by analogy to the functionally equivalent 836 [Firmware|ResidentApplication|UserApplication]StringVersion and 837 [Firmware|ResidentApplication|UserApplication]Version elements defined in PWG 838 Hardcopy Device Health Assessment Attributes [PWG5110.1] and PWG Hardcopy 839 Device Health Assessment Trusted Network Connect Binding [PWG5110.4]. 840

Page 32: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 32 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

5.8 Printer Description Attributes 841

Additional potentially READ-WRITE attributes in the IPP Printer Description group are 842 listed in Table 6. 843

Table 6 – IPP Printer Description Attributes 844

Conformance IPP Attribute Name SM Element Name Reference REQUIRED printer-owner-col OwnerUri, OwnerVCard[1] [PWG5108.06]

845 Notes: 846

1) REQUIRED for all Systems since they MUST support the Set-Printer-Attributes 847 operation to conform to this IPP System Service specification – also “owner-uri” and 848 “owner-vcard” MUST be updated simultaneously if specified in a Set-Printer-849 Attributes operation (to preserve consistency). 850

5.9 Printer Status Attributes 851

Additional READ-ONLY attributes in the IPP Printer Status group are listed in Table 7. 852

Table 7 – IPP Printer Status Attributes 853

Conformance IPP Attribute Name SM Element Name Reference REQUIRED printer-config-changes ConfigChanges[1] [PWG5106.1] REQUIRED printer-id ID[2] [PWG5108.06] REQUIRED printer-resource-ids <none>[4] <none> REQUIRED printer-service-type ServiceType[3] [PWG5108.06]

854 Notes: 855

1) REQUIRED for all Printers and semantically equivalent to the Monitoring element 856 ConfigChanges defined in [PWG5106.1] and semantically equivalent to 857 “prtGeneralConfigChanges” in IETF Printer MIB v2 [RFC3805]. 858

2) REQUIRED for all Printers and semantically equivalent to the ServiceSummary 859 element ID defined in [PWG5108.06] and semantically analogous to the “job-id” 860 attribute defined in [RFC2911. 861

3) REQUIRED for all Printers and semantically equivalent to the ServiceSummary 862 element ServiceType defined in [PWG5108.06]. 863

4) REQUIRED for all Printers since they MUST support the assignment of requested 864 Resources via the “resource-ids” Create-Printer operation attribute to conform to 865 this IPP System Service specification. 866

Page 33: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 33 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

5.10 Job Status Attributes 867

Additional READ--ONLY attributes in the IPP Job Status group are listed in Table 8. 868

Table 8 – IPP Job Status Attributes 869

Conformance IPP Attribute Name SM Element Name Reference REQUIRED job-owner-col OwnerUri, OwnerVCard[1] [PWG5108.06] REQUIRED job-resource-ids <none>[2] <none>

870 Notes: 871

1) REQUIRED for all Systems since they MUST support the Create-Job operation and 872 “requesting-user-vcard” operation attribute to conform to this IPP System Service 873 specification. 874

2) REQUIRED for all Systems since they MUST support the submission of requested 875 Resources via the “resource-ids” Job Creation operation attribute to conform to this 876 IPP System Service specification. 877

878

Page 34: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 34 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

6. IPP Operations 879

Note: All IPP System Service operation requests and responses use standard operation 880 parameters as defined in [RFC2911] and encoded in [RFC2910]. 881

6.1 Printer Operations 882

6.1.1 Allocate-Printer-Resources 883

[new operation to update Resources associated with a given Printer after Create-Printer 884 and “resource-use-count” in each Resource] 885

6.1.2 Create-Printer 886

This REQUIRED operation allows an authorized Operator or Administrator to create a new 887 Printer object (i.e., Job processing service) on the target System object and optionally also 888 create one or more new per-Printer Subscription objects. This operation is semantically 889 equivalent to the Create operation for a Printer object defined in ISO “Document Printing 890 Application (DPA) Part 3: Management Abstract Service Definition and Procedures” 891 [ISO10175-3] (where a newly created Printer object had the special initial state of ‘unknown’, 892 which is NOT defined or used in this specification). This operation is semantically analogous 893 to the Create-Job operation defined in [RFC2911]. This operation does not change the 894 “system-state” of the System itself. 895

A new Printer object will be created and initialized with the “printer-state” set to ‘stopped’ 896 (i.e., no Jobs can be processed and intervention is required), “printer-is-accepting-jobs” set 897 to ‘false’ (i.e., no incoming Jobs accepted), and the ‘paused’ value added to “printer-state-898 reasons” (i.e., no Job processing output allowed). One or more requested per-Printer 899 Subcription objects can also be created. The Client can then send one or more Set-900 Printer-Attributes operations to modify the configuration of the Printer, followed by 901 Resume-Printer (to remove ‘paused’ from “printer-state-reasons”) and Enable-Printer (to 902 change “printer-is-accepting-jobs” to ‘true’) to change “printer-state” to ‘idle’ (unless there is 903 another reason for the Printer to stay in the ‘stopped’ state). 904

Note: When the first Print Service is created on a System, the System MUST set the value 905 of “system-default-printer-id” to reference that Print Service. 906

Note: Printer-scope Resource objects MAY be: 907

1) Created before the related Create-Printer operation and then associated with a 908 given Printer using a Create-Printer operation via the “resource-ids” operation 909 attribute to update the “printer-resource-ids” Printer Status attribute; 910

2) Created after the related Create-Printer operation and then associated with a given 911 Printer using an Allocate-Printer-Resources operation via the “resource-ids” 912 operation attribute to update the “printer-resource-ids” Printer Status attribute; or 913

Page 35: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 35 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

3) Created after the related Create-Printer operation and then associated with a given 914 Printer using an HTTP PUT request [RFC7230] as defined in section 4.1.9 915 Resources of IPP Shared Infrastructure Extensions [PWG5100.18] to update the 916 “printer-resource-ids” Printer Status attribute. 917

Note: Printer-scope Subscription objects MUST be created after the related Create-Printer 918 operation, so that “notify-printer-id” can be correctly specified. 919 920 Note: Appropriate Subunits are automatically associated with a new Printer object based 921 on “printer-service-type”, inherent System capabilities, (out-of-band) System policies. 922 Subunits are also associated by configured service capabilities (e.g., “sides-supported” and 923 duplexer, “finishings-supported” and finishers, “print-color-mode-supported” and colorants, etc. 924 – association by intent and not by explicit identification/listing of Subunits. 925

6.1.2.1 Create-Printer Request 926

The Client submits a Create-Printer operation request to a System object. The following 927 groups of attributes are part of a Create-Printer request. 928

Group 1: Operation Attributes 929

"attributes-charset" (charset) and 930 "attributes-natural-language" (naturalLanguage): 931

The Client MUST supply and the System MUST support both of these 932 attributes. 933

“system-uri” (uri): 934

The Client MUST supply and the System MUST support the “system-uri” 935 operation attribute which is the target System for the operation. 936

"requesting-user-name" (name(MAX)) and 937 "requesting-user-uri" (uri) and 938 “requesting-user-vcard” (1setOf text(1023)): 939

The Client SHOULD supply and the System MUST support all three of these 940 attributes. 941

“printer-service-type” (type2 keyword): 942

The Client MUST supply and the System MUST support this attribute. 943

“resource-ids” (1setOf integer (1:MAX)): 944

The Client MAY supply and the System MUST support this attribute. 945

Group 2: Printer Description Attributes 946

Page 36: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 36 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

<all mandatory Printer Description attributes> 947

The Client MUST supply and the System MUST support all of the attributes 948 listed in “system-mandatory-printer-atrributes” 949

<any other Printer Description attribute> 950

The Client MAY supply and the System MAY support these attributes. See 951 “printer-settable-attributes-supported” defined in [RFC3380]. 952

Groups 3-N: Subscription Attributes 953

See [RFC3995] for details on supplying Subscription Attributes. 954

6.1.2.2 Create-Printer Response 955

The System MUST return a Create-Printer operation response to the Client. 956

Group 1: Operation Attributes 957

"attributes-charset" (charset) and 958 "attributes-natural-language" (naturalLanguage): 959

The System MUST return both of these attributes. 960

"status-message" (text(255)) and/or 961 "detailed-status-message" (text(MAX)): 962

The System MAY return one or both of these attributes. 963

Group 2: Unsupported Attributes 964

See [RFC2911] for details on returning Unsupported Attributes. 965

Groups 3: Printer Attributes 966

See [RFC2911] for details on returning Printer Attributes. 967

“printer-id (integer(1:MAX)): 968

The System MUST return this attribute. 969

“printer-uuid” (uri(45)): 970

The System MUST return this attribute. 971

“printer-xri-supported” (1setOf collection) 972

The System MUST return this attribute. 973

Page 37: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 37 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

“printer-state” (type1 enum) and 974 “printer-state-reasons” (1setOf type2 keyword): 975

The System MUST return both of these attributes. 976

Groups 4-N: Subscription Attributes 977

See [RFC3995] for details on returning Subscription Attributes. 978

6.1.3 Deallocate-Printer-Resources 979

[to update Resources associated with a given Printer after Create-Printer] 980

6.1.4 Delete-Printer 981

This REQUIRED operation allows an authorized Operator or Administrator to delete 982 entirely one configured Printer object (i.e., Job processing service) on the target System 983 object. If the Printer object is not already shutdown, with ‘shutdown’ in the “printer-state-984 reasons”, then the System MUST return a “status-code” of ‘client-error-forbidden’. This 985 operation is semantically equivalent to the DeleteService operation defined in 986 [PWG5108.06]. The Printer object and all associated Jobs will be removed entirely. The 987 Printer object cannot be subsequently started up with a Startup-One-Printer operation. 988 This operation MAY change the state of the System itself to ‘stopped’ (if there are no other 989 configured Printers or all other Printers already had a “printer-state” of ‘stopped’). 990

The specified Printer will be shutdown with the “printer-state” set to ‘stopped’ (i.e., no Jobs 991 can be processed and intervention is required) and the ‘shutdown’ value added to “printer-992 state-reasons”. The Client can later send a Startup-One-Printer operation to the System 993 (preferred) or a Startup-Printer operation [RFC3998] to the Printer to start up the specified 994 Printer. 995

6.1.4.1 Delete-Printer Request 996

The Client submits a Delete-Printer operation request to a System object. The following 997 groups of attributes are part of a Delete-Printer request. 998

Group 1: Operation Attributes 999

The System MUST support the same operation attributes in a Delete-Printer operation 1000 request as those defined for the Startup-One-Printer operation. 1001

“printer-id (integer(1:MAX)): 1002

The Client MUST supply and the System MUST support this operation 1003 attribute which is the target Printer for the operation. 1004

Page 38: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 38 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

6.1.4.2 Delete-Printer Response 1005

The System MUST return a Delete-Printer operation response to the Client. 1006

Group 1: Operation Attributes 1007

The System MUST support the same operation attributes in a Delete-Printer operation 1008 response as those defined for the Startup-One-Printer operation. 1009

6.1.5 Get-Printers 1010

This REQUIRED operation allows an authorized Client to retrieve a filtered list of some or 1011 all of the Printer objects (i.e., Job processing services) on the target System object. This 1012 operation is semantically equivalent to the ListAllServices operation defined in 1013 [PWG5108.06]. This operation is also semantically equivalent to a sequence of Get-1014 Printer-Attributes [RFC2911] operations to each Printer object. A “printer-id” and “printer-1015 xri-supported” will be returned for each matching Printer object. The returned Printers and 1016 Printer attributes from the System MAY also be filtered based on Client access rights (i.e., 1017 the value of “requesting-user-name”) or the specified “document-format”.Note: This End 1018 User operation does NOT require Client authentication, but MAY be encrypted just as any 1019 other IPP System Service operation. 1020

6.1.5.1 Get-Printers Request 1021

The Client submits a Get-Printers operation request to a System object. The following 1022 groups of attributes are part of a Get-Printers request. 1023

Group 1: Operation Attributes 1024

"attributes-charset" (charset) and 1025 "attributes-natural-language" (naturalLanguage): 1026

The Client MUST supply and the System MUST support both of these 1027 attributes. 1028

“system-uri” (uri): 1029

The Client MUST supply and the System MUST support the “system-uri” 1030 operation attribute which is the target System for the operation. 1031

“printer-ids (1setOf (integer(1:MAX))): 1032

The Client MAY supply and the System MUST support the “printer-ids” 1033 operation attribute which is the list of target Printers for the operation. 1034

"requesting-user-name" (name(MAX)) and 1035 "requesting-user-uri" (uri) and 1036 “requesting-user-vcard” (1setOf text(1023)): 1037

Page 39: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 39 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

The Client SHOULD supply and the System MUST support all three of these 1038 attributes. 1039

“first-index” (integer(1:MAX)): 1040

The Client MAY supply and the System MUST support this attribute. 1041

"limit" (integer(1:MAX)): 1042

The Client MAY supply and the System MUST support this attribute. 1043

“printer-geo-location” (uri): 1044

The Client MAY supply and the System MUST support this attribute. 1045

“printer-location” (text(127)): 1046

The Client MAY supply and the System MUST support this attribute. 1047

“printer-service-type” (1setOf (type2 keyword)): 1048

The Client MAY supply and the System MUST support this attribute. If this 1049 operation attribute is supplied, then the System MUST return the attributes 1050 and values for the selected Printers (e.g., Printers offering ‘scan’ service). 1051 See “printer-service-type” in section 7.5 Printer Status Attributes. 1052

“requested-attributes” (1setOf type2 keyword): 1053

The Client MAY supply and the System MUST support this attribute. If this 1054 operation attribute is NOT supplied, then the System MUST only return the 1055 value of the “system-configured-printers” entry for each selected Printer. See 1056 section “system-configured-printers” in section 7.3 System Status Attrbutes. 1057

The Client MUST NOTSHOULD only supply and the System MUST only 1058 NOT support requests for any Printer attributes that are not listed as IPP 1059 Printer source attributes in the table in section 4 Definition of Attribute Types 1060 in the IETF LDAP Schema for Printer Services [RFC7612]. 1061

"document-format" (mimeMediaType): 1062

The Client MAY supply and the System MUST support this attribute. If this 1063 operation attribute is supplied, then the System MUST return the attributes 1064 and values that it uses to validate a job on a create or Validate-Job operation 1065 in which this document format is supplied. The System SHOULD return only 1066 (1) those attributes that are supported for the specified format and (2) the 1067 attribute values that are supported for the specified document format. 1068

“which-printers” (type2 keyword): 1069

Page 40: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 40 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

The Client MAY supply and the System MUST support this attribute. If this 1070 operation attribute is supplied, then the System MUST return the attributes 1071 and values for the selected printers (e.g., Printers in ‘idle’ state). See “which-1072 printers” in section 7.1 Operation Attributes. 1073

6.1.5.2 Get-Printers Response 1074

The System MUST return a Get-Printers operation response to the Client up to the number 1075 specified by the “limit” operation attribute that match the filter criteria as specified by the 1076 attribute values supplied by the Client in the request. If no Printers match the specified 1077 filter criteria, then the System MUST return a “status-code” of 'successful-ok'. Group 1: 1078 Operation Attributes 1079

"attributes-charset" (charset) and 1080 "attributes-natural-language" (naturalLanguage): 1081

The System MUST return both of these attributes, unless no Printers match 1082 the filter criteria specified by the Client. 1083

"status-message" (text(255)) and/or 1084 "detailed-status-message" (text(MAX)): 1085

The System MAY return one or both of these attributes. 1086

Group 2: Unsupported Attributes 1087

See [RFC2911] for details on returning Unsupported Attributes. 1088

Groups 3 to N: Printer Attributes 1089

See [RFC2911] for details on returning Printer Attributes. 1090

“printer-id (integer(1:MAX)): 1091

The System MUST return this attribute for each Printer. 1092

“printer-xri-supported” (1setOf collection): 1093

The System MUST return this attribute for each Printer. 1094

6.1.6 Get-Printer-Attributes 1095

This REQUIRED operation allows an unauthenticated Client to retrieve a filtered list of the 1096 Printer attributes for either the default Printer specified by the “system-default-printer-id” on 1097 the target System object or an explicit Printer specified by the “printer-iduri” ofn the target 1098 Printer object. This operation supports backward compatibility with previously deployed 1099 IPP Clients. This operation is semantically equivalent to the Get-Printer-Attributes 1100 operation defined in [RFC2911], except that the target MAY beis a System object (rather 1101

Page 41: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 41 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

than a Printer object), although previously deployed IPP Clients MAY omit the “system-uri” 1102 operation attribute and supply the “printer-uri” operation attribute instead. A “printer-id” 1103 and “printer-xri-supported” will be returned for either the default Printer specified by the 1104 “system-default-printer-id” attribute on the target System object or an explicit Printer 1105 specified by the “printer-id” or “printer-uri” of the target Printer object. The returned Printer 1106 attributes from the System MAY also be filtered based on Client access rights (i.e., the 1107 value of “requesting-user-name”) or the specified “document-format”. 1108

6.1.6.1 Get-Printer-Attributes Request 1109

The Client submits a Get-Printer-Attributes operation request to a System object or a 1110 Printer object. The following groups of attributes are part of a Get-Printer-Attributes 1111 request. 1112

Group 1: Operation Attributes 1113

"attributes-charset" (charset) and 1114 "attributes-natural-language" (naturalLanguage): 1115

The Client MUST supply and the System MUST support both of these 1116 attributes. 1117

“system-uri” (uri) or: 1118

The Client SHOULD supply and the System MUST support the “system-uri” 1119 operation attribute which is the target System for the operation. 1120

“printer-id (integer(1:MAX)): 1121

The Client MAY supply and the System MUST support this operation 1122 attribute which is the explicit target Printer for the operation. 1123

“system-uri (uri) or 1124 “printer-uri” (uri): 1125

The Client MUST supply either the "system-uri" or "printer-uri" operation 1126 attributes MAY supply and the System both the "system-uri" and "printer-uri" 1127 operation attributesMUST support this operation attribute which isspecify the 1128 target System or the explicit target Printer for the operation. 1129

"requesting-user-name" (name(MAX)) and 1130 "requesting-user-uri" (uri) and 1131 “requesting-user-vcard” (1setOf text(1023)): 1132

The Client SHOULD supply and the System MUST support all three of these 1133 attributes. 1134

“first-index” (integer(1:MAX)): 1135

Page 42: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 42 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

The Client MAY supply and the System MUST support this attribute. 1136

"limit" (integer(1:MAX)): 1137

The Client MAY supply and the System MUST support this attribute. 1138

“requested-attributes” (1setOf type2 keyword): 1139

The Client MAY supply and the System MUST support this attribute. If this 1140 operation attribute is NOT supplied, then the System MUST only return the 1141 value of the “system-configured-printers” entry for each selected Printer. See 1142 section “system-configured-printers” in section 7.3 System Status Attrbutes. 1143

"document-format" (mimeMediaType): 1144

The Client MAY supply and the System MUST support this attribute. If this 1145 operation attribute is supplied, then the System MUST return the attributes 1146 and values that it uses to validate a job on a create or Validate-Job operation 1147 in which this document format is supplied. The System SHOULD return: only 1148 (1) those attributes that are supported for the specified format; and (2) the 1149 attribute values that are supported for the specified document format. 1150

6.1.6.2 Get-Printer-Attributes Response 1151

The System MUST return a Get-Printer-Attributes operation response to the Client up to 1152 the number specified by the “limit” operation attribute that match the filter criteria as 1153 specified by the attribute values supplied by the Client in the request. If there is no 1154 configured default Printer, then the System MUST return a “status-code” of 'successful-ok'. 1155

Group 1: Operation Attributes 1156

"attributes-charset" (charset) and 1157 "attributes-natural-language" (naturalLanguage): 1158

The System MUST return both of these attributes, unless no Printers match 1159 the filter criteria specified by the Client. 1160

"status-message" (text(255)) and/or 1161 "detailed-status-message" (text(MAX)): 1162

The System MAY return one or both of these attributes. 1163

Group 2: Unsupported Attributes 1164

See [RFC2911] for details on returning Unsupported Attributes. 1165

Group 3: Printer Attributes 1166

Page 43: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 43 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

See [RFC2911] for details on returning Printer Attributes. 1167

“printer-id (integer(1:MAX)): 1168

The System MUST return this attribute for the target Printer. 1169

“printer-xri-supported” (1setOf collection): 1170

The System MUST return this attribute for the target Printer. 1171

6.1.7 Shutdown-One-Printer 1172

This REQUIRED operation allows an authorized Operator or Administrator to shutdown 1173 one configured Printer object (i.e., Job processing service) on the target System object. 1174 This operation is semantically equivalent to the ShutdownService operation defined in 1175 [PWG5108.06]. This operation is also semantically equivalent to a Shutdown-Printer 1176 operation [RFC3998] to the configured Printer object (except for the resulting “printer-state” 1177 of ‘stopped’ rather than ‘idle’). This operation MAY cause the System to pause with 1178 “system-state” set to ‘stopped’ (if all other Printers already had a “printer-state” of 1179 ‘stopped’). 1180

The specified Printer will be shutdown with the “printer-state” set to ‘stopped’ (i.e., no Jobs 1181 can be processed and intervention is required) and the ‘shutdown’ value added to “printer-1182 state-reasons”. The Client can later send a Startup-One-Printer operation to the System 1183 (preferred) or a Startup-Printer operation [RFC3998] to the Printer to start up the specified 1184 Printer. 1185

6.1.7.1 Shutdown-One-Printer Request 1186

The Client submits a Shutdown-One-Printer operation request to a System object. The 1187 following groups of attributes are part of a Shutdown-One-Printer request. 1188

Group 1: Operation Attributes 1189

The System MUST support the same operation attributes in a Shutdown-One-Printer 1190 operation request as those defined for the Startup-One-Printer operation. 1191

6.1.7.2 Shutdown-One-Printer Response 1192

The System MUST return a Shutdown-One-Printer operation response to the Client. 1193

Group 1: Operation Attributes 1194

The System MUST support the same operation attributes in a Shutdown-One-Printer 1195 operation response as those defined for the Startup-One-Printer operation. 1196

Page 44: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 44 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

6.1.8 Startup-One-Printer 1197

This REQUIRED operation allows an authorized Operator or Administrator to startup one 1198 configured Printer object (i.e., Job processing service) on the target System object. This 1199 operation is semantically equivalent to the StartupService operation defined in 1200 [PWG5108.06]. This operation MAY cause the System to pause with “system-state” set to 1201 ‘stopped’ (if all other Printers already had a “printer-state” of ‘stopped’). 1202

The specified Printer will be started up with the “printer-state” set to ‘stopped’ (i.e., no Jobs 1203 can be processed and intervention is required), “printer-is-accepting-jobs” set to ‘false’ 1204 (i.e., no incoming Jobs accepted), and the ‘paused’ value added to “printer-state-reasons” 1205 (i.e., no Job processing output allowed). The Client can then send one or more Set-1206 Printer-Attributes operations to modify the configuration of the Printer, followed by 1207 Resume-Printer (i.e., remove ‘paused’ from “printer-state-reasons”) and Enable-Printer 1208 (i.e., change “printer-is-accepting-jobs” to ‘true’) to change the “printer-state” to ‘idle’ 1209 (unless there is another reason for the Printer to stay in the ‘stopped’ state). 1210

6.1.8.1 Startup-One-Printer Request 1211

The Client submits a Startup-One-Printer operation request to a System object. The 1212 following groups of attributes are part of a Startup-One-Printer request. 1213

Group 1: Operation Attributes 1214

"attributes-charset" (charset) and 1215 "attributes-natural-language" (naturalLanguage): 1216

The Client MUST supply and the System MUST support both of these 1217 attributes. 1218

“system-uri” (uri): 1219

The Client MUST supply and the System MUST support the “system-uri” 1220 operation attribute which is the target System for the operation. 1221

“printer-id (integer(1:MAX)): 1222

The Client MUST supply and the System MUST support the “printer-id” 1223 operation attribute which is the target Printer for the operation. 1224

"requesting-user-name" (name(MAX)) and 1225 "requesting-user-uri" (uri) and 1226 “requesting-user-vcard” (1setOf text(1023)): 1227

The Client SHOULD supply and the System MUST support all three of these 1228 attributes. 1229

1230

Page 45: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 45 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

6.1.8.2 Startup-One-Printer Response 1231

The System MUST return a Startup-One-Printer operation response to the Client. 1232

Group 1: Operation Attributes 1233

"attributes-charset" (charset) and 1234 "attributes-natural-language" (naturalLanguage): 1235

The System MUST return both of these attributes. 1236

"status-message" (text(255)) and/or 1237 "detailed-status-message" (text(MAX)): 1238

The System MAY return one or both of these attributes. 1239

6.2 Resource Operations 1240

6.2.1 Cancel-Resource 1241

This REQUIRED operation allows an authorized Operator or Administrator to cancel an 1242 existing Resource object on the target System object. If the Resource object’s “resource-1243 state” is ‘canceled’ or ‘aborted’ or “resource-state-reasons” includes ‘cancel-requested’, 1244 then the System MUST return a “status-code” of ‘client-error-not-possible’. The System 1245 MUST set the “resource-state” to ‘canceled’ or leave “resource-state” unchanged and add 1246 ‘cancel-requested’ to “resource-state-reasons” (e.g., if the Resource is currently in use by 1247 a Job). In either case, the System MUST make the Resource permanently unavailable for 1248 future use. The System MUST preserve all Resource object attributes for an 1249 implementation-defined Resource History period – see below. When “resource-state” 1250 eventually transitions to ‘canceled’, the System SHOULD delete any local copy of 1251 Resource data. This operation is semantically analogous to the DeleteResource operation 1252 defined in [PWG5108.06] (except that the Resource is not removed, in order to preserve the 1253 integrity of system log files). This operation does not change the “system-state” of the 1254

System itself. See section 4.6. Resource Object and section 4.6.1 Resource History for 1255 more details. 1256

Resource History 1257

Page 46: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 46 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

6.2.1.1 The System MUST support an implementation-defined Resource History phase of 1258 at least 300 seconds, to preserved the integrity of system log files. The System SHOULD 1259 “age” out (i.e., delete) Resource objects with “resource-state” of ‘canceled’ from the 1260 Resource History when they have exceeded the implementation-defined Resource History 1261 period. This is to the handling of Job objects in a terminal state as discussed in the section 1262 “Partitioning of Job States” in [RFC2911]. However, unlike Job objects, the Resource 1263 object associated data referenced by “resource-data-uri” SHOULD be discarded as soon 1264 as “resource-state” transitions to ‘canceled’. Cancel-Resource Request 1265

The Client submits a Cancel-Resource operation request to a System object to cancel an 1266 existing Resource object. The following groups of attributes are part of a Cancel-Resource 1267 request. 1268

Group 1: Operation Attributes 1269

"attributes-charset" (charset) and 1270 "attributes-natural-language" (naturalLanguage): 1271

The Client MUST supply and the System MUST support both of these 1272 attributes. 1273

“system-uri” (uri): 1274

The Client MUST supply and the System MUST support the “system-uri” 1275 operation attribute which is the target System for the operation. 1276

“resource-id” (integer(1:MAX)): 1277

The Client MUST supply and the System MUST support this attribute which 1278 is the target Resource for the operation. 1279

"requesting-user-name" (name(MAX)) and 1280 "requesting-user-uri" (uri) and 1281 “requesting-user-vcard” (1setOf text(1023)): 1282

The Client SHOULD supply and the System MUST support all three of these 1283 attributes. 1284

6.2.1.2 Cancel-Resource Response 1285

The System MUST return a Cancel-Resource operation response to the Client. 1286

Group 1: Operation Attributes 1287

"attributes-charset" (charset) [RFC2911] and 1288 "attributes-natural-language" (naturalLanguage) [RFC2911]: 1289

The System MUST return both of these attributes. 1290

Page 47: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 47 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

"status-message" (text(255)) and/or 1291 "detailed-status-message" (text(MAX)): 1292

The System MAY return one or both of these attributes. 1293

Group 2: Unsupported Attributes 1294

See [RFC2911] for details on returning Unsupported Attributes. 1295

6.2.2 Create-Resource 1296

This REQUIRED operation allows an authorized Operator or Administrator to create a new 1297 Resource object on the target System object and optionally also create one or more new 1298 per-Resource Subscription objects. This operation is semantically analogous to the 1299 StoreResource operation defined in [PWG5108.06] (except that the Resource data is 1300 separately transferred with a subsequent Send-Resource-Data operation and installed for use 1301 with a subsequent Install-Resource operation). This operation does not change the “system-1302

state” of the System itself. 1303

A new Resource object will be created and initialized with the “resource-state” set to 1304 ‘pending’ (i.e., no Resource data has been associated yet). One or more requested per-1305 Resource Subcription objects can also be created. The Client can then use one or more 1306 Set-Resource-Attributes operations to modify the Resource object, followed by a Send-1307 Resource-Data operation (i.e., upload the associated Resource data) to change the 1308 “resource-state” to ‘available’. During processing of the Send-Resource-Data operation, 1309 the System can keep the “resource-state” of ‘pending’ and also add ‘resource-incoming’ to 1310 “resource-state-reasons” if the upload completion is delayed. The Client can then use an 1311 Install-Resource operation to install the Resource for use, which will either change 1312 “resource-state” to ‘installed’ or keep “resource-state” of ‘available’ add ‘install-requested’ 1313 to “resource-state-reasons”. See section 7.7.12 resource-state for a discussion of 1314 Resource object states and lifecycle phases. 1315

Note: The Client MUST use both the Send-Resource-Data and Install-Resource 1316 operations for all “resource-type” values, which simplifies the Resource state machine. 1317

Note: Printer-scope Resource objects MAY be: 1318

1) Created before the related Create-Printer operation and then associated with a 1319 given Printer using a Create-Printer operation via the “resource-ids” operation 1320 attribute to update the “printer-resource-ids” Printer Status attribute; 1321

2) Created after the related Create-Printer operation and then associated with a given 1322 Printer using an Allocate-Printer-Resources operation via the “resource-ids” 1323 operation attribute to update the “printer-resource-ids” Printer Status attribute; or 1324

3) Created after the related Create-Printer operation and then associated with a given 1325 Printer using an HTTP PUT request [RFC7230] as defined in section 4.1.9 1326

Page 48: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 48 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

Resources of IPP Shared Infrastructure Extensions [PWG5100.18] to update the 1327 “printer-resource-ids” Printer Status attribute. 1328

Note: Job-scope Resource objects MUST be created before the Job creation operation 1329 and then associated with a given Job via the “resource-ids” Job creation operation attribute 1330 to update the “job-resource-ids” Job Status attribute. 1331

Note: Resource-scope Subscription objects MUST be created after the related Create-1332 Resource operation, so that “notify-resource-id” can be correctly specified. 1333 1334

6.2.2.1 Create-Resource Request 1335

The Client submits a Create-Resource operation request to a System object. The 1336 following groups of attributes are part of a Create-Resource request. 1337

Group 1: Operation Attributes 1338

"attributes-charset" (charset) and 1339 "attributes-natural-language" (naturalLanguage): 1340

The Client MUST supply and the System MUST support both of these 1341 attributes. 1342

“system-uri” (uri): 1343

The Client MUST supply and the System MUST support the “system-uri” 1344 operation attribute which is the target System for the operation. 1345

"requesting-user-name" (name(MAX)) and 1346 "requesting-user-uri" (uri) and 1347 “requesting-user-vcard” (1setOf text(1023)): 1348

The Client SHOULD supply and the System MUST support all three of these 1349 attributes. 1350

“resource-format” (mimeMediaType) and 1351 “resource-type” (type2 keyword): 1352

The Client MUST supply and the System MUST support both of these 1353 attributes. 1354

Group 2: Resource Description Attributes 1355

<any Resource Description attribute> 1356

The Client MAY supply and the System MAY support these attributes. 1357

Page 49: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 49 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

Groups 3-N: Subscription Attributes 1358

See [RFC3995] for details on supplying Subscription Attributes. 1359

6.2.2.2 Create-Resource Response 1360

The System MUST return a Create-Resource operation response to the Client. 1361

Group 1: Operation Attributes 1362

"attributes-charset" (charset) [RFC2911] and 1363 "attributes-natural-language" (naturalLanguage) [RFC2911]: 1364

The System MUST return both of these attributes. 1365

"status-message" (text(255)) and/or 1366 "detailed-status-message" (text(MAX)): 1367

The System MAY return one or both of these attributes. 1368

1369

Group 2: Unsupported Attributes 1370

See [RFC2911] for details on returning Unsupported Attributes. 1371

Groups 3: Resource Attributes 1372

See [RFC2911] for details on returning analogous Printer Attributes. 1373

“resource-id” (integer(1:MAX)): 1374

The System MUST return this attribute. 1375

“resource-uuid” (uri(45)): 1376

The System MUST return this attribute. 1377

“resource-state” (type1 enum) and 1378 “resource-state-reasons” (1setOf type2 keyword): 1379

The System MUST return both of these attributes. 1380

Groups 4-N: Subscription Attributes 1381

See [RFC3995] for details on returning Subscription Attributes. 1382

Page 50: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 50 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

6.2.3 Get-Resources 1383

[rename of ListResources] 1384

- modeled on Get-Jobs with “requested-attributes” for which attributes to return – default is 1385 “resource-id” and “resource-state” 1386

Note: This Administrator operation requires Client authentication. 1387

6.2.4 Get-Resource-Attributes 1388

[rename of GetResourceElements] 1389

- modeled on Get-Job-Attributes with “requested-attributes” for which attributes to return – 1390 default is “resource-id” and “resource-state” 1391

6.2.5 Install-Resource 1392

[rename of part of original StoreResource] 1393

[To install a Resource (for use) after Create-Resource and Send-Resource-Data have 1394 completed and “resource-state” has transitioned to ‘available’] 1395

[Per IPP WG review on 08/15/16 Install-Resource: treat like Release-Job? where resource 1396 might be used immediately or after the next boot? 1397

⁃ 'resource-incoming' state reason, etc. 1398

⁃ Q: Which Subunit to install firmware resources to? 1399

⁃ A: Say that the firmware file/manifest identifies the subunit, it’s the responsiblity of the 1400

System/Printer to understand/interpret the manifest.] 1401

[Install-Resource MUST perform validation of the Resource data contents (e.g., metadata 1402 in the Resource data manifest file), unless this validation has already been performed 1403 during a previous associated Send-Resource-Data operation] 1404

[If the Resource object’s “resource-state” is ‘canceled’ or ‘aborted’ or “resource-state-1405 reasons” includes ‘cancel-requested’, then the System MUST return a “status-code” of 1406 ‘client-error-not-possible’.] 1407

[If this operation has a fatal immediate failure, then the System MUST immediately set 1408 “resource-state” to ‘aborted’. If this operation has a fatal delayed failure with ‘install-1409 requested’, then the System MUST immediately set “resource-state” to ‘aborted’.] 1410

[Per PWG F2F on 11/15/16, Executable resources MUST and other resources SHOULD 1411 have an associated cryptographic signature to allow the System to validate the content 1412 and origin of the resource. Maybe add subsections on resource validation in section 4.x, 1413 back reference it here.] 1414

Page 51: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 51 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

[Need to document metadata and validation requirements (avoiding DRM topics). For 1415 example, code signatures and format/data validation for executable resources, just 1416 format/data validation for nonexecutable resources. Point implementors to guidance on 1417 proper ways to do metadata validation in TBD external specs.] 1418

6.2.6 Send-Resource-Data 1419

[rename of part of original StoreResource] 1420

⁃ Agreement on not supporting replacement of resource data 1421

[Send-Resource-Data MAY perform validation of the Resource data contents (e.g., 1422 metadata in the Resource data manifest file), in order to avoid later failure of a subsequent 1423 associated Install-Resource] 1424

[If the Resource object’s “resource-state” is ‘canceled’ or ‘aborted’ or “resource-state-1425 reasons” includes ‘cancel-requested’, then the System MUST return a “status-code” of 1426 ‘client-error-not-possible’.] 1427

[If this operation has a fatal immediate failure, then the System MUST immediately set 1428 “resource-state” to ‘aborted’. If this operation has a fatal delayed failure with ‘resource-1429 incoming’, then the System MUST immediately set “resource-state” to ‘aborted’.] 1430

[Per PWG F2F on 11/15/16, SHOULD perform validation of the resource data, including 1431 the presence and correct formatting of any cryptographic signature in the resource data. 1432 Maybe add subsections on resource validation in section 4.x, back reference it here.] 1433

[Need to document metadata and validation requirements (avoiding DRM topics). For 1434 example, code signatures and format/data validation for executable resources, just 1435 format/data validation for nonexecutable resources. Point implementors to guidance on 1436 proper ways to do metadata validation in TBD external specs.] 1437

6.2.7 Set-Resource-Attributes 1438

[rename of SetResourceElements for Resource description attributes – MUST NOT 1439 change Resource status attributes or Resource data] 1440

[If the Resource object’s “resource-state” is ‘canceled’ or ‘aborted’ or “resource-state-1441 reasons” includes ‘cancel-requested’, then the System MUST return a “status-code” of 1442 ‘client-error-not-possible’.][If this operation has a fatal immediate failure, then the System 1443 MUST immediately set “resource-state” to ‘aborted’.] 1444

Page 52: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 52 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

6.3 Subscription Operations 1445

6.3.1 Create-Resource-Subscriptions 1446

This REQUIRED operation allows an authorized Client to create one or more per-1447 Resource Subscription objects. The Client supplies one or more Subscription Attributes 1448 groups, each containing one or more of the Subscription Template Attributes defined in 1449 section 5.3 Table 1 of [RFC3995]. The System MUST support all of the Subscription 1450 Template Attributes defined in section 5.3 Table 1 of [RFC3995]. If the Resource object’s 1451 “resource-state” is ‘canceled’ or ‘aborted’ or “resource-state-reasons” includes ‘cancel-1452 requested’, then the System MUST return a “status-code” of ‘client-error-not-possible’. 1453 This operation is semantically analogous to the Create-Job-Subscriptions operation 1454 defined in [RFC3995]. 1455

6.3.1.1 Create-Resource-Subscriptions Request 1456

The Client submits a Create-Resource-Subscriptions operation request to a System object. 1457 The following groups of attributes are part of a Create-Resource-Subscriptions request. 1458

Group 1: Operation Attributes 1459

"attributes-charset" (charset) and 1460 "attributes-natural-language" (naturalLanguage): 1461

The Client MUST supply and the System MUST support both of these 1462 attributes. 1463

“system-uri” (uri): 1464

The Client MUST supply and the System MUST support the “system-uri” 1465 operation attribute which is the target System for the operation. 1466

“resource-id” (integer(1:MAX)): 1467

The Client MUST supply and the System MUST support this attribute which 1468 is the target Resource for the operation. 1469

"requesting-user-name" (name(MAX)) and 1470 "requesting-user-uri" (uri) and 1471 “requesting-user-vcard” (1setOf text(1023)): 1472

The Client SHOULD supply and the System MUST support all three of these 1473 attributes. 1474

Groups 2-N: Subscription Attributes 1475

See [RFC3995] for details on supplying Subscription Attributes. 1476

Page 53: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 53 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

6.3.1.2 Create-Resource-Subscriptions Response 1477

The System MUST return a Create-Resource-Subscriptions operation response to the 1478 Client. 1479

Group 1: Operation Attributes 1480

"attributes-charset" (charset) [RFC2911] and 1481 "attributes-natural-language" (naturalLanguage) [RFC2911]: 1482

The System MUST return both of these attributes. 1483

"status-message" (text(255)) and/or 1484 "detailed-status-message" (text(MAX)): 1485

The System MAY return one or both of these attributes. 1486

Group 2: Unsupported Attributes 1487

See [RFC2911] for details on returning Unsupported Attributes. 1488

Groups 3-N: Subscription Attributes 1489

See [RFC3995] for details on returning Subscription Attributes. 1490

6.3.2 Create-System-Subscriptions 1491

This REQUIRED operation allows an authorized Client to create one or more per-System 1492 Subscription objects. The Client supplies one or more Subscription Attributes groups, 1493 each containing one or more of the Subscription Template Attributes defined in section 5.3 1494 Table 1 of [RFC3995]. The System MUST support all of the Subscription Template 1495 Attributes defined in section 5.3 Table 1 of [RFC3995]. This operation is semantically 1496 analogous to the Create-Printer-Subscriptions operation defined in [RFC3995]. 1497

6.3.2.1 Create-System-Subscriptions Request 1498

The Client submits a Create-System-Subscriptions operation request to a System object. 1499 The following groups of attributes are part of a Create-Resource-Subscriptions request. 1500

Group 1: Operation Attributes 1501

"attributes-charset" (charset) and 1502 "attributes-natural-language" (naturalLanguage): 1503

The Client MUST supply and the System MUST support both of these 1504 attributes. 1505

“system-uri” (uri): 1506

Page 54: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 54 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

The Client MUST supply and the System MUST support the “system-uri” 1507 operation attribute which is the target System for the operation. 1508

"requesting-user-name" (name(MAX)) and 1509 "requesting-user-uri" (uri) and 1510 “requesting-user-vcard” (1setOf text(1023)): 1511

The Client SHOULD supply and the System MUST support all three of these 1512 attributes. 1513

Groups 2-N: Subscription Attributes 1514

See [RFC3995] for details on supplying Subscription Attributes. 1515

6.3.2.2 Create-System-Subscriptions Response 1516

The System MUST return a Create-System-Subscriptions operation response to the Client. 1517

Group 1: Operation Attributes 1518

"attributes-charset" (charset) [RFC2911] and 1519 "attributes-natural-language" (naturalLanguage) [RFC2911]: 1520

The System MUST return both of these attributes. 1521

"status-message" (text(255)) and/or 1522 "detailed-status-message" (text(MAX)): 1523

The System MAY return one or both of these attributes. 1524

Group 2: Unsupported Attributes 1525

See [RFC2911] for details on returning Unsupported Attributes. 1526

Groups 3-N: Subscription Attributes 1527

See [RFC3995] for details on returning Subscription Attributes. 1528

6.4 System Operations 1529

6.4.1 Disable-All-Printers 1530

This REQUIRED operation allows an authorized Operator or Administrator to pause all 1531 configured Printer objects (i.e., Job processing services) on the target System object. This 1532 operation is semantically equivalent to the DisableAllServices operation defined in 1533 [PWG5108.06]. This operation is also semantically equivalent to a sequence of Disable-1534 Printer operations [RFC3398] to each configured Printer object. This operation does not 1535 change the “system-state” of the System itself. 1536

Page 55: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 55 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

Each configured Printer will be disabled with “printer-is-accepting-jobs” set to ‘false’ but the 1537 value of “printer-state” or “printer-state-reasons” is not affected by the Disable-All-Printers 1538 operation. 1539

6.4.1.1 Disable-All-Printers Request 1540

The Client submits a Disable-All-Printers operation request to a System object. The 1541 following groups of attributes are part of a Disable-All-Printers request. 1542

Group 1: Operation Attributes 1543

The System MUST support the same operation attributes in a Disable-All-Printers 1544 operation request as those defined for the Startup-All-Printers operation. 1545

6.4.1.2 Disable-All-Printers Response 1546

The System MUST return a Disable-All-Printers operation response to the Client. If no 1547 Printers are configured on the System, then the System MUST return a “status-code” of 1548 'successful-ok'. 1549

Group 1: Operation Attributes 1550

The System MUST support the same operation attributes in a Disable-All-Printers 1551 operation response as those defined for the Startup-All-Printers operation. 1552

6.4.2 Enable-All-Printers 1553

This REQUIRED operation allows an authorized Operator or Administrator to enable all 1554 configured Printer objects (i.e., Job processing services) on the target System object. This 1555 operation is semantically equivalent to the EnableAllServices operation defined in 1556 [PWG5108.06]. This operation is also semantically equivalent to a sequence of Enable-1557 Printer operations [RFC3398] to each configured Printer object. This operation does not 1558 change the “system-state” of the System itself. 1559

Each configured Printer will be enabled with “printer-is-accepting-jobs” set to ‘true’ but the 1560 value of “printer-state” or “printer-state-reasons” is not affected by the Enable-All-Printers 1561 operation. 1562

6.4.2.1 Enable-All-Printers Request 1563

The Client submits a Enable-All-Printers operation request to a System object. The 1564 following groups of attributes are part of a Enable-All-Printers request. 1565

Group 1: Operation Attributes 1566

The System MUST support the same operation attributes in a Enable-All-Printers 1567 operation request as those defined for the Startup-All-Printers operation. 1568

Page 56: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 56 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

6.4.2.2 Enable-All-Printers Response 1569

The System MUST return a Enable-All-Printers operation response to the Client. If no 1570 Printers are configured on the System, then the System MUST return a “status-code” of 1571 'successful-ok'. 1572

Group 1: Operation Attributes 1573

The System MUST support the same operation attributes in a Enable-All-Printers 1574 operation response as those defined for the Startup-All-Printers operation. 1575

6.4.3 Get-System-Attributes 1576

- modeled on 2911 Get-Printer-Attributes with “requested-attributes” for which attributes to 1577 return – default is all [TBD – may not be desirable] 1578

- require explicit attribute request for either system-configured-resources or system-1579 configured-printers (by analogy to media-col-database) 1580

6.4.4 Get-System-Supported-Values 1581

- modeled on Get-Printer-Supported-Values in [RFC3380] – REQUIRED in this 1582 specification 1583

6.4.5 Pause-All-Printers 1584

This REQUIRED operation allows an authorized Operator or Administrator to pause all 1585 configured Printer objects (i.e., Job processing services) on the target System object. This 1586 operation is semantically equivalent to the PauseAllServices operation defined in 1587 [PWG5108.06]. This operation is also semantically equivalent to a sequence of Pause-1588 Printer operations [RFC2911] to each configured Printer object. The System will be 1589 paused with the “system-state” set to ‘stopped’. 1590

Each configured Printer will be paused with the “printer-state” set to ‘stopped’ (although 1591 incoming Jobs can be accepted if the Printer is not disabled) and the ‘paused’ value added 1592 to “printer-state-reasons” (i.e., no Job processing output allowed). 1593

6.4.5.1 Pause-All-Printers Request 1594

The Client submits a Pause-All-Printers operation request to a System object. The 1595 following groups of attributes are part of a Pause-All-Printers request. 1596

Group 1: Operation Attributes 1597

The System MUST support the same operation attributes in a Pause-All-Printers operation 1598 request as those defined for the Startup-All-Printers operation. 1599

Page 57: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 57 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

6.4.5.2 Pause-All-Printers Response 1600

The System MUST return a Pause-All-Printers operation response to the Client. If no 1601 Printers are configured on the System, then the System MUST return a “status-code” of 1602 'successful-ok'. 1603

Group 1: Operation Attributes 1604

The System MUST support the same operation attributes in a Pause-All-Printers operation 1605 response as those defined for the Startup-All-Printers operation. 1606

6.4.6 Pause-All-Printers-After-Current-Job 1607

6.4.7 Register-Output-Device 1608

[for IPP Infra/Cloud Model] 1609

⁃ Drop system attributes in request? Continue discussion later (from PWG F2F 4/29/15) 1610

⁃ Put static resource attributes in the printer groups of the response 1611

6.4.8 Restart-System 1612

[operation to restart an entire System with existing firmware or different firmware (from 1613 Install-Resource after Create-Resource and Send-Resource-Data) – added for normal 1614 System maintenance and also System remediation based on health monitoring] 1615

6.4.9 Resume-All-Printers 1616

This REQUIRED operation allows an authorized Operator or Administrator to resume all 1617 configured Printer objects (i.e., Job processing services) on the target System object. This 1618 operation is semantically equivalent to the ResumeAllServices operation defined in 1619 [PWG5108.06]. This operation is also semantically equivalent to a sequence of Resume-1620 Printer operations [RFC2911] to each configured Printer object. This operation changes 1621 the “system-state” of the System itself to ‘idle’ (unless there is another reason for one or 1622 more Printers to stay in the ‘stopped’ state). 1623

Each configured Printer will be resumed with the “printer-state” set to ‘idle’ (unless there is 1624 another reason for the Printer to stay in the ‘stopped’ state) and the ‘paused’ value 1625 removed from “printer-state-reasons” (i.e., Job processing output allowed). 1626

6.4.9.1 Resume-All-Printers Request 1627

The Client submits a Resume-All-Printers operation request to a System object. The 1628 following groups of attributes are part of a Resume-All-Printers request. 1629

Group 1: Operation Attributes 1630

Page 58: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 58 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

The System MUST support the same operation attributes in a Resume-All-Printers 1631 operation request as those defined for the Startup-All-Printers operation. 1632

6.4.9.2 Resume-All-Printers Response 1633

The System MUST return a Resume-All-Printers operation response to the Client. If no 1634 Printers are configured on the System, then the System MUST return a “status-code” of 1635 'successful-ok'. 1636

Group 1: Operation Attributes 1637

The System MUST support the same operation attributes in a Resume-All-Printers 1638 operation response as those defined for the Startup-All-Printers operation. 1639

6.4.10 Set-System-Attributes 1640

This REQUIRED operation allows an authorized Operator or Administrator to set the 1641 values of System Description attributes listed in “system-settable-attributes-supported” 1642 (see section 7.2). 1643

For Client support for localization see “system-strings-languages-supported” and “system-1644 strings-uri” in section 7.2 1645

6.4.11 Shutdown-All-Printers 1646

This REQUIRED operation allows an authorized Operator or Administrator to shutdown all 1647 configured Printer objects (i.e., Job processing services) on the target System object. 1648 This operation is semantically equivalent to the ShutdownAllServices operation defined in 1649 [PWG5108.06]. This operation is also semantically equivalent to a sequence of Shutdown-1650 Printer operations [RFC3998] to each configured Printer object (except for the resulting 1651 “printer-state” of ‘stopped’ rather than ‘idle’). The System will be paused with the “system-1652 state” set to ‘stopped’. 1653

Each configured Printer will be shutdown with the “printer-state” set to ‘stopped’ (i.e., no 1654 Jobs can be processed and intervention is required) and the ‘shutdown’ value added to 1655 “printer-state-reasons”. The Client can later send a Startup-All-Printers operation 1656 (preferred) or a sequence of Startup-One-Printer operations (preferred) or Startup-Printer 1657 operations [RFC3998] to each Printer to start up all of the configured Printers. 1658

6.4.11.1 Shutdown-All-Printers Request 1659

The Client submits a Shutdown-All-Printers operation request to a System object. The 1660 following groups of attributes are part of a Shutdown-All-Printers request. 1661

Group 1: Operation Attributes 1662

The System MUST support the same operation attributes in a Shutdown-All-Printers 1663 operation request as those defined for the Startup-All-Printers operation. 1664

Page 59: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 59 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

6.4.11.2 Shutdown-All-Printers Response 1665

The System MUST return a Shutdown-All-Printers operation response to the Client. If no 1666 Printers are configured on the System, then the System MUST return a “status-code” of 1667 'successful-ok'. 1668

Group 1: Operation Attributes 1669

The System MUST support the same operation attributes in a Shutdown-All-Printers 1670 operation response as those defined for the Startup-All-Printers operation. 1671

6.4.12 Startup-All-Printers 1672

This REQUIRED operation allows an authorized Operator or Administrator to startup all 1673 configured Printer objects (i.e., Job processing services) on the target System object. 1674 This operation is semantically equivalent to the StartupAllServices operation defined in 1675 [PWG5108.06]. This operation is also semantically equivalent to a sequence of Startup-1676 One-Printer operations for each configured Printer object. The System will be paused with 1677 the “system-state” set to ‘stopped’. 1678

Each configured Printer will be started up with the “printer-state” set to ‘stopped’ (i.e., no 1679 Jobs can be processed and intervention is required), “printer-is-accepting-jobs” set to 1680 ‘false’ (i.e., no incoming Jobs accepted), and the ‘paused’ value added to “printer-state-1681 reasons” (i.e., no Job processing output allowed). The Client can then send one or more 1682 Set-Printer-Attributes operations to modify the configuration of each Printer, followed by 1683 Resume-Printer (i.e., remove ‘paused’ from “printer-state-reasons”) and Enable-Printer 1684 (i.e., change “printer-is-accepting-jobs” to ‘true’). 1685

6.4.12.1 Startup-All-Printers Request 1686

The Client submits a Startup-All-Printers operation request to a System object. The 1687 following groups of attributes are part of a Startup-All-Printers request. 1688

Group 1: Operation Attributes 1689

"attributes-charset" (charset) and 1690 "attributes-natural-language" (naturalLanguage): 1691

The Client MUST supply and the System MUST support both of these 1692 attributes. 1693

“system-uri” (uri): 1694

The Client MUST supply and the System MUST support the “system-uri” 1695 operation attribute which is the target System for the operation. 1696

Page 60: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 60 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

"requesting-user-name" (name(MAX)) and 1697 "requesting-user-uri" (uri) and 1698 “requesting-user-vcard” (1setOf text(1023)): 1699

The Client SHOULD supply and the System MUST support all three of these 1700 attributes. 1701

1702

6.4.12.2 Startup-All-Printers Response 1703

The System MUST return a Startup-All-Printers operation response to the Client. If no 1704 Printers are configured on the System, then the System MUST return a “status-code” of 1705 'successful-ok'. 1706

Group 1: Operation Attributes 1707

"attributes-charset" (charset) and 1708 "attributes-natural-language" (naturalLanguage): 1709

The System MUST return both of these attributes. 1710

"status-message" (text(255)) and/or 1711 "detailed-status-message" (text(MAX)): 1712

The System MAY return one or both of these attributes. 1713

1714

Page 61: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 61 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

7. IPP Attributes 1715

7.1 IPP Operation Attributes 1716

The following operation attributes can be applicable to one or more System, Printer, 1717 Resource, Job, or Subscription operations. 1718

7.1.1 printer-id (integer(1:MAX)) 1719

This operation attribute specifies the target Printer object as used in Get-Printer-Attributes 1720 and some other Printer operations defined in section 6 and is semantically equivalent to 1721 the ServiceSummary element ID defined in [PWG5108.06] and semantically analogous to 1722 the “job-id” attribute defined in [RFC2911]. See “printer-id” in section 7.5 Printer Status 1723 Attributes. 1724

7.1.2 printer-ids (1setOf (integer(1:MAX))) 1725

This operation attribute specifies the list of “printer-id” values for target Printer objects as 1726 used in Get-Printers and the list of associated Printer objects as used in Create-Resource 1727 and some other Printer operations and the list of associated Printer objects as used in 1728 Create-Resource defined in section 6 and is semantically equivalent a list of the 1729 ServiceSummary element ID defined in [PWG5108.06] and semantically analogous a list 1730 of the “job-id” attribute defined in [RFC2911]. See “printer-id” in section 7.5 Printer Status 1731 Attributes. 1732

7.1.3 printer-geo-location (uri) 1733

This operation attribute specifies a filter for the applicable Printers as used in Get-Printers 1734 defined in section 6 and is semantically analogous to the “printer-geo-location” attribute 1735 defined in [PWG5100.13]. 1736

7.1.4 printer-location (text(127)) 1737

This operation attribute specifies a filter for the applicable Printers as used in Get-Printers 1738 defined in section 6 and is semantically analogous to the “printer-location” attribute defined 1739 in [RFC2911]. 1740

7.1.5 printer-service-type (1setOf (type2 keyword)) 1741

This operation attribute specifies the service type for a Printer as used in Create-Printer or 1742 a filter for the applicable Printers as used in Get-Printers defined in section 6 and is 1743 semantically equivalent to the ServiceSummary element ServiceType defined in 1744 [PWG5108.06]. See “printer-service-type” in section 7.5 Printer Status Attributes. 1745

Page 62: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 62 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

7.1.6 requesting-user-vcard (1setOf text(1023)) 1746

This operation attribute contains the System, Printer, Resource, or Job Owner vCard 1747 [RFC6350] for a Set-System-Attributes, Create-Printer, Create-Resource, or Create-Job 1748 operation and is semantically analogous to the Service object’s OwnerVCard defined in 1749 [PWG5108.01]. See “printer-owner-col” (section 7.4)and “resource-owner-col” (section 1750 7.6) description attributes for updates via subsequent Set-Printer-Attributes or Set-1751 Resource-Attributes operations. 1752 The recorded values System, Printer, Resource, or Job Owner MUST identify the most 1753 authenticated user information. As with “requesting-user-name” [RFC2911], the most 1754 authenticated user information is copied to the System, Printer, Resource, or Job object. 1755

7.1.7 resource-format (1setOf (mimeMediaType)) 1756

This operation attribute specifies the format for a Resource as used in Create-1757 Resource/Send-Resource-Data or a filter for the applicable Resources as used in Get-1758 Resources defined in section 6 and is semantically equivalent to the ResourceFormat 1759 element defined in [PWG5108.03] and semantically analogous to the “document-format” 1760 attribute defined in [RFC2911]. See “resource-format” in section 7.7 Resource Status 1761 Attributes. 1762

7.1.8 resource-id (integer(1:MAX)) 1763

This operation attribute specifies the target Resource object as used in Get-Resource-1764 Attributes and other Resource operations defined in section 6 and is semantically 1765 equivalent to the ResourceId element defined in [PWG5108.03] and semantically 1766 analogous to the “job-id” attribute defined in [RFC2911]. See “resource-id” in section 7.7 1767 Resource Status Attributes. 1768

7.1.9 resource-ids (1setOf integer(1:MAX)) 1769

This operation attribute specifies the list of “resource-id” values for associated Resource 1770 objects as used in the Create-Printer and Allocate Printer-Resources operations defined in 1771 section 6 or in a Job Creation operation (Create-Job, Print-Job, or Print-URI) defined in 1772 [RFC2911] and is semantically analogous to the “job-printer-uri” attribute defined in 1773 [RFC2911]. See “resource-id” in section 7.7 Resource Status Attributes. 1774

7.1.10 resource-k-octets (integer(0:MAX)) 1775

This operation attribute specifies the size of the data for a Resource as used in Create-1776 Resource/Send-Resource-Data defined in section 6 and is semantically analogous to the 1777 “job-k-octets” attribute defined in [RFC2911]. See “resource-k-octets” in section 7.7 1778 Resource Status Attributes. 1779

Page 63: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 63 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

7.1.11 resource-state (type1 enum) 1780

This operation attribute specifies a filter for the applicable Resources as used in Get-1781 Resources defined in section 6 and is semantically analogous to the “job-state” attribute 1782 defined in [RFC2911] and replaces the semantically analogous DateTimeAtExpiration 1783 (Resource lease time) and ResourceIsExpired elements defined in [PWG5108.03]. See 1784 “resource-state” in section 7.7 Resource Status Attributes. 1785

7.1.12 resource-type (type2 keyword) 1786

This operation attribute specifies a filter for the applicable Resources as used in Get-1787 Resources defined in section 6 and replaces the semantically analogous 1788 DateTimeAtExpiration (Resource lease time) element defined in [PWG5108.03]. See 1789 “resource-type” in section 7.7 Resource Status Attributes. 1790

7.1.13 system-uri (uri) 1791

This operation attribute specifies the target System object as used in Get-Printers and all 1792 other operations defined in section 6 and is semantically analogous to the “printer-uri” 1793 attribute defined in [RFC2911] and semantically equivalent to the “SystemURI” attribute 1794 defined in [PWG5108.06]. 1795

7.1.14 which-printers (type2 keyword): 1796

This operation attribute specifies a filter for the applicable Printers as used in Get-Printers 1797 defined in section 6 and is semantically analogous to the “which-jobs” attribute defined in 1798 [RFC2911]. 1799

Standard keyword values for this attribute include: 1800

‘accepting’: All Printers with “printer-state” of ‘idle’ or ‘processing’ and “printer-is-1801 accepting-jobs” of ‘true’. 1802

‘all’: All Printers configured on this System object, regardless of their state. 1803

‘idle’: All Printers with “printer-state” of ‘idle’. 1804

‘not-accepting: All Printers with “printer-is-accepting-jobs” of ‘false’. 1805

‘processing’: All Printers with “printer-state” of ‘processing’. 1806

‘shutdown’: All Printers with “printer-state” of ‘stopped’ and “printer-state-reasons” 1807 of ‘shutdown’. 1808

‘stopped’: All Printers with “printer-state” of ‘stopped’, but do not have “printer-state-1809 reasons” of ‘shutdown’ or ‘testing’. 1810

Page 64: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 64 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

‘testing’: All Printers with “printer-state” of ‘stopped’ and “printer-state-reasons” of 1811 testing’. 1812

7.2 System Description Attributes 1813

System Description attributes are typically READ-WRITE and can potentially be set by an 1814 Operator or Administrator using the Set-System-Attributes operation (see section 6). 1815 Writable System Description attributes are listed in the value of “system-settable-attributes-1816 supported” (see section 7.2). 1817

7.2.1 Power States and Policies 1818

This specification imports (and renames for clarity and common usage) the normative 1819 definitions and semantics of System power states from the PWG Power Management 1820 Model for Imaging Systems 1.0 [PWG5106.4], which is aligned with DMTF CIM and ACPI 1821 power state definitions and semantics. 1822 1823

7.2.1.1 IEEE 1621 Power Modes 1824

[IEEE1621] (which is primarily concerned with a simple user interface) defines 3 basic 1825 power modes: Off Mode, Sleep Mode, and On Mode. These power modes in turn can be 1826 qualified with “soft / hard”, “light / deep”, and “graceful” to describe specific power states 1827 (see the following sections on DMTF stable and ephemeral power states). 1828

Off Mode – the set of power states where incoming jobs cannot be accepted 1829 immediately and existing jobs cannot be processed immediately (i.e., without a long 1830 delay for a power state transition to On Mode). 1831

On Mode – the set of power states where incoming jobs can be accepted 1832 immediately and existing jobs can be processed immediately (i.e., with no delay for 1833 a power state transition). 1834

Sleep Mode – the set of power states where incoming jobs MAY be accepted 1835 immediately, but existing jobs cannot be processed immediately (i.e., without a 1836 short delay for a power state transition to On Mode). 1837

7.2.1.2 DMTF Stable Power States 1838

This specification imports (and renames for clarity and common usage) the normative 1839 definitions and semantics of the following DMTF CIM [DSP1027] stable power states. All 1840 other DMTF CIM power states are ephemeral (orderly shutdowns and power resets) and 1841 will eventually result in one of the stable power states defined below. 1842

‘hibernate’: DMTF “Hibernate (Off-Soft)” (7) and ACPI S4. The stable “Off Mode” 1843 power state where all kernel and application programs and data have been saved 1844 (e.g., to a hard disk) such that a transition to On allows recovery and continued 1845

Page 65: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 65 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

processing without any loss of jobs or data. Limited auxiliary power is consumed 1846 (e.g., console lights), no network interfaces are operational, and human intervention 1847 is required to power up the system. 1848

‘off-hard’: DMTF “Off-Hard” (6) and ACPI G3. The stable “Off Mode” power state 1849 where System power is mechanically or electrically turned off. No power is 1850 consumed, no network interfaces are operational, and human intervention is 1851 required to power up the System. 1852

‘off-soft’: DMTF “Off-Soft” (8) and ACPI G2 or S5. The stable “Off Mode” power 1853 state where only limited auxiliary power is consumed (e.g., console lights), no 1854 network interfaces are operational, and human intervention is required to power up 1855 the system. 1856

‘on’: DMTF “On” (2) – ACPI G0 or S0 – the stable “On Mode” power state where 1857 the System is in ‘idle’, ‘processing’, or ‘stopped’ operational states, with no delay 1858 required for a power state transition before processing incoming jobs. 1859

‘standby’: DMTF “Sleep-Light” (3) and ACPI S1 or S2. The stable “Sleep Mode” 1860 power state with the shortest wake-up transition to the ‘on’ power state. Typically, 1861 mechanical elements (motors, lamps, heaters, etc.) are turned off or turned down, 1862 but processors and network interfaces are fully active (e.g., normal clock rate). 1863

‘suspend’: DMTF “Sleep-Deep” (4) and ACPI S3. The stable “Sleep Mode” power 1864 state with the lowest power consumption of any “Sleep Mode” power state. 1865 Typically, mechanical elements (motors, lamps, heaters, etc.) are turned off, but 1866 processors and network interfaces are partially active (e.g., lower clock rate). 1867 Kernel and application programs and data are preserved (i.e., periodically 1868 refreshed) in main memory and at least one network interface is operational. 1869

Additional vendor-specific power sub-states are defined as qualifiers of the stable power 1870 states ‘hibernate’, ‘off-soft’, ‘on’, ‘standby’, and ‘suspend’ (but not ‘off-hard’). These 1871 additional power sub-state keywords are all of the form ‘<base>-vendorN’ where ‘N’ is from 1872 ‘1’ to ‘5’ and the semantics MUST be exactly the same as those defined for these power 1873 sub-states as defined in [PWG5106.4]. Vendor-specific power sub-states MUST be used 1874 in strict order according to their nominal power consumption, e.g., ‘standby-vendor2’ 1875 MUST consume power equal to or higher than ‘standby-vendor1’ and ‘standby-vendor1’ 1876 MUST consume power equal to or higher than ‘standby’ (the base state). 1877

7.2.1.3 DMTF Ephemeral Power States 1878

This specification imports (and renames for clarity and common usage) the normative 1879 definitions and semantics of the following DMTF CIM [DSP1027] ephemeral (transitional) 1880 power states that initiate orderly shutdowns (e.g., ‘off-soft-graceful’) and power resets 1881 (e.g., ‘reset-hard’). All DMTF CIM ephemeral power state transitions will eventually result 1882 in one of the stable power states defined in section 7.2.1.2 above. 1883

Page 66: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 66 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

‘off-hard-graceful’: DMTF “Off-Hard Graceful” (13) and ACPI G3. The ephemeral 1884 power state that performs a graceful hard power off (orderly shutdown, followed by 1885 a hard power off cycle) and completes in the ‘off-hard’ power state. 1886

‘off-soft-graceful’: DMTF “Off-Soft Graceful” (12) and ACPI G2 or S5. The 1887 ephemeral power state that performs a graceful soft power off (orderly shutdown, 1888 followed by a soft power off cycle) and completes in the ‘off-soft’ power state. 1889

‘reset-hard’: DMTF “Power Cycle (Off-Hard)” (9) and ACPI G0 to G3, then S0. The 1890 ephemeral power state that performs a hard power reset (hard power off cycle, 1891 followed by normal power on cycle) and completes in the ‘on’ power state. 1892

‘reset-hard-graceful’: DMTF “Power Cycle Off-Soft Graceful” (16) and ACPI G3, 1893 then S0. The ephemeral power state that performs a graceful hard power reset 1894 (orderly shutdown, followed by a hard power reset) and completes in the ‘on’ power 1895 state. 1896

‘reset-init’: DMTF “Diagnostic Interrupt (INIT)” (17) and ACPI S5, then S0. The 1897 ephemeral power state (based on a diagnostic interrupt) that performs a hard power 1898 reset (hard power off cycle, followed by normal power on cycle) and completes in 1899 the ‘on’ power state. 1900

‘reset-mbr’: DMTF “Master Bus Reset” (10) and ACPI S5, then S0. The ephemeral 1901 power state (based on a master bus reset) that performs a hard power reset (hard 1902 power off cycle, followed by normal power on cycle) and completes in the ‘on’ power 1903 state. 1904

‘reset-mbr-graceful’: DMTF “Master Bus Reset Graceful” (14) and ACPI S5, then 1905 S0. The ephemeral power state that performs an orderly shutdown, followed by an 1906 MBR reset, and completes in the ‘on’ power state. 1907

‘reset-nmi’: DMTF “Diagnostic Interrupt (NMI)” (11) and ACPI S5, then S0. The 1908 ephemeral power state (based on a non-maskable interrupt) that performs a hard 1909 power reset (hard power off cycle, followed by normal power on cycle) and 1910 completes in the ‘on’ power state. 1911

‘reset-soft’: DMTF “Power Cycle (Off-Soft)” (5) and ACPI G2 or S5, then S0 w/ lost 1912 context. The ephemeral power state that performs a soft power reset (soft power 1913 off, followed by normal power on cycle) and completes in the ‘on’ power state. 1914

‘reset-soft-graceful’: DMTF “Power Cycle Off-Soft Graceful” (16) and ACPI G2 or 1915 S5, then S0 w/ lost context. The ephemeral power state that performs a graceful 1916 soft power reset (orderly shutdown, followed by a soft power reset) and completes 1917 in the ‘on’ power state. 1918

Page 67: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 67 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

7.2.1.4 Power Policies 1919

Power state transition policies can be scheduled by an Operator or Administrator in 1920 “power-calendar-policy-col”, “power-event-policy-col”, and “power-timeout-policy-col” 1921 System attributes. These policies can use triggers based on calendar times (e.g., 1st day 1922 of month), named events (e.g., ‘jam’), or elapsed time (e.g., 5 minutes of inactivity after 1923 entering ‘standby’ power state resulting in a further transition to ‘suspend’ power state). 1924

System administrative operations can also invoke System power state transitions (e.g., 1925 Restart-System can invoke a ‘reset-soft-graceful’ transition). Job creation operations can 1926 be delayed in some System power states (e.g., during the warm up transition from 1927 ‘suspend’ to ‘on’). Job creation operations can also be prohibited in some System power 1928 states (e.g., in ‘hibernate’ and ‘off-soft’). 1929

Note: This specification intentionally does not define any explicit operations for changing 1930 System power states. System power policies can be used instead to schedule power state 1931 transitions. 1932

An example of an automated System power state transition to ‘hibernate’ at 6pm every 1933 Friday evening could be scheduled in “power-calendar-policy-col” as follows: 1934

calendar-id=32 # arbitrary unique value for calendar policy 1935

day-of-week=6 # Friday is 6th day counting from Sunday 1936

hour=18 # 6pm is 18:00 on a 24-hour clock 1937

request-power-state=’hibernate’ # target power state 1938

In the above example, the irrelevant “day-of-month”, “minute”, “month”, and “run-once” 1939 member attributes have been omitted. 1940

An example of a Restart-System operation implementation could be as follows: 1941

1) ‘stopping’ is added to “system-state-reasons” for the System. 1942

2) ‘stopping’ is added to “printer-state-reasons” for each configured Printer. 1943

3) ‘processing-to-stop-point’ is added to “job-state-reasons” for each active Job. 1944

4) All active Jobs complete normally (because the stop point is a Job boundary) and 1945 ‘processing-to-stop-point’ is removed from “job-state-reasons” for each completed 1946 Job. 1947

5) ‘stopping’ is removed from “printer-state-reasons” and “printer-state” is changed to 1948 ‘stopped’ for each configured Printer. 1949

Page 68: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 68 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

6) ‘stopping’ is removed from “system-state-reasons” and “system-state” is changed to 1950 ‘stopped’ for the System. 1951

7) The System executes a ‘reset-soft-graceful’ transition, resulting in “power-state” in 1952 “power-state-monitor-col” values: on standby off-soft standby on. 1953

8) “system-state” is changed to ‘idle’ for the System and “printer-state” is changed to 1954 ‘idle’ for each configured Printer. 1955

9) Job processing resumes normally on all Printers. 1956

7.2.2 charset-configured (charset) 1957

This REQUIRED System attribute identifies the charset that is used to represent attributes 1958 with 'text' and 'name' attribute syntaxes and is semantically analogous to the "charset-1959 configured" Printer attribute defined in [RFC2911]. The value of the "charset-configured" 1960 attribute MUST be one of the values of the "charset-supported" attribute defined in section 1961 7.2.2. 1962

7.2.3 charset-supported (1setOf charset) 1963

This REQUIRED System attribute lists the charsets that are supported for values of 1964 attributes with 'text' and 'name' attribute syntaxes and is semantically analogous to the 1965 "charset-supported" Printer attribute defined in [RFC2911]. The value 'utf-8' MUST be 1966 present, since IPP objects MUST support the UTF-8 [RFC3629] charset. 1967

7.2.4 ipp-versions-supported (1setOf type2 keyword) 1968

This REQUIRED attribute identifies the supported IPP protocol version(s) and is 1969 semantically analogous to the "ipp-versions-supported" Printer attribute defined in 1970 [RFC2911]. 1971

7.2.5 natural-language-configured (naturalLanguage) 1972

This REQUIRED System attribute identifies the natural language that is used for System-1973 generated attribute values with 'text' and 'name' attribute syntaxes and is semantically 1974 analogous to the "natural-language-configured" Printer attribute defined in [RFC2911]. 1975

7.2.6 generated-natural-language-supported (1setOf naturalLanguage) 1976

This REQUIRED System attribute lists the natural language(s) that are supported for 1977 System-generated attribute values with 'text' and 'name' attribute syntaxes and is 1978 semantically analogous to the "generated-natural-language-supported" Printer attribute 1979 defined in [RFC2911]. 1980

Note: The natural language(s) supported for System-generated values depends on 1981 implementation and/or configuration. However, unlike charsets, System objects MUST 1982

Page 69: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 69 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

accept requests with any natural language or any Natural Language Override whether or 1983 not the natural language is supported for System-generated attribute values. 1984

Note: A System that supports multiple natural languages, often has separate catalogs of 1985 messages, one for each natural language supported. 1986

7.2.7 operations-supported (1setOf type2 enum) 1987

This REQUIRED System attribute lists the supported System operations and is 1988 semantically analogous to the “operations-supported" Printer attribute defined in 1989 [RFC2911]. 1990

7.2.8 power-calendar-policy-col (1setOf collection) 1991

This OPTIONAL System attribute lists the configured System calendar-based power state 1992 change policies and is semantically equivalent to the Power Calendar group defined in 1993 [PWG5106.4]. If “power-calendar-policy-col” is supported, then all member attributes in 1994 this collection are REQUIRED for the System but are OPTIONAL for the Client to supply. 1995

For example, an automated System power state transition to ‘hibernate’ at 6pm every 1996 Friday evening could be scheduled in “power-calendar-policy-col” as follows: 1997

calendar-id=32 # arbitrary unique value for calendar policy 1998

day-of-week=6 # Friday is 6th day counting from Sunday 1999

hour=18 # 6pm is 18:00 on a 24-hour clock 2000

request-power-state=’hibernate’ # target power state 2001

In the above example, the irrelevant “day-of-month”, “minute”, “month”, and “run-once” 2002 member attributes have been omitted. 2003

7.2.8.1 calendar-id (integer(1:MAX)) 2004

This REQUIRED member attribute contains the unique key of this calendar policy and is 2005 semantically equivalent to the CalendarID element in the Power Calendar group defined in 2006 [PWG5106.4]. 2007

7.2.8.2 day-of-month (integer(1:31)) 2008

This REQUIRED member attribute specifies the trigger day of the month for this calendar 2009 policy and is semantically equivalent to the CalendarDay element in the Power Calendar 2010 group defined in [PWG5106.4]. The value ‘1’ represents the first day of the month. 2011

See “system-current-time” defined above for the relevant System date, time, and time zone 2012 values. 2013

Page 70: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 70 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

7.2.8.3 day-of-week (integer(1:7)) 2014

This REQUIRED member attribute specifies the trigger day of the week for this calendar 2015 policy and is semantically equivalent to the CalendarDayOfWeek element in the Power 2016 Calendar group defined in [PWG5106.4]. The value ‘1’ represents Sunday. 2017

See “system-current-time” defined above for the relevant System date, time, and time zone 2018 values. 2019

7.2.8.4 hour (integer(0:23)) 2020

This REQUIRED member attribute specifies the trigger hour for this calendar policy and is 2021 semantically equivalent to the CalendarHour element in the Power Calendar group defined 2022 in [PWG5106.4]. The value ‘0’ represents the first hour of the day (i.e., 12:00-12:59am). 2023 Midnight (i.e., 12:00am) is specified by a value of zero for “hour” and a value of zero for 2024 “minute”. 2025

See “system-current-time” defined above for the relevant System date, time, and time zone 2026 values. 2027

Note: Due to local time zone changes (summer time to standard time or vice versa), it’s 2028 possible that a given hour will not occur in a given month. 2029

7.2.8.5 minute (integer(0:59)) 2030

This REQUIRED member attribute specifies the trigger minute for this calendar policy and 2031 is semantically equivalent to the CalendarMinute element in the Power Calendar group 2032 defined in [PWG5106.4]. The value ‘0’ represents the first minute of the hour (e.g., 2033 7:00am). 2034

See “system-current-time” defined above for the relevant System date, time, and time zone 2035 values. 2036

7.2.8.6 month (integer(1:12)) 2037

This REQUIRED member attribute specifies the trigger month for this calendar policy and 2038 is semantically equivalent to the CalendarMonth element in the Power Calendar group 2039 defined in [PWG5106.4]. The value of ‘1’ represents January. 2040

See “system-current-time” defined above for the relevant System date, time, and time zone 2041 values. 2042

7.2.8.7 request-power-state (type1 keyword) 2043

This REQUIRED member attribute specifies the requested stable or ephemeral 2044 (transitional) power state for this calendar policy and is semantically equivalent to the 2045 RequestPowerState element in the Power Calendar group defined in [PWG5106.4]. 2046

Page 71: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 71 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

Standard values and constraints on vendor extension values are defined in section 7.2.1 2047 Power States and Policies. 2048

7.2.8.8 run-once (boolean) 2049

This REQUIRED member attribute specifies whether this calendar policy should be run 2050 once (single execution) or repeatedly (multiple executions) and is semantically equivalent 2051 to the CalendarRunOnce element in the Power Calendar group defined in [PWG5106.4]. 2052

7.2.9 power-event-policy-col (1setOf collection) 2053

This OPTIONAL System attribute lists the configured System event-based power state 2054 change policies and is semantically equivalent to the Power Event group defined in 2055 [PWG5106.4]. 2056

For example, an automated System power state transition to ‘standby’ upon every ‘jam’ 2057 condition could be scheduled in “power-event-policy-col” as follows: 2058

event-id=11 # arbitrary unique value for event policy 2059

event-name=’jam’ # name of event 2060

request-power-state=’standby’ # target power state 2061

7.2.9.1 event-id (integer(1:MAX)) 2062

This REQUIRED member attribute contains the unique key of this event policy and is 2063 semantically equivalent to the EventID element in the Power Event group defined in 2064 [PWG5106.4]. 2065

7.2.9.2 event-name (name(127)) 2066

This REQUIRED member attribute specifies the trigger event name of this event policy and 2067 is semantically equivalent to the EventName element in the Power Event group defined in 2068 [PWG5106.4]. 2069

Event names MUST be either: (a) the exact case-sensitive label (starting with a lowercase 2070 character) of an enumerated value in the PrtAlertCodeTC textual convention in the IANA 2071 Printer MIB [IANAPRT] (e.g., ‘jam’); or (b) a case-sensitive vendor event name (starting 2072 with an uppercase character, e.g., ‘ExamplePowerEvent’). Event names MUST be 2073 specified in US-ASCII [ISO646] (for interoperability). 2074

7.2.9.3 request-power-state (type1 keyword) 2075

This REQUIRED member attribute specifies the requested stable or ephemeral 2076 (transitional) power state for this event policy and is semantically equivalent to the 2077 RequestPowerState element in the Power Event group defined in [PWG5106.4]. 2078

Page 72: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 72 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

Standard values and constraints on vendor extension values are defined in section 7.2.1 2079 Power States and Policies. 2080

7.2.10 power-timeout-policy-col (1setOf collection) 2081

This RECOMMENDED System attribute lists the configured System timeout-based power 2082 state change policies and is semantically equivalent to the Power Timeout group defined in 2083 [PWG5106.4]. 2084

For example, an automated System power state transition to ‘standby’ upon 5 minutes of 2085 inactivity in ‘on’ power state could be scheduled in “power-timeout-policy-col” as follows: 2086

request-power-state=’standby’ # target power state 2087

start-power-state=’on’ # starting power state 2088

timeout-id=23 # arbitrary unique value for timeout policy 2089

timeout-predicate=’inactivity’ # predicate of system inactivity 2090

timeout-seconds=300 # duration before transition to target power state 2091

7.2.10.1 request-power-state (type1 keyword) 2092

This REQUIRED member attribute specifies the requested stable or ephemeral 2093 (transitional) power state for this timeout policy and is semantically equivalent to the 2094 RequestPowerState element in the Power Timeout group defined in [PWG5106.4]. 2095

Standard values and constraints on vendor extension values are defined in section 7.2.1 2096 Power States and Policies. 2097

7.2.10.2 start-power-state (type1 keyword) 2098

This REQUIRED member attribute specifies the trigger starting stable power state for this 2099 timeout policy and is semantically equivalent to the StartPowerState element in the Power 2100 Timeout group defined in [PWG5106.4].Note: Ephemeral (transitional) power states 2101 cannot be specified as triggers for timeout policies. 2102

Standard values and constraints on vendor extension values for stable power states are 2103 defined in section 7.2.1 Power States and Policies. 2104

7.2.10.3 timeout-id (integer(1:MAX)) 2105

This REQUIRED member attribute contains the unique key of this timeout policy and is 2106 semantically equivalent to the TimeoutID element in the Power Timeout group defined in 2107 [PWG5106.4]. 2108

Page 73: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 73 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

7.2.10.4 timeout-predicate (type1 keyword) 2109

This REQUIRED member attribute specifies the trigger predicate (i.e., pre-condition) for 2110 this timeout policy and is semantically equivalent to the TimeoutPredicate element in the 2111 Power Timeout group defined in [PWG5106.4]. 2112

The standard keyword values for this attribute are: 2113

‘activity’ (i.e., incoming Job, console input, etc.) 2114

‘inactivity’ (i.e., no incoming, queued, or processing Jobs, console input, etc.) 2115

‘none’ 2116

7.2.10.5 timeout-seconds (integer(0:MAX)) 2117

This REQUIRED member attribute specifies the trigger timeout interval in seconds (or zero 2118 for an immediate trigger controlled by the other trigger member attributes) for this timeout 2119 policy and is semantically equivalent to the TimeoutSeconds element in the Power 2120 Timeout group defined in [PWG5106.4]. 2121

7.2.11 printer-creation-attributes-supported (1setOf type2 keyword) 2122

This REQUIRED System attribute lists Printer Description attributes supported for the 2123 Create-Printer operation and is semantically analogous to the “job-creation-attributes-2124 supported” Printer Description attribute defined in [PWG5100.11]. 2125

7.2.117.2.12 resource-settable-attributes-supported (1setOf type 2 keyword) 2126

This REQUIRED System attribute lists Resource Description attributes supported for 2127 READ-WRITE access and can be configured by an Operator or Administrator. See 2128 “system-strings-languages-supported” and “system-strings-uri” below for Client localization 2129 support. 2130

7.2.127.2.13 system-current-time (dateTime) 2131

This REQUIRED System attribute specifies the current date and time for the System and is 2132 semantically equivalent to the CurrentTime element defined in [PWG5108.06]. 2133

7.2.137.2.14 system-default-printer-id (integer (1:MAX) | no-value) 2134

This REQUIRED System attribute identifies the unique identifier of the default Print Service 2135 configured by the Operator, Administrator, or manufacturer (used by the End User 2136 operation Get-Printer-Attributes defined in this specification) and is semantically analogous 2137 to the “printer-uri-supported” and “job-printer-uri” attributes defined in [RFC2911]. When a 2138 System has no configured Print Services, that System MUST return the ‘no-value’ out-of-2139 band value defined in [RFC2911] for “system-default-printer-id”. For a related use case, 2140 see section 3.2.5 Bootstrap Client Access to Default Print Service. 2141

Page 74: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 74 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

Note: When the first Print Service is created on a System, the System MUST set the value 2142 of “system-default-printer-id” to reference that Print Service. 2143

7.2.147.2.15 system-device-id (text(1023)) 2144

This REQUIRED System attribute specifies the IEEE 1284 Device ID of the overall System 2145 as defined in [IEEE1284] and further refined in [PWG5107.2] and is semantically 2146 analogous to the "printer-device-id" Printer attribute defined in [PWG5107.2. 2147

7.2.157.2.16 system-geo-location (uri | unknown) 2148

This REQUIRED System attribute specifies the System geographic location using the 2149 “geo:” URI scheme [RFC5870] and is semantically analogous to the "printer-geo-location" 2150 Printer attribute defined in [PWG5100.13]. When the location is unknown, Systems MUST 2151 return the ‘unknown’ out-of-band value defined in [RFC2911]. Systems MUST allow the 2152 Operator or Administrator to set the geographic location manually. 2153

7.2.167.2.17 system-info (text(127)) 2154

This REQUIRED System attribute specifies System descriptive information, e.g., "This 2155 System can be used for printing color transparencies for HR presentations,” and is 2156 semantically analogous to the "printer-info" Printer attribute defined in [RFC2911]. 2157

7.2.177.2.18 system-location (text(127)) 2158

This REQUIRED System attribute identifies the System location, e.g., "This System is in 2159 Room 123A, second floor of building XYZ," and is semantically analogous to the "printer-2160 location" Printer attribute defined in [RFC2911]. 2161

7.2.187.2.19 system-mandatory-printer-attributes (1setOf type2 keyword) 2162

This REQUIRED System attribute identifies the mandatory-to-supply Printer Description 2163 attributes for a Create-Printer operation on this System and is semantically analogous to 2164 the “printer-mandatory-job-attributes” Printer Description attribute defined in 2165 [PWG5100.13]. This REQUIRED System attribute lists the minimum Printer and operation 2166 attributes that are required for a successful Create-Printer operation. This attribute MUST 2167 include the values 'printer-name' and 'printer-xri-supported' and SHOULD include the 2168 recommended attributes in Table 9 below.The System MUST include all of the REQUIRED 2169 Printer Description attributes and SHOULD include all of the RECOMMENDED Printer 2170 Description attributes listed in Table 9 below in the value of “system-mandatory-printer-2171 attributes”. 2172

Table 9 – MandatoryRecommended-to-Supply Printer Creation Attributes 2173

Conformance IPP Attribute Name Reference RECOMMENDED charset-configured [RFC2911] RECOMMENDED document-format-default [RFC2911] RECOMMENDED multiple-document-jobs-supported [RFC2911]

Page 75: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 75 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

RECOMMENDED natural-language-configured [RFC2911] RECOMMENDED pdl-override-supported [RFC2911] RECOMMENDED printer-info [RFC2911] RECOMMENDED printer-location [RFC2911] RECOMMENDED printer-make-and-model [RFC2911] REQUIRED printer-name [RFC2911] REQUIRED printer-xri-supported[1] [RFC3380]

Notes: 2174

1) The Client MUST supply and the System MUST support “printer-xri-supported” in 2175 the Create-Printer operation, to avoid the ambiguities possible with the original 2176 “printer-uri-supported”, “uri-authentication-supported”, and “uri-security-supported” 2177 attributes defined in [RFC2911]. 2178

2179

7.2.197.2.20 system-make-and-model (text(127)) 2180

This REQUIRED System attribute identifies the System make and model and is 2181 semantically analogous to the "printer-make-and-model" Printer attribute defined in 2182 [RFC2911]. The manufacturer can initially populate this attribute. 2183

7.2.207.2.21 system-message-from-operator (text(127)) 2184

This OPTIONAL System attribute provides a message from an Operator, Administrator, or 2185 "intelligent" process to indicate the reasons for modification or other System management 2186 action and is semantically analogous to the "printer-message-from-operator" Printer 2187 attribute defined in [RFC2911]. 2188

7.2.217.2.22 system-name (name(127)) 2189

This REQUIRED System attribute contains the System name and is semantically 2190 analogous to the "printer-name" Printer attribute defined in [RFC2911]. 2191

7.2.227.2.23 system-owner-col (collection) 2192

This REQUIRED System attribute identifies the System Owner. 2193

7.2.22.17.2.23.1 owner-uri (uri) 2194

This REQUIRED member attribute contains a System Owner URI, e.g., 2195 “mailto:[email protected],” and is semantically analogous to the Service object’s 2196 OwnerURI defined in [PWG5108.01]. If specified in a Set-System-Attributes operation, 2197 then the “owner-vcard” member attribute MUST also be specified (to preserve 2198 consistency). 2199

Page 76: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 76 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

7.2.22.27.2.23.2 owner-vcard (1setOf text(1023)) 2200

This REQUIRED member attribute contains a System Owner vCard [RFC6350] and is 2201 semantically analogous to the Service object’s OwnerVCard defined in [PWG5108.01]. If 2202 specified in a Set-System-Attributes operation, then the “owner-uri” member attribute 2203 MUST also be specified (to preserve consistency). 2204

7.2.237.2.24 system-settable-attributes-supported (1setOf type2 keyword) 2205

This REQUIRED System attribute lists System Description attributes supported for READ-2206 WRITE access and can be configured by an Operator or Administrator. See “system-2207 strings-languages-supported” and “system-strings-uri” below for Client localization support. 2208

7.2.247.2.25 system-strings-languages-supported (1setOf naturalLanguage) 2209

This RECOMMENDED System attribute lists natural languages supported for the “system-2210 strings-uri” System attribute and is semantically analogous to the “printer-strings-2211 languages-supported” Printer attribute defined in [PWG5100.13]. 2212

This attribute MUST be supported if the "system-strings-uri" attribute is supported. 2213

7.2.257.2.26 system-strings-uri (uri | no-value) 2214

This RECOMMENDED System attribute provides a "text/strings" message catalog file 2215 using "http:" or "https:" URIs that SHOULD be System-resident so that Client interaction 2216 with the System does not require access to external networks and is semantically 2217 analogous to the “printer-strings-uri” Printer attribute defined in [PWG5100.13]. Systems 2218 SHOULD provide localizations for all supported System attributes, keywords, and enums, 2219 so that a Client may present a consistent user interface to the User. 2220

This attribute MUST be supported if the "system-strings-uri" attribute is supported. 2221

7.2.267.2.27 system-xri-supported (1setOf collection) 2222

This REQUIRED System attribute lists supported XRI (URI, authentication, and security 2223 tuples) for the System and is semantically analogous to the "printer-xri-supported" Printer 2224 attribute defined in [RFC3380] and semantically analogous to Service object’s 2225 XriSupported defined in [PWG5108.01]. 2226

7.2.26.17.2.27.1 xri-uri (uri) 2227

This REQUIRED member attribute specifies an “ipp:” [RFC3510] or “ipps:” [RFC7472] URI 2228 for this System and is semantically analogous to a value of the “xri-uri” member attribute 2229 defined in [RFC3380]. 2230

Page 77: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 77 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

7.2.26.27.2.27.2 xri-authentication (type2 keyword) 2231

This REQUIRED member attribute specifies the IPP Client Authentication mechanism 2232 associated with the corresponding value of “xri-uri” above and is semantically analogous to 2233 a value of the “xri-authentication” member attribute defined in [RFC3380]. The original 2234 standard values for this attribute are defined in [RFC2911] and extension values are 2235 registered in the IANA IPP Registry [IANAIPP]. 2236

7.2.26.37.2.27.3 xri-security (type2 keyword) 2237

This REQUIRED member attribute specifies the IPP security mechanism associated with 2238 the corresponding value of “xri-uri” above and is semantically analogous to a value of the 2239 “xri-security” member attribute defined in [RFC3380]. The original standard values for this 2240 attribute are defined in [RFC2911] and extension values are registered in the IANA IPP 2241 Registry [IANAIPP]. 2242

Page 78: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 78 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

7.3 System Status Attributes 2243

All of the System Status attributes are READ-ONLY and cannot be changed directly by the 2244 Set-System-Attributes operation. 2245

7.3.1 power-log-col (1setOf collection) 2246

This RECOMMENDED System attribute lists System power log entries (for events) and is 2247 semantically equivalent to the Power Log group defined in [PWG5106.4]. 2248

Systems SHOULD minimize the number of power log entries in this attribute for reliability. 2249 Systems MUST record all final stable power state transitions in this attribute for every 2250 sequence invoked by an ephemeral requested power state such as ‘reset-nmi’. Systems 2251 MAY omit intermediate state transitions invoked by such ephemeral requested states as 2252 ‘reset-nmi’. 2253

7.3.1.1 log-id (integer(1:MAX)) 2254

This REQUIRED member attribute contains the unique key of this power log entry and is 2255 semantically equivalent to the LogID element in the Power Log group defined in 2256 [PWG5106.4]. 2257

7.3.1.2 power-state (type1 keyword) 2258

This REQUIRED member attribute identifies the recorded stable or ephemeral 2259 (transitional) power state for this power log entry and is semantically equivalent to the 2260 PowerState element in the Power Log group defined in [PWG5106.4]. 2261

Standard values and constraints on vendor extension values are defined in section 7.2.1 2262 Power States and Policies. 2263

7.3.1.3 power-state-date-time (dateTime) 2264

This REQUIRED member attribute identifies the date and time of transition into the 2265 recorded power state for this power log entry and is semantically equivalent to the 2266 PowerStateDateAndTime element in the Power Log group defined in [PWG5106.4]. 2267

7.3.1.4 power-state-message (text (255)) 2268

This OPTIONAL member attribute contains a human-readable string in UTF-8 [RFC3629] 2269 that describes, explains, or qualifies the logged power state and is semantically equivalent 2270 to the PowerStateMessage element in the Power Log group defined in [PWG5106.4]. For 2271 example, "standby - System is shutting down by user request (2W)" when transitioning to 2272 final 'off-soft' power state. 2273

Usage: This attribute: (a) MUST identify the power state; (b) SHOULD identify the method 2274 of entry to the power state, e.g., “from timeout trigger” or “from user request”; (c) SHOULD 2275

Page 79: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 79 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

identify the nominal power consumption, e.g., “(34 watts)”; and (d) MAY include any other 2276 power-related information, e.g., “can accept jobs” or “can process jobs”. 2277

7.3.2 power-state-capabilities-col (1setOf collection) 2278

This OPTIONAL System attribute lists System supported power capabilities for each stable 2279 power state and is semantically equivalent to the Power Support group defined in 2280 [PWG5106.4]. 2281

7.3.2.1 can-accept-jobs (boolean) 2282

This REQUIRED member identifies whether the System can accept new incoming Jobs in 2283 this stable power state, unless the System or has been disabled by an Operator or 2284 Administrator, and is semantically equivalent to the CanAcceptJobs element in the Power 2285 Support group defined in [PWG5106.4]. 2286

7.3.2.2 can-process-jobs (boolean) 2287

This REQUIRED member identifies whether the System can process new incoming Jobs 2288 or existing queued Jobs in this stable power state and is semantically equivalent to the 2289 CanProcessJobs element in the Power Support group defined in [PWG5106.4]. 2290

7.3.2.3 power-active-watts (integer(0:MAX)) 2291

This REQUIRED member attribute identifies the nominal power consumption in watts for 2292 this stable power state when the System is in an active operational state (i.e., ‘processing’) 2293 and is semantically equivalent to the PowerActiveWatts element in the Power Support 2294 group defined in [PWG5106.4]. 2295

7.3.2.4 power-inactive-watts (integer(0:MAX)) 2296

This REQUIRED member attribute identifies the nominal power consumption in watts for 2297 this stable power state when the System is in an inactive operational state (i.e., ‘idle’ or 2298 ‘stopped’) and is semantically equivalent to the PowerInactiveWatts element in the Power 2299 Support group defined in [PWG5106.4]. 2300

7.3.2.5 power-state (type1 keyword) 2301

This REQUIRED member attribute identifies a System supported stable power state that is 2302 the unique key of this power state capability entry and is semantically equivalent to the 2303 PowerState element in the Power Support group defined in [PWG5106.4]. 2304

Standard values and constraints on vendor extension values are defined in section 7.2.1 2305 Power States and Policies. 2306

Page 80: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 80 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

7.3.3 power-state-counters-col (1setOf collection) 2307

This OPTIONAL System attribute lists System power state transition counters and is 2308 semantically equivalent to the Power Counter group defined in [PWG5106.4]. 2309

7.3.3.1 hibernate-transitions (integer(0:MAX)) 2310

This REQUIRED member attribute contains the System lifetime number of transitions into 2311 the ‘hibernate’ power state and is semantically equivalent to the HibernateTransitions 2312 element in the Power Counter group defined in [PWG5106.4]. 2313

7.3.3.2 on-transitions (integer(0:MAX)) 2314

This REQUIRED member attribute contains the System lifetime number of transitions into 2315 the ‘on’ power state and is semantically equivalent to the OnTransitions element in the 2316 Power Counter group defined in [PWG5106.4]. 2317

7.3.3.3 standby-transitions (integer(0:MAX)) 2318

This REQUIRED member attribute contains the System lifetime number of transitions into 2319 the ‘standby’ power state and is semantically equivalent to the StandbyTransitions element 2320 in the Power Counter group defined in [PWG5106.4]. 2321

7.3.3.4 suspend-transitions (integer(0:MAX)) 2322

This REQUIRED member attribute contains the System lifetime number of transitions into 2323 the ‘suspend’ power state and is semantically equivalent to the SuspendTransitions 2324 element in the Power Counter group defined in [PWG5106.4]. 2325

7.3.4 power-state-monitor-col (collection) 2326

This RECOMMENDED System attribute contains the System power state and is 2327 semantically equivalent to the Power General, Power Meters, and Power Monitor groups 2328 defined in [PWG5106.4]. 2329

Note: Power consumption attribute values are volatile and typically change regularly at 2330 implementation-defined intervals. 2331

7.3.4.1 current-month-kwh (integer(0:MAX)) 2332

This REQUIRED member attribute contains the current month's System power 2333 consumption in kilowatt hours and is semantically equivalent to the 2334 PowerCurrentMonthKWH element in the Power Meter group defined in [PWG5106.4]. The 2335 System MUST reset the value of this attribute to zero at the beginning of every month. 2336

Page 81: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 81 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

7.3.4.2 current-watts (integer(0:MAX)) 2337

This REQUIRED member attribute contains the current System instantaneous power 2338 consumption in watts and is semantically equivalent to the PowerCurrentWatts element in 2339 the Power Meter group defined in [PWG5106.4]. 2340

Note: The value of this attribute is typically determined by software estimation instead of 2341 actual current measurement. 2342

7.3.4.3 lifetime-kwh (integer(0:MAX)) 2343

This REQUIRED member attribute contains the lifetime System power consumption in 2344 kilowatt hours and is semantically equivalent to the PowerLifetimeKWH element in the 2345 Power Meter group defined in [PWG5106.4]. 2346

7.3.4.4 meters-are-actual (boolean) 2347

This REQUIRED member attribute identifies whether or not System power meter attributes 2348 are based on actual measurement (true) or software estimation (false) and is semantically 2349 equivalent to the PowerMetersAreActual element in the Power Meter group defined in 2350 [PWG5106.4]. 2351

7.3.4.5 power-state (type1 keyword) 2352

This REQUIRED member attribute identifies the current stable or ephemeral (transitional) 2353 System power state and is semantically equivalent to the PowerState element in the 2354 Power Monitor group defined in [PWG5106.4]. 2355

Standard values and constraints on vendor extension values are defined in section 7.2.1 2356 Power States and Policies. 2357

7.3.4.6 power-state-message (text (255)) 2358

This OPTIONAL member attribute contains a human-readable string in UTF-8 [RFC3629] 2359 that describes, explains, or qualifies the current System power state (e.g.,) and is 2360 semantically equivalent to the PowerStateMessage element in the Power Monitor group 2361 defined in [PWG5106.4]. For example, "standby - System is shutting down by user 2362 request (2W)" when transitioning to final 'off-soft' power state. 2363

Usage: This attribute: (a) MUST identify the power state; (b) SHOULD identify the method 2364 of entry to the power state, e.g., “from timeout trigger” or “from user request”; (c) SHOULD 2365 identify the nominal power consumption, e.g., “(34 watts)”; and (d) MAY include any other 2366 power-related information, e.g., “can accept jobs” or “can process jobs”. 2367

7.3.4.7 power-usage-is-rms-watts (boolean) 2368

This REQUIRED member attribute identifies whether or not the power consumption 2369 properties for this System use units of Root Mean Square (RMS) watts (true) or 2370

Page 82: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 82 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

unnormalized so-called peak watts (false) and is semantically equivalent to the 2371 PowerUsageIsRMSWatts element in the Power General group defined in 2372 [PWG5106.4].valid-request-power-states (1setOf (type1 keyword)) 2373

This REQUIRED member attribute identifies all of the stable and ephemeral power states 2374 that can be requested (in policies) on this System and is semantically equivalent to the 2375 CanRequestPowerStates element in the Power General group defined in [PWG5106.4]. 2376

Standard values and constraints on vendor extension values are defined in section 7.2.1 2377 Power States and Policies. 2378

7.3.5 power-state-transitions-col (1setOf collection) 2379

This OPTIONAL System attribute lists valid System power state transitions and is 2380 semantically equivalent to the Power Transition group defined in [PWG5106.4]. 2381

7.3.5.1 end-power-state (type1 keyword) 2382

This REQUIRED member attribute identifies the ending stable System power state for this 2383 valid power state transition and is semantically equivalent to the EndPowerState element 2384 in the Power Transition group defined in [PWG5106.4]. 2385

Standard values and constraints on vendor extension values are defined in section 7.2.1 2386 Power States and Policies. 2387

7.3.5.2 start-power-state (type1 keyword) 2388

This REQUIRED member attribute identifies the starting stable System power state for this 2389 valid power state transition and is semantically equivalent to the EndPowerState element 2390 in the Power Transition group defined in [PWG5106.4]. 2391

Standard values and constraints on vendor extension values are defined in section 7.2.1 2392 Power States and Policies. 2393

7.3.5.3 state-transition-seconds (integer(0:MAX)) 2394

This REQUIRED member attribute contains the nominal duration in seconds for this valid 2395 power state transition and is semantically equivalent to the StateChangeSeconds element 2396 in the Power Transition group defined in [PWG5106.4]. 2397

7.3.6 system-config-change-date-time (dateTime) 2398

This REQUIRED System attribute contains the value of “system-current-time” (date and 2399 time) for the most recent System configuration change. 2400

Page 83: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 83 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

7.3.7 system-config-change-time (integer(0:MAX)) 2401

This REQUIRED System attribute contains the value of “system-up-time” (seconds since 2402 System startup) for the most recent System configuration change or zero if no System 2403 configuration change has occurred. 2404

7.3.8 system-config-changes (integer(0:MAX)) 2405

This REQUIRED System attribute contains the count of configuration changes for the 2406 System and is semantically equivalent to the SystemConfigChangeNumber element 2407 defined in [PWG5108.06] and semantically analogous to the prtGeneralConfigChanges 2408 object defined in [RFC3805]. Each time a Set-System-Attributes operation is performed 2409 that changes the value of any attribute and each time the System changes the value of any 2410 attribute, the System MUST increment value of the “system-config-changes” attribute by 2411 exactly one. Each time that the System performs a power cycle (from ‘off’ to ‘on’), the 2412 System MUST reset the value of this attribute to zero. 2413

7.3.9 system-configured-printers (1setOf collection) 2414

This REQUIRED System attribute contains the summary of all configured Printers for the 2415 System and is semantically equivalent to the ConfiguredServices element defined in 2416 [PWG5108.06]. 2417

Table 10 – Member Attributes of system-configured-printers 2418

Conformance IPP Attribute Name Reference REQUIRED printer-id [PWG5100.SYS] REQUIRED printer-info [RFC2911] REQUIRED printer-is-accepting-jobs [RFC2911] REQUIRED printer-name [RFC2911] REQUIRED printer-service-type [PWG5100.SYS] REQUIRED printer-state [RFC2911] REQUIRED printer-state-reasons [RFC2911] REQUIRED printer-xri-supported [RFC3380]

2419

7.3.9.1 printer-id (integer(1:MAX)) 2420

7.3.9.2 This REQUIRED member attribute uniquely identifies the Printer within the System 2421 and is semantically equivalent to the ServiceSummary element ID defined in 2422 [PWG5108.06] and semantically analogous to the “job-id” attribute defined in [RFC2911]. 2423 See “printer-id” in section 7.5 Printer Status Attributes.printer-info (text(127)) 2424

This REQUIRED member attribute contains the description of the Printer and is 2425 semantically equivalent to the "printer-info" Printer attribute defined in [RFC2911] but is not 2426 included in the ServiceSummary element defined in [PWG5108.06]. 2427

Page 84: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 84 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

7.3.9.3 printer-is-accepting-jobs (boolean) 2428

This REQUIRED member attribute identifies whether the Printer is currently able to accept 2429 incoming Jobs and is semantically equivalent to the "printer-is-accepting-jobs" Printer 2430 attribute defined in [RFC2911] and semantically equivalent to the ServiceSummary 2431 element IsAcceptingJobs defined in [PWG5108.06]. 2432

7.3.9.4 printer-name (name(127)) 2433

This REQUIRED member attribute identifies the name of the Printer and is semantically 2434 equivalent to the "printer-name" Printer attribute defined in [RFC2911] and semantically 2435 equivalent to the ServiceSummary element ServiceName defined in [PWG5108.06]. 2436

7.3.9.5 printer-service-type (type2 keyword) 2437

This REQUIRED member attribute identifies the service type of the Printer and is 2438 semantically equivalent to the "printer-service-type" Printer attribute defined in section 2439 7.5.2 and semantically equivalent to the ServiceSummary element ServiceType defined in 2440 [PWG5108.06]. 2441

7.3.9.6 printer-state (type1 enum) 2442

This REQUIRED member attribute contains the current state of the Printer and is 2443 semantically equivalent to the "printer-state" Printer attribute defined in [RFC2911] and 2444 semantically equivalent to the ServiceSummary element State defined in [PWG5108.06]. 2445

7.3.9.7 printer-state-reasons (1setOf type2 keyword) 2446

This REQUIRED member attribute contains additional detail about the current state of the 2447 Printer and is semantically equivalent to the "printer-state-reasons" Printer attribute defined 2448 in [RFC2911] and semantically equivalent to the ServiceSummary element StateReasons 2449 defined in [PWG5108.06]. 2450

7.3.9.8 printer-xri-supported (1setOf collection) 2451

This REQUIRED member attribute lists supported XRI (URI, authentication, and security 2452 tuples) for the Printer and is semantically equivalent to the "printer-xri-supported" Printer 2453 attribute defined in [RFC3380] and semantically equivalent to the ServiceSummary 2454 element ServiceXriSupported defined in [PWG5108.06]. 2455

7.3.10 system-configured-resources (1setOf collection) 2456

This REQUIRED System attribute contains the summary of all configured Resources for 2457 the System and is semantically equivalent to the ConfiguredResources element defined in 2458 [PWG5108.06]. 2459

Table 11 – Member attributes of system-configured-resources 2460

Page 85: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 85 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

Conformance IPP Attribute Name Reference REQUIRED resource-format [PWG5100.SYS] REQUIRED resource-id [PWG5100.SYS] REQUIRED resource-info [PWG5100.SYS] REQUIRED resource-name [PWG5100.SYS] REQUIRED resource-state [PWG5100.SYS] REQUIRED resource-type [PWG5100.SYS]

2461

7.3.10.1 resource-format (mimeMediaType) 2462

This REQUIRED member attribute identifies the format of the Resource and is 2463 semantically equivalent to the "resource-format" Resource attribute defined in section 7.7.7 2464 and semantically equivalent to the ResourceSummary element ResourceFormat defined in 2465 [PWG5108.06]. 2466

7.3.10.2 resource-id (integer (1:MAX)) 2467

This REQUIRED member attribute contains the unique identier of the Resource and is 2468 semantically equivalent to the "resource-id" Resource attribute defined in section 7.7.8 and 2469 semantically equivalent to the ResourceSummary element ResourceId defined in 2470 [PWG5108.06]. 2471

7.3.10.3 resource-info (text(127)) 2472

This REQUIRED member attribute contains the description of the Resource and is 2473 semantically equivalent to the "resource-info" Resource attribute defined in section 7.6.1 2474 but is not included in the original ResourceSummary element defined in [PWG5108.06]. 2475

7.3.10.4 resource-name (name(127)) 2476

This REQUIRED member attribute identifies the name of the Resource and is semantically 2477 equivalent to the "resource-name" Resource attribute defined in section 7.6.2 and 2478 semantically equivalent to the ResourceSummary element ResourceName defined in 2479 [PWG5108.06]. 2480

7.3.10.5 resource-state (type1 enum) 2481

This REQUIRED member attribute contains the current state of the Resource and is 2482 semantically equivalent to the "resource-state" Resource attribute defined in section 7.7.12 2483 but is not included in the original ResourceSummary element defined in [PWG5108.06]. 2484

7.3.10.6 resource-type (type2 keyword) 2485

This REQUIRED member attribute identifies the type of the Resource and is semantically 2486 equivalent to the "resource-type" Resource attribute defined in section 7.7.16 and 2487

Page 86: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 86 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

semantically equivalent to the ResourceSummary element ResourceType defined in 2488 [PWG5108.06]. 2489

7.3.11 system-serial-number (text(255)) 2490

This OPTIONAL System attribute identifies the serial number for the System and is 2491 semantically equivalent to the SerialNumber element defined in [PWG5108.06] and 2492 semantically analogous to the prtGeneralSerialNumber element defined in [RFC3805]. 2493

7.3.12 system-state (type1 enum) 2494

This REQUIRED System attribute contains the current state for the System and is 2495 semantically equivalent to the State element defined in [PWG5108.06] and semantically 2496 analogous to the “printer-state” attribute defined in [RFC2911]. 2497

Standard values for this attribute are: 2498

'3' 'idle': Indicates that all Printers are in the ‘idle’ state. 2499

'4' 'processing': Indicates that one or more Printers are processing Jobs. 2500

'5' 'stopped': Indicates that all Printers are in the ‘stopped’ state. 2501

7.3.13 system-state-change-date-time (dateTime) 2502

This REQUIRED System attribute contains the value of “system-current-time” (date and 2503 time) for the most recent System state change and is semantically analogous to the 2504 “printer-state-change-date-time” attribute defined in [RFC3995]. 2505

7.3.14 system-state-change-time (integer(0:MAX)) 2506

This REQUIRED System attribute contains the value of “system-up-time” (seconds since 2507 System startup) for the most recent System state change or zero if no System state 2508 change has occurred and is semantically analogous to the “printer-state-change-time” 2509 attribute defined in [RFC3995]. 2510

7.3.15 system-state-message (1setOf (text(MAX))) 2511

This REQUIRED System attribute contains a list of state messages for the System and is 2512 semantically equivalent to the StateMessages element defined in [PWG5108.06] and 2513 semantically analogous to the “printer-state-message” attribute defined in [RFC2911]. 2514

7.3.16 system-state-reasons (1setOf type2 keyword) 2515

This REQUIRED System attribute contains a list of state reasons for the System and is 2516 semantically equivalent to the StateReasons element defined in [PWG5108.06] and 2517 semantically analogous to the “printer-state-reasons” attribute defined in [RFC2911]. Any 2518 applicable “printer-state-reasons” keyword value can be used in “system-state-reasons”. 2519

Page 87: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 87 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

7.3.17 system-up-time (integer(1:MAX)) 2520

This REQUIRED System attribute contains the time in seconds since last boot for the 2521 System and is semantically equivalent to the UpTime element defined in [PWG5108.06]. 2522

7.3.18 system-uuid (uri(45)) 2523

This REQUIRED System attribute identifies the UUID as a URI [RFC4122] for the System 2524 and is semantically equivalent to the ServiceUuid element defined in [PWG5108.01]. 2525

7.4 Printer Description Attributes 2526

Printer Description attributes are typically READ-WRITE and can potentially be set by an 2527 Operator or Administrator using the Set-Printer-Attributes operation [RFC3380]. Writable 2528 Printer Description attributes are listed in the value of “printer-settable-attributes-2529 supported” [RFC3380]. 2530

7.4.1 printer-owner-col (collection) 2531

This REQUIRED Printer attribute identifies the Printer Owner. 2532

7.4.1.1 owner-uri (uri) 2533

This REQUIRED member attribute contains a Printer Owner URI, e.g., 2534 “mailto:[email protected],” and is semantically analogous to the Service object’s 2535 OwnerURI defined in [PWG5108.01]. If specified in a Set-Printer-Attributes operation, then 2536 the “owner-vcard” member attribute MUST also be specified (to preserve consistency). 2537

7.4.1.2 owner-vcard (1setOf text(1023)) 2538

This REQUIRED member attribute contains a Printer Owner vCard [RFC6350] and is 2539 semantically analogous to the Service object’s OwnerVCard defined in [PWG5108.01]. If 2540 specified in a Set-Printer-Attributes operation, then the “owner-uri” member attribute MUST 2541 also be specified (to preserve consistency). 2542

7.5 Printer Status Attributes 2543

All of the Printer Status attributes are READ-ONLY and cannot be set directly by the Set-2544 Printer-Attributes operation. 2545

7.5.1 printer-config-changes (integer(0:MAX)) 2546

This REQUIRED Printer attribute identifies the number of configuration changes (in Printer 2547 Description attributes) for a Printer semantically equivalent to the Monitoring element 2548 ConfigChanges defined in [PWG5106.1] and semantically equivalent to 2549 “prtGeneralConfigChanges” in IETF Printer MIB v2 [RFC3805]. The value of this attribute 2550 MUST be incremented by one for each operation that changes the Printer configuration 2551

Page 88: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 88 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

(rather than incrementing by one for each configuration attribute that was changed by the 2552 single operation). 2553

7.5.2 printer-id (integer(1:MAX)) 2554

This REQUIRED Printer attribute uniquely identifies the Printer within the System and is 2555 semantically equivalent to the ServiceSummary element ID defined in [PWG5108.06] and 2556 semantically analogous to the “job-id” attribute defined in [RFC2911]. 2557

7.5.3 printer-service-type (type2 keyword) 2558

This REQUIRED Printer attribute identifies the service type for a Printer as used in Create-2559 Printer defined in section 6 and is semantically equivalent to the Service Summary 2560 element ServiceType defined in [PWG5108.06]. Vendor-specific service types SHOULD 2561 be have keywords constructed of the form “smiNNN-name”, where “NNN” is the vendor’s 2562 enterprise SMI number registered assigned by IANA. Vendor-specific service types 2563 SHOULD be registered with IANA. 2564

Standard keyword values for this attribute include: 2565

‘copy’: A Copy service defined in [PWG5108.04]. 2566

‘faxin’: A FaxIn service defined in [RFC2707] and [PWG5108.01]. 2567

‘faxout’: A FaxOut service defined in [PWG5100.15]. 2568

‘print’: A Print service defined in [RFC2911]. 2569

‘print3d’: A 3D Print service defined in [PWG5100.P3D] 2570

‘scan’: A Scan service defined in [PWG5100.17]. 2571

‘transform’: A Transform service defined in [PWG5108.01]. 2572

7.6 Resource Description Attributes 2573

Resource Description attributes are typically READ-WRITE and can potentially be set by 2574 an Operator or Administrator using the Set-Resource-Attributes operation (see section 6). 2575 Writable Resource Description attributes are listed in the value of “resource-settable-2576 attributes-supported” System Description attribute defined above in section 7.2. 2577

7.6.1 resource-info (text(127)) 2578

This REQUIRED Resource attribute contains the description of the Resource and is 2579 semantically equivalent to the ResourceInfo element defined in [PWG5108.03] and 2580 semantically analogous to the "printer-info" Printer attribute defined in [RFC2911]. 2581

Page 89: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 89 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

7.6.2 resource-name (name(127)) 2582

This REQUIRED Resource attribute contains the name of the Resource and is 2583 semantically equivalent to the ResourceName element defined in [PWG5108.03] and 2584 semantically analogous to the "printer-name" Printer attribute defined in [RFC2911]. 2585

7.6.3 resource-owner-col (collection) 2586

This REQUIRED Resource attribute identifies the Resource Owner. 2587

7.6.3.1 owner-uri (uri) 2588

This REQUIRED member attribute contains a Resource Owner URI, e.g., 2589 “mailto:[email protected],” and is semantically analogous to the Service object’s 2590 OwnerURI defined in [PWG5108.01]. If specified in a Set-Resource-Attributes operation, 2591 then the “owner-vcard” member attribute MUST also be specified (to preserve 2592 consistency). 2593

7.6.3.2 owner-vcard (1setOf text(1023)) 2594

This REQUIRED member attribute contains a Resource Owner vCard [RFC6350] and is 2595 semantically analogous to the Service object’s OwnerVCard defined in [PWG5108.01]. If 2596 specified in a Set-Resource-Attributes operation, then the “owner-uri” member attribute 2597 MUST also be specified (to preserve consistency). 2598

7.7 Resource Status Attributes 2599

All of the Resource Status attributes are READ-ONLY and cannot be directly updated by 2600 the Set-Resource-Attributes operation. 2601

7.7.1 date-time-at-canceled (dateTime) 2602

This REQUIRED Resource attribute contains the date and time of Resource cancelation 2603 request (i.e., when Cancel-Resource operation is accepted) or Resource abortion by the 2604 System, which can be before “resource-state” actually the Resource transitions to the 2605 ‘canceled’ or ‘aborted’ state), and is semantically analogous to the DateTimeAtExpiration 2606 element defined in [PWG5108.03] and semantically analogous to the Job “date-time-at-2607 completed” attribute defined in [RFC2911]. 2608

7.7.2 date-time-at-creation (dateTime) 2609

This REQUIRED Resource attribute contains the date and time of Resource creation 2610 request (i.e., when Create-Resource operation is accepted) and is semantically equivalent 2611 to the DateTimeAtCreation element defined in [PWG5108.03] and semantically analogous 2612 to the “date-time-at-creation” Job attribute defined in [RFC2911]. 2613

Page 90: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 90 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

7.7.3 date-time-at-installed (dateTime) 2614

This REQUIRED Resource attribute contains the date and time of Resource installation 2615 request (i.e., when Install-Resource operation is accepted), which can be before “resource-2616 state” actually the Resource transitions to the ‘installed’ state), and is semantically 2617 analogous to the “date-time-at-processing” Job attribute defined in [RFC2911]. 2618

7.7.4 resource-data-uri (uri | no-value)) 2619

This REQUIRED Resource attribute identifies the URI of the Resource data (if any) and is 2620 semantically equivalent to the ResourceFormat element defined in [PWG5108.03] and 2621 semantically analogous to the “document-format” attribute defined in [RFC2911]. When a 2622 Resource has no associated data, the System MUST return the ‘no-value’ out-of-band 2623 value defined in [RFC2911] for “resource-data-uri”. 2624

7.7.5 resource-format (mimeMediaType) 2625

This REQUIRED Resource attribute identifies the format of the Resource data and is 2626 semantically equivalent to the ResourceFormat element defined in [PWG5108.03] and 2627 semantically analogous to the “document-format” attribute defined in [RFC2911]. 2628

7.7.6 resource-id (integer(1:MAX)) 2629

This REQUIRED Resource attribute uniquely identifies the Resource within the System 2630 and is semantically equivalent to the ResourceId element defined in [PWG5108.03] and 2631 semantically analogous to the “job-id” attribute defined in [RFC2911]. 2632

7.7.7 resource-k-octets (integer(0:MAX)) 2633

This REQUIRED Resource attribute contains the size of the data associated with the 2634 Resource (if any) but is not included in the original Resource object defined in 2635 [PWG5108.03] and semantically analogous to the “job-k-octets” attribute defined in 2636 [RFC2911]. 2637

7.7.8 resource-state (type1 enum) 2638

This REQUIRED Resource attribute contains the current state of the Resource and is 2639 semantically analogous to the DateTimeOfExpiration and ResourceHasExpired elements 2640 defined in [PWG5108.03] and semantically analogous to the “printerjob-state” attribute 2641 defined in [RFC2911]. 2642

Standard enum values for this attribute are: 2643

‘3’ ‘pending’: The Resource has been created but is not yet available or 2644 installed. 2645

‘4’ ‘available’: The Resource data has been uploaded and the Resource is 2646 available for installation. 2647

Page 91: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 91 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

‘5’ ‘installed’: The Resource has been installed and is ready for use. 2648

‘6’ ‘canceled’: The Resource has been canceled and can no longer be used. 2649

‘7’ ‘aborted’: The Resource has been aborted by the System and can no longer 2650 be used. 2651

Normal Resource state transitions are show in Figure 1 below. Resource states normally 2652 progress from top to bottom (‘created’ to ‘available’ to ‘installed’) until the Resource finally 2653 transitions to a terminal state of ‘canceled’ (by Administrator) or ‘aborted’ (by System). 2654 See note 2 below for one of the exceptions to normal Resource state transitions. 2655

2656

Figure 1 – IPP Resource Object Life Cycle 2657

Notes: 2658

1) A Resource object can transition to the ‘aborted’ state due to an interrupted Send-2659 Resource-Data request, corrupted Resource data, an unsupported Resource data 2660 format, inability to store the Resource data, inability to install the Resource data, 2661 and/or other System internal fault conditions. The “resource-state-reasons” attribute 2662 will contain the reason for the Resource being aborted by the System. 2663

1)2) When a new Resource version is installed that replaces a previous Resource 2664 version (e.g., firmware), the old Resource “resource-state” MUST transition back to 2665 ‘available’ and the old Resource “resource-use-count” MUST be set to zero. 2666

Page 92: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 92 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

7.7.9 resource-state-message (text(MAX)) 2667

This REQUIRED Resource attribute contains a state message for the Resource but is not 2668 included in the original Resource object defined in [PWG5108.03] and semantically 2669 analogous to the “printerjob-state-message” attribute defined in [RFC2911]. 2670

7.7.10 resource-state-reasons (1setOf type2 keyword) 2671

This REQUIRED Resource attribute contains a list of state reasons for the Resource but is 2672 not included in the original Resource object defined in [PWG5108.03] and semantically 2673 analogous to the “printerjob-state-reasons” attribute defined in [RFC2911]. Any applicable 2674 “printerjob-state-reasons” keyword value can be used in “resource-state-reasons”. 2675

Standard values for this attribute are: 2676

‘cancel-requested’: A Cancel-Resource operation has been received and accepted 2677 and the Resource will become permanently unavailable when the cancellation is 2678 completed (e.g., after the current Job using the Resource is completed). 2679

‘install-requested’: An Install-Resource operation has been received and accepted 2680 and the Resource will become available for use when the installation is completed 2681 (e.g., potentially after the next System or Subunit reboot in the case of an 2682 executable Resource). 2683

‘resource-incoming’: A Send-Resource-Data operation has been received and 2684 accepted, Resource data upload is in progress, and “resource-state” will transition 2685 to ‘available’ after the upload is completed. 2686

7.7.11 resource-string-version (text(127)) 2687

This REQUIRED Resource attribute contains the string version of the Resource, which 2688 SHOULD conform to section 4.2.4 “String Version” of IETF PA-TNC [RFC5792] which 2689 defines the internal string fields Product Version Number, Internal Build Number, and 2690 Configuration Version Number. This attribute is semantically analogous to the 2691 FirmwareStringVersion attribute defined in [PWG5110.4]. 2692

7.7.12 resource-type (type2 keyword) 2693

This REQUIRED Resource attribute identifies the type of the Resource and is semantically 2694 equivalent to the ResourceType element defined in [PWG5108.03]. 2695

IPP System Service implementations SHOULD support System-scope executable 2696 resources (e.g., for firmware update). System Service implementations MAY support 2697 Printer-scope and/or Job-scope executable resources in an implementation-defined 2698 manner. 2699

Standard values for this attribute (with their resource category prefix) include: 2700

Page 93: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 93 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

‘executable-firmware’: Executable firmware. 2701

‘executable-software’: Executable software. 2702

‘static-font’: Static font. 2703

‘static-form’: Static form. 2704

‘static-iccprofile’: Static ICC profile. 2705

‘static-image’: Static image. 2706

‘static-logo’: Static logo. 2707

‘template-document’: Template for creating Document object [PWG5100.5]. 2708

‘template-job’: Template for creating Job object [PWG5108.07]. 2709

‘template-printer’: Template for creating Printer object [RFC2911]. 2710

7.7.13 resource-use-count (integer(0:MAX)) 2711

This REQUIRED Resource attribute contains the use count (i.e., allocation count) for the 2712 Resource but is not included in the original Resource object defined in [PWG5108.03]. 2713

7.7.137.7.14 resource-uuid (uri(45)) 2714

This REQUIRED Resource attribute identifies the UUID as a URI [RFC4122] for the 2715 Resource but is not included in the original Resource object defined in [PWG5108.03] and 2716 is semantically analogous to the “system-uuid” attribute defined in section 7.3. 2717

7.7.147.7.15 resource-version (octetString(16)) 2718

This REQUIRED Resource attribute contains the numeric version of the Resource, which 2719 SHOULD conform to section 4.2.3 “Numeric Version” of IETF PA-TNC [RFC5792] which 2720 defines the internal integer fields Major Version Number, Minor Version Number, Build 2721 Number, Service Pack Major, and Service Pack Minor. This attribute is semantically 2722 analogous to the FirmwareVersion attribute defined in [PWG5110.4]. 2723

7.7.157.7.16 time-at-canceled (integer(MIN:MAX)) 2724

This REQUIRED Resource attribute contains the time of Resource cancelation request 2725 (i.e., when Cancel-Resource operation is accepted) or Resource abortion by the System, 2726 which can be before “resource-state” actually the Resource transitions to the ‘canceled’ or 2727 ‘aborted’ state), but is not included in the original Resource object defined in 2728 [PWG5108.03] and is semantically analogous to the “time-at-completed” Job attribute 2729 defined in [RFC2911]. 2730

Page 94: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 94 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

7.7.167.7.17 time-at-creation (integer(MIN:MAX)) 2731

This REQUIRED Resource attribute contains the time of Resource creation request (i.e., 2732 when Create-Resource operation is accepted) but is not included in the original Resource 2733 object defined in [PWG5108.03] and is semantically analogous to the “time-at-creation” 2734 Job attribute defined in [RFC2911]. 2735

7.7.177.7.18 time-at-installed (integer(MIN:MAX)) 2736

This REQUIRED Resource attribute contains the time of Resource installation request 2737 (i.e., when Install-Resource operation is accepted), which can be before “resource-state” 2738 actually the Resource transitions to the ‘installed’ state), but is not included in the original 2739 Resource object defined in [PWG5108.03] and is semantically analogous to the “date-time-2740 at-processing” Job attribute defined in [RFC2911]. 2741

7.8 Job Status Attributes 2742

All of the Job Status attributes are READ-ONLY and cannot be directly updated by the Set-2743 Job-Attributes operation. 2744

7.8.1 job-owner-col (collection) 2745

This REQUIRED Job attribute identifies the Job Owner. 2746

7.8.1.1 owner-uri (uri) 2747

This REQUIRED member attribute contains a Job Owner URI, e.g., 2748 “mailto:[email protected],” and is semantically analogous to the Service object’s 2749 OwnerURI defined in [PWG5108.01]. 2750

7.8.1.2 owner-vcard (1setOf text(1023)) 2751

This REQUIRED member attribute contains a Job Owner vCard [RFC6350] and is 2752 semantically analogous to the Service object’s OwnerVCard defined in [PWG5108.01]. 2753

2754

Page 95: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 95 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

8. Additional Semantics for Existing Operations 2755

8.1 Cancel-Subscription, Get-Notifications, and Renew-Subscription: 2756

system-uri (uri) and resource-id (integer(1:MAX)) 2757

8.2 Get-Printer-Attributes: printer-resource-ids (1setOf integer(1:MAX)) 2758

[for compatibility with legacy IPP Clients – choose implementation-dependent “default” 2759 Printer object, “redirect” operation to that Printer object, and relay response to Client] 2760

8.3 Create-Job, Get-Job-Attributes: job-resource-ids (1setOf 2761

integer(1:MAX)) 2762

2763

9. Additional Values for Existing Attributes 2764

9.1 notify-events (1setOf type2 keyword) 2765

2766

Page 96: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 96 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

10. Conformance Requirements 2767

Provide numbered lists of conformance requirements for the document. 2768

10.1 Conformance Requirements for Clients 2769

10.2 Conformance Requirements for Infrastructure Systems 2770

10.3 Conformance Requirements for Systems 2771

2772

11. Internationalization Considerations 2773

For interoperability and basic support for multiple languages, conforming implementations 2774 MUST support the Universal Character Set (UCS) Transformation Format -- 8 bit (UTF-8) 2775 [RFC3629] encoding of Unicode [UNICODE] [ISO10646] and the Unicode Format for 2776 Network Interchange [RFC5198]. 2777

Implementations of this specification SHOULD conform to the following standards on 2778 processing of human-readable Unicode text strings, see: 2779

Unicode Bidirectional Algorithm [UAX9] – left-to-right, right-to-left, and vertical 2780

Unicode Line Breaking Algorithm [UAX14] – character classes and wrapping 2781

Unicode Normalization Forms [UAX15] – especially NFC for [RFC 5198] 2782

Unicode Text Segmentation [UAX29] – grapheme clusters, words, sentences 2783

Unicode Identifier and Pattern Syntax [UAX31] – identifier use and normalization 2784

Unicode Collation Algorithm [UTS10] – sorting 2785

Unicode Locale Data Markup Language [UTS35] – locale databases 2786

Implementations of this specification are advised to also review the following informational 2787 documents on processing of human-readable Unicode text strings: 2788

Unicode Character Encoding Model [UTR17] – multi-layer character model 2789

Unicode in XML and other Markup Languages [UTR20] – XML usage 2790

Unicode Character Property Model [UTR23] – character properties 2791

Page 97: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 97 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

Unicode Conformance Model [UTR33] – Unicode conformance basis 2792

12. Security Considerations 2793

The IPP extensions defined in this document require the same security considerations as 2794 defined in the IPP/1.1: Model and Semantics [RFC2911] and PWG System Object and 2795 System Control Service Semantics [PWG5108.06]. 2796

Implementations of this specification SHOULD conform to the following standard on 2797 processing of human-readable Unicode text strings, see: 2798

Unicode Security Mechanisms [UTS39] – detecting and avoiding security attacks 2799

Implementations of this specification are advised to also review the following informational 2800 document on processing of human-readable Unicode text strings: 2801

Unicode Security FAQ [UNISECFAQ] – common Unicode security issues 2802

2803

13. IANA and PWG Considerations 2804

TBD 2805

14. References 2806

14.1 Normative References 2807

[ACPI] Advanced Configuration and Power Interface Specification Revision 2808 5.0 Errata A, November 2013. 2809 http://www.acpi.info/DOWNLOADS/ACPI_5_Errata%20A.pdf 2810

[DSP1027] DMTF Power State Management Profile, DSP1027, December 2009. 2811 http://www.dmtf.org/standards/published_documents/DSP1027_2.0.0.2812 pdf 2813

[IANAIPP] IANA IPP Registry, 2814 http://www.iana.org/assignments/ipp-registrations/ipp-2815 registrations.xhtml 2816

[IEEE1284] Standard Signaling Method for a Bi-directional Parallel Peripheral 2817 Interface for Personal Computers, IEEE 1284, January 2000. 2818

Page 98: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 98 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

[IEEE1621] “Standard for User Interface Elements in Power Control of Electronic 2819 Devices Employed in Office/Consumer Environments”, IEEE 1621, 2820 December 2004. 2821

[ISO10175-1] T. Hastings et al, “ISO Document Printing Application (DPA) Part 1: 2822 Abstract Service Definition and Procedures”, ISO 10175-1, 1996 2823

[ISO10175-3] T. Hastings et al, “ISO Document Printing Application (DPA) Part 3: 2824 Management Abstract Service Definition and Procedures”, ISO 10175-2825 1, 1996 2826

[PWG5100.1FIN] M. Sweet, “IPP Finishings 2.01 (FIN)”, PWG5100.1-2014work-in-2827 progress, December 2014November 2016, 2828 http://ftp.pwg.org/pub/pwg/ipp/wd/wd-ippfinishings21-20161109.pdf 2829

[PWG5100.12] R. Bergman, H. Lewis, I. McDonald, M. Sweet, “IPP Version 2.0, 2.1, 2830 and 2.2”, PWG 5100.12-2015, October 2015, 2831 http://ftp.pwg.org/pub/pwg/standards/std-ipp20-20151030-5100.12.pdf 2832

[PWG5100.13] M.Sweet, I. McDonald, P. Zehler, “IPP Job and Printer Extensions – 2833 Set 3”, PWG 5100.13-2012, July 2012, 2834 http://ftp.pwg.org/pub/pwg/candidates/cs-ippjobprinterext3v10-2835 20120727-5100.13.pdf 2836

[PWG5100.14] M. Sweet, I. McDonald, A. Mitchell, J. Hutchings, “IPP Everywhere”, 2837 PWG 5100.14-2013, January 2013, 2838 http://ftp.pwg.org/pub/pwg/candidates/cs-ippeve10-20130128-2839 5100.14.pdf 2840

[PWG5100.15] M. Sweet, “IPP FaxOut Service”, PWG 5100.15-2014, June 2014, 2841 http://ftp.pwg.org/pub/pwg/candidates/cs-ippfaxout10-20140618-2842 5100.15.pdf 2843

[PWG5100.17] P. Zehler, M. Sweet, “IPP Scan Service”, PWG 5100.17-2014, 2844 October 2014, 2845 http://ftp.pwg.org/pub/pwg/candidates/cs-ippscan10-20140918-2846 5100.17.pdf 2847

[PWG5100.18] M. Sweet, I. McDonald, “IPP Shared Infrastructure Extensions 2848 (INFRA)”, PWG 5100.18-2015, June 2015, 2849 http://ftp.pwg.org/pub/pwg/candidates/cs-ippinfra10-20150619-2850 5100.18.pdf 2851

[PWG5100.P3D] M. Sweet, “IPP 3D Printing Extensions (3D)”, work-in-progress, 2852 August November 2016, 2853 http://ftp.pwg.org/pub/pwg/ipp/wd/wd-ipp3d10-20161114.pdf 2854

Page 99: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 99 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

[PWG5105.1] P. Zehler, T. Hastings, S. Albright, “Semantic Model v1.0”, PWG 2855 5105.1-2004, January 2004, 2856 http://ftp.pwg.org/pub/pwg/candidates/cs-sm10-20040120-5105.1.pdf 2857

[PWG5106.1] P. Zehler, H. Lewis, I. McDonald, J. Thrasher, W. Wagner, 2858 “Standardized Imaging Counters 1.1”, PWG 5106.1-2007, April 2007, 2859 http://ftp.pwg.org/pub/pwg/candidates/cs-wimscount11-20070427-2860 5106.1.pdf 2861

[PWG5106.3] I. McDonald, “Imaging System State and Counter MIB v2”, 2862 PWG5106.3-2008, March 2008, 2863 ftp://ftp.pwg.org/pub/pwg/candidates/cs-wimscountmib20-20080318-2864 5106.3.pdf 2865 ftp://ftp.pwg.org/pub/pwg/candidates/cs-wimscountmib20-20080318-2866 5106.3.mib 2867

[PWG5106.4] I. McDonald, “Power Management Model for Imaging Systems 1.0”, 2868 PWG 5106.4-2011, February 2011, 2869 http://ftp.pwg.org/pub/pwg/general/pwg-process-30.pdf 2870

[PWG5107.2] I. McDonald, “PWG Command Set Format for IEEE 1284 Device ID 2871 v1.0”, PWG 5107.2-2010, May 2010, 2872 http://ftp.pwg.org/pub/pwg/candidates/cs-pmp1284cmdset10-2873 20100531-5107.2.pdf 2874

[PWG5108.01] W. Wagner, P. Zehler, “MFD Model and Common Semantics”, PWG 2875 5801.01-2011, April 2011, 2876 http://ftp.pwg.org/pub/pwg/candidates/cs-sm20-mfdmodel10-2877 20110415-5801.1.pdf 2878

[PWG5108.02] N. Chen, P. Zehler, “Network Scan Service Semantic Model and 2879 Service Interface”, PWG 5108.02, April 2009, 2880 http://ftp.pwg.org/pub/pwg/candidates/cs-sm20-scan10-20090410-2881 5108.02.pdf 2882

[PWG5108.03] N. Chen, I. McDonald, P. Zehler, “Network Resource Service 2883 Semantic Model and Service Interface”, PWG 5108.03, July 2009, 2884 http://ftp.pwg.org/pub/pwg/candidates/cs-sm20-resource10-20090703-2885 5108.03.pdf 2886

[PWG5108.05] P. Zehler, “FaxOut Service Semantic Model and Service Interface”, 2887 PWG 5108.05-2011, August 2011, 2888 http://ftp.pwg.org/pub/pwg/candidates/cs-sm20-faxout10-20110809-2889 5108.05.pdf 2890

[PWG5108.06] P. Zehler, "System Object and System Control Service Semantics", 2891 PWG 5108.06-2012, February 2012, 2892

Page 100: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 100 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

http://ftp.pwg.org/pub/pwg/candidates/cs-sm20-system10-20120217-2893 5108.06.pdf 2894

[PWG5109.1] R. Nevo, W. Wagner, “Cloud Imaging Requirements and Model 2895 (IMAGINGMODEL)”, PWG 5109.1-2015, June 2015, 2896 http://ftp.pwg.org/pub/pwg/candidates/cs-cloudimagingmodel10-2897 20150619-5109.1.pdf 2898

[RFC2119] S. Bradner, "Key words for use in RFCs to Indicate Requirement 2899 Levels", RFC 2119/BCP 14, March 1997, 2900 http://www.ietf.org/rfc/rfc2119.txt 2901

[RFC2707] R. Bergman, T. Hastings, S. Isaacson, H. Lewis, “Job Monitoring MIB 2902 - V1.0, RFC 2707, November 1999, 2903 http://www.ietf.org/rfc/rfc2707.txt 2904

[RFC2911] T. Hastings, R. Herriot, R. deBry, S. Isaacson, P. Powell, "Internet 2905 Printing Protocol/1.1: Model and Semantics", RFC 2911, September 2906 2000, http://www.ietf.org/rfc/rfc2911.txt 2907

[RFC3380] T. Hastings, R. Herriot, C. Kugler, H. Lewis, “Internet Printing Protocol 2908 (IPP): Job and Printer Set Operations”, RFC 3380, September 2002, 2909 http://www.ietf.org/rfc/rfc3380.txt 2910

[RFC3382] R. deBry, R. Herriot, T. Hastings, K. Ocke, P. Zehler, "Internet Printing 2911 Protocol (IPP): The ‘collection’ Attribute Syntax", RFC 3382, 2912 September 2002, http://www.ietf.org/rfc/rfc3382.txt 2913

[RFC3510] R. Herriot, I. McDonald, “Internet Printing Protocol/1.1: IPP URL 2914 Scheme”, RFC 3510, April 2003, http://www.ietf.org/rfc/rfc3510.txt 2915

[RFC3805] R. Bergman, H. Lewis, I. McDonald, "Printer MIB v2", RFC 3805, June 2916 2004, 2917 http://www.ietf.org/rfc/rfc3805.txt 2918

[RFC3806] R. Bergman, H. Lewis, I. McDonald, "Printer Finishing MIB", RFC 2919 3806, June 2004, 2920 http://www.ietf.org/rfc/rfc3806.txt 2921

[RFC3995] R. Herriot, T. Hastings, “Internet Printing Protocol (IPP): Event 2922 Notifications and Subscriptions”, RFC 3995, March 2005, 2923 http://www.ietf.org/rfc/rfc3995.txt 2924

[RFC3996] R. Herriot, T. Hastings, H. Lewis, “Internet Printing Protocol (IPP): The 2925 'ippget' Delivery Method for Event Notifications”, RFC 3996, March 2926 2005, http://www.ietf.org/rfc/rfc3996.txt 2927

Page 101: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 101 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

[RFC6350] S. Perreault, “vCard Format Specification”, RFC 6350, August 2011, 2928 http://www.ietf.org/rfc/rfc6350.txt 2929

[RFC7472] I. McDonald, M. Sweet, “Internet Printing Protocol (IPP) over HTTPS 2930 Transport Binding and the 'ipps' URI Scheme”, RFC 7472, March 2931 2015, http://www.ietf.org/rfc/rfc7472.txt 2932

[UAX9] Unicode Consortium, “Unicode Bidirectional Algorithm”, UAX#9, June 2933 2014, 2934 http://www.unicode.org/reports/tr9/tr9-31.html 2935

[UAX14] Unicode Consortium, “Unicode Line Breaking Algorithm”, UAX#14, 2936 June 2014, 2937 http://www.unicode.org/reports/tr14/tr14-33.html 2938

[UAX15] Unicode Consortium, “Normalization Forms”, UAX#15, June 2014, 2939 http://www.unicode.org/reports/tr15/tr15-41.html 2940

[UAX29] Unicode Consortium, “Unicode Text Segmentation”, UAX#29, June 2941 2014, 2942 http://www.unicode.org/reports/tr29/tr29-25.html 2943

[UAX31] Unicode Consortium, “Unicode Identifier and Pattern Syntax”, 2944 UAX#31, June 2014, 2945 http://www.unicode.org/reports/tr31/tr31-21.html 2946

[UNICODE] Unicode Consortium, "Unicode Standard", Version 8.0.0, June 2015, 2947 http://unicode.org/versions/Unicode8.0.0/ 2948

[UTS10] Unicode Consortium, “Unicode Collation Algorithm”, UTS#10, June 2949 2014, 2950 http://www.unicode.org/reports/tr10/tr10-30.html 2951

[UTS35] Unicode Consortium, “Unicode Locale Data Markup Language”, 2952 UTS#35, September 2014, 2953 http://www.unicode.org/reports/tr35/tr35-37/tr35.html 2954

[UTS39] Unicode Consortium, “Unicode Security Mechanisms”, UTS#39, 2955 September 2014, 2956 http://www.unicode.org/reports/tr39/tr39-9.html 2957

2958

14.2 Informative References 2959

[RFC2567] F.D. Wright, “Design Goals for an Internet Printing Protocol”, RFC 2960 2567, April 1999, http://www.ietf.org/rfc/rfc2567.txt 2961

Page 102: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 102 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

[RFC5209] P. Sangster, H. Khosravi, M. Mani, K. Narayan, J. Tardo, “Network 2962 Endpoint Assessment (NEA): Overview and Requirements”, RFC 2963 5209, June 2008, http://www.ietf.org/rfc/rfc5209.txt 2964

[UTR17] Unicode Consortium “Unicode Character Encoding Model”, UTR#17, 2965 November 2008, 2966 http://www.unicode.org/reports/tr17/tr17-7.html 2967

[UTR20] Unicode Consortium “Unicode in XML and other Markup Languages”, 2968 UTR#20, January 2013, 2969 http://www.unicode.org/reports/tr20/tr20-9.html 2970

[UTR23] Unicode Consortium “Unicode Character Property Model”, UTR#23, 2971 November 2008, 2972 http://www.unicode.org/reports/tr23/tr23-9.html 2973

[UTR33] Unicode Consortium “Unicode Conformance Model”, UTR#33, 2974 November 2008, 2975 http://www.unicode.org/reports/tr33/tr33-5.html 2976

[UNISECFAQ] Unicode Consortium “Unicode Security FAQ”, November 2013, 2977 http://www.unicode.org/faq/security.html 2978

15. Authors' Addresses 2979

Primary authors: 2980

Ira McDonald 2981 High North 2982 PO Box 221 2983 Grand Marais, MI 49839 2984 [email protected] 2985 2986 Michael Sweet 2987 Apple Inc. 2988 1 Infinite Loop 2989 Cupertino, CA 95014 2990 [email protected] 2991

The authors would also like to thank the following individuals for their contributions to this 2992 standards-track document: 2993

Smith Kennedy (HP Inc) 2994 William Wagner (TIC) 2995 Peter Zehler (Xerox) 2996

Page 103: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 103 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

16. Appendix A – Rationale for Design Choices 2997

This section describes the rationale for important design choices made in the development 2998 of this IPP System Service specification. 2999

16.1 Resource Object 3000

16.1.1 Move Resource Service operations into System Service 3001

The PWG Network Resource Service [PWG5108.03] was unique because it wasn’t a Job 3002 service and was implicitly a capability of the overall System. Therefore, selected Resource 3003 operations have been incorporated into the System Service. 3004

16.1.2 Remove some Resource operations 3005

The PWG Network Resource Service [PWG5108.03] defined a DeleteResource operation 3006 that was incompatible with System log files and audit trail mechanisms. Instead a new 3007 Cancel-Resource operation has been added to the System Service that permanently 3008 removes the Resource from further use but preserves the Resource metadata in a 3009 Resource History phase for correlation with System log files. 3010

The PWG Network Resource Service [PWG5108.03] defined a RetrieveResource 3011 operation for reading the contents of the Resource data that was inherently insecure. This 3012 operation has been removed from the System Service. 3013

The PWG Network Resource Service [PWG5108.03] defined a ReplaceResource 3014 operation for replacing the contents of the Resource data that was inherently insecure. 3015 This operation has been removed from the System Service. 3016

The PWG Network Resource Service [PWG5108.03] defined a RenewResource operation 3017 for renewing the lease on a Resource. This operation has been removed from the System 3018 Service. 3019

The PWG Network Resource Service [PWG5108.03] defined a set of Administrative 3020 service-level operations (DisableResourceService, EnableResourceService, 3021 RestartResourceService, ShutdownResourceService, and StartupResourceService). 3022 These operations have been removed from the System Service. 3023

16.1.3 Decompose some Resource operations 3024

The PWG Network Resource Service [PWG5108.03] defined a single operation 3025 StoreResource that both created the Resource metadata object and uploaded the 3026 Resource data, by analogy to the Print-Job operation defined in [RFC2911]. Consistent 3027 with current PWG design philosophy, this StoreResource operation has been decomposed 3028 into Create-Resource (create Resource object), Send-Resource-Data (upload Resource 3029 data), and Install-Resource (install executable, static, or template Resource for use). 3030

Page 104: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 104 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

Installation of an executable Resource (e.g., firmware) can involve a System or Subunit 3031 reboot to complete. 3032

16.1.4 Replace Resource lease with Resource state 3033

The PWG Network Resource Service [PWG5108.03] used the lease concept from the 3034 Subscription object defined in [RFC3995]. There was a strong consensus to move away 3035 from leases and instead add a new “resource-state” Resource Status attribute for clarity 3036 and flexibility. 3037

3038

Page 105: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 105 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

17. Change History 3039

17.1 29 November 2016 3040

- Interim draft – changes per IPP WG at Virtual F2F on 15 November 2016 3041 - global – accepted all changes per complete review at Virtual F2F 3042 - global – changed “but not included in the Resource object” to “but not included in the 3043 original Resource object” for clarity 3044 - global – searched for all instances of "specifies a/the list of" and made sure the list is the 3045 correct items 3046 - global – searched for all instances of “type 2” and changed to “type2” (without space) 3047 - revised section 4.2 Subunit Object to clarify that System Service spec does NOT define 3048 any explicit System object attributes for access to Subunit objects and instead existing 3049 Printer object attributes (e.g., “printer-input-tray” from PWG 5100.13) can be used. 3050 - revised section 4.6 Resource Object to state that Resources are persistent until they are 3051 explicitly canceled by an Administrator or aborted by the System, discuss “resource-use-3052 count”, and discuss deferred cancelation of busy resources with ‘cancel-requested’ added 3053 to “resource-state-reasons” 3054 - revised section 4.6 Resource Object to add section 4.6.1 Resource History 3055 - revised section 4.6 Resource Object and section 7.7.12 resource-type to state that IPP 3056 System Service implementations SHOULD support System-scope executable resources 3057 (e.g., for firmware update) and MAY support Printer-scope and/or Job-scope executable 3058 resources in an implementation-defined manner 3059 - revised section 5.2 System Description Attributes and Table 1 to add “printer-creation-3060 attributes-supported” 3061 - revised section 5.6 Resource Description Attributes and section 6.2.2 Create-Resource to 3062 add notes about Job-scope Resources (allocated via “resource-ids” operation attribute) 3063 - revised section 5.7 Resource Status Attributes and Table 5 to add “resource-use-count” 3064 - revised section 6.1.5.1 Get-Printers Request text on “requested-attributes” to say that 3065 Clients SHOULD only supply and Systems MUST only support Printer attributes listed as 3066 Printer source attributes in the table in section 4 of IETF LDAP Schema for Printer 3067 Services [RFC7612] 3068 - revised section 6.1.6.1 Get-Printer-Attributes Request to say Clients MUST supply 3069 “system-uri” or “printer-uri” and Systems MUST support both “system-uri” and “printer-uri” 3070 operation attributes 3071 - revised section 6.2.1 Cancel-Resource to move Resource History paragraph up to 3072 section 4.6 Resource Object and add backward reference to section 4.6 3073 - revised section 6.2.2 Create-Resource to support optional creation of one or more per-3074 Resource Subcription objects with request and response Subscription Attributes groups 3075 - revised section 6.2.2 Create-Resource to change “Resource for use” to just “Resource”, 3076 change “will change” to “will either change”, delete redundant “keep “resource” state of 3077 ‘available’ clause, and Job-scope Resource note 3078 - revised section 6.2.5 Install-Resource and section 6.2.6 Send-Resource-Data to add 3079 notes about need for validation of Resource metadata 3080 - revised section 6.2.7 Set-Resource-Attributes to remove discussion of aborting 3081

Page 106: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 106 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

Resources due to bad Set-Resource-Attributes request 3082 - revised section 7.1.2 printer-ids to drop references to Create-Resource and add 3083 “list of “printer-id” values for target…” 3084 - revised section 7.1.9 resource-ids to add reference to Allocate-Printer-Resources and 3085 add “list of “resource-id” values for associated…” 3086 - added section 7.2.11 printer-creation-attributes-supported for capabilities in Create-3087 Printer operation 3088 - revised section 7.2.12 resource-settable-attributes-supported to change “type 2” to 3089 “type2” 3090 - revised section 7.2.19 system-mandatory-printer-attributes to add analogy to “printer-3091 mandatory-job-attributes”, reword conformance for ‘printer-name’ and ‘printer-xri-3092 supported’ values, rename Table 9 to Recommended-to-Supply Printer Creation Attributes, 3093 and delete redundant Conformance column and Notes below 3094 - revised section 7.5.3 printer-service-type to change “SMI number registered by IANA” to 3095 “SMI number assigned by IANA” 3096 - revised section 7.7.1 date-time-at-canceled and section 7.7.16 time-at-canceled to 3097 change “before “resource-state” actually transitions to ‘canceled’” to “the Resource 3098 transitions to the ‘canceled’ or ‘aborted’ state” 3099 - revised section 7.7.3 date-time-at-installed and section 7.7.18 time-at-installed to change 3100 “before “resource-state” actually transitions to ‘installed’” to “before the Resource 3101 transitions to the ‘installed’ state” 3102 - revised section 7.7.8 resource-state to crop Note 1 from figure and add Note 1 and new 3103 Note 2 about special state transitions when a new executable Resource is installed and 3104 *replaces* a previous executable Resource (which transitions backwards to ‘available’) 3105 - revised section 7.7.8 resource-state, section 7.7.9 resource-state-message, and section 3106 7.7.10 resource-state-reasons to correct the analogy to Job state/message/reasons (from 3107 previous Printer analogy) 3108 - added section 7.7.13 resource-use-count for Resource allocation count 3109 - revised section 14.1 Normative References to update references to [PWG5100.FIN] and 3110 [PWG5100.P3D] 3111 - TODO – add status-code text to section 6 preamble and to all operations in sections 6.x 3112 - TODO – add back explicit full parms for every operation in section 6 per PWG F2F review 3113 - TODO – fix all the broken section 6.x references from the reorganization of section 6 3114

17.117.2 1 November 2016 3115

- Interim draft – changes per IPP WG discussion on 19 October 2016 3116 - revised prologue to add List of Figures 3117 - revised section 4.6 Resource Object and section 5.7 Resource Status Attributes to add 3118 forward references to Figure 1 in section 7.7.8 resource-state for Resource life cycle 3119 - revised section 7.1 IPP Operation Attributes, section 7.3 System Status Attributes, and 3120 section 7.7 Resource Status Attributes to accept previously deleted sections for readability 3121 - revised section 7.7.8 resource-state to add Figure 1 IPP Resource Object Life Cycle 3122

Page 107: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 107 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

17.217.3 18 October 2016 3123

- Interim draft – changes per IPP WG review on 5 October 2016 3124 - global – accepted all changes before section 6.1.6 Get-Printer-Attributes (all reviewed by 3125 IPP WG) 3126 - revised section 5.6 Resource Description Attributes to replicate note taken from Create-3127 Printer operation about how Printer-scope Resources are associated with Printers 3128 - revised section 6.1.5.1 Get-Printers Request to remove “printer-uri” (redundant with class 3129 Get-Printer-Attributes) since this is a new request 3130 - revised section 6.1.5.1 Get-Printers Request to explicitly limit the values of “requested-3131 attributes” to those IPP Printer source attributes listed in the table in section 4 Definition of 3132 Attribute Types in the IETF LDAP Schema for Printer Services [RFC7612] (to limit new 3133 Get-Printers operation to first-order discovery of appropriate Printers) 3134 - revised section 16. Appendix A – Rationale for Design Choices to accept all changes (to 3135 reduce editor’s annoyance) 3136

17.317.4 4 October 2016 3137

- Interim draft – changes per IPP WG review on 19 September 2016 3138 - global – accepted all changes before section 6 (all reviewed by IPP WG) 3139 - global – removed “resource-printer-id” and “resource-printer-ids” from sections 5, 6, and 3140 7, thus removing interaction with “printer-resource-ids” and rewrote Create-Printer and 3141 Create-Resource accordingly 3142 - revised sections 4.x to change “are [long|short]-lived objects” to “are typically [long|short]-3143 lived objects” 3144 - revised section 5.4 System Operations and Table 3 to add Allocate-Printer-Resources 3145 and Deallocate-Printer-Resources 3146 - revised section 5.7 Resource Status Attributes and Table 5 to delete “resource-printer-3147 ids” and note 5 3148 - added section 6.1.1 Allocate-Printer-Resources and section 6.1.3 Deallocate-Printer-3149 Resources to update Resources associated with a given Printer after Create-Printer 3150 - revised section 6.1.2 Create-Printer to clarify choices for associating Resources with a 3151 given Printer and refer to Resource upload defined in [PWG5100.18]. 3152 - revised section 6.2.2 Create-Resource to clarify choices for associating Resources with a 3153 given Printer and refer to Create-Resource-Subscription operation. 3154 - TODO – add status-code text to section 6 preamble and to all operations in sections 6.x 3155 - TODO – add back explicit full parms for every operation in section 6 per PWG F2F review 3156 - TODO – fix all the broken section 6.x references from the reorganization of section 6 3157

17.417.5 15 September 2016 3158

- Interim draft – changes per PWG F2F review on 23 August 2016 3159 - global – accepted all changes before section 8 (all reviewed at PWG F2F) 3160 - global – renamed section 5 to IPP Objects and Operations Summary and revised to 3161 delete reference to “system-configured-subunits” and change Description attributes 3162

Page 108: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 108 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

sections from “READ-WRITE” to “potentially READ-WRITE” (consistent with section 7) 3163 - global – revised section 6 IPP Operations to replace “allows allows” with “allows” 3164 - global – changed “resource-state” keywords of ‘pending’ to ‘created’ and ‘active’ to 3165 ‘available,’ added “resource-state” keyword of ‘aborted’, and added “resource-state-3166 reasons” keywords of ‘cancel-requested’, ‘install-requested’, and ‘resource-incoming’ for 3167 operations with delayed state transitions 3168 - revised section 4 IPP Object Model to add notes that System, Printer, and Resource 3169 Owners are mutable (long-lived objects) while Job and Subscription Owners are immutable 3170 (short-lived objects) 3171 - revised section 4.6 Resource Object to correctly explicitly refer to Send-Resource-Data 3172 and Install-Resource operations 3173 - revised section 5.3 System Status Attributes and Table 2 to delete reference to “system-3174 configured-subunits” 3175 - revised section 5.4 System Operations to include Install-Resource in note 3 and state 3176 that the original StoreResource operation has been decomposed into the sequence of 3177 Create-Resource, Send-Resource-Data, and Install-Resource and to revise and reference 3178 note 4 about Install-Resource 3179 - revised section 5.7 Resource Status Attributes and Table 5 to delete “resource-3180 authenticator” and “resource-category” and note 7 about “resource-authenticator”, delete 3181 “resource-job-id” and note 5 about “resource-job-id”, and change “resource-printer-id” 3182 (singular) to “resource-printer-ids” (a list of explicitly associated Printers) 3183 - revised section 5.9 Printer Status Attributes to delete double period on second list item 3184 - revised section 5.9 Printer Status Attributes and Table 7 to add “printer-resource-ids” with 3185 note about “resource-ids” operation attribute in Create-Printer 3186 - revised section 5.10 Job Status Attributes and Table 8 to add “job-resource-ids” with note 3187 about “resource-ids” operation attribute in Job Creation operations 3188 - revised section 6 IPP Operations to regroup all operations under Printer, Resource, 3189 Subscription, and System Operation subsections (this breaks DOZENS of cross-3190 references throughout the document) 3191 - revised note in section 6.1.1 Create-Printer and section 6.2.2 Create-Resource to explain 3192 two alternatives for correctly populating “printer-resource-ids” and “resource-printer-ids” 3193 status attributes 3194 - revised section 6.1.1 Create-Printer to add <all mandatory Printer Description attributes> 3195 with reference to “system-mandatory-printer-attributes” 3196 - revised section 6.1.1.1 Create-Printer Request to add “resource-ids” operation attribute 3197 that requests Resources and is copied (if valid) to the “printer-resource-ids” Printer Status 3198 attribute – note that this is intentionally NOT a Printer Description attribute for security 3199 - revised section 6.1.3 Get-Printers and section 6.1.4 Get-Printer-attributes to state that the 3200 returned Printers and Printer attributes MAY be filtered based on Client access rights (i.e., 3201 the value of “requesting-user-name”) or the specified “document-format” 3202 - revised section 6.1.3 Get-Printers and section 6.1.4 Get-Printer-attributes to list all 3203 operation and response attributes explicitly, add optional “printer-uri” alternative to “printer-3204 ids” or “printer-id” for target Printer, optional “document-format” (for filtering returned 3205 attributes), and required “printer-xri-supported” in response 3206 - revised section 6.1.4 Get-Printer-attributes to discuss backwards compatibility, change 3207 “system-uri” target to “Client SHOULD supply” (for legacy IPP Clients), add back optional 3208

Page 109: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 109 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

“printer-uri” (for legacy IPP Clients), add “first-index” and “element, and change “Groups 3 3209 to N” to “Group 3” 3210 - revised section 6.2.1 Cancel-Resource, section 6.2.5 Install-Resource, section 6.2.6 3211 Send-Resource-Data, and section 6.2.7 Set-Resource-Attributes to add that if “resource-3212 state” is ‘canceled’ or ‘aborted’ or “resource-state-reasons” includes ‘cancel-requested’ 3213 then System MUST return ‘client-error-not-possible’ 3214 - revised section 6.2.1 Cancel-Resource to correct typos from “Create-Resource” to 3215 “Cancel-Resource”, clarify transition of “resource-state” to ‘canceled’ (could be delayed if 3216 Resource is in use in a Job) and “resource-state-reasons” to ‘cancel-requested’, change 3217 “MAY” to “SHOULD” for the System delete of Resource data, add a definition of the 3218 Resource History lifecycle phase, and state that the System MUST support Resource 3219 History period of at least 300 seconds for reliable system log files 3220 - revised section 6.2.2 Create-Resource to delete “resource-category” (redundant with 3221 resource-type), delete “resource-job-id”, and clarify transitions (and keyword names) of 3222 “resource-state” and “resource-state-reasons” 3223 - revised section 6.4.3 Get-System-Attributes to add note that we will require explicit 3224 request for “system-configured-resources” or “system-configured-printers” (by analogy to 3225 “media-col-database” for Get-Printer-Attributes) 3226 - renamed section 7.1 System, Printer, Resource, and Job Operation Attributes to simply 3227 “Operation Attributes” and added note about their applicability 3228 - revised section 7.1 Operation Attributes to add “resource-ids” for Create-Printer and Job 3229 Creation operations to list requested Resources 3230 - deleted section 7.1.7 resource-category operation attribute 3231 - deleted section 7.1.10 resource-job-id operation attribute 3232 - revised section 7.2.11 resource-settable-attributes-supported to add missing type 3233 - revised section 7.2.13 system-default-printer-id to keep “MAX” and delete “max” in type 3234 - added section 7.2.18 system-mandatory-printer-attributes and Table 9 – Mandatory-to-3235 Supply Printer Creation Attributes for use in Create-Printer operation 3236 - revised section 7.3.11 system-configured-resources and Table 10 to delete “resource-3237 category” 3238 - deleted section 7.3.11.1 resource-category (redundant with resource-type) 3239 - revised section 7.3.17 system-state-reasons to state that any applicable “printer-state-3240 reasons” keyword value can be used (to avoid enumerating the existing keywords here) 3241 - revised section 7.5.3 printer-service-type to add ‘print3d’, delete ‘emailin’ and ‘emailout’ 3242 (security nightmares), delete ‘vendor’ (not interoperable), and add ‘smiNNN-name’ pattern 3243 and explanation for vendor service types 3244 - revised section 7.7.x “[date-time|time]-at-[cancelation|creation|installation]” to state the 3245 timestamps MUST be set at the time the System accepts a Cancel-Resource, Create-3246 Resource, or Install-Resource operation (instead of when the process completes and the 3247 appropriate “resource-state-reasons” pending value is removed) 3248 - deleted section 7.7.4 resource-authenticator (access info must be included in resource 3249 data manifest file) 3250 - deleted section 7.7.5 resource-category (redundant with resource-type) 3251 - deleted section 7.7.9 resource-job-id (use “job-resource-ids” in Job for association) 3252 - revised section 7.7.10 resource-state to define ‘pending’ (after creation), ‘available’ (after 3253 upload of data), ‘installed’ (after installation), ‘canceled’ (by Client, not by System), and 3254

Page 110: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 110 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

‘aborted’ (by System) so that ‘canceled’ and ‘aborted’ are the two alternative terminal 3255 states 3256 - revised section 7.7.12 resource-state-reasons to define ‘cancel-requested’, ‘install-3257 requested’, and ‘upload-requested’ for delayed completion of the respective operations 3258 processing 3259 - revised section 7.7.16 resource-type to change reference to “resource-category” 3260 reference (an attribute) to simply “resource category” (a prefix for a resource-type) and 3261 insert explicit resource category prefix into all “resource-type” keyword values and add 3262 ‘template-printer’ for potential Create-Printer extension 3263 - revised section 14.1 Normative References to add “PWG5100.P3D” for ‘print3d’ service 3264 type 3265 - added Appendix A – Rationale for Design Choices – added first Resource topics 3266 - TODO – add status-code text to section 6 preamble and to all operations in sections 6.x 3267 - TODO – add back explicit full parms for every operation in section 6 per PWG F2F review 3268 - TODO – fix all the broken section 6.x references from the reorganization of section 6 3269

17.517.6 18 August 2016 3270

- Interim draft – changes per IPP WG review on 15 August 2016 3271 - global – accepted all changes before section 7 3272 - global – changed “system-default-printer-uri” (ambiguous, N per Printer) to “system-3273 default-printer-id” (explicit, 1 per Printer) 3274 - global – changed “resource-printer-uri” (ambiguous, N per Printer) to “resource-printer-id” 3275 (explicit, 1 per Printer) 3276 - global – changed all Printer operations to replace “printer-uri” (ambiguous, N per Printer) 3277 with “printer-id” (explicit, 1 per Printer) 3278 - added section 1.2 Get-Printer-Attributes extension (about “default” Printer) 3279 - added section 1.3 Printer Identity Extension (about “printer-id”) 3280 - revised section 5.9 Printer Status Attributes and Table 7 to add “printer-id” and correct 3281 SM references for all three attributes 3282 - revised sections 6.x to explicit state requirement for “authorized Operator or 3283 Administrator” (most operations), “authorized Client” (few operations), or “unauthenticated 3284 Client” (ONLY for Get-Printer-Attributes extended legacy operation) 3285 - revised section 6.1 Cancel-Resource to discuss “age” out (delete) of Resource objects in 3286 the Resource History (after cancellation) – need some more text here 3287 - revised section 6.1.1 Cancel-Resource Request and section 6.4.1 Create-Resource-3288 Subscriptions Request to move up the “resource-id” target operation attribute 3289 - revised section 6.2.2 Create-Printer Response to delete “printer-uri” and “printer-uri-3290 supported”, etc and add “printer-id” and “printer-xri-supported” 3291 - revised section 6.3 Create-Resource to fix spelling of Install-Resource and “notify-printer-3292 id” 3293 - revised section 6.4 Create-Resource-Subscriptions to return “status-code” of ‘client-error-3294 not-possible’ for “resource-state” or ‘canceled’ 3295 - revised section 6.4 Create-Resource-Subscriptions to change analogy from Create-3296 Printer-Subscriptions to Create-Job-Subscriptions 3297 - revised section 6.6.1 Delete-Printer Request to explicitly add the (mandatory to supply) 3298

Page 111: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 111 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

“printer-id” operation attribute 3299 - revised section 6.9.1 Get-Printers Request to explicitly add the (optional for Client to 3300 supply) “printer-ids” operation attribute 3301 - revised section 6.9.2 Get-Printers Response to explicitly add the (mandatory for System 3302 to return) “printer-id” Printer response attribute for each Printer object returned 3303 - revised section 6.10 Get-Printer-Attributes to change “system-default-printer-uri” to 3304 “system-default-printer-id” and add (Client optionally supplies) explicit “printer-id” 3305 - revised section 7.1 System, Printer, Resource, and Job Operation Attributes to add 3306 “printer-id” 3307 - revised section 7.3.9 system-configured-printers and Table 9 to add “printer-id” 3308 - revised section 7.5 Printer Status Attributes to define “printer-id” for resource-constrained 3309 Clients 3310 - TODO – add status-code text to section 6 preamble and to all operations in sections 6.x 3311 - TODO – add resource-state discussion and clarify Install-Resource (i.e., could it be 3312 immediate without a reboot?) 3313

17.617.7 10 August 2016 3314

- Interim draft – changes per IPP WG review on 25 July 2016 3315 - global – accepted all changes before section 7.3.11 system-configured-subunits 3316 - renamed section 5.10 from Job Description Attributes to Job Status Attributes for new 3317 “job-owner-col” 3318 - revised sections 6.x to add requesting-user-vcard to all operations (as Client SHOULD 3319 supply and System MUST support) 3320 - revised section 6.1 Cancel-Resource to define the operation 3321 - revised section 6.2 Create-Printer to remove erroneous “printer-uri” as input attribute 3322 - revised section 6.3 Create-Resource to refer to new Install-Resource and ‘installed’ value 3323 of “resource-state” 3324 - revised section 6.4 Create-Resource-Subscriptions to define the operation 3325 - revised section 6.5 Create-System-Subscriptions to define the operation 3326 - revised section 7.1.4 requesting-user-vcard to clarify usage and that it goes to a Job 3327 Status attribute (rather than Description attribute), different from System, Printer, and 3328 Resource long-lived objects 3329 - revised section 7.3.1 power-log-col to change “transition” to “transitions” (plural) and 3330 correct spelling of ‘reset-nmi’ in example 3331 - revised sections 7.3.10.x to correct forward references to sections 7.x 3332 - revised section 7.3.10.3 resource-id to change “(1:max)” to “(1:MAX)” 3333 - deleted former section 7.3.11 system-configured-subunits per consensus 3334 - deleted former section 7.3.18 system-totals per consensus (redundant with counters in 3335 Printer service objects) 3336 - revised section 7.7.12 resource-state to add ‘installed’ as a first class state for executable 3337 Resource objects (which shows in system-configured-resources summary) 3338 - renamed section 7.8 from Job Description Attributes to Job Status Attributes for new “job-3339 owner-col” 3340 3341

Page 112: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 112 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

17.717.8 20 July 2016 3342

- Interim draft – changes per IPP WG review on 11 July 2016 3343 - global – accepted all changes before section 7.3.10 system-configured-resources 3344 - revised Abstract and Introduction to tighten up wording 3345 - revised section 5.6 Resource Description Attributes and Table 4 to add note for 3346 REQUIRED “resource-owner-col” 3347 - revised section 5.7 Resource Status Attributes and Table 5 to delete “resource-owner-3348 col” (belongs in settable description attributes for change of owner) and associated note 3349 - revised section 5.7 Resource Status Attributes and Table 5 to add note for “date-time-at-3350 installed” and “time-at-installed” including analogy to “date-time-at-processing” and “time-3351 at- processing” Job attributes 3352 - added section 5.10 Job Description Attributes and Table 8 for “job-owner-col” extension 3353 - revised section 7.1.4 “requesting-user-vcard” to extend to System, Printer, Resource, and 3354 Job objects and discuss “most authenticated” user identity with pointer to “job-originating-3355 user-name” in [RFC2911]. 3356 - revised section 7.3.1 “power-log-col” to discuss minimizing log entries, MUST log final 3357 states, and MAY omit intermediate states (e.g., from ‘resetNMI’) 3358 - revised section 7.3.9 “system-configured-printers” to add Table 9 of member attributes 3359 - revised section 7.3.10 “system-configured-resources” to add Table 10 of member 3360 attributes 3361 - revised section 7.3.11 “system-configured-subunits” to add Table 11 of member attributes 3362 - deleted section 7.3.9.8 “queued-job-count” from “system-configured-printers” (too much 3363 detail without much utility) 3364 - revised section 7.7.3 “date-time-at-installation” and section 7.7.21 “time-at-installation” to 3365 note analogy to analogy to “date-time-at-processing” and “time-at- processing” Job 3366 attributes 3367 - revised section 7.7.11 “resource-state” to add comment suggesting new first class state 3368 of ‘installed’ (follows ‘active’) to show up in “system-configured-resources” summary 3369 3370

17.817.9 6 July 2016 3371

- Interim draft – changes per IPP WG review on 27 June 2016 3372 - global – accepted all changes before section 7.3.4 power-state-capabilities-col 3373 - global – added many comments with design choice notes 3374 - global – replaced “*word*” with “word” in BOLD for consistency 3375 - global – revised all System, Printer, and Resource status attribute definitions to use 3376 “identifies” or “contains” instead of “specifies” (since status attributes always report values 3377 rather than allowing them to be set) 3378 - global – changes all power state attributes to be (type1 keyword) in order to disallow any 3379 vendor unique extension keywords 3380 - global – corrected references to former section 7.2.7.7 power state definitions to section 3381 7.2.1 Power States and Policies 3382 - revised section 5.3 System State Attributes and Table 2 to rename “power-monitor-col” to 3383 “power-state-monitor-col” and combine with former “power-general-col” and “power-3384

Page 113: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 113 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

meters-col” 3385 - revised section 5.4 System Operations and Table 3 to remove document references on 3386 “<none>” operation columns and add appropriate footnotes 3387 - revised section 5.6 Resource Description Attributes and Table 4 to delete “resource-3388 string-version” and “resource-version” 3389 - revised section 5.7 Resource Status Attributes and Table 5 to add “date-time-at-installed” 3390 “time-at-installed”, “resource-string-version”, and “resource-version” 3391 - revised section 5.7 Resource Status Attributes and Table 5 to add “resource-owner-col”, 3392 “resource-string-version”, and “resource-version” and appropriate footnotes 3393 - revised section 5.7 Resource Status Attributes and Table 5 to remove document 3394 references on “<none>” operation columns and add appropriate footnotes 3395 - added section 5.9 Printer Status Attributes and Table 7 for “printer-config-changes” and 3396 “printer-service-type” 3397 - revised section 6.2 Create-Printer, section 6.3 Create-Resource, and section 7.1 System, 3398 Printer, and Resource Operation Attributes to add “requesting-user-vcard” attribute for use 3399 in setting “printer-owner-col” and “resource-owner-col” description attributes 3400 - added section 7.2.1 Power States and Policies to define all power states (including 3401 examples of their typical effect on System activities), their relationships to DMTF CIM and 3402 ACPI, their order of power consumption based on DMTF CIM, and examples of their usage 3403 (in power policies and in operations such as Restart-System) 3404 - revised section 7.2.8.2 event-name to replace vendor name ‘AcmeCrackedCrock’ with 3405 ‘ExampleEventName’ 3406 - revised section 7.2.24 xri-supported member attributes to reference [RFC3380] and use 3407 corresponding member attribute names 3408 - revised sections 7.2.x power-calendar-policy-col, power-event-policy-col, and power-3409 timeout-policy-col to add commented examples 3410 - revised section 7.3.2.4 power-state-message to remove ‘959’, ‘960’, etc. from cut-and-3411 paste from PDF source and add complete example for system shutdown 3412 - revised section 7.3.5 power-state-monitor-col to include all attributes from former “power-3413 general-col” and “power-meters-col” collections except for “power-peak-watts” and 3414 “previous-month-kwh” and to rename “can-request-power-states” to “valid-request-power-3415 states” (for clarity) 3416 - revised section 7.3.5.6 power-state-message to add complete example for system 3417 shutdown 3418 - revised section 7.3.11 system-configured-subunits to add all member attributes per PWG 3419 MFD Model and PWG Imaging System State and Counter MIB v2 3420 - revised section 7.6 Resource Description Attributes to add “resource-owner-col” and 3421 delete “resource-string-version” and “resource-version” 3422 - revised section 7.7 Resource Status Attributes to add “date-time-at-installed”, “time-at-3423 installed”, “resource-string-version”, and “resource-version” 3424 - revised section 7.7.14 resource-state-reasons to add ‘installed’ (others are still TBD) 3425 - revised section 14.1 Normative References to add [ACPI], DMTF [DSP1027], and 3426 [IEEE1621] for power state definitions and semantics and various RFCs and PWG specs 3427 for other references 3428 - TODO: Design and define “system-totals” as a subset of [PWG5108.06] 3429

Page 114: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 114 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

- TODO: Design and define “resource-authenticator” 3430 - ISSUE: Indices for "system-configured-subunits" for multiple output devices? 3431

17.917.10 23 June 2016 3432

- Interim draft – further updates for collection attributes 3433 - completed all System, Printer, and Resource attribute definitions, except for “resource-3434 authenticator” and “system-totals” (both need design work) 3435 - kept all redlines from 12 June 2016 version (not yet reviewed) 3436 - revised section 5.3 System Status Attributes and Table 2 to to rename “power-counters-3437 col” (obscure) to “power-state-counters-col” (counts of state transitions), rename “power-3438 monitor-col” (obscure) to “power-state-monitor-col” (current System power state), rename 3439 “power-state-capability-col” (obscure) to “power-state-capabilities-col” (set of booleans and 3440 gauges), and rename “power-state-transition-col” (obscure) to “power-state-transitions-col” 3441 (set of valid stable/ephemeral state transitions) 3442 - revised section 5.6 Resource Description Attributes and Table 4 to add “resource-owner-3443 col” (for consistency w/ System and Printer objects) 3444 - revised section 5.7 Resource Status Attributes and Table 5 to delete “resource-3445 originating-user-name” and “resource-originating-user-uri” (redundant with “resource-3446 owner-col”) 3447 - revised section 7.3 System Status Attributes to add “-col” suffix to all power collection 3448 attributes and add all member attributes 3449 - revised section 7.3 System Status Attributes to rename “power-counters-col” (obscure) to 3450 “power-state-counters-col” (counts of state transitions), rename “power-monitor-col” 3451 (obscure) to “power-state-monitor-col” (current System power state), and rename “power-3452 state-capability-col” (obscure) to “power-state-capabilities-col” (set of booleans and 3453 gauges) 3454 - revised section 7.3.1 power-general-col to add all member attributes 3455 - revised section 7.3.2 power-log-col to add all member attributes, except for 3456 PowerComponentType and PowerComponentReferenceId (used for Subunits in power 3457 model) 3458 - revised section 7.3.3 power-meters-col to add all member attributes 3459 - revised section 7.3.4 power-state-capabilities-col to add all member attributes, except for 3460 CanUseInterfaces (used for Interface subunits in power model) 3461 - revised section 7.3.5 power-state-counters-col to add all member attributes 3462 - revised section 7.3.6 power-state-monitor-col to add all member attributes 3463 - revised section 7.3.7 power-state-transitions-col to add all member attributes 3464 - revised section 7.3.11 system-configured-printers to add all member attributes 3465 - revised section 7.3.12 system-configured-resources to add all member attributes 3466 - revised section 7.6 Resource Description Attributes to define all group attributes 3467 - revised section 7.6 Resource Description Attributes to add “resource-owner-col” (for 3468 consistency w/ System and Printer objects 3469 - revised section 7.7 Resource Status Attributes to define all group attributes, except for 3470 “resource-authenticator” (hash/signature for verification of Resource data) as this needs 3471 some design discussion 3472 - revised section 7.7 Resource Status Attributes to delete “resource-originating-user-name” 3473

Page 115: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 115 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

and “resource-originating-user-uri” (redundant with “resource-owner-col”) 3474 - TODO: Design and define “system-totals” as a subset of [PWG5108.06] 3475 - TODO: Design and define “resource-authenticator” 3476

17.1017.11 12 June 2016 3477

- Interim draft – changes per IPP WG review on 9 May 2016 3478 - accepted all previous changes through end of section 7.3 System Status Attributes 3479 - revised section 5.2 System Description Attributes and Table 1 to clarify note 4 about Set-3480 System-Attributes 3481 - revised section 5.2 System Description Attributes and Table 1 to clarify note 6 about Set-3482 System-Attributes and change “equivalent” to “analogous” and add full title of [RFC3380]. 3483 - revised section 5.2 System Description Attributes and Table 1 to add “resource-settable-3484 attributes-supported” and corresponding new note 7 (for consistency w/ System and 3485 Printer objects) 3486 - revised section 5.3 System Status Attributes and Table 2 to change to “<none>[8]” for 3487 system-state-change-[date-time|time] 3488 - revised section 5.3 System Status Attributes and Table 2 to clarify note 8 about 3489 configuration and state changes 3490 - revised section 5.3 System Status Attributes and Table 2 to clarify notes 7 and 9 and add 3491 full title of [PWG5100.13] 3492 - revised section 5.4 System Operations and Table 3 to move note [7] reference to correct 3493 column 3494 - revised section 5.8 Printer Description Attributes and Table 6 to change “printer-owner” to 3495 “printer-owner-col” and add note 1 about Set-Printer-Attributes coherence of “owner-uri” 3496 and “owner-vcard” member attributes. 3497 - revised section 6.2 Create-Printer to delete redundant “and”, missing hyphen in “print-3498 color-mode-supported”, and add quotes around attribute names in final note 3499 - revised section 6.14 Get-System-Supported-Values to correct name from “Settable” to 3500 “Supported” and to correct reference to Get-Printer-Supported-Values in [RFC3380]. 3501 - revised section 7.2 System Description Attributes first paragraph to remove redundancy 3502 - revised section 7.2 System Description Attributes to add “resource-settable-attributes-3503 supported” (for consistency w/ System and Printer objects) 3504 - accepted all changes in section 7.2.7 power-calendar-policy-col and put all member 3505 attributes in alphabetical order, clarified first values (zero or one), and removed 3506 redundancy in descriptions 3507 - renamed section 7.2.7.1 policy-id to calendar-id for consistency with [PWG5106.4] 3508 - revised section 7.2.7.3 day-of-week (now integer) to delete previous keyword values 3509 - revised section 7.2.7.7 request-power-state to separate stable states and ephemeral 3510 (transitional) states into two lists of standard keywords for clarity 3511 - revised section 7.2.8 power-event-policy-col to add all member attributes 3512 - revised section 7.2.9 power-event-policy-col to add all member attributes 3513 - revised section 7.2.24 system-xri-supported to add all member attributes 3514 - revised section 7.4 Printer Description Attributes first paragraph to remove redundancy 3515 - revised section 7.4 Printer Description Attributes to add “printer-owner-col”, “owner-uri”, 3516 and “owner-vcard” attributes 3517

Page 116: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 116 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

- revised section 7.5 Printer Status Attributes to add “printer-config-changes” attribute per 3518 PWG F2F review on 26 April 2016 3519 - revised section 7.6 Resource Description Attributes first paragraph to remove 3520 redundancy 3521 - revised section 14.1 Normative References to correct reference to PWG 5100.12 per 3522 PWG F2F review on 26 April 2016 3523

17.1117.12 9 May 2016 3524

- Interim draft – changes per PWG F2F review on 26 April 2016 3525 - revised section 7.2.7.1 to rename “power-calendar-policy-id” to “policy-id” 3526 - revised section 7.2.7.2 request-power-state to delete ‘other’ (invalid) and ‘unknown’ (out-3527 of-band value) 3528 - revised section 7.2.7.4 day-of-week to change syntax to “integer(1:7)” 3529 - revised section 7.2.7.5 month to change syntax to “integer(1:12)” 3530 - revised section 7.2.7.6 to rename “day” to “day-of-month” and correct integer syntax 3531 - revised section 7.2.7.7 hour and section 7.2.6.8 minute to correct integer syntax 3532 - revised section 7.2.7.7 hour to add note about local time zone changes (summer time to 3533 standard time or vice versa) and the possibility that a given hour will not occur. 3534

17.1217.13 8 May 2016 3535

- Interim draft – changes per PWG F2F review on 26 April 2016 3536 - revised section 3.2.5 Bootstrap Client Access to Default Print Service to use 3537 “ipp://printer12.example.com/ipp/print” for discovered default Print Service 3538 - revised section 5 IPP System and Resource Objects and Operations to add note about tables 3539 listing only top-level attributes and forward reference collection member attributes in section 7 3540 - revised section 5.2 System Description Attibutes Table 1 to add “system-settable-3541

attributes-supported”, “system-strings-languages-supported”, and “system-strings-uri” and 3542 delete “system-health” 3543 - revised section 5.2 System Description Attibutes Table 1 to rename “system-owner-uri” to 3544 “system-owner-col” (collection) and make it REQUIRED and delete “system-owner-vcard” 3545 - revised section 5.2 System Description Attibutes Table 1 to add “-col” suffix to all power 3546 model collection attributes for consistency 3547 - revised section 5.3 System Status Attributes Table 2 to also add “-col” suffix to all power 3548 model collection attributes for consistency 3549 - revised section 5.4 System Operations Table 3 to add Get-System-Supported-Values 3550 - revised section 6.2 Create-Printer to note that Subunits are also associated by configured 3551 service capabilities – intent and not explicit listing 3552 - revised section 6 IPP Operations to add REQUIRED Get-System-Supported-Values for 3553 newly REQUIRED Set-System-Attributes operation 3554 - revised section 6 IPP Operations definition of Set-System-Attributes to include forward 3555 reference to “system-strings-languages-supported” and “system-strings-uri” for Client 3556 localization. 3557 - revised section 7.2 System Description Attributes to add “system-settable-attributes-3558

Page 117: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 117 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

supported”, “system-strings-languages-supported”, and “system-strings-uri” 3559 and add “-col” suffix to all power model collection attributes for consistency and delete 3560 “system-health” 3561 - revised section 7.2.7 power-calendar-policy-col to change all enums to keywords 3562 - revised section 7.2.19 system-owner-col to changed to REQUIRED 3563 - revised section 7.3.10 system-config-changes to clarify semantics and state a System 3564 MUST reset to zero when a power cycle occurs (from ‘off’ to ‘on’). 3565

17.1317.14 25 April 2016 3566

- Interim draft – changes per IPP WG review on 29 February 2016 3567 - global – accepted all redlines from previous versions up to end of section 7.3 3568 - global – changed “out-of-band value defined in [RFC2910]” to “out-of-band value defined 3569 in [RFC2911]” 3570 - revised section 2.3 Printing Terminology to add references for every definition 3571 - revised section 3.2.5 Bootstrap Client Access to Default Print Service to use explicit IPv4 3572 address to query the System Service listening to port 631 for the default print service URI 3573 - revised section 5.2 System Description Attibutes Table 1 to rename “natural-language-3574 supported” to “generated-natural-language-supported” for consistency with RFC 2911 3575 - revised section 5.2 System Description Attibutes Table 1 to add “system-current-time” 3576 - revised section 5.3 System Status Attributes Table 2 to add system-config-change-date-3577 time, system-config-change-time, system-state-change-date-time, and system-state-3578 change-time 3579 - revised section 5.3 System Status Attributes Table 2 to delete “system-current-time” 3580 - revised section 5.3 System Status Attributes Table 2 to to rename “power-support” to 3581 “power-state-capability” and “power-transition” to “power-state-transition” for clarity 3582 - revised section 7.2 System Description Attribues to explicitly mention Set-System-3583 Attributes operation and “system-settable-attributes-supported” 3584 - revised section 7.2.4 natural-language-configured to restrict scope to only System-3585 generated attribute values. 3586 - revised section 7.2.5 to rename “natural-language-supported” to “generated-natural-3587 language-supported” for consistency with RFC 2911 and restored text about a System 3588 accepting any natural language value. 3589 - revised section 7.2.7 power-calendar-policy to define power-calendar-policy-col and all 3590 member attributes 3591 - revised section 7.2.10 system-default-printer-uri and section 6.2 Create-Printer to clarify 3592 that when the first Print Service is created on a System, the System MUST set the value of 3593 “system-default-printer-uri” 3594 - revised section 7.2.12 system-geo-location to delete trailing fragment 3595 - revised section 3596 - added section 7.2.18 system-owner (collection) to include “system-owner-uri” and 3597 “system-owner-vcard” and provide extensibility for additional System Owner metadata 3598 - revised section 7.3 System Status Attributes to add “system-config-change-date-time”, 3599 “system-config-change-time”, “system-state-change-date-time”, and “system-state-change-3600 time” 3601 - revised section 7.3.6 to rename “power-support” to “power-state-capability” for clarity 3602

Page 118: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 118 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

- revised section 7.3.7 to rename “power-transition” to “power-state-transition” for clarity 3603 - revised section 7.3.8 system-config-changes to clarify that the System MUST increment 3604 the value each time an attribute value is changed with a Set-System-Attributes operation. 3605 - moved section 7.3.12 system-current-time to section 7.2 System Description Attributes 3606 3607

17.1417.15 28 February 2016 3608

- Interim draft – changes per PWG F2F review on 10 February 2016 3609 - global – kept some redlines from previous versions for review by IPP WG 3610 - global – changed “as described in [xxx]” to “defined in [xxx]” for clarity 3611 - global – manually changed lowercase “ system Administrator” to titlecase “ 3612 Administrator”, lowercase “ operator” to titlecase “ Operator”, and standalone “ user” or “ 3613 User” to titlecase “ End User” 3614 - global – changed “specifies [a/the] list of” to simply “lists” 3615 - global – accepted all redlines in section 7.1 System, Printer, and Resource Operation 3616 Attributes, section 7.2 System Description Attributes, and section 7.3 System Status 3617 Attributes up through section 7.3.13 system-health before making current changes for 3618 readability 3619 - revised section 2.3 Printing Terminology to add definitions of Administrator, End User, 3620 and Operator from RFC 2911bis (taken from RFC 2567) and Delivery Method, Event 3621 Notification, Notification, Owner, Resource, and Subscription (taken from PWG 5108.01, 3622 PWG 5108.03, or RFC 3995) 3623 - added section 3.2.5 Bootstrapping Client Access to Default Print Service and added 3624 cross-reference to section 7.2.10 system-default-printer-uri 3625 - revised section 7.1 System, Printer, and Resource Operation Attributes, section 7.2 3626 System Description Attributes, and section 7.3 System Status Attributes to attach second 3627 sentence (semantic equivalence or analogy) to first sentence for clarity 3628 - revised sections 7.2.7, 7.2.8, and 7.2.9 to add “-policy” suffix to “power-calendar”, “power-3629 event”, and “power-timeout” collection System Description attributes 3630 - revised section 7.2.10 system-default-printer-uri to change syntax to “(uri | no-value”) 3631 - revised section 7.2.11 system-geo-location to change syntax to “(uri | unknown)” 3632 - revised section 14.2 Informative References to add RFC 2567 3633

17.1517.16 17 January 2016 3634

- Interim draft – changes per IPP WG reviews on 7 December 2015 and 4 January 2016 3635 - global – kept most redlines from previous versions for review by IPP WG 3636 - global – revised section 6 IPP Operations to delete trailing document references after 3637 every operation request and operation response attribute for clarity 3638 - global – revised section 7.1 System, Printer, and Resource Operation Attributes to further 3639 simplify and clarify filter text 3640 - revised section 5.4 System Operations and section 6 IPP Operations to delete redundant 3641 and ambiguous Restart-All-Printers and Restart-One-Printer operations (use Shutdown 3642 and Startup instead) 3643

Page 119: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 119 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

- revised section 6 IPP Operations to add note that all operation requests and responses 3644 use standard operation parameters defined in [RFC2911] and encoded in [RFC2910] 3645 - revised section 6 IPP Operations definition of Get-Printers to add note that it is an End 3646 User operation and does NOT require Client authentication, but MAY be encrypted and 3647 another note that requested-attributes is limited to the LDAP Printer Schema [RFC7612] 3648 and if request-attributes is missing, then the System MUST only return printer-uri-3649 supported, uri-authentication-supported, and uri-security-supported. 3650 - revised section 6 IPP Operations definition of Get-Resources to add note that it is an 3651 Administrator operation and requires Client authentication. 3652 - revised section 6 IPP Operations definition of Get-Printers to change operation attribute 3653 printer-service-type to ‘1setOf’ (for Get-Printers) 3654 - revised section 6 IPP Operations definition of Startup-All-Printers and Startup-One-3655 Printer to remove reference to RFC 3998 Startup-Printer 3656 - revised section 6 IPP Operations definition of Create-Printer, Create-Resources, Get-3657 Printers, Startup-All-Printers responses to delete status-code (parameter, not an attribute) 3658 and move attributes-charset/attributes-natural-language before status-message 3659 - revised section 7.1 System, Printer, and Resource Operation Attributes to delete 3660 redundant printer-service-types, to change operation attribute printer-service-type to 3661 ‘1setOf’ (for Get-Printers), and to move values to section 7.7 System Status Attributes 3662 printer-service-type 3663 - revised section 7.1 System, Printer, and Resource Operation Attributes to references to 3664 Create-Resource/Send-Resource-Data when appropriate 3665 - revised section 7.1 System, Printer, and Resource Operation Attributes resource-k-octets 3666 to correct forward reference to section 7.7 3667 - - revised section 7.1 System, Printer, and Resource Operation Attributes which-printers 3668 to clarify ‘all’ and ‘stopped’ and add ‘shutdown’ and ‘testing’ to harmonize with MFD Model 3669 and IETF Host Resources MIB [RFC2790] 3670

17.1617.17 6 December 2015 3671

- Interim draft – new content after IPP WG review on 5 October 2015 3672 - global – kept all redlines from previous versions for review by IPP WG 3673 - revised section 6 IPP Operations to define Startup-All-Printers (prototype for all other 3674 Xxx-All-Printers operation attributes), Startup-One-Printer (prototype for all other Xxx-One-3675 Printer operation attributes), Create-Printer, Create-Resource, Delete-Printer, Disable-All-3676 Printers, Enable-All-Printers, Get-Printer-Attributes, Pause-All-Printers, Restart-All-3677 Printers, Restart-One-Printer, Resume-All-Printers, Shutdown-All-Printers, Shutdown-One-3678 Printer 3679 - revised section 7.7 Resource Status Attributes to define resource-state (to be reviewed 3680 by IPP WG since the Resource object has unique states) 3681

17.1717.18 2 November 2015 3682

- Interim draft – new content after IPP WG review on 5 October 2015 3683 - global – kept all redlines from previous version for review at PWG November F2F 3684

Page 120: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 120 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

- revised section 7.1 System, Printer, and Resource Operation Attributes to add Resource 3685 operation attributes resource-category, resource-format, resource-id, resource-job-id, 3686 resource-k-octets, resource-printer-uri, resource-state, and resource-type 3687 - revised section 7.3 System Status Attributes to add power-counters, power-general, 3688 power-log, power-meters, power-monitor, power-support, power-transition, system-config-3689 changes, system-configured-printers, system-configured-resources, system-configured-3690 subunits, system-current-time, system-health, system-serial-number, system-state, 3691 system-state-messages, system-state-reasons, system-totals, system-up-time, and 3692 system-uuid 3693

17.1817.19 18 October 2015 3694

- Interim draft – changes per IPP WG review on 5 October 2015 3695 - global - accepted all changes up to and through section 6.9 (from previous review) 3696 - revised section 7.1 title to “System, Printer, and Resource Operation Attributes” to allow 3697 for Printer operation attributes in future such as “printer-service-type” for Create-Printer 3698 - revised sections 7.1.x to change “filters the set of Printers” to “specifies a filter for the 3699 applicable Printers” 3700 - added section 7.1.3 printer-service-type for Create-Printer operation 3701 - revised section 7.1.4 printer-service-types to change “Service Type attribute” to “Service 3702 Type element”, add forward reference to “printer-service-type” in section 7.5 Printer Status 3703 Attributes, and add emailin, emailout, and faxin (references to PWG 5108.01 and RFC 3704 2707) 3705 - revised section 7.1.5 resource-id to add forward reference to “resource-id” in section 7.7 3706 Resource Status Attributes 3707 - revised section 7.1.11 system-uri to change “attribute the target” to “attribute specifies the 3708 target” 3709 - revised section 7.1.12 which-printers to change "This attribute and is" to “This attribute is” 3710 (drop “and”) 3711 - revised section 14 References to accept all changes and add PWG Job Monitoring MIB 3712 (RFC 2707) 3713

17.1917.20 20 September 2015 3714

- Interim draft - changes per PWG F2F review on 31 August 2015 3715 - global - accepted all changes up to and through section 6.9 (from previous review) 3716 - revised Abstract and section 1 Introduction to add explicit references to Cloud & Infra 3717 - deleted section 5.2 System Operation Attributes and section 5.7 Resource Operation 3718 Attributes 3719 - added section 5.8 Printer Description Attributes and table for “printer-owner-[uri|vcard]” 3720 - revised section 6.9.1 Get-Printers Request to make “attributes-charset” and “attributes-3721 natural-language” REQUIRED for Client (per RFC 2911) 3722 - revised section 6.9.1 Get-Printers Request to add note to “requested-attributes” about the 3723 primary Printer attributes in the IETF LDAP Printer Schema (RFC 7612) 3724

Page 121: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 121 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

- revised section 7,2 System Description Attributes to add new attribute definitions 3725 - revised section 14.1 Normative References to add references for new attribute definitions 3726

17.2017.21 31 August 2015 3727

- Interim draft – changes per PWG F2F review on 10 August 2015 3728 - global – deleted redundant “new” and “now” and “below” in several dozen places 3729 - revised Table of Contents to delete List of Figures (all now deleted in this version) 3730 - revised section 2.2 Protocol Role Terminology to correct “Infrastructure System” from 3731 “PWG5109.CLOUD” to “PWG5109.1”, add “Printer”, and correct typos in “Protocol 3732 Endpoint” 3733 - revised section 2.2 Protocol Role Terminology to add references to IPP INFRA (PWG 3734 5100.18) to “Infrastructure Printer”, “Infrastructure System”, and “Proxy” 3735 - revised section 2.3 Printing Terminology to add “Printer” (synonym for “Imaging Service”) 3736 with RFC 2911 reference 3737 - revised section 3.1 Rationale for the IPP System Service to correct title of IPP/2.0 3738 - revised section 3.1 Rationale for the IPP System Service to add paragraphs for IPP 3739 INFRA [PWG5100.18] and Cloud Imaging Model [PWG5109.1] 3740 - revised section 5 IPP System and Resource Objects and Operations for clarity and 3741 deleted redundant Figure 1 through Figure 4 (PWG SM abstract objects) and text 3742 - revised section 5.1 System Attribute Groups and section 5.6 Resource Attribute Groups 3743 titles to be singular (only one of each) 3744 - revised section 5.2 System Operation Attributes and section 5.7 Resource Operation 3745 Attributes to be just forward references to section 7.1 System and Resource Operation 3746 Attributes 3747 - revised section 5.3 System Description Attributes Table 1 and section 7.2 System 3748 Description Attributes to add “system-default-printer-uri” to support the enhanced “Get-3749 Printer-Attributes” operation 3750 - revised and reordered (alphabetized) section 5.3 System Description Attributes Table 1 3751 and section 7.2 System Description Attributes to insert “system” prefix on several attributes 3752 for consistency with Printer object in RFC 2911 3753 - revised and reordered (alphabetized) section 5.4 System Status Attributes Table 2 and 3754 section 7.3 System Status Attributes to insert “system” prefix on several attributes and add 3755 “system-up-time”for consistency with Printer object in RFC 2911 3756 - revised section 5.5 System Operations Table 3 to add missing references and change 3757 “Cancel-Subscriptions” and “Renew-Subscriptions” to singular per RFC 3995 3758 - revised section 5.5 System Operations Table 3 to update note for Create-Resource and 3759 add note for Create-Printer referring to the semantically equivalent Create operation in ISO 3760 10175-3 3761 - revised section 5.5 System Operations Table 3 to add note that Register-Output-Device 3762 is semantically equivalent to Register-System in PWG 5109.1 (with differences explained) 3763 - revised section 5.9 Resource Status Attributes Table 5 to add note for “resource-id” 3764 analogous to “job-id” in RFC 2911. 3765 - revised section 5.9 Resource Status Attributes Table 5 to add note for “resource-k-octets” 3766 analogous to “job-k-octets” in RFC 2911. 3767 - revised section 5.9 Resource Status Attributes Table 5 to add notes for “resource-job-id” 3768

Page 122: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 122 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

and “resource-printer-uri” which are requried for Job and Printer scoped Resource objects, 3769 respectively 3770 - revised section 5.9 Resource Status Attributes Table 5 to add “resource-authenticator” for 3771 verification of Resource data after a Send-Resource-Data operation 3772 - deleted redundant sections 6.x Cancel-Subscription, Get-Notifications, Get-Printer-3773 Attributes, and Renew-Subscription and moved to sections 8.x for existing operations with 3774 new semantics 3775 - revised section 6.x Get-Printers to change “selected” to “matching” and make sure that 3776 each attribute has a colon (:) at the end and put the reference(s) at the end of each 3777 attribute name 3778 - revised section 6.x Get-Printers to use “the Client [MUST|SHOULD|MAY] supply and the 3779 System MUST support” for clarity – “OPTIONALLY” is NOT a defined conformance 3780 keyword 3781 - revised section 6.x Get-Printers and section 7.1.x “printer-geo-location” to remove 3782 ‘unknown’ value (never appropriate in this specification) 3783 - revised section 6.x Get-Printers and section 7.1.x “printer-service-types” to change 3784 singular to plural (i.e., multiple printers can be chosen by the filter) 3785 - revised sections 6.x Get-Resources and Get-Resource-Attributes to note that they are 3786 modeled on Get-Jobs and Get-Job-Attributes with default returns of “resource-id” and 3787 “resource-state” 3788 - revised section 6.x Get-System-Attributes to note that it is modeled on Get-Printer-3789 Attributes with default return of all System attributes 3790 - revised section 7.1 title to be “System and Resource Operation Attributes” (since some 3791 apply to operations on both objects) 3792 - revised section 7.1.x to change “selects” to “filters” and “selected” to “matching” for clarity 3793 - added sections 7.1.x for “resource-category”, “resource-id”, “resource-job-id”, “resource-3794 printer-uri”, “resource-state”, and “resource-type” operation attributes 3795 - revised section 14.1 Normative References to update IPP/2.0 title and reference (work-in-3796 progress) and add IPP INFRA (PWG 5100.18-2015) and Cloud Imaging Model (PWG 3797 5109.1-2015) 3798 3799

17.2117.22 10 August 2015 3800

- Interim draft – changes per PWG F2F review on 29 April 2015 3801 - global – added working notes from PWG F2F at appropriate operations and attributes to 3802 capture discussion and agreements 3803 - revised Abstract and section 1 Introduction to say “support registration of an IPP System, 3804 through its IPP Proxy, with one or more Cloud Imaging Systems” 3805 - revised section 1.1 Rationale for two IPP Protocol Endpoints to titlecase “Protocol 3806 Endpoint” in first paragraph 3807 - revised section 2.2 Protocol Role Terminology, to add “Endpoint” (whole computing 3808 device) from IETF NEA Overview [RFC5209], clarify “Infrastructure System”, and rewrite 3809 “Protocol Endpoint” (an application interface) based on standard IETF usage. 3810 - revised section 3.4 Out-of-Scope to add support for any non-IPP Cloud Imaging System. 3811 - revised section 5.3 System Description Attributes to delete issue about cardinality of 3812

Page 123: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 123 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

“owner-uri” and “owner-vcard” (they are single-valued) and to remove Register-System 3813 operation from Table 1 Note 4 3814 - revised section 5.5 System Operations Table 3 to replace “Cancel-Xxx-Subscriptions” 3815 with “Cancel-Subscriptions” and “Renew-Xxx-Subscriptions” with “Renew-Subscriptions” 3816 and reference RFC 3995 3817 - revised section 5.5 System Operations Table 3 to delete “Renew-Resource”, add “Get-3818 Subscriptions” and “Get-Subscription-Attributes, and replace “Get-Xxx-Notifications” with 3819 “Get-Notifications” and reference RFC 3996 3820 - revised section 5.5 System Operations Table 3 to add new “Install-Resource” operation 3821 to activate (for use) firmware, software, fonts, etc. after Create-Resource and Send-3822 Resource-Data have completed 3823 - added section 5.6 Resource Attribute Groups 3824 - added section 5.7 Resource Operation Attributes 3825 - added section 5.8 Resource Description Attributes and Table 4 3826 - added section 5.9 Resource Status Attributes and Table 5 3827 - revised sections 6.x to align with current set of operations 3828 - added section 6.x Get-Printers in complete detail for review 3829 - added section 7 New IPP Attributes and sections 7.x for all System and Resource 3830 operation, description, and status attributes 3831 - revised sections 14.x to add or update several references 3832

17.2217.23 28 April 2015 3833

- Interim draft – changes per IPP WG review on 30 March 2015 3834 - global – replaced “IPP System Control Service” with “IPP System Service” (but NOT in 3835 the abstract PWG equivalent), per IPP WG review 3836 - global – replaced titlecase “Object” with lowercase “object” (except in section title or PWG 3837 SM spec titles), per IPP WG review 3838 - revised Abstract to change “[PWG510x.y]” document references to “(PWG 510x.y)”, 3839 consistent with IETF RFC styles and change “Cloud Imaging services” to “Cloud Imaging 3840 Systems”, per IPP WG review 3841 - revised section 1 Introduction to replace with expanded scope text from Abstract, per IPP 3842 WG review 3843 - revised section 1.1 Rationale for two IPP Protocol Endpoints to clarify that a conforming 3844 IPP System Service supports both a URI for an IPP System object and a separate URI for 3845 the implementation defined “default” IPP Printer returned from Get-Printer-Attributes, per 3846 IPP WG review 3847 - revised section 2.2 Protocol Role Terminology to add definitions of Infrastructure System 3848 and Protocol Endpoint, remove the “IPP” prefix from the definitions of Client, Infrastructure 3849 Printer, Proxy, and System terms, and enhance the definition of Proxy, per IPP WG review 3850 - revised section 3.1 Rationale for the IPP System Service, to replace period “.” with semi-3851 colon “;” in non-terminal members of both numbered lists, per IPP WG review 3852 - revised section 5.3 System Description Attributes in Table 1 to change owner-uri from 3853 RECOMMENDED to CONDITIONALLY REQUIRED and owner-vcard from OPTIONAL to 3854 CONDITIONALLY REQUIRED for systems that support the Set-System-Attributes and 3855 Register-System operations and added issue about possible multi-valued ordered sets for 3856

Page 124: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 124 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

multiple owners (whose semantics are presently undefined in any PWG spec), per IPP WG 3857 review 3858 - revised section 5.4 System Status Attributes in Table 2, note (7) to delete sentence about 3859 already removed device-uuid attribute, per IPP WG review 3860 - revised section 5.5 System Operations to add Create/Cancel/Renew-Resource-3861 Subscriptions, Create/Cancel/Renew-System-Subscriptions, Get-Notifications, Get-Printer-3862 Attributes (for implementation-defined “default” Printer), RestartSystem (for restart with 3863 existing or new firmware Resource for remediation based on health monitoring), and to 3864 divide original StoreResource into Create-Resource and Send-Resource-Data (to correct 3865 scope ambiguity of original PWG Resource Service operation), per IPP WG review 3866 - added (blank placeholder) section 10.2 Conformance Requirements for Infrastructure 3867 Systems, per IPP WG review 3868 - revised section 11 Internationalization Considerations to add new Unicode boilerplate 3869 from JDFMAP, per IPP WG review 3870 - revised section 12 Security Considerations to add new Unicode boilerplate from 3871 JDFMAP, per IPP WG review 3872 - revised section 14.1 Normative References and section 14.2 Informative References to 3873 add new Unicode boilerplate specs from JDFMAP, per IPP WG review 3874 - TODO – add various spec references, per IPP WG review 3875

17.2317.24 15 March 2015 3876

- Interim draft – changes per PWG F2F and IPP WG reviews on 4 November 2014, 17 3877 November 2014, 19 January 2015, and 3 February 2015 3878 - revised title to “IPP System Service”, per IPP WG review on 4 November 2014 3879 - revised Abstract to include management and status of Services, Subunits, and 3880 Resources and Cloud registration extensions, per IPP WG review on 4 November 2014 3881 - revised section 1.1 Rationale for two IPP Protocol Endpoint to mention of inclusion of 3882 original Get-Printer-Attributes that automatically selects the implementation-defined or site-3883 defined “default” IPP Printer object for the convenience of existing IPP Clients, per IPP WG 3884 review on 4 November 2014 3885 - revised section 2.2 Protocol Role Terminology to add definitions of Infrastructure Printer 3886 and IPP Proxy from IPP Shared Infrastructure Extensions, per IPP WG review on 3 3887 February 2015 3888 - revised section 2.3 Printing Terminology to delete Resource Service and revise the 3889 definitions of Spooling Service and Streaming Service, per IPP WG review on 4 November 3890 2014 3891 - revised section 2.3 Printing Terminology to add definitions of Logical Device, Output 3892 Device, and Physical Device from IPP Shared Infrastructure Extensions, per IPP WG 3893 review on 3 February 2015 3894 - renamed section 2.4 from “Acronyms and Organizations” to simply “Abbreviations”, for 3895 consistency with RFC 7472, per RFC Editor on 5 March 2015 3896 - revised section 3.1 Rationale for the IPP System Service to add the Resource Service 3897 functionality (objects, operations, and attributes), per IPP WG review on 4 November 2014 3898 - added new use case in section 3.2.4 Resource Management, per IPP WG review on 4 3899 November 2014 3900

Page 125: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 125 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

- revised section 3.4 Out-of-Scope, to delete creation/deletion of Imaging Services, per IPP 3901 WG review on 3 February 2015 3902 - revised section 3.5 Design Requirements, to add Resource object, per IPP WG review on 3903 4 November 2014 3904 - added section 4.6 Resource Service, to add Resource object, per IPP WG review on 4 3905 November 2014 3906 - revised section 5.1 Attribute Groups to define the system-attributes-tag and resource-3907 attributes-tag, per IPP WG review on 19 January 2015 3908 - revised section 5.2 Operation Attributes to define system-uri and resource-uri, per IPP 3909 WG review on 19 January 2015 3910 - revised title of section 5.3 to System Description Attributes, per IPP WG review on 19 3911 January 2015 3912 - revised section 5.3 System Description Attributes in Table 1 to raise owner-uri from 3913 OPTIONAL to RECOMMENDED, per IPP WG review on 19 January 2015 3914 - revised section 5.3 System Description Attributes to delete redundant original Figure 3 3915 and Figure 4, per IPP WG review on 19 January 2015 3916 - revised title of section 5.4 to System Status Attributes, per IPP WG review on 19 January 3917 2015 3918 - revised section 5.4 to System Status Attributes in Table 2 to delete redundant device-3919 uuid, per IPP WG review on 19 January 2015 3920 - revised section 5.4 to System Status Attributes to delete redundant original Figure 4, 3921 Figure 5, Figure 6, and Figure 7, per IPP WG review on 19 January 2015 3922 - revised section 5.5 System Operations to delete issue about Subscription operations, per 3923 IPP WG review on 3 February 2015 3924 - revised section 5.5 System Operations in Table 3 to add Create/Delete-Printer and 3925 Resource operations, per IPP WG review on 3 February 2015 3926

17.2417.25 2 November 2014 3927

- Interim draft – changes per IPP WG review on 29 September 2014 3928 - corrected typos and wording 3929 - revised cover page and headers to change “IPPSYSTEM” to “SYSTEM”, per IPP WG 3930 review 3931 - globally changed “Imaging Device” to “Imaging System” where appropriate (most 3932 instances), per IPP WG review 3933 - globally changed “[RFC2616]” to “[RFC7230]”, per IPP WG review 3934 - globally changed “[PWG5100.SCAN]” to “PWG5100.17]” and corrected reference in 3935 section 10.1, per PWG approval of IPP Scan Service 3936 - added section 1.1 Rationale for two IPP Protocol Endpoints to explain the reason for 3937 separate URI for System and Printer objects, per IPP WG review 3938 - revised section 2.2 to change title from “Printing Terminology” to “Protocol Roles”, per 3939 IPP WG review 3940 - revised section 2.2 to delete “IPP Printer” (and thus Logical Device and Physical Device 3941 definitions and details) as not applicable to System Control Service and to add “IPP 3942 System”, per IPP WG review 3943 - revised section 2.3 to change title from “Other Terminology” to “Printing Terminology”, per 3944

Page 126: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 126 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

IPP WG review 3945 - moved first sentence of section 2.2 (sources of terms) to section 2.3, per IPP WG review 3946 - revised section 2.3 to add new terms, including “Document”, “FaxOut Job/Service”, “ith”, 3947 “Job”, “Print Job/Service”, “Scan Job/Service”, “Spooling Service”, “Streaming Service”, 3948 “Subunit”, “Transform Job/Service”, per IPP WG review 3949 - revised section 2.3 to improve “Imaging System” definition, per IPP WG review 3950 - revised section 3.1 Rationale to clarify various paragraphs and add numbered lists, per 3951 IPP WG review 3952 - revised section 3.2 Use Cases to clarify various paragraphs, per IPP WG review 3953 - revised section 3.3 to change “TBD” to “There are no exceptions to the use cases defined 3954 in section 3.2”, per IPP WG review 3955 - revised section 3.4 Out of Scope to clarify first sentence, per IPP WG review 3956 - revised section 3.4 Out of Scope to clarify several statements, per IPP WG review 3957 - revised section 3.4 Design Requirements to clarify first sentence, per IPP WG review 3958 - added section 4.5 Document Object, per IPP WG review 3959 - revised section 5.3 System Description to change “READ-ONLY” to “READ-WRITE” 3960 (because Set-System-Attributes was restored in this draft), per IPP WG review and Cloud 3961 Imaging WG recommendations 3962 - revised section 5.4 System Status to clarify the “READ-ONLY” cannot be modified by a 3963 Set-System-Attributes operation, per IPP WG review and Cloud Imaging WG 3964 recommendations 3965 - revised section 5.4 System Status to clarify the meaning of “system-uuid” (SCS), “printer-3966 uuid” (Imaging Service), and “device-uuid” (physical hardware, i.e., network device), per 3967 IPP WG review 3968 - revised section 5.4 System Status Table 2 to change “configured-services” to 3969 “configured-printers”, per IPP WG review 3970 - revised section 5.5 System Operations Table 3 to add back Restart-One-Printer, Startup-3971 One-Printer, Shutdown-One-Printer, and Set-System-Elements, per IPP WG review and 3972 Cloud Imaging WG recommendations 3973 - revised section 6 New IPP Operations to add back Restart-One-Printer, Startup-One-3974 Printer, Shutdown-One-Printer, and Set-System-Elements, per IPP WG review and Cloud 3975 Imaging WG recommendations 3976 - revised section 8.1 title to add “Create-Subscription” operation, per IPP WG review 3977 - revised section 13 to change title from “IANA Considerations” to “IANA and PWG 3978 Considerations”, per IPP WG review 3979 3980

17.2517.26 24 August 2014 3981

- Interim draft 3982 - corrected typos and wording 3983 - revised section 5.3 and added Table 1 – Attributes in IPP System Description group with 3984 notes for rationale of all conformance requirements 3985 - revised section 5.4 and added Table 2 – Attributes in IPP System Status group with notes 3986 for rationale of all conformance requirements 3987

Page 127: The Printer Working Groupftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20161129-rev.pdf · The Printer Working Group 29 November 2016 Working Draft Copyright © 2014-2016 The Printer

Working Draft – IPP System Service v1.0 (SYSTEM) 29 November 2016

Page 127 of 127 Copyright © 2014-2016 The Printer Working Group. All rights reserved.

- added section 6 New IPP Operations (empty) 3988 - added section 7 New IPP Attributes (empty) 3989

17.2617.27 11 August 2014 3990

- Initial draft 3991 - based on Mike Sweet’s presentation at PWG F2F meeting in October 2013 3992 - added Abstract and Introduction 3993 - added Terminology, including new and refined terms for clarity 3994 - added Requirements (rationale, use cases, out-of-scope, design requirements) 3995 - added IPP Object Model (extensions to RFC 2911) 3996 - added IPP System Object (still a sketch) 3997 - combined System object and System Control Service object (separation was artificial) 3998 - added References (normative and informative) 3999