259
® The Printer Working Group 10 September 2017 Working Draft IPP System Service v1.0 (SYSTEM) Status: Prototype 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 Copyright © 2014-2017 The Printer Working Group. All rights reserved. 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28

ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

  • Upload
    others

  • View
    2

  • Download
    0

Embed Size (px)

Citation preview

Page 1: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

®The Printer Working Group

10 September 2017Working Draft

IPP System Service v1.0 (SYSTEM)

Status: Prototype

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-2017 091 0 0719 .pdf

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

12345678910

11

12

13

14151617181920212223

24

25

26

27

Page 2: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

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

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

Title: IPP System Service v1.0 (SYSTEM)

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

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

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

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

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

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

Page 2 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

12

28

29303132333435

36

373839

404142

4344454647

48495051525354

55565758

59606162

3

Page 3: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

About the IEEE-ISTO

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

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

http://www.ieee-isto.org

About the IEEE-ISTO PWG

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

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

For additional information regarding the Printer Working Group visit:

http://www.pwg.org

Contact information:

The Printer Working Groupc/o The IEEE Industry Standards and Technology Organization445 Hoes LanePiscataway, NJ 08854USA

Page 3 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

45

63

6465666768

69

70

71

7273747576777879808182

838485

86

87

88

899091929394

6

Page 4: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

About the Internet Printing Protocol Work Group

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

For additional information regarding IPP visit:

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

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

Page 4 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

78

95

96979899100

101

102

103104105

9

Page 5: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

Table of Contents1. Introduction.....................................................................................................................12

1.1 Rationale for two IPP Protocol Endpoints.................................................................121.2 Get-Printer-Attributes Extension...............................................................................121.3 Printer Identifier Extension........................................................................................12

2. Terminology....................................................................................................................132.1 Conformance Terminology........................................................................................132.2 Protocol Role Terminology........................................................................................142.3 Printing Terminology.................................................................................................152.4 Abbreviations............................................................................................................18

3. Requirements for the IPP System Service.....................................................................193.1 Rationale for the IPP System Service.......................................................................193.2 Use Cases................................................................................................................20

3.2.1 Imaging System Service Enumeration...............................................................203.2.2 Imaging System Monitoring................................................................................203.2.3 Imaging System Management............................................................................203.2.4 Resource Management......................................................................................213.2.5 Bootstrap Client Access to Default Print Service................................................21

3.3 Exceptions................................................................................................................213.4 Out of Scope.............................................................................................................213.5 Design Requirements...............................................................................................21

4. IPP Object Model............................................................................................................224.1 System Object...........................................................................................................224.2 Subunit Object..........................................................................................................224.3 Printer Object............................................................................................................224.4 Job Object.................................................................................................................224.5 Document Object......................................................................................................234.6 Resource Object.......................................................................................................23

4.6.1 Resource History................................................................................................244.7 Subscription Object...................................................................................................24

5. IPP Objects and Operations Summary...........................................................................255.1 System Attribute Group.............................................................................................265.2 System Description Attributes...................................................................................265.3 System Status Attributes...........................................................................................285.4 System Operations...................................................................................................295.5 Resource Attribute Group.........................................................................................335.6 Resource Description Attributes................................................................................335.7 Resource Status Attributes.......................................................................................345.8 Printer Description Attributes....................................................................................355.9 Printer Status Attributes............................................................................................365.10 Job Status Attributes...............................................................................................36

6. IPP Operations...............................................................................................................386.1 Printer Operations.....................................................................................................38

6.1.1 Allocate-Printer-Resources.................................................................................386.1.2 Create-Printer.....................................................................................................406.1.3 Deallocate-Printer-Resources............................................................................43

Page 5 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

1011

106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151

12

Page 6: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

6.1.4 Delete-Printer.....................................................................................................456.1.5 Get-Printers........................................................................................................476.1.6 Get-Printer-Resources........................................................................................526.1.7 Shutdown-One-Printer........................................................................................556.1.8 Startup-One-Printer............................................................................................57

6.2 Resource Operations................................................................................................596.2.1 Cancel-Resource................................................................................................596.2.2 Create-Resource................................................................................................606.2.3 Get-Resources...................................................................................................636.2.4 Get-Resource-Attributes.....................................................................................666.2.5 Install-Resource.................................................................................................676.2.6 Send-Resource-Data..........................................................................................696.2.7 Set-Resource-Attributes.....................................................................................71

6.3 Subscription Operations............................................................................................736.3.1 Create-Resource-Subscriptions.........................................................................736.3.2 Create-System-Subscriptions.............................................................................75

6.4 System Operations...................................................................................................766.4.1 Disable-All-Printers.............................................................................................776.4.2 Enable-All-Printers.............................................................................................786.4.3 Get-System-Attributes........................................................................................806.4.4 Get-System-Supported-Values...........................................................................826.4.5 Pause-All-Printers..............................................................................................846.4.6 Pause-All-Printers-After-Current-Job..................................................................866.4.7 Register-Output-Device......................................................................................886.4.8 Restart-System...................................................................................................906.4.9 Resume-All-Printers...........................................................................................926.4.10 Set-System-Attributes.......................................................................................946.4.11 Shutdown-All-Printers.......................................................................................966.4.12 Startup-All-Printers...........................................................................................99

7. IPP Attributes................................................................................................................1017.1 IPP Operation Attributes.........................................................................................101

7.1.1 printer-id (integer(1:65535))..............................................................................1017.1.2 printer-ids (1setOf (integer(1:65535)))..............................................................1017.1.3 printer-geo-location (uri)...................................................................................1017.1.4 printer-location (text(127))................................................................................1027.1.5 printer-service-type (1setOf (type2 keyword))..................................................1027.1.6 requesting-user-vcard (1setOf text(MAX))........................................................1027.1.7 resource-format (mimeMediaType)..................................................................1027.1.8 resource-format-accepted (1setOf mimeMediaType).......................................1027.1.9 resource-formats (1setOf (mimeMediaType))..................................................1027.1.10 resource-id (integer(1:MAX))..........................................................................1037.1.11 resource-ids (1setOf integer(1:MAX)).............................................................1037.1.12 resource-k-octets (integer(0:MAX))................................................................1037.1.13 resource-signature (1setOf octetString).........................................................1037.1.14 resource-states (1setOf (type1 enum))...........................................................1037.1.15 resource-type (type2 keyword).......................................................................104

Page 6 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

1314152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197

15

Page 7: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

7.1.16 resource-types (1setOf (type2 keyword)).......................................................1047.1.17 restart-get-interval (integer(0:MAX)................................................................1047.1.18 system-uri (uri)...............................................................................................1047.1.19 which-printers (type2 keyword):......................................................................104

7.2 System Description Attributes.................................................................................1057.2.1 Power States and Policies................................................................................1057.2.2 charset-configured (charset).............................................................................1097.2.3 charset-supported (1setOf charset)..................................................................1097.2.4 ipp-features-supported (1setOf type2 keyword)...............................................1097.2.5 ipp-versions-supported (1setOf type2 keyword)...............................................1097.2.6 natural-language-configured (naturalLanguage)..............................................1097.2.7 generated-natural-language-supported (1setOf naturalLanguage)..................1107.2.8 operations-supported (1setOf type2 enum)......................................................1107.2.9 power-calendar-policy-col (1setOf collection)...................................................1107.2.10 power-event-policy-col (1setOf collection)......................................................1127.2.11 power-timeout-policy-col (1setOf collection)...................................................1137.2.12 printer-creation-attributes-supported (1setOf keyword)..................................1147.2.13 resource-format-supported (1setOf mimeMediaType)....................................1147.2.14 resource-type-supported (1setOf type2 keyword)..........................................1147.2.15 resource-settable-attributes-supported (1setOf keyword)..............................1157.2.16 system-current-time (dateTime).....................................................................1157.2.17 system-default-printer-id (integer (1:65535) | no-value).................................1157.2.18 system-device-id (text(MAX)).........................................................................1157.2.19 system-geo-location (uri | unknown)...............................................................1157.2.20 system-info (text(127))....................................................................................1157.2.21 system-location (text(127)).............................................................................1167.2.22 system-mandatory-printer-attributes (1setOf type2 keyword).........................1167.2.23 system-make-and-model (text(127))..............................................................1167.2.24 system-message-from-operator (text(127))....................................................1167.2.25 system-name (name(127)).............................................................................1167.2.26 system-owner-col (collection).........................................................................1167.2.27 system-settable-attributes-supported (1setOf keyword).................................1177.2.28 system-strings-languages-supported (1setOf naturalLanguage)....................1177.2.29 system-strings-uri (uri | no-value)...................................................................1177.2.30 system-xri-supported (1setOf collection)........................................................117

7.3 System Status Attributes.........................................................................................1197.3.1 power-log-col (1setOf collection)......................................................................1197.3.2 power-state-capabilities-col (1setOf collection)................................................1207.3.3 power-state-counters-col (1setOf collection)....................................................1217.3.4 power-state-monitor-col (collection).................................................................1217.3.5 power-state-transitions-col (1setOf collection).................................................1237.3.6 system-config-change-date-time (dateTime)....................................................1237.3.7 system-config-change-time (integer(0:MAX))...................................................1247.3.8 system-config-changes (integer(0:MAX)).........................................................1247.3.9 system-configured-printers (1setOf collection).................................................1247.3.10 system-configured-resources (1setOf collection)...........................................125

Page 7 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

1617198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243

18

Page 8: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

7.3.11 system-serial-number (text(255))...................................................................1277.3.12 system-state (type1 enum).............................................................................1277.3.13 system-state-change-date-time (dateTime)....................................................1277.3.14 system-state-change-time (integer(0:MAX))...................................................1277.3.15 system-state-message (text(MAX))................................................................1277.3.16 system-state-reasons (1setOf type2 keyword)..............................................1287.3.17 system-up-time (integer(1:MAX))...................................................................1287.3.18 system-uuid (uri(45))......................................................................................128

7.4 Printer Description Attributes..................................................................................1287.4.1 printer-owner-col (collection)............................................................................128

7.5 Printer Status Attributes..........................................................................................1287.5.1 printer-config-changes (integer(0:MAX))..........................................................1297.5.2 printer-id (integer(1:65535))..............................................................................1297.5.3 printer-service-type (type2 keyword)................................................................129

7.6 Resource Description Attributes..............................................................................1297.6.1 resource-info (text(127))...................................................................................1307.6.2 resource-name (name(127)).............................................................................1307.6.3 resource-owner-col (collection)........................................................................130

7.7 Resource Status Attributes.....................................................................................1307.7.1 date-time-at-canceled (dateTime)....................................................................1307.7.2 date-time-at-creation (dateTime)......................................................................1317.7.3 date-time-at-installed (dateTime)......................................................................1317.7.4 resource-data-uri (uri | no-value)).....................................................................1317.7.5 resource-format (mimeMediaType)..................................................................1317.7.6 resource-id (integer(1:MAX))............................................................................1317.7.7 resource-k-octets (integer(0:MAX))..................................................................1317.7.8 resource-state (type1 enum)............................................................................1317.7.9 resource-state-message (text(MAX))...............................................................1337.7.10 resource-state-reasons (1setOf type2 keyword)............................................1337.7.11 resource-string-version (text(127)).................................................................1337.7.12 resource-type (type2 keyword).......................................................................1347.7.13 resource-use-count (integer(0:MAX)).............................................................1347.7.14 resource-uuid (uri(45))....................................................................................1347.7.15 resource-version (octetString(16))..................................................................1357.7.16 time-at-canceled (integer(MIN:MAX)).............................................................1357.7.17 time-at-creation (integer(MIN:MAX))..............................................................1357.7.18 time-at-installed (integer(MIN:MAX))..............................................................135

7.8 Job Status Attributes...............................................................................................1357.8.1 job-owner-col (collection)..................................................................................135

8. Additional Semantics for Existing Operations...............................................................1378.1 Cancel-Subscription, Get-Notifications, and Renew-Subscription: system-uri (uri) and resource-id (integer(1:MAX))........................................................................................1378.2 Get-Printer-Attributes: system-uri (uri) or printer-uri (uri)........................................1378.3 Create-Job, Get-Job-Attributes: job-resource-ids (1setOf integer(1:MAX))............139

9. Additional Values for Existing Attributes.......................................................................1399.1 notify-events (1setOf type2 keyword)......................................................................139

Page 8 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

1920244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289

21

Page 9: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

9.2 printer-state-reasons (1setOf type2 keyword).........................................................13910. Conformance Requirements.......................................................................................141

10.1 Conformance Requirements for Clients................................................................14110.2 Conformance Requirements for Infrastructure Systems.......................................14110.3 Conformance Requirements for Systems.............................................................141

11. Internationalization Considerations.............................................................................14112. Security Considerations..............................................................................................142

12.1 Human-readable Strings.......................................................................................14212.2 Confidentiality and Integrity...................................................................................14212.3 Access Control......................................................................................................14212.4 Physical Safety.....................................................................................................14212.5 Digital Signature Validation...................................................................................14212.6 Encrypted Resources............................................................................................143

13. IANA and PWG Considerations..................................................................................14313.1 Object Registrations..............................................................................................14313.2 Attribute Registrations...........................................................................................14313.3 Type2 keyword Attribute Value Registrations.......................................................14713.4 Type2 enum Attribute Value Registrations............................................................14813.5 Attribute Group Registrations................................................................................14913.6 Operation Registrations........................................................................................150

14. References.................................................................................................................15114.1 Normative References..........................................................................................15114.2 Informative References.........................................................................................155

15. Authors' Addresses.....................................................................................................15616. Appendix A – Rationale for Design Choices...............................................................157

16.1 Resource Object...................................................................................................15716.1.1 Move Resource Service operations into System Service...............................15716.1.2 Remove some Resource operations..............................................................15716.1.3 Decompose some Resource operations........................................................15716.1.4 Replace Resource lease with Resource state................................................158

16.2 Printer Object........................................................................................................15816.2.1 Restrict “printer-id” range ...............................................................................158

17. Change History...........................................................................................................15917.1 13 September 2017..............................................................................................15917.2 19 July 2017..........................................................................................................16117.3 24 June 2017........................................................................................................16117.4 9 May 2017...........................................................................................................16217.5 14 March 2017......................................................................................................16317.6 12 February 2017..................................................................................................16317.7 8 January 2017.....................................................................................................16417.8 11 December 2016...............................................................................................16517.9 29 November 2016...............................................................................................16617.10 1 November 2016...............................................................................................16817.11 18 October 2016.................................................................................................16817.12 4 October 2016...................................................................................................16817.13 15 September 2016............................................................................................169

Page 9 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

2223290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335

24

Page 10: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

17.14 18 August 2016...................................................................................................17117.15 10 August 2016...................................................................................................17217.16 20 July 2016........................................................................................................17317.17 6 July 2016..........................................................................................................17417.18 23 June 2016......................................................................................................17517.19 12 June 2016......................................................................................................17617.20 9 May 2016.........................................................................................................17717.21 8 May 2016.........................................................................................................17817.22 25 April 2016.......................................................................................................17817.23 28 February 2016................................................................................................17917.24 17 January 2016.................................................................................................18017.25 6 December 2015...............................................................................................18117.26 2 November 2015...............................................................................................18117.27 18 October 2015.................................................................................................18117.28 20 September 2015............................................................................................18217.29 31 August 2015...................................................................................................18217.30 10 August 2015...................................................................................................18417.31 28 April 2015.......................................................................................................18517.32 15 March 2015....................................................................................................18617.33 2 November 2014...............................................................................................18717.34 24 August 2014...................................................................................................18817.35 11 August 2014...................................................................................................188

Page 10 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

2526336337338339340341342343344345346347348349350351352353354355356357358

27

Page 11: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

List of FiguresFigure 1 – IPP Resource Object Life Cycle......................................................................132

List of TablesTable 1 – IPP System Description Attributes......................................................................26Table 2 – IPP System Status Attributes..............................................................................28Table 3 – IPP System Service Operations.........................................................................29Table 4 – IPP Resource Description Attributes..................................................................33Table 5 – IPP Resource Status Attributes..........................................................................34Table 6 – IPP Printer Description Attributes.......................................................................35Table 7 – IPP Printer Status Attributes...............................................................................36Table 8 – IPP Job Status Attributes....................................................................................36Table 9 – Recommended-to-Supply Printer Creation Attributes.......................................116Table 10 – Member Attributes of system-configured-printers...........................................124Table 11 – Member attributes of system-configured-resources........................................125

Page 11 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

2829

359360361362

363364365366367368369370371372373374375

30

Page 12: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

1. IntroductionThis 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 [PWG5108.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 [PWG5109.1] and concrete PWG IPP Shared Infrastructure Extensions [PWG5100.18].

1.1 Rationale for two IPP Protocol Endpoints

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

1.2 Get-Printer-Attributes Extension

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

1.3 Printer Identifier Extension

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

Page 12 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

3132

376

377378379380381382383384385

386

387388389390391392393

394

395396397398399

400

401402403404405406407

408

33

Page 13: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

2. Terminology

2.1 Conformance Terminology

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

Page 13 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

3435

409

410

411412413414415416

36

Page 14: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

2.2 Protocol Role Terminology

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

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

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

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

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

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

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

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

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

Page 14 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

3738

417

418419

420421

422423424425426

427428429

430431432433

434435436

437438439440441

442443444445

446447448449

39

Page 15: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

2.3 Printing Terminology

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

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

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

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

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

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

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

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

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

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

Page 15 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

4041

450

451452453454455456457458459

460461462

463464

465466467

468469470471

472473474

475476

477478479

480481482

483484

42

Page 16: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

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

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

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

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

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

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

Notification: Synonym for Event Notification [RFC3995].

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

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

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

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

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

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

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

Page 16 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

4344485486487

488489

490491492

493494

495496497

498499500

501

502503504505

506

507508

509510

511512513

514515

516517

45

Page 17: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

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

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

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

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

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

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

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

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

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

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

Page 17 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

4647518519520

521522523

524525526

527528

529530

531532533534

535536

537538539

540541542

543544545

546547

48

Page 18: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

2.4 Abbreviations

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

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

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

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

Page 18 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

4950

548

549

550

551

552

553

51

Page 19: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

3. Requirements for the IPP System Service

3.1 Rationale for the IPP System Service

Existing IPP specifications define the following features and functionality:

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

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

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

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

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

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

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

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

Page 19 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

5253

554

555

556

557558559560561562

563564

565566567

568569

570571

572573574575576

577

578579

580581582583584585

54

Page 20: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

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

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

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

Therefore, this IPP System Service specification should define:

1) An IPP binding of the PWG System object;

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

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

3.2 Use Cases

3.2.1 Imaging System Service Enumeration

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

3.2.2 Imaging System Monitoring

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

3.2.3 Imaging System Management

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

Page 20 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

5556586587588

589590

591592593594

595

596

597

598599

600

601

602

603604605606607608

609

610611612613

614

615616617

57

Page 21: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

3.2.4 Resource Management

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

3.2.5 Bootstrap Client Access to Default Print Service

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

3.3 Exceptions

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

3.4 Out of Scope

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

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

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

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

3.5 Design Requirements

The design requirements for this IPP System Service specification are:

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

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

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

Page 21 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

5859618

619620621

622

623624625626627628

629

630

631

632

633634635636637638639

640

641

642643644645646647

648

60

Page 22: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

4. IPP Object ModelThis specification extends the original IPP Model defined in section 2 of IETF IPP/1.1 Model and Semantics [RFC8011] from the original print service scope to include all Imaging Services on a managed Imaging System.

4.1 System Object

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

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

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

4.2 Subunit Object

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

4.3 Printer Object

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

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

4.4 Job Object

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

Page 22 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

6162

649

650651652

653

654655

656657658

659660

661

662663664665666667668

669

670671672673

674675

676

677678

63

Page 23: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

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

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

4.5 Document Object

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

4.6 Resource Object

This specification extends the original Resource object defined in PWG Network Resource Service [PWG5108.03], in order to incorporate Resource operations directly into the IPP System Service. Resources are managed by the System and each Resource has a system-wide unique status attribute “resource-id”. Resources are persistent until they are explicitly canceled by an Administrator or aborted by the System.

Resources have an allocation scope of System, Printer, or Job. Throughout this specification, the phrases “[System|Printer|Job]-scope Resource” and “per-[System|Printer|Job] Resource” are used to specify the usage of Resources.

Creation of a new Resource is supported via the Create-Resource operation and “resource-use-count” will be set to zero. Upload of Resource data is supported via the Send-Resource-Data operation. Installation of a Resource (for subsequent use) is supported via the Install-Resource operation. For a System-scope Resource, “resource-use-count” will be set to one after the Resource is successfully installed. For a Printer-scope or Job-scope Resource, “resource-use-count” will be incremented by one each time that the Resource is allocated to a Printer or a Job, e.g., via Allocate-Printer-Resource or a Job Creation operation that includes a “resource-ids” operation attribute. When an allocated Resource is busy at the time of a Cancel-Resource request, ‘cancel-requested’ will be added to the “resource-state-reasons” and the Resource will not transition to a “resource-state” of ‘canceled’ until the allocated Resource is no longer busy, as indicated by a “resource-use-count” value of zero.

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

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

Page 23 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

6465679680

681682

683

684685686687

688

689690691692693

694695696

697698699700701702703704705706707708

709710711

712713714715

66

Page 24: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

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

4.6.1 Resource History

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

4.7 Subscription Object

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

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

Page 24 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

6768716717

718

719720721722723724725726727

728

729730731

732733

69

Page 25: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

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

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

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

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

Page 25 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

7071

734

735736737738

739740

741

742743744745

72

Page 26: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

5.1 System Attribute Group

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

5.2 System Description Attributes

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

Note: An SM/IPP Equivalent entry of “<none>” indicates that there is no previously defined equivalent attribute and the attribute is defined for the first time in this specification.

Table 1 – IPP System Description Attributes

Conformance IPP Attribute Name SM/IPP Equivalent Element Name

Reference

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

supportedNaturalLanguageSupported[1] [PWG5108.06]

REQUIRED ipp-features-supported ipp-features-supported [PWG5100.13]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-

supportedjob-creation-attributes-supported [8]

[PWG5100.11]

REQUIRED resource-format-supported document-format-supported [10]

[RFC8011]

REQUIRED resource-type-supported document-format-supported [11]

[RFC8011]

REQUIRED resource-settable-attributes-supported

jobprinter-settable-attributes-supported [7]

[RFC3380]

REQUIRED system-current-time CurrentTime[2] [PWG5108.06]REQUIRED system-default-printer-id <none>system-default-printer-id

[5]<none>[PWG.SYS]

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]REQUIRED system-mandatory-printer-

attributesprinter-mandatory-job-attributes [9]

[PWG5100.13]

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-

supportedprinter-settable-attributes-supported [6]

[RFC3380]

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

Page 26 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

7374

746

747

748

749750

751752

753

75

Page 27: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

Notes:

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

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

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

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

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

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

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

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

8)[9)] REQUIRED for System support of the REQUIRED Create-Printer operation and semantically analogous to the “printer-mandatory-job-attributes” Printer Description attribute defined in IPP: Job and Printer Extensions – Set 3[PWG5100.13].

9)[10)] REQUIRED for System support of the REQUIRED Send-Resource-Data operation and semantically analogous to the “document-format-supported” Printer Description attribute defined in [RFC8011].

10)[11)] REQUIRED for System support of the REQUIRED Create-Resource operation and semantically analogous to the “document-format-supported” Printer Description attribute defined in [RFC8011].

Page 27 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

7677754

755

756

757758

759760761

762763764

765766767768

769770771772

773774775776

777778779

780781782

783784785

78

Page 28: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

5.3 System Status Attributes

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

Note: An SM/IPP Equivalent entry of “<none>” indicates that there is no previously defined equivalent attribute and the attribute is defined for the first time in this specification.

Table 2 – IPP System Status Attributes

Conformance IPP Attribute Name SM/IPP Equivalent 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-

timeprinter-config-change-date-time [8]

[PWG5100.13]

REQUIRED system-config-change-time printer-config-change-time [8] [PWG5100.13]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-

timeprinter-state-change-date-time [8] [RFC3995]

REQUIRED system-state-change-time printer-state-change-time [8] [RFC3995]REQUIRED system-state-message StateMessages[2] [PWG5108.06]REQUIRED system-state-reasons StateReasons[2] [PWG5108.06]RECOMMENDED system-strings-languages-

supportedprinter-strings-languages-supported[9]

[PWG5100.13]

RECOMMENDED system-strings-uri printersystem-strings-uri<none>[9]

[PWG5100.13]

RECOMMENDED system-totals SystemTotals[6] [PWG5108.06]REQUIRED system-up-time UpTime[2] [PWG5108.06]REQUIRED system-uuid ServiceUuid[2] [7] [PWG5108.01]

Notes:

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

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

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

Page 28 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

7980

786

787788789790

791792

793

794

795

796

797

798799800

81

Page 29: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

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

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

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

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

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

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

5.4 System Operations

The operations for an IPP System Service conforming to this specification are listed in Table 3. All of these operations are REQUIRED except for Register-Output-Device which is CONDITIONALLY REQUIRED for systems that implement IPP Shared Infrastructure Extensions [PWG5100.18]

Note: An SM/IPP/DPA Equivalent entry of “<none>” indicates that there is no previously defined equivalent operation and the operation is defined for the first time in this specification.

Table 3 – IPP System Service Operations

Code IPP Operation Name SM/IPP/DPA Equivalent Operation Name

Reference

0x004Bnn

Allocate-Printer-Resources <none> <none>

0x0052nn

Cancel-Resource DeleteResource [PWG5108.03]

0x001Bnn

Cancel-Subscription Cancel-Subscription[8] [RFC3995]

Page 29 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

8283801802

803

804

805806807808

809810811812813814

815816817818819

820

821822823824

825826827

828

829

84

Page 30: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

0x004Cnn

Create-Printer Create[5] [ISO10175-3]

0x0053nn

Create-Resource StoreResource[3] [PWG5108.03]

0x0057nn

Create-Resource-Subscriptions

Create-Printer-Subscriptions[8] [RFC3995]

0x0058nn

Create-System-Subscriptions

Create-Printer-Subscriptions [8]

[RFC3995]

0x004Dnn

Deallocate-Printer-Resources

<none>Deallocate-Printer-Resources

<none>[PWG.SYS]

0x004Enn

Delete-Printer DeleteService [PWG5108.06]

0x0059nn

Disable-All-Printers DisableAllServices[2] [PWG5108.06]

0x005Ann

Enable-All-Printers EnableAllServices[2] [PWG5108.06]

0x001Cnn

Get-Notifications Get-Notifications[8] [RFC3996]

0x004Fnn

Get-Printers ListAllServices [PWG5108.06]

0x000Bnn

Get-Printer-Attributes Get-Printer-AttributesGetServiceElements[4]

[RFC8011PWG5108.06]

0x0065 Get-Printer-Resources <none>[10] <none>0x0020nn

Get-Resources ListResources [PWG5108.03]

0x001Enn

Get-Resource-Attributes GetResourceElements [PWG5108.03]

0x0019nn

Get-Subscriptions Get-Subscriptions [8] [RFC3995]

0x0018nn

Get-Subscription-Attributes Get-Subscription-Attributes [8] [RFC3995]

0x005Bnn

Get-System-Attributes GetSystemElements [PWG5108.06]

0x005Cnn

Get-System-Supported-Values

Get-Printer-Supported-Values [7]

[RFC3380]

0x0054nn

Install-Resource StoreResource [3][4] [PWG5108.03]

0x005Dnn

Pause-All-Printers PauseAllServices [PWG5108.06]

0x005Enn

Pause-All-Printers-After-Current-Job

PauseAllServicesAfterCurrentJob[1]

[PWG5108.06]

0x005Fnn

Register-Output-Device RegisterSystem[6] [PWG5109.1]

0x001Ann

Renew-Subscription Renew-Subscription[8] [RFC3995]

0x0060nn

Restart-System Restart-Printer[9] [RFC3998]

0x0061nn

Resume-All-Printers ResumeAllServices [PWG5108.06]

0x0055nn

Send-Resource-Data StoreResource[3] [PWG5108.03]

0x0056<none>

Set-Resource-Attributes SetResourceElements [PWG5108.03]

0x006 Set-System-Attributes SetSystemElements [PWG5108.06]

Page 30 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

8586

87

Page 31: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

2<none>0x0063nn

Shutdown-All-Printers ShutdownAllServices [PWG5108.06]

0x0050<none>

Shutdown-One-Printer ShutdownService [PWG5108.06]

0x0064nn

Startup-All-Printers StartupAllServices [PWG5108.06]

0x0051<none>

Startup-One-Printer StartupService [PWG5108.06]

Notes:

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

2) [Enable/Disable]-Printer and [Pause/Resume]-Printer are intentionally left out of this specification – they should be directed to the specific Imaging Service that is enumerated in the “system-configured-printers” attribute defined in section 5.x above.

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

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

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

6) Register-Output-Device is semantically equivalent to RegisterSystem defined in PWG Cloud Imaging Model [PWG5109.1] with the difference that the System itself is not registered, but rather the associated Output Devices are registered. Register-Output-Device is CONDITIONALLY REQUIRED for systems that implement IPP Shared Infrastructure Extensions [PWG5100.18].

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

Page 31 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

8889

830

831832833

834835836837

838839840841842843844

845846847

848849850851852

853854855856857

858859860

90

Page 32: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

8) REQUIRED for a System and/or Resource and analogous to the operations defined in IPP: Event Notifications and Subscriptions [RFC3995] and IPP: The 'ippget' Delivery Method for Event Notifications[RFC3996]. CancelSubscription, Get-Notifications, Get-Subscription-Attributes, Get-Subscriptions, and Renew-Subscription (all defined in [RFC3995]) are extended by this specification for use with the IPP System Service.

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

10)REQUIRED for a Printer and analogous to Get-Resources operation defined in this specification.

Page 32 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

9192861862863864865866

867868

869870871

93

Page 33: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

5.5 Resource Attribute Group

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

5.6 Resource Description Attributes

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

Note: An SM/IPP Equivalent entry of “<none>” indicates that there is no previously defined equivalent attribute and the attribute is defined for the first time in this specification.

Note: Printer-scope Resource objects MAY be:

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

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

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

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

Table 4 – IPP Resource Description Attributes

Conformance IPP Attribute Name SM/IPP Equivalent Element Name

Reference

REQUIRED resource-info ResourceInfo [PWG5108.03]REQUIRED resource-name ResourceName [PWG5108.03]REQUIRED resource-owner-col OwnerUri, OwnerVCard[1] [PWG5108.06]

Notes:

1) REQUIRED for a Resource by analogy to “system-owner-col” in System since all Systems MUST support the Set-Resource-Attributes operation to conform to this IPP System Service specification – also “owner-uri” and “owner-vcard” MUST be updated simultaneously if specified in a Set-Resource-Attributes operation (to preserve consistency).

Page 33 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

9495

872

873

874

875876

877878

879

880881882

883884885

886887888889

890891892

893

894895

896897898899900

96

Page 34: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

5.7 Resource Status Attributes

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

Note: An SM/IPP Equivalent entry of “<none>” indicates that there is no previously defined equivalent attribute and the attribute is defined for the first time in this specification.

Table 5 – IPP Resource Status Attributes

Conformance IPP Attribute Name SM/IPP Equivalent Element Name

Reference

REQUIRED date-time-at-canceled date-time-at-completedDateTimeOfExpiration[1]

[RFC8011PWG5108.03]

REQUIRED date-time-at-creation date-time-at-creationDateTimeAtCreation[1]

[RFC8011PWG5108.03]

REQUIRED date-time-at-installed date-time-at-processinginstalled [17][6]

[RFC8011PWG.SYS]

REQUIRED resource-data-uri <none>resource-data-uri <none>[PWG.SYS]

REQUIRED resource-format ResourceFormat [PWG5108.03]REQUIRED resource-id ResourceId[4] [PWG5108.03]REQUIRED resource-k-octets job-k-octets[2][5] [RFC8011]REQUIRED resource-state job-state[2] [RFC8011[REQUIRED resource-state-reasons job-state-reasons[2] [RFC8011]REQUIRED resource-string-version XxxStringVersion[7] [PWG5110.1]REQUIRED resource-type ResourceType [PWG5108.03]REQUIRED resource-use-count <none>resource-use-count <none

>[PWG.SYS]REQUIRED resource-uuid job-uuid[3] [PWG5100.13]REQUIRED resource-version XxxVersion[7] [PWG5110.1]REQUIRED time-at-canceled time-at-completed[2] [RFC8011]REQUIRED time-at-creation time-at-creation[2] [RFC8011]REQUIRED time-at-installed time-at-processing

creation[2][6][RFC8011]

Notes:

1) REQUIRED for a Resource by analogy to PWG Network Resource Service Semantic Model and Service Interface [PWG5108.03] and “date-time-at-completed” “date-time-at-creation”, and “date-time-at-processing” Job attributes defined in IETF IPP/1.1 Model and Semantics [RFC8011].

Page 34 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

9798

901

902903904905906

907908

909

910

911912913914

99

Page 35: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

[2)] REQUIRED for a Resource by analogy to a “job-state”, “job-state-reasons”, “time-at-completed” “time-at-creation”, and “time-at-processing” Job attributes defined in IETF IPP/1.1 Model and Semantics [RFC8011].

[3)] REQUIRED for a Resource by analogy to a “job-uuid” Job attribute defined in PWG IPP: Job and Printer Extensions – Set 3 (JPS3) [PWG5100.13].

[4)] REQUIRED for a Resource by analogy to PWG Network Resource Service Semantic Model and Service Interface [PWG5108.03] andto a Job in IETF IPP/1.1 Model and Semantics [RFC8011]. See section 7.6 of this specification for details of the “resource-id” attribute which MUST be monotonically increasing (as is “job-id”) to avoid re-use of a “resource-id” values and resulting ambiguity in log files.

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

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

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

5.8 Printer Description Attributes

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

Note: An SM/IPP Equivalent entry of “<none>” indicates that there is no previously defined equivalent attribute and the attribute is defined for the first time in this specification.

Table 6 – IPP Printer Description Attributes

Conformance IPP Attribute Name SM/IPP Equivalent Element Name

Reference

REQUIRED printer-owner-col OwnerUri, OwnerVCard[1] [PWG5108.06]

Notes:

1) REQUIRED for a Printer by analogy to “system-owner-col” in System since all Systems MUST support the Set-Printer-Attributes operation to conform to this IPP System Service specification – also “owner-uri” and “owner-vcard” MUST be

Page 35 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

100101915916917

918919

920921922923924

925926

927928929930

931932933934935

936

937938

939940

941

942943

944945946

102

Page 36: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

updated simultaneously if specified in a Set-Printer-Attributes operation (to preserve consistency).

5.9 Printer Status Attributes

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

Note: An SM/IPP Equivalent entry of “<none>” indicates that there is no previously defined equivalent attribute and the attribute is defined for the first time in this specification.

Table 7 – IPP Printer Status Attributes

Conformance IPP Attribute Name SM/IPP Equivalent Element Name

Reference

REQUIRED printer-config-changes ConfigChanges[1] [PWG5106.1]REQUIRED printer-id ID[2] [PWG5108.06]REQUIRED printer-resource-ids <none>printer-resource-ids[4] <none

>[PWG.SYS]REQUIRED printer-service-type ServiceType[3] [PWG5108.06]

Notes:

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

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

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

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

5.10 Job Status Attributes

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

Note: An SM/IPP Equivalent entry of “<none>” indicates that there is no previously defined equivalent attribute and the attribute is defined for the first time in this specification.

Table 8 – IPP Job Status Attributes

Conformance IPP Attribute Name SM/IPP Equivalent Element Name

Reference

Page 36 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

103104947948

949

950

951952

953

954955

956957958

959960961

962963

964965966

967

968

969970

971

105

Page 37: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

REQUIRED job-owner-col OwnerUri, OwnerVCard[1] [PWG5108.06]REQUIRED job-resource-ids <none>job-resource-ids[2] <none

>[PWG.SYS]

Notes:

1) REQUIRED for a Job by analogy to “system-owner-col” in System since all Systems MUST support the Set-Job-Attributes operation to conform to this IPP System Service specification – also “owner-uri” and “owner-vcard” MUST be updated simultaneously if specified in a Set-Job-Attributes operation (to preserve consistency all Systems since they MUST support the “requesting-user-vcard” Job Creation operation attribute to conform to this IPP System Service specification.

2) REQUIRED for all Jobs since all Systems MUST support the assignment of requested Job-scope Resources via the “resource-ids” Job Creation operation attribute to conform to this IPP System Service specification.

Page 37 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

106107

972973

974975976977978979

980981982983

108

Page 38: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

6. IPP OperationsIPP System Service implementations MUST support Client authentication and Client authorization based on System policy. All IPP System Service operations, eExcept for Get-Printers and Get-Printer-Attributes, all System Service operations MAY require Client authentication based on enforce Client authentication and System policy-based authorization of the originating Operator or Administrator. The Get-Printers and Get-Printer-Attributes operations are available to any authorized User and System policy can omit Client authentication of this User. All IPP System Service Clients MUST support HTTP Basic authentication and SHOULD support HTTP Digest authentication per [RFC8011].

Note: Get-Printer-Attributes does not require Client authentication for backwards compatibility with existing Clients.

Note: All IPP System Service operation requests and responses use standard operation parameters as defined in [RFC8011] and encoded in [RFC8010].

6.1 Printer Operations

IPP System Service operations on single Printer objects (except for Get-Printers) are defined in this section.

Note: The System MUST copy the value of any supplied “printer-message-from-operator” operation attribute to any affected Printer objects (for Create-Printer, Shutdown-One-Printer, and Startup-One-Printer).

6.1.1 Allocate-Printer-Resources

This REQUIRED operation allows an authorized Operator or Administrator to allocate Resources to an existing Printer object on the target System object and update “resource-use-count” in each Resource. If the Printer object is already shutdown, with ‘shutdown’ in the “printer-state-reasons”, then the System MUST return a “status-code” of ‘client-error-forbidden’.

6.1.1.1 Allocate-Printer-Resources Request

The following groups of attributes are part of an Allocate-Printer-Resources request.

Group 1: Operation Attributes

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

Page 38 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

109110

984

985986987988989990991992993

994995

996997

998

9991000

100110021003

1004

10051006100710081009

1010

1011

1012

10131014

111

Page 39: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

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

“system-uri” (uri):

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

“printer-id” (integer(1:65535)):

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

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

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

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

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

6.1.1.2 Allocate-Printer-Resources Response

The following groups of attributes are part of an Allocate-Printer-Resources response.

Group 1: Operation Attributes

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

The System MUST return both of these attributes.

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

The System MAY return one or both of these attributes.

Group 2: Unsupported Attributes

See [RFC8011] for details on returning Unsupported Attributes.

Group 3: Printer Attributes

See [RFC8011] for details on returning Printer Attributes.

“printer-id” (integer(1:65535)):

Page 39 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

11211310151016

1017

10181019

1020

10211022

102310241025

10261027

1028

1029

1030

1031

1032

10331034

1035

10361037

1038

1039

1040

1041

1042

1043

114

Page 40: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

The System MUST return this attribute.

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

The System MUST return this attribute, which contains the complete list of Resources currently allocated to this Printer (including all of the valid ones listed in the request attribute “resource-ids”).

6.1.2 Create-Printer

This REQUIRED operation allows an authorized Operator or Administrator to create a new Printer object (i.e., Job processing service) on the target System object and optionally also create one or more new per-Printer Subscription objects.

This operation is semantically equivalent to the Create operation for a Printer object defined in ISO “Document Printing Application (DPA) Part 3: Management Abstract Service Definition and Procedures” [ISO10175-3] (where a newly created Printer object had the special initial state of ‘unknown’, which is NOT defined or used in this specification). This operation is semantically analogous to the Create-Job operation defined in [RFC8011].

If accepted, the System MUST create and initialize a new Printer object with the “printer-state” set to ‘stopped’ (i.e., no Jobs can be processed and intervention is required), “printer-is-accepting-jobs” set to ‘false’ (i.e., no incoming Jobs accepted), and the ‘paused’ value added to “printer-state-reasons” (i.e., no Job processing output allowed). This operation does not change the “system-state” of the System itself.

One or more per-Printer Subscription objects can also be created. The Client can then send one or more Set-Printer-Attributes operations to modify the configuration of the Printer, followed by Resume-Printer (to remove ‘paused’ from “printer-state-reasons”) and Enable-Printer (to change “printer-is-accepting-jobs” to ‘true’) to change “printer-state” to ‘idle’ (unless there is another reason for the Printer to stay in the ‘stopped’ state).

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

Note: Printer-scope Resource objects MAY be:

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

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

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

Page 40 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

1151161044

1045

104610471048

1049

105010511052

10531054105510561057

10581059106010611062

10631064106510661067

10681069

1070

107110721073

107410751076

10771078

117

Page 41: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

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

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

6.1.2.1 Create-Printer Request

The following groups of attributes are part of a Create-Printer request.

Group 1: Operation Attributes

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

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

“system-uri” (uri):

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

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

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

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

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

“printer-message-from-operator” (text(127)):

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

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

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

Page 41 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

11811910791080

10811082108310841085108610871088

1089

1090

1091

10921093

10941095

1096

10971098

109911001101

11021103

1104

1105

1106

1107

1108

1109

120

Page 42: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

Group 2: Printer Description Attributes

<all mandatory Printer Description attributes>

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

<any other Printer Description attribute>

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

Groups 3-N: Subscription Attributes

See [RFC3995] for details on supplying Subscription Attributes.

6.1.2.2 Create-Printer Response

The following groups of attributes are part of a Create-Printer response.

Group 1: Operation Attributes

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

The System MUST return both of these attributes.

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

The System MAY return one or both of these attributes.Group 2: Unsupported Attributes

See [RFC8011] for details on returning Unsupported Attributes.

Groups 3: Printer Attributes

See [RFC8011] for details on returning Printer Attributes.

“printer-id” (integer(1:65535)):

The System MUST return this attribute.

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

The System MUST return this attribute.

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

The System MUST return this attribute.

Page 42 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

1211221110

1111

11121113

1114

11151116

1117

1118

1119

1120

1121

11221123

1124

11251126

1127

1128

1129

1130

1131

1132

1133

1134

1135

1136

123

Page 43: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

“printer-state” (type1 enum) and“printer-state-reasons” (1setOf type2 keyword) and“printer-is-accepting-jobs” (boolean):

The System MUST return all three of these attributes.

Groups 4-N: Subscription Attributes

See [RFC3995] for details on returning Subscription Attributes.

Group N+1: System Attributes

See [RFC8011] and [RFC3380] for details on returning analogous Printer Attributes.

“system-uuid” (uri(45)):

The System MUST return this attribute.

“system-xri-supported” (1setOf collection)

The System MUST return this attribute.

“system-state” (type1 enum) and“system-state-reasons” (1setOf type2 keyword):

The System MUST return both of these attributes.

6.1.3 Deallocate-Printer-Resources

This REQUIRED operation allows an authorized Operator or Administrator to deallocate Resources from an existing Printer object on the target System object and update “resource-use-count” in each Resource. If the Printer object is already shutdown, with ‘shutdown’ in the “printer-state-reasons”, then the System MUST return a “status-code” of ‘client-error-forbidden’.

6.1.3.1 Deallocate-Printer-Resources Request

The following groups of attributes are part of a Deallocate-Printer-Resources request.

Group 1: Operation Attributes

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

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

“system-uri” (uri):

Page 43 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

124125113711381139

1140

1141

1142

1143

1144

1145

1146

1147

1148

11491150

1151

1152

11531154115511561157

1158

1159

1160

11611162

11631164

1165

126

Page 44: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

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

“printer-id” (integer(1:65535)):

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

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

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

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

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

6.1.3.2 Deallocate-Printer-Resources Response

The following groups of attributes are part of a Deallocate-Printer-Resources response.

Group 1: Operation Attributes

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

The System MUST return both of these attributes.

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

The System MAY return one or both of these attributes.

Group 2: Unsupported Attributes

See [RFC8011] for details on returning Unsupported Attributes.

Groups 3: Printer Attributes

See [RFC8011] for details on returning Printer Attributes.

“printer-id” (integer(1:65535)):

The System MUST return this attribute.

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

Page 44 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

12712811661167

1168

11691170

117111721173

11741175

1176

1177

1178

1179

1180

11811182

1183

11841185

1186

1187

1188

1189

1190

1191

1192

1193

129

Page 45: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

The System MUST return this attribute, which contains the complete list of remaining Resources currently allocated to this Printer (after removing all of the valid ones listed in the request attribute “resource-ids”).

6.1.4 Delete-Printer

This REQUIRED operation allows an authorized Operator or Administrator to delete entirely one configured Printer object (i.e., Job processing service) on the target System object. If the Printer object is not already shutdown, with ‘shutdown’ in the “printer-state-reasons”, then the System MUST return a “status-code” of ‘client-error-forbidden’.

This operation is semantically equivalent to the DeleteService operation defined in [PWG5108.06]. The Printer object and all associated Jobs will be removed entirely. The Printer object cannot be subsequently started up with a Startup-One-Printer operation.

If accepted, the System MUST shutdown the specified Printer with the “printer-state” set to ‘stopped’ (i.e., no Jobs can be processed and intervention is required) and the ‘shutdown’ value added to “printer-state-reasons”. This operation MAY change the state of the System itself to ‘stopped’ (if there are no other configured Printers or all other Printers already had a “printer-state” of ‘stopped’).

6.1.4.1 Delete-Printer Request

The following groups of attributes are part of a Delete-Printer request.

Group 1: Operation Attributes

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

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

“system-uri” (uri):

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

“printer-id” (integer(1:65535)):

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

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

Page 45 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

130131119411951196

1197

1198119912001201

120212031204

12051206120712081209

1210

1211

1212

12131214

12151216

1217

12181219

1220

12211222

122312241225

132

Page 46: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

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

6.1.4.2 Delete-Printer Response

The following groups of attributes are part of a Delete-Printer response.

Group 1: Operation Attributes

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

The System MUST return both of these attributes.

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

The System MAY return one or both of these attributes.

Group 2: Unsupported Attributes

See [RFC8011] for details on returning Unsupported Attributes.

Groups 3: Printer Attributes

See [RFC8011] for details on returning Printer Attributes.

“printer-id” (integer(1:65535)):

The System MUST return this attribute.

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

The System MUST return this attribute.

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

The System MUST return this attribute.

“printer-state” (type1 enum) and“printer-state-reasons” (1setOf type2 keyword) and“printer-is-accepting-jobs” (boolean):

The System MUST return all three of these attributes.

Group 4: System Attributes

See [RFC8011] and [RFC3380] for details on returning analogous Printer Attributes.

Page 46 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

13313412261227

1228

1229

1230

12311232

1233

12341235

1236

1237

1238

1239

1240

1241

1242

1243

1244

1245

1246

124712481249

1250

1251

1252

135

Page 47: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

“system-uuid” (uri(45)):

The System MUST return this attribute.

“system-xri-supported” (1setOf collection)

The System MUST return this attribute.

“system-state” (type1 enum) and“system-state-reasons” (1setOf type2 keyword):

The System MUST return both of these attributes.

6.1.5 Get-Printers

This REQUIRED operation allows an authorized User to retrieve a filtered list of some or all of the Printer objects (i.e., Job processing services) on the target System object. If no Printers match the specified filter criteria, then the System MUST return a “status-code” of 'successful-ok'.

This operation is semantically equivalent to the ListAllServices operation defined in [PWG5108.06]. This operation is also semantically equivalent to a sequence of Get-Printer-Attributes [RFC8011] operations to each Printer object.

If accepted, the System MUST return “printer-id” and “printer-xri-supported” for each matching Printer object. The returned Printers and Printer attributes from the System MAY also be filtered based on Client access rights (i.e., the value of “requesting-user-name”) or the specified “document-format”. This operation does not change the state of any Printer or the System itself.

6.1.5.1 Get-Printers Request

The following groups of attributes are part of a Get-Printers request.

Group 1: Operation Attributes

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

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

“system-uri” (uri):

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

“printer-ids” (1setOf (integer(1:65535))):

Page 47 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

1361371253

1254

1255

1256

12571258

1259

1260

1261126212631264

126512661267

12681269127012711272

1273

1274

1275

12761277

12781279

1280

12811282

1283

138

Page 48: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

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

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

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

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

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

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

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

“printer-geo-location” (uri):

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

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

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

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

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

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

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

The Client SHOULD supply only and the System MUST support requests for Printer attributes that are listed as IPP Printer source attributes in the table in section 4 Definition of Attribute Types in the IETF LDAP Schema for Printer Services [RFC7612].

"document-format" (mimeMediaType):

Page 48 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

13914012841285

128612871288

12891290

1291

1292

1293

1294

1295

1296

1297

1298

1299

1300130113021303

1304

1305130613071308

1309131013111312

1313

141

Page 49: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

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

“which-printers” (type2 keyword):

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

6.1.5.2 Get-Printers Response

The following groups of attributes are part of a Get-Printers response. The System returns a Get-Printers operation response to the Client up to the number specified by the “limit” operation attribute that match the filter criteria as supplied by the Client in the request.

Group 1: Operation Attributes

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

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

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

The System MAY return one or both of these attributes.

Group 2: Unsupported Attributes

See [RFC8011] for details on returning Unsupported Attributes.

Groups 3 to N: Printer Attributes

See [RFC8011] for details on returning Printer Attributes.

“printer-id” (integer(1:65535)):

The System MUST return this attribute for each Printer.

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

The System MUST return this attribute for each Printer.

Page 49 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

142143131413151316131713181319

1320

1321132213231324

1325

132613271328

1329

13301331

13321333

13341335

1336

1337

1338

1339

1340

1341

1342

1343

1344

144

Page 50: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

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

The System MUST return this attribute for each Printer.

“printer-state” (type1 enum) and“printer-state-reasons” (1setOf type2 keyword) and“printer-is-accepting-jobs” (boolean):

The System MUST return all three of these attributes for each Printer.

Get-Printer-Attributes

This REQUIRED operation allows an authorized User to retrieve a filtered list of the Printer attributes for either the default Printer specified by the “system-default-printer-id” on the target System object or an explicit Printer specified by the “printer-uri” of the target Printer object. This operation supports backward compatibility with previously deployed IPP Clients. If there is no configured default Printer, then the System MUST return a “status-code” of 'successful-ok'.

This operation is semantically equivalent to the Get-Printer-Attributes operation defined in [RFC8011], except that the target MAY be a System object (rather than a Printer object), although previously deployed IPP Clients MAY omit the “system-uri” operation attribute and supply the “printer-uri” operation attribute instead.

If accepted, the System MUST return “printer-id” and “printer-xri-supported” for either the default Printer specified by the “system-default-printer-id” attribute on the target System object or an explicit Printer specified by the “printer-uri” of the target Printer object. The returned Printer attributes from the System MAY also be filtered based on Client access rights (i.e., the value of “requesting-user-name”) or the specified “document-format”. This operation does not change the state of any Printer or the System itself.

[6.1.5.3] Get-Printer-Attributes Request

The following groups of attributes are part of a Get-Printer-Attributes request.

Group 1: Operation Attributes

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

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

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

The Client MUST supply either the "system-uri" or "printer-uri" operation attributes and the System MUST support both the "system-uri" and "printer-

Page 50 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

1451461345

1346

134713481349

1350

1351

135213531354135513561357

1358135913601361

136213631364136513661367

1368

1369

1370

13711372

13731374

13751376

13771378

147

Page 51: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

uri" operation attributes which specify the target System or the explicit target Printer for the operation.

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

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

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

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

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

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

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

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

"document-format" (mimeMediaType):

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

[6.1.5.4] Get-Printer-Attributes Response

The following groups of attributes are part of a Get-Printer-Attributes response. The System returns a Get-Printer-Attributes operation response to the Client up to the number specified by the “limit” operation attribute that match the filter criteria as specified by the attribute values supplied by the Client in the request.

Group 1: Operation Attributes

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

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

Page 51 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

14814913791380

138113821383

13841385

1386

1387

1388

1389

1390

1391139213931394

1395

139613971398139914001401

1402

1403140414051406

1407

14081409

14101411

150

Page 52: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

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

The System MAY return one or both of these attributes.

Group 2: Unsupported Attributes

See [RFC8011] for details on returning Unsupported Attributes.

Group 3: Printer Attributes

See [RFC8011] for details on returning Printer Attributes.

“printer-id” (integer(1:65535)):

The System MUST return this attribute for the target Printer.

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

The System MUST return this attribute for the target Printer.

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

The System MUST return this attribute for the target Printer.

“printer-state” (type1 enum) and“printer-state-reasons” (1setOf type2 keyword) and“printer-is-accepting-jobs” (boolean):

The System MUST return all three of these attributes for the target Printer.

6.1.6 Get-Printer-Resources

This REQUIRED operation allows an authorized End User to retrieve a filtered list of some or all of the Resource objects allocated on the target Printer object. If no Resources match the specified filter criteria, then the Printer MUST return a “status-code” of 'successful-ok'.

This operation is semantically analogous to the ListResources operation defined in [PWG5108.03]. This operation is also semantically analogous the Get-Jobs operation defined in [RFC8011].

If accepted, the Printer MUST return “resource-id” for each matching Resource object. This operation does not change the state of any Resource or the Printer itself.

6.1.6.1 Get-Printer-Resources Request

The following groups of attributes are part of a Get-Printer-Resources request.

Group 1: Operation Attributes

Page 52 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

15115214121413

1414

1415

1416

1417

1418

1419

1420

1421

1422

1423

1424

142514261427

1428

1429

143014311432

143314341435

14361437

1438

1439

1440

153

Page 53: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

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

The Client MUST supply and the Printer MUST support both of these attributes.

“printer-uri” (uri):

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

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

The Client MAY supply and the Printer MUST support the “resource-ids” operation attribute which is the list of target Resources for the operation.

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

The Client SHOULD supply and the Printer MUST support all three of these attributes.

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

The Client MAY supply and the Printer MUST support this attribute.

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

The Client MAY supply and the Printer MUST support this attribute.

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

The Client MAY supply and the Printer MUST support this attribute. If this operation attribute is NOT supplied, then the the System MUST only return the value of the equivalent “system-configured-resources” entry for each selected Resource. See section “system-configured-resources” in section 7.3 System Status Attributes.

"resource-formats" (1setOf (mimeMediaType)):

The Client MAY supply and the Printer MUST support this attribute. If this operation attribute is supplied, then the Printer MUST return the attributes and values for the selected Resources. See “resource-format” in section 7.7 Resource Status Attributes.

“resource-states” (1setOf (type1 enum)):

Page 53 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

15415514411442

14431444

1445

14461447

1448

14491450

145114521453

14541455

1456

1457

1458

1459

1460

14611462146314641465

1466

1467146814691470

1471

156

Page 54: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

The Client MAY supply and the Printer MUST support this attribute. If this operation attribute is supplied, then the Printer MUST return the attributes and values for the selected Resources. See “resource-state” in section 7.7 Resource Status Attributes.

“resource-types” (1setOf (type2 keyword)):

The Client MAY supply and the Printer MUST support this attribute. If this operation attribute is supplied, then the Printer MUST return the attributes and values for the selected Resources. See “resource-type” in section 7.7 Resource Status Attributes.

6.1.6.2 Get-Printer-Resources Response

The following groups of attributes are part of a Get-Printer-Resources response. The Printer returns a Get-Printer-Resources operation response to the Client up to the number specified by the “limit” operation attribute that match the filter criteria as supplied by the Client in the request.

Group 1: Operation Attributes

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

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

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

The Printer MAY return one or both of these attributes.

Group 2: Unsupported Attributes

See [RFC8011] for details on returning Unsupported Attributes.

Groups 3 to N: Resource Attributes

See [RFC8011] for details on returning analogous Printer Attributes.

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

The Printer MUST return this attribute.

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

The Printer MUST return this attribute.

Page 54 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

1571581472147314741475

1476

1477147814791480

1481

1482148314841485

1486

14871488

14891490

14911492

1493

1494

1495

1496

1497

1498

1499

1500

1501

159

Page 55: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

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

The Printer MUST return both of these attributes.

6.1.7 Shutdown-One-Printer

This REQUIRED operation allows an authorized Operator or Administrator to shutdown one configured Printer object (i.e., Job processing service) on the target System object.

This operation is semantically equivalent to the ShutdownService operation defined in [PWG5108.06]. This operation is also semantically equivalent to a Shutdown-Printer operation [RFC3998] to the configured Printer object (except for the resulting “printer-state” of ‘stopped’ rather than ‘idle’).

If accepted, the System MUST shutdown the specified Printer with the “printer-state” set to ‘stopped’ (i.e., no Jobs can be processed and intervention is required) and the ‘shutdown’ value added to “printer-state-reasons”. This operation MAY cause the System to pause with “system-state” set to ‘stopped’ (if all other Printers already had a “printer-state” of ‘stopped’).

The Client can later send a Startup-One-Printer operation to the System (preferred) or a Startup-Printer operation [RFC3998] to the Printer to start up the specified Printer.

6.1.7.1[6.1.5.5] Shutdown-One-Printer Request

The following groups of attributes are part of a Shutdown-One-Printer request.

Group 1: Operation Attributes

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

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

“system-uri” (uri):

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

“printer-id” (integer(1:65535)):

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

Page 55 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

16016115021503

1504

1505

15061507

1508150915101511

15121513151415151516

15171518

1519

1520

1521

15221523

15241525

1526

15271528

1529

15301531

162

Page 56: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

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

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

“printer-message-from-operator” (text(127)):

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

6.1.7.2[6.1.5.6] Shutdown-One-Printer Response

The following groups of attributes are part of a Shutdown-One-Printer response.

Group 1: Operation Attributes

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

The System MUST return both of these attributes.

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

The System MAY return one or both of these attributes.

Group 2: Unsupported Attributes

See [RFC8011] for details on returning Unsupported Attributes.

Group 3: Printer Attributes

See [RFC8011] for details on returning Printer Attributes.

“printer-id” (integer(1:65535)):

The System MUST return this attribute for the target Printer.

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

The System MUST return this attribute for the target Printer.

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

The System MUST return this attribute for the target Printer.

Page 56 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

163164153215331534

15351536

1537

1538

1539

1540

1541

15421543

1544

15451546

1547

1548

1549

1550

1551

1552

1553

1554

1555

1556

1557

165

Page 57: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

“printer-state” (type1 enum) and“printer-state-reasons” (1setOf type2 keyword) and“printer-is-accepting-jobs” (boolean):

The System MUST return all three of these attributes for the target Printer.

6.1.8[6.1.6] Startup-One-Printer

This REQUIRED operation allows an authorized Operator or Administrator to startup one configured Printer object (i.e., Job processing service) on the target System object.

This operation is semantically equivalent to the StartupService operation defined in [PWG5108.06].

If accepted, the System MUST startup the specified Printer with the “printer-state” set to ‘stopped’ (i.e., no Jobs can be processed and intervention is required), “printer-is-accepting-jobs” set to ‘false’ (i.e., no incoming Jobs accepted), and the ‘paused’ value added to “printer-state-reasons” (i.e., no Job processing output allowed). This operation MAY cause the System to resume with “system-state” set to ‘idle’ (if all other Printers already had a “printer-state” of ‘stopped’).

The Client can later send one or more Set-Printer-Attributes operations to modify the configuration of the Printer, followed by Resume-Printer (i.e., remove ‘paused’ from “printer-state-reasons”) and Enable-Printer (i.e., change “printer-is-accepting-jobs” to ‘true’) to change the “printer-state” to ‘idle’ (unless there is another reason for the Printer to stay in the ‘stopped’ state).

6.1.8.1[6.1.6.1] Startup-One-Printer Request

The following groups of attributes are part of a Startup-One-Printer request.

Group 1: Operation Attributes

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

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

“system-uri” (uri):

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

“printer-id” (integer(1:65535)):

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

Page 57 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

166167155815591560

1561

1562

15631564

15651566

156715681569157015711572

15731574157515761577

1578

1579

1580

15811582

15831584

1585

15861587

1588

15891590

168

Page 58: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

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

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

“printer-message-from-operator” (text(127)):

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

6.1.8.2[6.1.6.2] Startup-One-Printer Response

The following groups of attributes are part of a Startup-One-Printer response.

Group 1: Operation Attributes

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

The System MUST return both of these attributes.

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

The System MAY return one or both of these attributes.

Group 2: Unsupported Attributes

See [RFC8011] for details on returning Unsupported Attributes.

Group 3: Printer Attributes

See [RFC8011] for details on returning Printer Attributes.

“printer-id” (integer(1:65535)):

The System MUST return this attribute for the target Printer.

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

The System MUST return this attribute for the target Printer.

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

The System MUST return this attribute for the target Printer.

Page 58 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

169170159115921593

15941595

1596

1597

1598

1599

1600

16011602

1603

16041605

1606

1607

1608

1609

1610

1611

1612

1613

1614

1615

1616

171

Page 59: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

“printer-state” (type1 enum) and“printer-state-reasons” (1setOf type2 keyword) and“printer-is-accepting-jobs” (boolean):

The System MUST return all three of these attributes for the target Printer.

6.2 Resource Operations

IPP System Service operations on single Resource objects (except for Get-Resources) are defined in this section.

6.2.1 Cancel-Resource

This REQUIRED operation allows an authorized Operator or Administrator to cancel an existing Resource object on the target System object. If the Resource object’s “resource-state” is ‘canceled’ or ‘aborted’ or “resource-state-reasons” includes ‘cancel-requested’, then the System MUST return a “status-code” of ‘client-error-not-possible’.

This operation is semantically analogous to the DeleteResource operation defined in [PWG5108.03] (except that the Resource is not removed, in order to preserve the integrity of system log files). See section 4.6. Resource Object and section 4.6.1 Resource History for more details.

If accepted, the System MUST set the “resource-state” to ‘canceled’ or leave “resource-state” unchanged and add ‘cancel-requested’ to “resource-state-reasons” (e.g., if the Resource is currently in use by a Job). In either case, the System MUST make the Resource permanently unavailable for future use. The System MUST preserve all Resource object attributes for an implementation-defined Resource History period.

When “resource-state” eventually transitions to ‘canceled’, the System SHOULD delete any local copy of Resource data. This operation does not change the “system-state” of the System itself.

6.2.1.1 Cancel-Resource Request

The following groups of attributes are part of a Cancel-Resource request.

Group 1: Operation Attributes

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

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

“system-uri” (uri):

Page 59 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

172173161716181619

1620

1621

16221623

1624

1625162616271628

1629163016311632

16331634163516361637

163816391640

1641

1642

1643

16441645

16461647

1648

174

Page 60: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

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

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

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

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

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

6.2.1.2 Cancel-Resource Response

The following groups of attributes are part of a Cancel-Resource response.

Group 1: Operation Attributes

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

The System MUST return both of these attributes.

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

The System MAY return one or both of these attributes.

Group 2: Unsupported Attributes

See [RFC8011] for details on returning Unsupported Attributes.

6.2.2 Create-Resource

This REQUIRED operation allows an authorized Operator or Administrator to create a new Resource object on the target System object and optionally also create one or more new per-Resource Subscription objects.

This operation is semantically analogous to the StoreResource operation defined in [PWG5108.03] (except that the Resource data is separately transferred with a subsequent Send-Resource-Data operation and installed for use with a subsequent Install-Resource operation).

If accepted, the System MUST create and initialize a new Resource object with the “resource-state” set to ‘pending’ (i.e., no Resource data has been associated yet). This

Page 60 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

17517616491650

1651

16521653

165416551656

16571658

1659

1660

1661

16621663

1664

16651666

1667

1668

1669

1670

167116721673

1674167516761677

16781679

177

Page 61: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

operation does not change the “system-state” of the System itself.One or more per-Resource Subscription objects can also be created. The Client can then use one or more Set-Resource-Attributes operations to modify the Resource object, followed by a Send-Resource-Data operation (i.e., upload the associated Resource data) to change the “resource-state” to ‘available’. During processing of the Send-Resource-Data operation, the System can keep the “resource-state” of ‘pending’ and also add ‘resource-incoming’ to “resource-state-reasons” if the upload completion is delayed. The Client can then use an Install-Resource operation to install the Resource, which will either change “resource-state” to ‘installed’ or add ‘install-requested’ to “resource-state-reasons”. See section 7.7.12 resource-state for a discussion of Resource object states and lifecycle phases.

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

Note: Printer-scope Resource objects MAY be:

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

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

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

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

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

6.2.2.1 Create-Resource Request

The following groups of attributes are part of a Create-Resource request.

Group 1: Operation Attributes

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

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

Page 61 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

1781791680168116821683168416851686168716881689

16901691

1692

169316941695

169616971698

1699170017011702

170317041705

17061707

1709

1710

1711

17121713

17141715

180

Page 62: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

“system-uri” (uri):

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

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

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

“resource-type” (type2 keyword):

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

Group 2: Resource Description Attributes

<any Resource Description attribute>

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

Groups 3-N: Subscription Attributes

See [RFC3995] for details on supplying Subscription Attributes.

6.2.2.2 Create-Resource Response

The following groups of attributes are part of a Create-Resource response..

Group 1: Operation Attributes

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

The System MUST return both of these attributes.

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

The System MAY return one or both of these attributes.

“resource-format-accepted” (1setOf mimeMediaType)

This System MUST return this list of accepted Resource formats (for use in Send-Resource-Data) based on the “resource-type” specified in the Create-Response request.

Group 2: Unsupported Attributes

Page 62 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

1811821716

17171718

171917201721

17221723

1724

1725

1726

1727

1728

1729

1730

1731

1732

1733

17341735

1736

17371738

1739

1740

174117421743

1744

183

Page 63: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

See [RFC8011] for details on returning Unsupported Attributes.

Groups 3: Resource Attributes

See [RFC8011] for details on returning analogous Printer Attributes.

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

The System MUST return this attribute.

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

The System MUST return this attribute.

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

The System MUST return both of these attributes.

Groups 4-N: Subscription Attributes

See [RFC3995] for details on returning Subscription Attributes.

6.2.3 Get-Resources

This REQUIRED operation allows an authorized Operator or Administrator to retrieve a filtered list of some or all of the Resource objects on the target System object. If no Resources match the specified filter criteria, then the System MUST return a “status-code” of 'successful-ok'.

This operation is semantically equivalent to the ListResources operation defined in [PWG5108.03]. This operation is also semantically analogous the Get-Jobs operation defined in [RFC8011].

If accepted, the System MUST return “resource-id” for each matching Resource object. This operation does not change the state of any Resource or the System itself.

6.2.3.1 Get-Resources Request

The following groups of attributes are part of a Get-Resources request.

Group 1: Operation Attributes

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

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

Page 63 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

1841851745

1746

1747

1748

1749

1750

1751

17521753

1754

1755

1756

1757

1758175917601761

176217631764

17651766

1767

1768

1769

17701771

17721773

186

Page 64: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

“system-uri” (uri):

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

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

The Client MAY supply and the System MUST support the “resource-ids” operation attribute which is the list of target Resources for the operation.

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

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

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

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

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

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

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

The Client MAY supply and the System MUST support this attribute. If this operation attribute is NOT supplied, then the System MUST only return the value of the “system-configured-resources” entry for each selected Resource. See section “system-configured-resources” in section 7.3 System Status Attributes.

"resource-formats" (1setOf (mimeMediaType)):

The Client MAY supply and the System MUST support this attribute. If this operation attribute is supplied, then the System MUST return the attributes and values for the selected Resources. See “resource-format” in section 7.7 Resource Status Attributes.

“resource-states” (1setOf (type1 enum)):

The Client MAY supply and the System MUST support this attribute. If this operation attribute is supplied, then the System MUST return the attributes and values for the selected Resources. See “resource-state” in section 7.7 Resource Status Attributes.

“resource-types” (1setOf (type2 keyword)):

Page 64 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

1871881774

17751776

1777

17781779

178017811782

17831784

1785

1786

1787

1788

1789

17901791179217931794

1795

1796179717981799

1800

1801180218031804

1805

189

Page 65: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

The Client MAY supply and the System MUST support this attribute. If this operation attribute is supplied, then the System MUST return the attributes and values for the selected Resources. See “resource-type” in section 7.7 Resource Status Attributes.

6.2.3.2 Get-Resources Response

The following groups of attributes are part of a Get-Resources response. The System returns a Get-Resources operation response to the Client up to the number specified by the “limit” operation attribute that match the filter criteria as supplied by the Client in the request.

Group 1: Operation Attributes

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

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

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

The System MAY return one or both of these attributes.

Group 2: Unsupported Attributes

See [RFC8011] for details on returning Unsupported Attributes.

Groups 3 to N: Resource Attributes

See [RFC8011] for details on returning analogous Printer Attributes.

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

The System MUST return this attribute.

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

The System MUST return this attribute.

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

The System MUST return both of these attributes.

Page 65 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

1901911806180718081809

1810

1811181218131814

1815

18161817

18181819

18201821

1822

1823

1824

1825

1826

1827

1828

1829

1830

18311832

1833

1834

192

Page 66: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

6.2.4 Get-Resource-Attributes

This REQUIRED operation allows an authorized Operator or Administrator to retrieve some or all of the attributes the target Resource object.

This operation is semantically equivalent to the GetResourceElements operation defined in [PWG5108.03]. This operation is also semantically analogous the Get-Job-Attributes and Get-Printer-Attributes operations defined in [RFC8011].

If accepted, the System MUST return the requested attributes for the selected Resource object. This operation does not change the state of any Resource or the System itself.

6.2.4.1 Get-Resource-Attributes Request

The following groups of attributes are part of a Get-Resource-Attributes request.

Group 1: Operation Attributes

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

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

“system-uri” (uri):

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

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

The Client MUST supply and the System MUST support the “resource-id” operation attribute which is the target Resource for the operation.

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

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

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

The Client MAY supply and the System MUST support this attribute. If this operation attribute is NOT supplied, then the System MUST only return the value of the “system-configured-resources” entry for each selected

Page 66 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

1931941835

18361837

183818391840

18411842

1843

1844

1845

1846

18471848

18491850

1851

18521853

1854

18551856

185718581859

18601861

1862

186318641865

195

Page 67: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

Resource. See section “system-configured-resources” in section 7.3 System Status Attributes.

6.2.4.2 Get-Resource-Attributes Response

The following groups of attributes are part of a Get-Resource-Attributes response.

Group 1: Operation Attributes

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

The System MUST return both of these attributes.

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

The System MAY return one or both of these attributes.

Group 2: Unsupported Attributes

See [RFC8011] for details on returning Unsupported Attributes.

Group 3: Resource Attributes

See [RFC8011] for details on returning analogous Printer Attributes.

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

The System MUST return this attribute.

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

The System MUST return this attribute.

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

The System MUST return both of these attributes.

6.2.5 Install-Resource

This REQUIRED operation allows an authorized Operator or Administrator to install an existing Resource object for use on the target System object.

This operation is semantically analogous to the StoreResource operation defined in [PWG5108.03] (except that the Resource object is separately created with a previous Create-Resource operation and Resource data is separately uploaded with a previous Send-Resource-Data operation).

Page 67 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

19619718661867

1868

1869

1870

18711872

1873

18741875

1876

1877

1878

1879

1880

1881

1882

1883

1884

18851886

1887

1888

18891890

1891189218931894

198

Page 68: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

If the Resource object’s “resource-state” is not ‘available’ or “resource-state-reasons” includes ‘install-requested’, then the System MUST return a “status-code” of ‘client-error-not-possible’. The System MUST validate any Resource signature supplied in a previous Send-Resource-Data operation or embedded in the Resource data, for example as described in US NIST Digital Signature Standard [FIPS186-4], ENISA Algorithms, Key Size and Parameters Report [ENISAALG], ETSI Electronic Signatures and Infrastructures (ESI) Signature validation procedures and policies [TS102853], and IETF XML-Signature Syntax and Processing [RFC3275]. The System MUST validate the Resource format and type. The System SHOULD validate the

If accepted, the System MUST set the “resource-state” to ‘installed’ or leave “resource-state” unchanged and add ‘install-requested’ to “resource-state-reasons” (e.g., if this is an executable Resource and requires a System reboot to complete the installation). This operation does not change the “system-state” of the System itself.

See section 4.6 Resource Object and section 4.6.1 Resource History for more details.

6.2.5.1 Install-Resource Request

The following groups of attributes are part of an Install-Resource request.

Group 1: Operation Attributes

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

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

“system-uri” (uri):

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

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

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

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

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

Page 68 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

199200189518961897189818991900190119021903

1904190519061907

1908

1909

1910

1911

19121913

19141915

1916

19171918

1919

19201921

192219231924

19251926

201

Page 69: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

6.2.5.2 Install-Resource Response

The following groups of attributes are part of an Install-Resource response.

Group 1: Operation Attributes

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

The System MUST return both of these attributes.

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

The System MAY return one or both of these attributes.

Group 2: Unsupported Attributes

See [RFC8011] for details on returning Unsupported Attributes.

Group 3: Resource Object Attributes

This is the same set of attributes described in the Create-Resource response in section 6.2.2.1.

6.2.6 Send-Resource-Data

This REQUIRED operation allows an authorized Operator or Administrator to upload Resource data for an existing Resource object on the target System object.

This operation is semantically analogous to the StoreResource operation defined in [PWG5108.03] (except that the Resource object is separately created with a previous Create-Resource operation and Resource is separately installed with a subsequent Install-Resource-Data operation).

If the Resource object’s “resource-state” is not ‘pending’, then the System MUST return a “status-code” of ‘client-error-not-possible’. The System SHOULD validate any Resource signature supplied or embedded in the Resource data, for example as described in US NIST Digital Signature Standard [FIPS186-4], ENISA Algorithms, Key Size and Parameters Report [ENISAALG], ETSI Electronic Signatures and Infrastructures (ESI) Signature validation procedures and policies [TS102853], and IETF XML-Signature Syntax and Processing [RFC3275]. The System SHOULD validate the Resource format and type. The System SHOULD validate the Resource data contents.

If accepted, the System MUST set the “resource-state” to ‘available’. This operation does not change the “system-state” of the System itself.

Page 69 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

2022031927

1928

1929

19301931

1932

19331934

1935

1936

1937

1938

19391940

1941

19421943

1944194519461947

19481949195019511952195319541955

19561957

204

Page 70: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

This operation is semantically analogous to the Send-Document operation defined in [RFC8011] and semantically analogous to the StoreResource operation defined in [PWG5108.03] (except that the Resource object is separately created with a previous Create-Resource operation and installed for use with a subsequent Install-Resource operation). See section 4.6 Resource Object and section 4.6.1 Resource History for more details.

6.2.6.1 Send-Resource-Data Request

The following groups of attributes are part of a Send-Resource-Data request.

Group 1: Operation Attributes

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

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

“system-uri” (uri):

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

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

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

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

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

“resource-format” (mimeMediaType):

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

“resource-signature” (1setOf octetString):

The Client MAY supply and the System MUST support this attribute which is the out-of-band digital signature for the Resource data.

Group 2: Resource Content

The Client MUST supply the Resource data.

Page 70 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

20520619581959196019611962

1963

1964

1965

19661967

19681969

1970

19711972

1973

19741975

197619771978

19791980

1981

1982

1983

19841985

1986

1987

207

Page 71: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

6.2.6.2 Send-Resource-Data Response

The following groups of attributes are part of a Send-Resource-Data response..

Group 1: Operation Attributes

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

The System MUST return both of these attributes.

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

The System MAY return one or both of these attributes.

Group 2: Unsupported Attributes

See [RFC8011] for details on returning Unsupported Attributes.

Group 3: Resource Object Attributes

This is the same set of attributes described in the Create-Resource response in section 6.2.2.1.

6.2.7 Set-Resource-Attributes

This REQUIRED operation allows an authorized Operator or Administrator to set the values of Resource Description attributes listed in “resource-settable-attributes-supported” (see section 7.2). For Client support for localization see “system-strings-languages-supported” and “system-strings-uri” in section 7.2. If one or more of the supplied Resource Description attributes and/or values are not actually settable, then the System MUST reject the entire request, indicating which attributes and/or values cannot be set, and return a “status-code” of 'client-error-not-possible'. If the Resource object’s “resource-state” is either ‘canceled’ or ‘aborted’ or “resource-state-reasons” contains ‘cancel-requested’, then the System MUST reject the entire request and return a “status-code” of 'client-error-not-possible'. See additional validation rules in section 4.1 Set-Printer-Attributes of [RFC3380].

This operation is semantically equivalent to the SetResourceElements operation defined in [PWG5108.03] and semantically analogous to the Set-Printer-Attributes operation defined in [RFC3380].

If accepted, the System MUST set every supplied Resource Description attribute to exactly the supplied value. The System MUST NOT partially set a subset of the supplied attributes. The System MUST accept this operation when the supplied attributes are valid and the value of “resource-state” (see section 7.7) is ‘installed’. The System SHOULD accept this operation when the supplied attributes are valid and the value of “resource-

Page 71 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

2082091988

1989

1990

19911992

1993

19941995

1996

1997

1998

1999

20002001

2002

20032004200520062007200820092010201120122013

201420152016

20172018201920202021

210

Page 72: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

state” (see section 7.3) is either ‘pending’ or ‘available’. This operation does not change the “system-state” of the System itself.

[6.2.7.1] Set- Resource-Attributes Request

The following groups of attributes are part of a Set- Resource-Attributes request.

Group 1: Operation Attributes

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

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

“system-uri” (uri):

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

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

The Client MUST supply and the System MUST support the “resource-id” operation attribute which is the target Resource for the operation.

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

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

Group 2: Resource Attributes

The IPP Client MUST supply a set of Resource attributes with one or more values (including explicitly allowed out-of-band values) as defined in [RFC8011] and section 7.2 of this document.

See [RFC3380] for details on setting analogous Printer Attributes.

[6.2.7.2] Set- Resource-Attributes Response

The following groups of attributes are part of a Set- Resource-Attributes response.

Group 1: Operation Attributes

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

Page 72 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

21121220222023

2024

2025

2026

20272028

20292030

2031

20322033

2034

20352036

203720382039

20402041

2042

204320442045

2046

2047

2048

2049

20502051

213

Page 73: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

The System MUST return both of these attributes.

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

The System MAY return one or both of these attributes.

Group 2: Unsupported Attributes

See [RFC8011] for details on returning Unsupported Attributes.

Group 3: Resource Attributes

See [RFC8011] and [RFC3380] for details on returning analogous Printer Attributes.

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

The System MUST return this attribute.

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

The System MUST return this attribute.

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

The System MUST return both of these attributes.

6.3 Subscription Operations

IPP System Service operations on single Subscription objects are defined in this section.

6.3.1 Create-Resource-Subscriptions

This REQUIRED operation allows an authorized Operator or Administrator to create one or more per-ResourceSystem Subscription objects on Resources.

This operation is semantically analogous to the Create-Job-Subscriptions operation defined in [RFC3995].

The Client supplies one or more Subscription Attributes groups, each containing one or more of the Subscription Template Attributes defined in section 5.3 Table 1 of [RFC3995]. The System MUST support all of the Subscription Template Attributes defined in section 5.3 Table 1 of [RFC3995]. If the Resource object’s “resource-state” is ‘canceled’ or ‘aborted’ or “resource-state-reasons” includes ‘cancel-requested’, then the System MUST return a “status-code” of ‘client-error-not-possible’.

Page 73 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

2142152052

20532054

2055

2056

2057

2058

2059

2060

2061

2062

2063

20642065

2066

2067

2068

2069

20702071

20722073

207420752076207720782079

216

Page 74: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

If accepted, the System MUST create the requested Subscription objects. This operation does not change the state of the System itself.

6.3.1.1 Create-Resource-Subscriptions Request

The following groups of attributes are part of a Create-Resource-Subscriptions request.

Group 1: Operation Attributes

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

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

“system-uri” (uri):

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

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

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

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

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

Groups 2-N: Subscription Attributes

See [RFC3995] for details on supplying Subscription Attributes.

6.3.1.2 Create-Resource-Subscriptions Response

The following groups of attributes are part of a Create-Resource-Subscriptions response.

Group 1: Operation Attributes

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

The System MUST return both of these attributes.

Page 74 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

21721820802081

2082

2083

2084

20852086

20872088

2089

20902091

2092

20932094

209520962097

20982099

2100

2101

2102

2103

2104

21052106

2107

219

Page 75: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

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

The System MAY return one or both of these attributes.

Group 2: Unsupported Attributes

See [RFC8011] for details on returning Unsupported Attributes.

Groups 3-N: Subscription Attributes

See [RFC3995] for details on returning Subscription Attributes.

6.3.2 Create-System-Subscriptions

This REQUIRED operation allows an authorized Operator or Administrator to create one or more per-System Subscription objects.

This operation is semantically analogous to the Create-Printer-Subscriptions operation defined in [RFC3995].

The Client supplies one or more Subscription Attributes groups, each containing one or more of the Subscription Template Attributes defined in section 5.3 Table 1 of [RFC3995]. The System MUST support all of the Subscription Template Attributes defined in section 5.3 Table 1 of [RFC3995].

If accepted, the System MUST create the requested Subscription objects. This operation does not change the state of the System itself.

6.3.2.1 Create-System-Subscriptions Request

The following groups of attributes are part of a Create-System-Subscriptions request.

Group 1: Operation Attributes

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

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

“system-uri” (uri):

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

Page 75 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

22022121082109

2110

2111

2112

2113

2114

2115

21162117

21182119

2120212121222123

21242125

2126

2127

2128

21292130

21312132

2133

21342135

222

Page 76: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

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

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

Groups 2-N: Subscription Attributes

See [RFC3995] for details on supplying Subscription Attributes.

6.3.2.2 Create-System-Subscriptions Response

The following groups of attributes are part of a Create-System-Subscriptions response.

Group 1: Operation Attributes

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

The System MUST return both of these attributes.

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

The System MAY return one or both of these attributes.

Group 2: Unsupported Attributes

See [RFC8011] for details on returning Unsupported Attributes.

Groups 3-N: Subscription Attributes

See [RFC3995] for details on returning Subscription Attributes.

6.4 System Operations

IPP System Service operations on single System objects or multiple Printer objects are defined in this section.

Note: The System MUST copy the value of any supplied “system-message-from-operator” operation attribute to printer-message-from-operator” for any affected Printer objects (for [Disable, Enable, Pause, Resume, Shutdown, Startup]All-Printers, Pause-All-Printers-After-Current-Job, and Restart-System.

Page 76 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

223224213621372138

21392140

2141

2142

2143

2144

2145

21462147

2148

21492150

2151

2152

2153

2154

2155

2156

21572158

2159216021612162

225

Page 77: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

[6.4.1] Disable-All-Printers

This REQUIRED operation allows an authorized Operator or Administrator to pause all configured Printer objects (i.e., Job processing services) on the target System object. If no Printers are configured on the System, then the System MUST return a “status-code” of 'successful-ok'.

This operation is semantically equivalent to the DisableAllServices operation defined in [PWG5108.06]. This operation is also semantically equivalent to a sequence of Disable-Printer operations [RFC3398] to each configured Printer object.

If accepted, the System MUST disable each configured Printer with “printer-is-accepting-jobs” set to ‘false’ but the value of “printer-state” or “printer-state-reasons” is not affected by the Disable-All-Printers operation. This operation does not change the System state.

6.4.1.1 Disable-All-Printers Request

The following groups of attributes are part of a Disable-All-Printers request.

Group 1: Operation Attributes

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

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

“system-uri” (uri):

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

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

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

“systemprinter-message-from-operator” (text(127)):

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

6.4.1.2 Disable-All-Printers Response

The following groups of attributes are part of a Disable-All-Printers response.

Group 1: Operation Attributes

Page 77 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

2262272163

2164216521662167

216821692170

217121722173

2174

2175

2176

21772178

21792180

2181

21822183

218421852186

21872188

2189

2190

2191

2192

2193

228

Page 78: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

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

The System MUST return both of these attributes.

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

The System MAY return one or both of these attributes.

Group 2: Unsupported Attributes

See [RFC8011] for details on returning Unsupported Attributes.

Groups 3-N: Printer Attributes

See [RFC8011] for details on returning Printer Attributes.

“printer-id” (integer(1:65535)):

The System MUST return this attribute.

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

The System MUST return this attribute.

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

The System MUST return this attribute.

“printer-state” (type1 enum) and“printer-state-reasons” (1setOf type2 keyword) and“printer-is-accepting-jobs” (boolean):

The System MUST return all three of these attributes.

6.4.2 Enable-All-Printers

This REQUIRED operation allows an authorized Operator or Administrator to enable all configured Printer objects (i.e., Job processing services) on the target System object. If no Printers are configured on the System, then the System MUST return a “status-code” of 'successful-ok'.

This operation is semantically equivalent to the EnableAllServices operation defined in [PWG5108.06]. This operation is also semantically equivalent to a sequence of Enable-Printer operations [RFC3398] to each configured Printer object.

Page 78 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

22923021942195

2196

21972198

2199

2200

2201

22022203

2204

2205

2206

2207

2208

2209

2210

221122122213

2214

2215

2216221722182219

222022212222

231

Page 79: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

If accepted, the System MUST enable each configured Printer with “printer-is-accepting-jobs” set to ‘true’ but the value of “printer-state” or “printer-state-reasons” is not affected by the Enable-All-Printers operation. This operation does not change the System state.

6.4.2.1 Enable-All-Printers Request

The following groups of attributes are part of a Enable-All-Printers request.

Group 1: Operation Attributes

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

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

“system-uri” (uri):

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

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

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

“systemprinter-message-from-operator” (text(127)):

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

6.4.2.2 Enable-All-Printers Response

The following groups of attributes are part of a Enable-All-Printers response..

Group 1: Operation Attributes

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

The System MUST return both of these attributes.

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

The System MAY return one or both of these attributes.

Page 79 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

232233222322242225

2226

2227

2228

22292230

22312232

2233

22342235

223622372238

22392240

2241

2242

2243

2244

2245

22462247

2248

22492250

2251

234

Page 80: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

Group 2: Unsupported Attributes

See [RFC8011] for details on returning Unsupported Attributes.

Groups 3-N: Printer Attributes

See [RFC8011] for details on returning Printer Attributes.

“printer-id” (integer(1:65535)):

The System MUST return this attribute.

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

The System MUST return this attribute.

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

The System MUST return this attribute.

“printer-state” (type1 enum) and“printer-state-reasons” (1setOf type2 keyword) and“printer-is-accepting-jobs” (boolean):

The System MUST return all three of these attributes.

6.4.3 Get-System-Attributes

This REQUIRED operation allows an authorized Operator or Administrator to retrieve some or all of the attributes the target System object.

This operation is semantically equivalent to the GetSystemElements operation defined in [PWG5108.06]. This operation is also semantically analogous the Get-Job-Attributes and Get-Printer-Attributes operations defined in [RFC8011].

If accepted, the System MUST return the requested attributes for the target System object. This operation does not change the state of the System itself.

6.4.3.1 Get-System-Attributes Request

The following groups of attributes are part of a Get-System-Attributes request.

Group 1: Operation Attributes

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

Page 80 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

2352362252

2253

22542255

2256

2257

2258

2259

2260

2261

2262

226322642265

2266

2267

2268

22692270

227122722273

22742275

2276

2277

2278

22792280

237

Page 81: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

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

“system-uri” (uri):

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

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

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

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

The Client MAY supply and the System MUST support this attribute. If this operation attribute is NOT supplied, then the System MUST return all of the System attributes except for “power-[xxx]’” (System power details), “system-configured-printers” and “system-configured-resources”. See sections “power-[xxx]” in section 7.2 System Description Attributes. See also sections “power-[xxx]”, “system-configured-printers” and “system-configured-resources” in section 7.3 System Status Attributes.

6.4.3.2 Get-System-Attributes Response

The following groups of attributes are part of a Get-System-Attributes response.

Group 1: Operation Attributes

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

The System MUST return both of these attributes.

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

The System MAY return one or both of these attributes.

Group 2: Unsupported Attributes

See [RFC8011] for details on returning Unsupported Attributes.

Group 3: System Attributes

See [RFC8011] for details on returning analogous Printer Attributes.

Page 81 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

23823922812282

2283

22842285

228622872288

22892290

2291

2292229322942295229622972298

2299

2300

2301

23022303

2304

23052306

2307

2308

2309

2310

2311

240

Page 82: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

“system-uuid” (uri(45)):

The System MUST return this attribute.

“system-xri-supported” (1setOf collection)

The System MUST return this attribute.

“system-state” (type1 enum) and“system-state-reasons” (1setOf type2 keyword):

The System MUST return both of these attributes.

6.4.4 Get-System-Supported-Values

This REQUIRED operation allows an authorized Operator or Administrator to to request the values that the System allows in the Set-System-Attributes operation for "xxx-supported" attributes.

This operation is semantically analogous to the Get-Printer-Supported-Values operation defined in [RFC3380].

If accepted, the System MUST return the requested attributes for the target System object. This operation does not change the state of the System itself.

6.4.4.1 Get-System-Supported-Values Request

The following groups of attributes are part of a Get-System-Supported-Values request.

Group 1: Operation Attributes

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

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

“system-uri” (uri):

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

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

Page 82 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

2412422312

2313

2314

2315

23162317

2318

2319

2320

232123222323

23242325

23262327

2328

2329

2330

23312332

23332334

2335

23362337

233823392340

243

Page 83: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

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

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

The Client MAY supply and the System MUST support this attribute. If this operation attribute is NOT supplied, then the System MUST return all of the System “xxx-supported”- attributes”.

6.4.4.2 Get-System-Supported-Values Response

The following groups of attributes are part of a Get-System-Supported-Values response.

Group 1: Operation Attributes

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

The System MUST return both of these attributes.

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

The System MAY return one or both of these attributes.

Group 2: Unsupported Attributes

See [RFC8011] for details on returning Unsupported Attributes.

Group 3: System Attributes

See [RFC8011] for details on returning analogous Printer Attributes.

“system-uuid” (uri(45)):

The System MUST return this attribute.

“system-xri-supported” (1setOf collection)

The System MUST return this attribute.

“system-state” (type1 enum) and“system-state-reasons” (1setOf type2 keyword):

The System MUST return both of these attributes.

Page 83 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

24424523412342

2343

234423452346

2347

2348

2349

23502351

2352

23532354

2355

2356

2357

2358

2359

2360

2361

2362

2363

23642365

2366

246

Page 84: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

6.4.5 Pause-All-Printers

This REQUIRED operation allows an authorized Operator or Administrator to pause all configured Printer objects (i.e., Job processing services) on the target System object. If no Printers are configured on the System, then the System MUST return a “status-code” of 'successful-ok'.

This operation is semantically equivalent to the PauseAllServices operation defined in [PWG5108.06]. This operation is also semantically equivalent to a sequence of Pause-Printer operations [RFC8011] to each configured Printer object.

If accepted, the System MUST pause each configured Printer with the “printer-state” set to ‘stopped’ and the ‘paused’ value added to “printer-state-reasons” (unless there is another reason for the Printer to stay in the ‘idle’ or ‘processing’ state, in which case the ‘moving-to-paused’ value is added to “printer-state-reasons”). This operation will change the state of the System itself to ‘stopped’ when all configured Printers have completed pause and moved to the 'stopped' state (with the ‘moving-to-paused’ value removed from their “printer-state-reasons”).

6.4.5.1 Pause-All-Printers Request

The following groups of attributes are part of a Pause-All-Printers request.

Group 1: Operation Attributes

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

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

“system-uri” (uri):

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

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

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

“systemprinter-message-from-operator” (text(127)):

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

Page 84 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

2472482367

2368236923702371

237223732374

2375237623772378237923802381

2382

2383

2384

23852386

23872388

2389

23902391

239223932394

23952396

2397

2398

249

Page 85: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

6.4.5.2 Pause-All-Printers Response

The following groups of attributes are part of a Pause-All-Printers response.

Group 1: Operation Attributes

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

The System MUST return both of these attributes.

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

The System MAY return one or both of these attributes.

Group 2: Unsupported Attributes

See [RFC8011] for details on returning Unsupported Attributes.

Groups 3-N: Printer Attributes

See [RFC8011] for details on returning Printer Attributes.

“printer-id” (integer(1:65535)):

The System MUST return this attribute.

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

The System MUST return this attribute.

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

The System MUST return this attribute.

“printer-state” (type1 enum) and“printer-state-reasons” (1setOf type2 keyword) and“printer-is-accepting-jobs” (boolean):

The System MUST return all three of these attributes.

Group N+1: System Attributes

See [RFC8011] and [RFC3380] for details on returning analogous Printer Attributes.

“system-uuid” (uri(45)):

Page 85 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

2502512399

2400

2401

24022403

2404

24052406

2407

2408

2409

24102411

2412

2413

2414

2415

2416

2417

2418

241924202421

2422

2423

2424

2425

252

Page 86: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

The System MUST return this attribute.

“system-xri-supported” (1setOf collection)

The System MUST return this attribute.

“system-state” (type1 enum) and“system-state-reasons” (1setOf type2 keyword):

The System MUST return both of these attributes.

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

This REQUIRED operation allows an authorized Operator or Administrator to pause all configured Printer objects (i.e., Job processing services) on the target System object after all currently processing Jobs have completed (but prevent new Jobs from starting). If no Printers are configured on the System, then the System MUST return a “status-code” of 'successful-ok'.

This operation is semantically equivalent to the PauseAllServicesAfterCurrentJob operation defined in [PWG5108.06]. This operation is also semantically equivalent to a sequence of Pause-Printer operations [RFC8011] to each configured Printer object.

If accepted, the System MUST pause each configured Printer with the “printer-state” set to ‘stopped’ and the ‘paused’ value added to “printer-state-reasons” (unless there is another reason for the Printer to stay in the ‘idle’ or ‘processing’ state, in which case the ‘moving-to-paused’ value is added to “printer-state-reasons”) after all currently Processing Jobs have completed. This operation will change the state of the System itself to ‘stopped’ when all configured Printers have completed pause and moved to the 'stopped' state (with the ‘moving-to-paused’ value removed from their “printer-state-reasons”).

6.4.6.1 Pause-All-Printers-After-Current-Job Request

The following groups of attributes are part of a Pause-All-Printers-After-Current-Job request.

Group 1: Operation Attributes

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

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

“system-uri” (uri):

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

Page 86 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

2532542426

2427

2428

24292430

2431

2432

24332434243524362437

243824392440

2441244224432444244524462447

2448

24492450

2451

24522453

24542455

2456

24572458

255

Page 87: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

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

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

“systemprinter-message-from-operator” (text(127)):

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

6.4.6.2 Pause-All-Printers-After-Current-Job Response

The following groups of attributes are part of a Pause-All-Printers-After-Current-Job response.

Group 1: Operation Attributes

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

The System MUST return both of these attributes.

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

The System MAY return one or both of these attributes.

Group 2: Unsupported Attributes

See [RFC8011] for details on returning Unsupported Attributes.

Groups 3-N: Printer Attributes

See [RFC8011] for details on returning Printer Attributes.

“printer-id” (integer(1:65535)):

The System MUST return this attribute.

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

The System MUST return this attribute.

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

The System MUST return this attribute.

Page 87 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

256257245924602461

24622463

2464

2465

2466

24672468

2469

24702471

2472

24732474

2475

2476

2477

24782479

2480

2481

2482

2483

2484

2485

2486

258

Page 88: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

“printer-state” (type1 enum) and“printer-state-reasons” (1setOf type2 keyword) and“printer-is-accepting-jobs” (boolean):

The System MUST return all three of these attributes.

Group N+1: System Attributes

See [RFC8011] and [RFC3380] for details on returning analogous Printer Attributes.

“system-uuid” (uri(45)):

The System MUST return this attribute.

“system-xri-supported” (1setOf collection)

The System MUST return this attribute.

“system-state” (type1 enum) and“system-state-reasons” (1setOf type2 keyword):

The System MUST return both of these attributes.

6.4.7 Register-Output-Device

This CONDITIONALLY REQUIRED operation allows an authorized Proxy to register an Output Device with the target System object. Systems that conform to the IPP Shared Infrastructure Extensions [PWG5100.18] MUST support this operation.

The Register-Output-Device operation returns a Printer object of the specified type that accepts Jobs on behalf of the Output Device. How these Printer objects are created or provisioned is implementation-specific.

Access Rights: The authenticated user (see section 9.3 of [RFC8011]) performing this operation MUST be a Proxy of the SystemPrinter object. Otherwise, the SystemInfrastructure Printer MUST reject the operation and return: 'client-error-forbidden', 'client-error-not-authenticated', or 'client-error-not-authorized' as appropriate.

6.4.7.1 Register-Output-Device Request

The following groups of attributes are part of a Register-Output-Device request.

Group 1: Operation Attributes

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

Page 88 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

259260248724882489

2490

2491

2492

2493

2494

2495

2496

24972498

2499

2500

250125022503

250425052506

2507250825092510

2511

2512

2513

25142515

261

Page 89: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

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

“system-uri” (uri):

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

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

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

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

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

"output-device-uuid" (uri(45)):

The Proxy MUST supply this attribute and the Infrastructure Printer MUST support this attribute. It provides the identity of the Output Device for the request.

6.4.7.2 Register-Output-Device Response

The following groups of attributes are part of a Register-Output-Device response.

Group 1: Operation Attributes

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

The System MUST return both of these attributes.

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

The System MAY return one or both of these attributes.

Group 2: Unsupported Attributes

See [RFC8011] for details on returning Unsupported Attributes.

Group 3: Printer Attributes

See [RFC8011] for details on returning Printer Attributes.

Page 89 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

26226325162517

2518

25192520

252125222523

25242525

2526

2527

2528

252925302531

2532

2533

2534

25352536

2537

25382539

2540

2541

2542

2543

2544

264

Page 90: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

“printer-id” (integer(1:65535)):

The System MUST return this attribute.

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

The System MUST return this attribute.

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

The System MUST return this attribute.

“printer-state” (type1 enum) and “printer-state-reasons” (1setOf type2 keyword) and “printer-is-acceptingjobs” (boolean):

The System MUST return all three of these attributes.

6.4.8 Restart-System

This REQUIRED operation allows an authorized Operator or Administrator to restart an entire System with existing firmware or different firmware (from Install-Resource after Create-Resource and Send-Resource-Data). This operation can be used as a cleanup when one more configured Printers have become non-responsive or corrupted, to restore the System to a known state. This operation can be used periodically to accomplish “software rejuvenation” – an approach to help prevent performance degradation and other associated failures related to “software aging” – this proactive technique was identified as a cost-effective solution during research at the AT&T Bell Laboratories on fault-tolerant software in the 1990s

This operation is semantically analogous to the Startup-Printer operation defined in [RFC3998].

If accepted, the System MUST:

(1) Send a Restart-System response to the Client (to confirm acceptance of the operation) that includes “restart-get-interval” (see below);

(2) Shutdown each configured Printer;

(3) Restart the entire System; and

(4) Startup each configured Printer with the “printer-state” set to ‘stopped’ (unless there is another reason for the Printer to stay in the ‘idle’ or ‘processing’ state, in which case the ‘starting’ value is added to “printer-state-reasons”), “printer-is-accepting-

Page 90 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

2652662545

2546

2547

2548

2549

2550

255125522553

2554

2555

2556

255725582559256025612562256325642565

25662567

2568

25692570

2571

2572

257325742575

267

Ira McDonald, 09/10/17,
PWG F2F 08/09/17 – add state diagram? Get help from Mike Sweet
Page 91: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

jobs” set to ‘false’ (i.e., no incoming Jobs accepted), and the ‘paused’ value added to “printer-state-reasons” (i.e., no Job processing output allowed).

This operation will change the “system-state” of the System itself to ‘stopped’ when all Printers have completed shutdown and later startup and moved to the ‘stopped’ state with the ‘starting’ value removed from “printer-state-reasons”.

The Client can later send one or more Set-System-Attributes operations to modify the configuration of the System.

6.4.8.1 Restart-System Request

The following groups of attributes are part of a Restart-System request.

Group 1: Operation Attributes

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

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

“system-uri” (uri):

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

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

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

“system-message-from-operator” (text(127)):

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

6.4.8.2 Restart-System Response

The following groups of attributes are part of a Restart-System response.

Group 1: Operation Attributes

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

The System MUST return both of these attributes.

Page 91 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

26826925762577

257825792580

25812582

2583

2584

2585

25862587

25882589

2590

25912592

259325942595

25962597

2598

2599

2600

2601

2602

26032604

2605

270

Page 92: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

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

The System MAY return one or both of these attributes.

“restart-get-interval” (integer(0:MAX)):

The System MUST return this attribute which contains the number of seconds that the Client should SHOULD wait before trying a Get-System-Attributes operation to confirm the completion of the System restart.

Group 2: Unsupported Attributes

See [RFC8011] for details on returning Unsupported Attributes.

Group 3: System Attributes

See [RFC8011] and [RFC3380] for details on returning analogous Printer Attributes.

“system-uuid” (uri(45)):

The System MUST return this attribute.

“system-xri-supported” (1setOf collection)

The System MUST return this attribute.

“system-state” (type1 enum) and“system-state-reasons” (1setOf type2 keyword):

The System MUST return both of these attributes.

6.4.9 Resume-All-Printers

This REQUIRED operation allows an authorized Operator or Administrator to resume all configured Printer objects (i.e., Job processing services) on the target System object. If no Printers are configured on the System, then the System MUST return a “status-code” of 'successful-ok'.

This operation is semantically equivalent to the ResumeAllServices operation defined in [PWG5108.06]. This operation is also semantically equivalent to a sequence of Resume-Printer operations [RFC8011] to each configured Printer object.

If accepted, the System MUST resume each configured Printer with the “printer-state” set to ‘idle’ and the ‘paused’ value removed from “printer-state-reasons” (unless there is another reason for the Printer to stay in the ‘stopped’ state, in which case the ‘resuming’ value is added to “printer-state-reasons”) . This operation will change the “system-state” of

Page 92 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

27127226062607

2608

2609

261026112612

2613

2614

2615

2616

2617

2618

2619

2620

26212622

2623

2624

2625262626272628

262926302631

2632263326342635

273

Page 93: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

the System itself to ‘idle’ when all configured Printers have completed resume and moved to the ‘idle’ state (with the ‘resuming’ value removed from “printer-state-reasons”).

6.4.9.1 Resume-All-Printers Request

The following groups of attributes are part of a Resume-All-Printers request.

Group 1: Operation Attributes

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

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

“system-uri” (uri):

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

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

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

“systemprinter-message-from-operator” (text(127)):

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

6.4.9.2 Resume-All-Printers Response

The following groups of attributes are part of a Resume-All-Printers response.

Group 1: Operation Attributes

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

The System MUST return both of these attributes.

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

The System MAY return one or both of these attributes.

Group 2: Unsupported Attributes

Page 93 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

27427526362637

2638

2639

2640

26412642

26432644

2645

26462647

264826492650

26512652

2653

2654

2655

2656

2657

26582659

2660

26612662

2663

2664

276

Page 94: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

See [RFC8011] for details on returning Unsupported Attributes.

Groups 3-N: Printer Attributes

See [RFC8011] for details on returning Printer Attributes.

“printer-id” (integer(1:65535)):

The System MUST return this attribute.

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

The System MUST return this attribute.

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

The System MUST return this attribute.

“printer-state” (type1 enum) and“printer-state-reasons” (1setOf type2 keyword) and“printer-is-accepting-jobs” (boolean):

The System MUST return all three of these attributes.

Group N+1: System Attributes

See [RFC8011] and [RFC3380] for details on returning analogous Printer Attributes.

“system-uuid” (uri(45)):

The System MUST return this attribute.

“system-xri-supported” (1setOf collection)

The System MUST return this attribute.

“system-state” (type1 enum) and“system-state-reasons” (1setOf type2 keyword):

The System MUST return both of these attributes.

6.4.10 Set-System-Attributes

This REQUIRED operation allows an authorized Operator or Administrator to set the values of System Description attributes listed in “system-settable-attributes-supported” (see section 7.2). For Client support for localization see “system-strings-languages-supported” and “system-strings-uri” in section 7.2. If one or more of the supplied System Description attributes and/or values are not actually settable, then the System MUST reject

Page 94 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

2772782665

26662667

2668

2669

2670

2671

2672

2673

2674

267526762677

2678

2679

2680

2681

2682

2683

2684

26852686

2687

2688

26892690269126922693

279

Page 95: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

the entire request, indicating which attributes and/or values cannot be set, and return a “status-code” of 'client-error-not-possible'. See additional validation rules in section 4.1 Set-Printer-Attributes of [RFC3380].

This operation is semantically equivalent to the SetSystemElements operation defined in [PWG5108.06] and semantically analogous to the Set-Printer-Attributes operation defined in [RFC3380].

If accepted, the System MUST set every supplied System Description attribute to exactly the supplied value. The System MUST NOT partially set a subset of the supplied attributes. The System MUST accept this operation when the supplied attributes are valid and the value of “system-state” (see section 7.3) is either ‘idle’ or ‘stopped’. The System SHOULD accept this operation when the supplied attributes are valid and the value of “system-state” (see section 7.3) is ‘processing’. This operation does not change the “system-state” of the System itself.

6.4.10.1 Set-System-Attributes Request

The following groups of attributes are part of a Set-System-Attributes request.

Group 1: Operation Attributes

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

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

“system-uri” (uri):

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

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

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

Group 2: System Attributes

The IPP Client MUST supply a set of System attributes with one or more values (including explicitly allowed out-of-band values) as defined in [RFC8011] and section 7.2 of this document.

See [RFC3380] for details on setting analogous Printer Attributes.

Page 95 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

280281269426952696

269726982699

2700270127022703270427052706

2707

2708

2709

27102711

27122713

2714

27152716

271727182719

27202721

2722

272327242725

2726

282

Page 96: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

6.4.10.2 Set-System-Attributes Response

The following groups of attributes are part of a Set-System-Attributes response.

Group 1: Operation Attributes

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

The System MUST return both of these attributes.

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

The System MAY return one or both of these attributes.

Group 2: Unsupported Attributes

See [RFC8011] for details on returning Unsupported Attributes.

Group 3: System Attributes

See [RFC8011] and [RFC3380] for details on returning analogous Printer Attributes.

“system-uuid” (uri(45)):

The System MUST return this attribute.

“system-xri-supported” (1setOf collection)

The System MUST return this attribute.

“system-state” (type1 enum) and“system-state-reasons” (1setOf type2 keyword):

The System MUST return both of these attributes.

6.4.11 Shutdown-All-Printers

This REQUIRED operation allows an authorized Operator or Administrator to shutdown all configured Printer objects (i.e., Job processing services) on the target System object. If no Printers are configured on the System, then the System MUST return a “status-code” of 'successful-ok'.

This operation is semantically equivalent to the ShutdownAllServices operation defined in [PWG5108.06]. This operation is also semantically equivalent to a sequence of Shutdown-Printer operations [RFC3998] to each configured Printer object (except for the resulting “printer-state” of ‘stopped’ rather than ‘idle’).

Page 96 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

2832842727

2728

2729

27302731

2732

27332734

2735

2736

2737

2738

2739

2740

2741

2742

2743

27442745

2746

2747

2748274927502751

2752275327542755

285

Page 97: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

If accepted, the System MUST shutdown each configured Printer that has not already been shutdown with the “printer-state” set to ‘stopped’ (unless there is another reason for the Printer to stay in the ‘idle’ or ‘processing’ state, in which case the ‘stopping’ value is added to “printer-state-reasons”) and the ‘shutdown’ value added to “printer-state-reasons”. This operation will change the “system-state” of the System itself to ‘stopped’ when configured Printers have completed shutdown and moved to the ‘stopped’ state with the ‘stopping’ value removed from “printer-state-reasons”.

The Client can later send a Startup-All-Printers operation (preferred) or a sequence of Startup-One-Printer operations (preferred) or Startup-Printer operations [RFC3998] to each Printer to start up all of the configured Printers.

6.4.11.1 Shutdown-All-Printers Request

The following groups of attributes are part of a Shutdown-All-Printers request.

Group 1: Operation Attributes

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

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

“system-uri” (uri):

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

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

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

“systemprinter-message-from-operator” (text(127)):

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

6.4.11.2 Shutdown-All-Printers Response

The following groups of attributes are part of a Shutdown-All-Printers response.

Group 1: Operation Attributes

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

Page 97 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

2862872756275727582759276027612762

276327642765

2766

2767

2768

27692770

27712772

2773

27742775

277627772778

27792780

2781

2782

2783

2784

2785

27862787

288

Page 98: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

The System MUST return both of these attributes.

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

The System MAY return one or both of these attributes.

Group 2: Unsupported Attributes

See [RFC8011] for details on returning Unsupported Attributes.

Groups 3-N: Printer Attributes

See [RFC8011] for details on returning Printer Attributes.

“printer-id” (integer(1:65535)):

The System MUST return this attribute.

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

The System MUST return this attribute.

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

The System MUST return this attribute.

“printer-state” (type1 enum) and“printer-state-reasons” (1setOf type2 keyword) and“printer-is-accepting-jobs” (boolean):

The System MUST return all three of these attributes.

Group N+1: System Attributes

See [RFC8011] and [RFC3380] for details on returning analogous Printer Attributes.

“system-uuid” (uri(45)):

The System MUST return this attribute.

“system-xri-supported” (1setOf collection)

The System MUST return this attribute.

“system-state” (type1 enum) and“system-state-reasons” (1setOf type2 keyword):

Page 98 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

2892902788

27892790

2791

2792

2793

27942795

2796

2797

2798

2799

2800

2801

2802

280328042805

2806

2807

2808

2809

2810

2811

2812

28132814

291

Page 99: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

The System MUST return both of these attributes.

6.4.12 Startup-All-Printers

This REQUIRED operation allows an authorized Operator or Administrator to startup or restart all configured Printer objects (i.e., Job processing services) on the target System object. If no Printers are configured on the System, then the System MUST return a “status-code” of 'successful-ok'.

This operation is semantically equivalent to the StartupAllServices operation defined in [PWG5108.06]. This operation is also semantically equivalent to a sequence of Startup-One-Printer operations for each configured Printer object.

If accepted, the System MUST startup or restart each configured Printer with the “printer-state” set to ‘stopped’ (unless there is another reason for the Printer to stay in the ‘idle’ or ‘processing’ state, in which case the ‘starting’ value is added to “printer-state-reasons”), “printer-is-accepting-jobs” set to ‘false’ (i.e., no incoming Jobs accepted), and the ‘paused’ value added to “printer-state-reasons” (i.e., no Job processing output allowed). This operation will change the “system-state” of the System itself to ‘stopped’ when all Printers have completed startup and moved to the ‘stopped’ state with the ‘starting’ value removed from “printer-state-reasons”.

The Client can later send one or more Set-Printer-Attributes operations to modify the configuration of each Printer, followed by Resume-Printer (i.e., remove ‘paused’ from “printer-state-reasons”) and Enable-Printer (i.e., change “printer-is-accepting-jobs” to ‘true’).

6.4.12.1 Startup-All-Printers Request

The following groups of attributes are part of a Startup-All-Printers request.

Group 1: Operation Attributes

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

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

“system-uri” (uri):

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

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

Page 99 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

2922932815

2816

2817281828192820

282128222823

28242825282628272828282928302831

2832283328342835

2836

2837

2838

28392840

28412842

2843

28442845

284628472848

294

Page 100: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

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

“systemprinter-message-from-operator” (text(127)):

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

6.4.12.2 Startup-All-Printers Response

The following groups of attributes are part of a Startup-All-Printers response.

Group 1: Operation Attributes

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

The System MUST return both of these attributes.

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

The System MAY return one or both of these attributes.

Group 2: Unsupported Attributes

See [RFC8011] for details on returning Unsupported Attributes.

Groups 3-N: Printer Attributes

See [RFC8011] for details on returning Printer Attributes.

“printer-id” (integer(1:65535)):

The System MUST return this attribute.

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

The System MUST return this attribute.

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

The System MUST return this attribute.

“printer-state” (type1 enum) and“printer-state-reasons” (1setOf type2 keyword) and“printer-is-accepting-jobs” (boolean):

The System MUST return all three of these attributes.

Page 100 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

29529628492850

2851

2852

2853

2854

2855

28562857

2858

28592860

2861

2862

2863

28642865

2866

2867

2868

2869

2870

2871

2872

287328742875

2876

297

Page 101: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

Group N+1: System Attributes

See [RFC8011] and [RFC3380] for details on returning analogous Printer Attributes.

“system-uuid” (uri(45)):

The System MUST return this attribute.

“system-xri-supported” (1setOf collection)

The System MUST return this attribute.

“system-state” (type1 enum) and“system-state-reasons” (1setOf type2 keyword):

The System MUST return both of these attributes.

7. IPP Attributes

7.1 IPP Operation Attributes

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

7.1.1 printer-id (integer(1:65535))

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

7.1.2 printer-ids (1setOf (integer(1:65535)))

This operation attribute specifies the list of “printer-id” values for target Printer objects as used in Get-Printers and some other Printer operations defined in section 6 and is semantically equivalent a list of the ServiceSummary element ID defined in [PWG5108.06] and semantically analogous a list of the “job-id” attribute defined in [RFC8011]. See “printer-id” in section 7.5 Printer Status Attributes.

7.1.3 printer-geo-location (uri)

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

Page 101 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

2982992877

2878

2879

2880

2881

2882

28832884

2885

2886

2887

28882889

2890

28912892289328942895

2896

28972898289929002901

2902

290329042905

300

Page 102: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

7.1.4 printer-location (text(127))

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

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

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

7.1.6 requesting-user-vcard (1setOf text(MAX))

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

7.1.7 resource-format (mimeMediaType)

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

7.1.8 resource-format-accepted (1setOf mimeMediaType)

This operation attribute specifies the accepted formats for a Resource as used in Create-Resource response and is semantically analogous to the ResourceFormat element defined in [PWG5108.03] and semantically analogous to the “document-format” attribute defined in [RFC8011]. See “resource-format” in section 7.7 Resource Status Attributes.

7.1.9 resource-formats (1setOf (mimeMediaType))

This operation attribute specifies a filter for the applicable Resources as used in Get-Resources defined in section 6 and is semantically analogous to the ResourceFormat element defined in [PWG5108.03] and semantically analogous to the “document-format” attribute defined in [RFC8011]. See “resource-format” in section 7.7 Resource Status Attributes.

Page 102 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

3013022906

290729082909

2910

2911291229132914

2915

291629172918291929202921292229232924

2925

29262927292829292930

2931

2932293329342935

2936

29372938293929402941

303

Page 103: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

7.1.10 resource-id (integer(1:MAX))

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

7.1.11 resource-ids (1setOf integer(1:MAX))

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

7.1.12 resource-k-octets (integer(0:MAX))

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

7.1.13 resource-signature (1setOf octetString)

This operation attribute specifies an out-of-band digital signature for Resource data as used in Send-Resource-Data defined in section 6.2.5, when the particular Resource data format does not include an embedded digital signature.

A Client MAY also supply this operation attribute with an out-of-band digital signature to request override of an embedded digital signature in the Resource data (e.g., when the embedded signature has been invalidated due to compromised keys, compromised algorithms, compromised CAs, etc.). An IPP System SHOULD support this method of signature override for long-term stability.

See section 12 Security Considerations for details of digital signature handling in IPP System Service.

7.1.14 resource-states (1setOf (type1 enum))

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

Page 103 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

3043052942

29432944294529462947

2948

29492950295129522953

2954

2955295629572958

2959

296029612962

29632964296529662967

29682969

2970

29712972297329742975

306

Page 104: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

7.1.15 resource-type (type2 keyword)

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

7.1.16 resource-types (1setOf (type2 keyword))

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

7.1.17 restart-get-interval (integer(0:MAX)

This operation attribute specifies and interval in seconds that the Client SHOULD wait before querying the System with a Get-System-Attributes operation to confirm completion of the restart requested by a Restart-System operation and is semantically analogous to the “notify-get-interval” attribute defined in [RFC3996].

7.1.18 system-uri (uri)

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

7.1.19 which-printers (type2 keyword):

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

Standard keyword values for this attribute include:

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

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

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

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

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

Page 104 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

3073082976

2977297829792980

2981

2982298329842985

2986

2987298829892990

2991

2992299329942995

2996

299729982999

3000

30013002

3003

3004

3005

3006

309

Page 105: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

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

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

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

7.2 System Description Attributes

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

7.2.1 Power States and Policies

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

7.2.1.1 IEEE 1621 Power Modes

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

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

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

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

7.2.1.2 DMTF Stable Power States

This specification imports (and renames for clarity and common usage) the normative definitions and semantics of the following DMTF CIM [DSP1027] stable power states. All

Page 105 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

31031130073008

30093010

30113012

3013

3014301530163017

3018

30193020302130223023

3024

3025302630273028

302930303031

303230333034

303530363037

3038

30393040

312

Page 106: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

other DMTF CIM power states are ephemeral (orderly shutdowns and power resets) and will eventually result in one of the stable power states defined below.

‘hibernate’: DMTF “Hibernate (Off-Soft)” (7) and ACPI S4. The stable “Off Mode” power state where all kernel and application programs and data have been saved (e.g., to a hard disk) such that a transition to On allows recovery and continued processing without any loss of jobs or data. Limited auxiliary power is consumed (e.g., console lights), no network interfaces are operational, and human intervention is required to power up the system.

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

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

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

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

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

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

Page 106 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

31331430413042

304330443045304630473048

3049305030513052

3053305430553056

305730583059

3060306130623063

306430653066306730683069

30703071307230733074307530763077

315

Page 107: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

7.2.1.3 DMTF Ephemeral Power States

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

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

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

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

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

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

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

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

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

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

Page 107 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

3163173078

30793080308130823083

308430853086

308730883089

309030913092

3093309430953096

3097309830993100

3101310231033104

310531063107

3108310931103111

311231133114

318

Page 108: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

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

7.2.1.4 Power Policies

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Page 108 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

3193203115311631173118

3119

31203121312231233124

31253126312731283129

313031313132

31333134

3135

3136

3137

3138

31393140

3141

3142

3143

3144

314531463147

321

Page 109: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

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

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

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

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

9) Job processing resumes normally on all Printers.

7.2.2 charset-configured (charset)

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

7.2.3 charset-supported (1setOf charset)

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

7.2.4 ipp-features-supported (1setOf type2 keyword)

This REQUIRED System attribute lists the IPP extension features that are supported by the System and is semantically analogous to the “ipp-features-supported” Printer attribute defined in [PWG5100.13]. Standard keyword values are listed in the IANA IPP Registry. The value 'none' MUST be reported if no extension features are supported and MUST NOT be reported otherwise.

7.2.5 ipp-versions-supported (1setOf type2 keyword)

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

7.2.6 natural-language-configured (naturalLanguage)

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

Page 109 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

32232331483149

31503151

31523153

31543155

3156

3157

31583159316031613162

3163

3164316531663167

3168

31693170317131723173

3174

317531763177

3178

317931803181

324

Page 110: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

7.2.7 generated-natural-language-supported (1setOf naturalLanguage)

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

Note: The natural language(s) supported for System-generated values depends on implementation and/or configuration. However, unlike charsets, System objects MUST accept requests with any natural language or any Natural Language Override whether or not the natural language is supported for System-generated attribute values.

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

7.2.8 operations-supported (1setOf type2 enum)

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

7.2.9 power-calendar-policy-col (1setOf collection)

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

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

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

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

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

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

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

7.2.9.1 calendar-id (integer(1:MAX))

This REQUIRED member attribute contains the unique key of this calendar policy and is semantically equivalent to the CalendarID element in the Power Calendar group defined in [PWG5106.4].

Page 110 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

3253263182

3183318431853186

3187318831893190

31913192

3193

319431953196

3197

3198319932003201

32023203

3204

3205

3206

3207

32083209

3210

321132123213

327

Page 111: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

7.2.9.2 day-of-month (integer(1:31))

This REQUIRED member attribute specifies the trigger day of the month for this calendar policy and is semantically equivalent to the CalendarDay element in the Power Calendar group defined in [PWG5106.4]. The value ‘1’ represents the first day of the month.

See “system-current-time” defined above for the relevant System date, time, and time zone values.

7.2.9.3 day-of-week (integer(1:7))

This REQUIRED member attribute specifies the trigger day of the week for this calendar policy and is semantically equivalent to the CalendarDayOfWeek element in the Power Calendar group defined in [PWG5106.4]. The value ‘1’ represents Sunday.

See “system-current-time” defined above for the relevant System date, time, and time zone values.

7.2.9.4 hour (integer(0:23))

This REQUIRED member attribute specifies the trigger hour for this calendar policy and is semantically equivalent to the CalendarHour element in the Power Calendar group defined in [PWG5106.4]. The value ‘0’ represents the first hour of the day (i.e., 12:00-12:59am). Midnight (i.e., 12:00am) is specified by a value of zero for “hour” and a value of zero for “minute”.

See “system-current-time” defined above for the relevant System date, time, and time zone values.

Note: Due to local time zone changes (summer time to standard time or vice versa), it’s possible that a given hour will not occur in a given month.

7.2.9.5 minute (integer(0:59))

This REQUIRED member attribute specifies the trigger minute for this calendar policy and is semantically equivalent to the CalendarMinute element in the Power Calendar group defined in [PWG5106.4]. The value ‘0’ represents the first minute of the hour (e.g., 7:00am).

See “system-current-time” defined above for the relevant System date, time, and time zone values.

7.2.9.6 month (integer(1:12))

This REQUIRED member attribute specifies the trigger month for this calendar policy and is semantically equivalent to the CalendarMonth element in the Power Calendar group defined in [PWG5106.4]. The value of ‘1’ represents January.

Page 111 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

3283293214

321532163217

32183219

3220

322132223223

32243225

3226

32273228322932303231

32323233

32343235

3236

3237323832393240

32413242

3243

324432453246

330

Page 112: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

See “system-current-time” defined above for the relevant System date, time, and time zone values.

7.2.9.7 request-power-state (type1 keyword)

This REQUIRED member attribute specifies the requested stable or ephemeral (transitional) power state for this calendar policy and is semantically equivalent to the RequestPowerState element in the Power Calendar group defined in [PWG5106.4].

Standard values and constraints on vendor extension values are defined in section 7.2.1 Power States and Policies.

7.2.9.8 run-once (boolean)

This REQUIRED member attribute specifies whether this calendar policy should be run once (single execution) or repeatedly (multiple executions) and is semantically equivalent to the CalendarRunOnce element in the Power Calendar group defined in [PWG5106.4].

7.2.10 power-event-policy-col (1setOf collection)

This OPTIONAL System attribute lists the configured System event-based power state change policies and is semantically equivalent to the Power Event group defined in [PWG5106.4].

For example, an automated System power state transition to ‘standby’ upon every ‘jam’ condition could be scheduled in “power-event-policy-col” as follows:

event-id=11 # arbitrary unique value for event policy

event-name=’jam’ # name of event

request-power-state=’standby’ # target power state

7.2.10.1 event-id (integer(1:MAX))

This REQUIRED member attribute contains the unique key of this event policy and is semantically equivalent to the EventID element in the Power Event group defined in [PWG5106.4].

7.2.10.2 event-name (name(127))

This REQUIRED member attribute specifies the trigger event name of this event policy and is semantically equivalent to the EventName element in the Power Event group defined in [PWG5106.4].

Event names MUST be either: (a) the exact case-sensitive label (starting with a lowercase character) of an enumerated value in the PrtAlertCodeTC textual convention in the IANA Printer MIB [IANAPRT] (e.g., ‘jam’); or (b) a case-sensitive vendor event name (starting

Page 112 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

33133232473248

3249

325032513252

32533254

3255

325632573258

3259

326032613262

32633264

3265

3266

3267

3268

326932703271

3272

327332743275

327632773278

333

Page 113: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

with an uppercase character, e.g., ‘ExamplePowerEvent’). Event names MUST be specified in US-ASCII [ISO646] (for interoperability).

7.2.10.3 request-power-state (type1 keyword)

This REQUIRED member attribute specifies the requested stable or ephemeral (transitional) power state for this event policy and is semantically equivalent to the RequestPowerState element in the Power Event group defined in [PWG5106.4].

Standard values and constraints on vendor extension values are defined in section 7.2.1 Power States and Policies.

7.2.11 power-timeout-policy-col (1setOf collection)

This RECOMMENDED System attribute lists the configured System timeout-based power state change policies and is semantically equivalent to the Power Timeout group defined in [PWG5106.4].

For example, an automated System power state transition to ‘standby’ upon 5 minutes of inactivity in ‘on’ power state could be scheduled in “power-timeout-policy-col” as follows:

request-power-state=’standby’ # target power state

start-power-state=’on’ # starting power state

timeout-id=23 # arbitrary unique value for timeout policy

timeout-predicate=’inactivity’ # predicate of system inactivity

timeout-seconds=300 # duration before transition to target power state

7.2.11.1 request-power-state (type1 keyword)

This REQUIRED member attribute specifies the requested stable or ephemeral (transitional) power state for this timeout policy and is semantically equivalent to the RequestPowerState element in the Power Timeout group defined in [PWG5106.4].

Standard values and constraints on vendor extension values are defined in section 7.2.1 Power States and Policies.

7.2.11.2 start-power-state (type1 keyword)

This REQUIRED member attribute specifies the trigger starting stable power state for this timeout policy and is semantically equivalent to the StartPowerState element in the Power Timeout group defined in [PWG5106.4].Note: Ephemeral (transitional) power states cannot be specified as triggers for timeout policies.

Page 113 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

33433532793280

3281

328232833284

32853286

3287

328832893290

32913292

3293

3294

3295

3296

3297

3298

329933003301

33023303

3304

3305330633073308

336

Page 114: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

Standard values and constraints on vendor extension values for stable power states are defined in section 7.2.1 Power States and Policies.

7.2.11.3 timeout-id (integer(1:MAX))

This REQUIRED member attribute contains the unique key of this timeout policy and is semantically equivalent to the TimeoutID element in the Power Timeout group defined in [PWG5106.4].

7.2.11.4 timeout-predicate (type1 keyword)

This REQUIRED member attribute specifies the trigger predicate (i.e., pre-condition) for this timeout policy and is semantically equivalent to the TimeoutPredicate element in the Power Timeout group defined in [PWG5106.4].

The standard keyword values for this attribute are:

‘activity’ (i.e., incoming Job, console input, etc.)

‘inactivity’ (i.e., no incoming, queued, or processing Jobs, console input, etc.)

‘none’

7.2.11.5 timeout-seconds (integer(0:MAX))

This REQUIRED member attribute specifies the trigger timeout interval in seconds (or zero for an immediate trigger controlled by the other trigger member attributes) for this timeout policy and is semantically equivalent to the TimeoutSeconds element in the Power Timeout group defined in [PWG5106.4].

7.2.12 printer-creation-attributes-supported (1setOf keyword)

This REQUIRED System attribute lists Printer Description attributes supported for the Create-Printer operation and is semantically analogous to the “job-creation-attributes-supported” Printer Description attribute defined in [PWG5100.11].

7.2.13 resource-format-supported (1setOf mimeMediaType)

This REQUIRED System attribute lists Resource formats supported for Send-Resource-Data operations and is semantically analogous to the “document-format-supported” attribute defined in [RFC8011].

7.2.14 resource-type-supported (1setOf type2 keyword)

This REQUIRED System attribute lists Resource types supported for Create-Resource and Send-Resource-Data operations and is semantically analogous to the “document-format-supported” attribute defined in [RFC8011].

Page 114 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

33733833093310

3311

331233133314

3315

331633173318

3319

3320

3321

3322

3323

3324332533263327

3328

332933303331

3332

333333343335

3336

333733383339

339

Page 115: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

7.2.15 resource-settable-attributes-supported (1setOf keyword)

This REQUIRED System attribute lists Resource Description attributes supported for READ-WRITE access and can be configured by an Operator or Administrator. See “system-strings-languages-supported” and “system-strings-uri” below for Client localization support.

7.2.16 system-current-time (dateTime)

This REQUIRED System attribute specifies the current date and time for the System and is semantically equivalent to the CurrentTime element defined in [PWG5108.06].

7.2.17 system-default-printer-id (integer (1:65535) | no-value)

This REQUIRED System attribute identifies the unique identifier of the default Print Service configured by the Operator, Administrator, or manufacturer (used by the End User operation Get-Printer-Attributes defined in this specification) and is semantically analogous to the “printer-uri-supported” and “job-printer-uri” attributes defined in [RFC8011]. When a System has no configured Print Services, that System MUST return the ‘no-value’ out-of-band value defined in [RFC8011] for “system-default-printer-id”. For a related use case, see section 3.2.5 Bootstrap Client Access to Default Print Service.

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

7.2.18 system-device-id (text(MAX))

This REQUIRED System attribute specifies the IEEE 1284 Device ID of the overall System as defined in [IEEE1284] and further refined in [PWG5107.2] and is semantically analogous to the "printer-device-id" Printer attribute defined in [PWG5107.2.

7.2.19 system-geo-location (uri | unknown)

This REQUIRED System attribute specifies the System geographic location using the “geo:” URI scheme [RFC5870] and is semantically analogous to the "printer-geo-location" Printer attribute defined in [PWG5100.13]. When the location is unknown, Systems MUST return the ‘unknown’ out-of-band value defined in [RFC8011]. Systems MUST allow the Operator or Administrator to set the geographic location manually.

7.2.20 system-info (text(127))

This REQUIRED System attribute specifies System descriptive information, e.g., "This System can be used for printing color transparencies for HR presentations,” and is semantically analogous to the "printer-info" Printer attribute defined in [RFC8011].

Page 115 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

3403413340

3341334233433344

3345

33463347

3348

3349335033513352335333543355

33563357

3358

335933603361

3362

33633364336533663367

3368

336933703371

342

Page 116: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

7.2.21 system-location (text(127))

This REQUIRED System attribute identifies the System location, e.g., "This System is in Room 123A, second floor of building XYZ," and is semantically analogous to the "printer-location" Printer attribute defined in [RFC8011].

7.2.22 system-mandatory-printer-attributes (1setOf type2 keyword)

This REQUIRED System attribute identifies the mandatory-to-supply Printer Description attributes for a Create-Printer operation on this System and is semantically analogous to the “printer-mandatory-job-attributes” Printer Description attribute defined in [PWG5100.13]. This REQUIRED System attribute lists the minimum Printer and operation attributes that are required for a successful Create-Printer operation. The System MUST include in this attribute the values 'printer-name' and 'printer-xri-supported' and SHOULD include the values in Table 9 below.

Table 9 – Recommended-to-Supply Printer Creation Attributes

IPP Attribute Name Referencecharset-configured [RFC8011]document-format-default [RFC8011]multiple-document-jobs-supported [RFC8011]natural-language-configured [RFC8011]pdl-override-supported [RFC8011]printer-info [RFC8011]printer-location [RFC8011]printer-make-and-model [RFC8011]

7.2.23 system-make-and-model (text(127))

This REQUIRED System attribute identifies the System make and model and is semantically analogous to the "printer-make-and-model" Printer attribute defined in [RFC8011]. The manufacturer can initially populate this attribute.

7.2.24 system-message-from-operator (text(127))

This OPTIONAL System attribute provides a message from an Operator, Administrator, or "intelligent" process to indicate the reasons for modification or other System management action and is semantically analogous to the "printer-message-from-operator" Printer attribute defined in [RFC8011].

7.2.25 system-name (name(127))

This REQUIRED System attribute contains the System name and is semantically analogous to the "printer-name" Printer attribute defined in [RFC8011].

7.2.26 system-owner-col (collection)

This REQUIRED System attribute identifies the System Owner.

Page 116 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

3433443372

337333743375

3376

3377337833793380338133823383

3384

3385

338633873388

3389

3390339133923393

3394

33953396

3397

3398

345

Page 117: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

7.2.26.1 owner-uri (uri)

This REQUIRED member attribute contains a System Owner URI, e.g., “mailto:[email protected],” and is semantically analogous to the Service object’s OwnerURI defined in [PWG5108.01]. If specified in a Set-System-Attributes operation, then the “owner-vcard” member attribute MUST also be specified (to preserve consistency).

7.2.26.2 owner-vcard (1setOf text(1023))

This REQUIRED member attribute contains a System Owner vCard [RFC6350] and is semantically analogous to the Service object’s OwnerVCard defined in [PWG5108.01]. If specified in a Set-System-Attributes operation, then the “owner-uri” member attribute MUST also be specified (to preserve consistency).

7.2.27 system-settable-attributes-supported (1setOf keyword)

This REQUIRED System attribute lists System Description attributes supported for READ-WRITE access and can be configured by an Operator or Administrator. See “system-strings-languages-supported” and “system-strings-uri” below for Client localization support.

7.2.28 system-strings-languages-supported (1setOf naturalLanguage)

This RECOMMENDED System attribute lists natural languages supported for the “system-strings-uri” System attribute and is semantically analogous to the “printer-strings-languages-supported” Printer attribute defined in [PWG5100.13].

This attribute MUST be supported if the "system-strings-uri" attribute is supported.

7.2.29 system-strings-uri (uri | no-value)

This RECOMMENDED System attribute provides a "text/strings" message catalog file using "http:" or "https:" URIs that SHOULD be System-resident so that Client interaction with the System does not require access to external networks and is semantically analogous to the “printer-strings-uri” Printer attribute defined in [PWG5100.13]. Systems SHOULD provide localizations for all supported System attributes, keywords, and enums, so that a Client may present a consistent user interface to the User.

This attribute MUST be supported if the "system-strings-uri" attribute is supported.

7.2.30 system-xri-supported (1setOf collection)

This REQUIRED System attribute lists supported XRI (URI, authentication, and security tuples) for the System and is semantically analogous to the "printer-xri-supported" Printer attribute defined in [RFC3380] and semantically analogous to Service object’s XriSupported defined in [PWG5108.01].

Page 117 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

3463473399

34003401340234033404

3405

3406340734083409

3410

341134123413

3414

341534163417

3418

3419

3420342134223423342434253426

3427

3428

3429343034313432

348

Page 118: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

7.2.30.1 xri-uri (uri)

This REQUIRED member attribute specifies an “ipp:” [RFC3510] or “ipps:” [RFC7472] URI for this System and is semantically analogous to a value of the “xri-uri” member attribute defined in [RFC3380].

7.2.30.2 xri-authentication (type2 keyword)

This REQUIRED member attribute specifies the IPP Client Authentication mechanism associated with the corresponding value of “xri-uri” above and is semantically analogous to a value of the “xri-authentication” member attribute defined in [RFC3380]. The original standard values for this attribute are defined in [RFC8011] and extension values are registered in the IANA IPP Registry [IANAIPP].

7.2.30.3 xri-security (type2 keyword)

This REQUIRED member attribute specifies the IPP security mechanism associated with the corresponding value of “xri-uri” above and is semantically analogous to a value of the “xri-security” member attribute defined in [RFC3380]. The original standard values for this attribute are defined in [RFC8011] and extension values are registered in the IANA IPP Registry [IANAIPP].

Page 118 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

3493503433

343434353436

3437

34383439344034413442

3443

34443445344634473448

351

Page 119: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

7.3 System Status Attributes

All of the System Status attributes are READ-ONLY and cannot be changed directly by the Set-System-Attributes operation.

7.3.1 power-log-col (1setOf collection)

This RECOMMENDED System attribute lists System power log entries (for events) and is semantically equivalent to the Power Log group defined in [PWG5106.4].

Systems SHOULD minimize the number of power log entries in this attribute for reliability. Systems MUST record all final stable power state transitions in this attribute for every sequence invoked by an ephemeral requested power state such as ‘reset-nmi’. Systems MAY omit intermediate state transitions invoked by such ephemeral requested states as ‘reset-nmi’.

7.3.1.1 log-id (integer(1:MAX))

This REQUIRED member attribute contains the unique key of this power log entry and is semantically equivalent to the LogID element in the Power Log group defined in [PWG5106.4].

7.3.1.2 power-state (type1 keyword)

This REQUIRED member attribute identifies the recorded stable or ephemeral (transitional) power state for this power log entry and is semantically equivalent to the PowerState element in the Power Log group defined in [PWG5106.4].

Standard values and constraints on vendor extension values are defined in section 7.2.1 Power States and Policies.

7.3.1.3 power-state-date-time (dateTime)

This REQUIRED member attribute identifies the date and time of transition into the recorded power state for this power log entry and is semantically equivalent to the PowerStateDateAndTime element in the Power Log group defined in [PWG5106.4].

7.3.1.4 power-state-message (text (255))

This OPTIONAL member attribute contains a human-readable string in UTF-8 [RFC3629] that describes, explains, or qualifies the logged power state and is semantically equivalent to the PowerStateMessage element in the Power Log group defined in [PWG5106.4]. For example, "standby - System is shutting down by user request (2W)" when transitioning to final 'off-soft' power state.

Page 119 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

352353

3449

34503451

3452

34533454

34553456345734583459

3460

346134623463

3464

346534663467

34683469

3470

347134723473

3474

34753476347734783479

354

Page 120: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

Usage: This attribute: (a) MUST identify the power state; (b) SHOULD identify the method of entry to the power state, e.g., “from timeout trigger” or “from user request”; (c) SHOULD identify the nominal power consumption, e.g., “(34 watts)”; and (d) MAY include any other power-related information, e.g., “can accept jobs” or “can process jobs”.

7.3.2 power-state-capabilities-col (1setOf collection)

This OPTIONAL System attribute lists System supported power capabilities for each stable power state and is semantically equivalent to the Power Support group defined in [PWG5106.4].

7.3.2.1 can-accept-jobs (boolean)

This REQUIRED member identifies whether the System can accept new incoming Jobs in this stable power state, unless the System or has been disabled by an Operator or Administrator, and is semantically equivalent to the CanAcceptJobs element in the Power Support group defined in [PWG5106.4].

7.3.2.2 can-process-jobs (boolean)

This REQUIRED member identifies whether the System can process new incoming Jobs or existing queued Jobs in this stable power state and is semantically equivalent to the CanProcessJobs element in the Power Support group defined in [PWG5106.4].

7.3.2.3 power-active-watts (integer(0:MAX))

This REQUIRED member attribute identifies the nominal power consumption in watts for this stable power state when the System is in an active operational state (i.e., ‘processing’) and is semantically equivalent to the PowerActiveWatts element in the Power Support group defined in [PWG5106.4].

7.3.2.4 power-inactive-watts (integer(0:MAX))

This REQUIRED member attribute identifies the nominal power consumption in watts for this stable power state when the System is in an inactive operational state (i.e., ‘idle’ or ‘stopped’) and is semantically equivalent to the PowerInactiveWatts element in the Power Support group defined in [PWG5106.4].

7.3.2.5 power-state (type1 keyword)

This REQUIRED member attribute identifies a System supported stable power state that is the unique key of this power state capability entry and is semantically equivalent to the PowerState element in the Power Support group defined in [PWG5106.4].

Standard values and constraints on vendor extension values are defined in section 7.2.1 Power States and Policies.

Page 120 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

3553563480348134823483

3484

348534863487

3488

3489349034913492

3493

349434953496

3497

3498349935003501

3502

3503350435053506

3507

350835093510

35113512

357

Page 121: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

7.3.3 power-state-counters-col (1setOf collection)

This OPTIONAL System attribute lists System power state transition counters and is semantically equivalent to the Power Counter group defined in [PWG5106.4].

7.3.3.1 hibernate-transitions (integer(0:MAX))

This REQUIRED member attribute contains the System lifetime number of transitions into the ‘hibernate’ power state and is semantically equivalent to the HibernateTransitions element in the Power Counter group defined in [PWG5106.4].

7.3.3.2 on-transitions (integer(0:MAX))

This REQUIRED member attribute contains the System lifetime number of transitions into the ‘on’ power state and is semantically equivalent to the OnTransitions element in the Power Counter group defined in [PWG5106.4].

7.3.3.3 standby-transitions (integer(0:MAX))

This REQUIRED member attribute contains the System lifetime number of transitions into the ‘standby’ power state and is semantically equivalent to the StandbyTransitions element in the Power Counter group defined in [PWG5106.4].

7.3.3.4 suspend-transitions (integer(0:MAX))

This REQUIRED member attribute contains the System lifetime number of transitions into the ‘suspend’ power state and is semantically equivalent to the SuspendTransitions element in the Power Counter group defined in [PWG5106.4].

7.3.4 power-state-monitor-col (collection)

This RECOMMENDED System attribute contains the System power state and is semantically equivalent to the Power General, Power Meters, and Power Monitor groups defined in [PWG5106.4].

Note: Power consumption attribute values are volatile and typically change regularly at implementation-defined intervals.

7.3.4.1 current-month-kwh (integer(0:MAX))

This REQUIRED member attribute contains the current month's System power consumption in kilowatt hours and is semantically equivalent to the PowerCurrentMonthKWH element in the Power Meter group defined in [PWG5106.4]. The System MUST reset the value of this attribute to zero at the beginning of every month.

Page 121 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

3583593513

35143515

3516

351735183519

3520

352135223523

3524

352535263527

3528

352935303531

3532

353335343535

35363537

3538

3539354035413542

360

Page 122: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

7.3.4.2 current-watts (integer(0:MAX))

This REQUIRED member attribute contains the current System instantaneous power consumption in watts and is semantically equivalent to the PowerCurrentWatts element in the Power Meter group defined in [PWG5106.4].

Note: The value of this attribute is typically determined by software estimation instead of actual current measurement.

7.3.4.3 lifetime-kwh (integer(0:MAX))

This REQUIRED member attribute contains the lifetime System power consumption in kilowatt hours and is semantically equivalent to the PowerLifetimeKWH element in the Power Meter group defined in [PWG5106.4].

7.3.4.4 meters-are-actual (boolean)

This REQUIRED member attribute identifies whether or not System power meter attributes are based on actual measurement (true) or software estimation (false) and is semantically equivalent to the PowerMetersAreActual element in the Power Meter group defined in [PWG5106.4].

7.3.4.5 power-state (type1 keyword)

This REQUIRED member attribute identifies the current stable or ephemeral (transitional) System power state and is semantically equivalent to the PowerState element in the Power Monitor group defined in [PWG5106.4].

Standard values and constraints on vendor extension values are defined in section 7.2.1 Power States and Policies.

7.3.4.6 power-state-message (text (255))

This OPTIONAL member attribute contains a human-readable string in UTF-8 [RFC3629] that describes, explains, or qualifies the current System power state (e.g.,) and is semantically equivalent to the PowerStateMessage element in the Power Monitor group defined in [PWG5106.4]. For example, "standby - System is shutting down by user request (2W)" when transitioning to final 'off-soft' power state.

Usage: This attribute: (a) MUST identify the power state; (b) SHOULD identify the method of entry to the power state, e.g., “from timeout trigger” or “from user request”; (c) SHOULD identify the nominal power consumption, e.g., “(34 watts)”; and (d) MAY include any other power-related information, e.g., “can accept jobs” or “can process jobs”.

7.3.4.7 power-usage-is-rms-watts (boolean)

This REQUIRED member attribute identifies whether or not the power consumption properties for this System use units of Root Mean Square (RMS) watts (true) or

Page 122 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

3613623543

354435453546

35473548

3549

355035513552

3553

3554355535563557

3558

355935603561

35623563

3564

35653566356735683569

3570357135723573

3574

35753576

363

Page 123: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

unnormalized so-called peak watts (false) and is semantically equivalent to the PowerUsageIsRMSWatts element in the Power General group defined in [PWG5106.4].valid-request-power-states (1setOf (type1 keyword))

This REQUIRED member attribute identifies all of the stable and ephemeral power states that can be requested (in policies) on this System and is semantically equivalent to the CanRequestPowerStates element in the Power General group defined in [PWG5106.4].

Standard values and constraints on vendor extension values are defined in section 7.2.1 Power States and Policies.

7.3.5 power-state-transitions-col (1setOf collection)

This OPTIONAL System attribute lists valid System power state transitions and is semantically equivalent to the Power Transition group defined in [PWG5106.4].

7.3.5.1 end-power-state (type1 keyword)

This REQUIRED member attribute identifies the ending stable System power state for this valid power state transition and is semantically equivalent to the EndPowerState element in the Power Transition group defined in [PWG5106.4].

Standard values and constraints on vendor extension values are defined in section 7.2.1 Power States and Policies.

7.3.5.2 start-power-state (type1 keyword)

This REQUIRED member attribute identifies the starting stable System power state for this valid power state transition and is semantically equivalent to the EndPowerState element in the Power Transition group defined in [PWG5106.4].

Standard values and constraints on vendor extension values are defined in section 7.2.1 Power States and Policies.

7.3.5.3 state-transition-seconds (integer(0:MAX))

This REQUIRED member attribute contains the nominal duration in seconds for this valid power state transition and is semantically equivalent to the StateChangeSeconds element in the Power Transition group defined in [PWG5106.4].

7.3.6 system-config-change-date-time (dateTime)

This REQUIRED System attribute contains the value of “system-current-time” (date and time) for the most recent System configuration change.

Page 123 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

364365357735783579

358035813582

35833584

3585

35863587

3588

358935903591

35923593

3594

359535963597

35983599

3600

360136023603

3604

36053606

366

Page 124: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

7.3.7 system-config-change-time (integer(0:MAX))

This REQUIRED System attribute contains the value of “system-up-time” (seconds since System startup) for the most recent System configuration change or zero if no System configuration change has occurred.

7.3.8 system-config-changes (integer(0:MAX))

This REQUIRED System attribute contains the count of configuration changes for the System and is semantically equivalent to the SystemConfigChangeNumber element defined in [PWG5108.06] and semantically analogous to the prtGeneralConfigChanges object defined in [RFC3805]. Each time a Set-System-Attributes operation is performed that changes the value of any attribute and each time the System changes the value of any attribute outside of an operation, the System MUST increment value of the “system-config-changes” attribute by exactly one. Each time that the System performs a power cycle (from ‘off’ to ‘on’), the System MUST reset the value of this attribute to zero.

7.3.9 system-configured-printers (1setOf collection)

This REQUIRED System attribute contains the summary of all configured Printers for the System and is semantically equivalent to the ConfiguredServices element defined in [PWG5108.06].

Table 10 – Member Attributes of system-configured-printers

Conformance IPP Attribute Name ReferenceREQUIRED printer-id [PWG5100.SYS]REQUIRED printer-info [RFC8011]REQUIRED printer-is-accepting-jobs [RFC8011]REQUIRED printer-name [RFC8011]REQUIRED printer-service-type [PWG5100.SYS]REQUIRED printer-state [RFC8011]REQUIRED printer-state-reasons [RFC8011]REQUIRED printer-xri-supported [RFC3380]

7.3.9.1 printer-id (integer(1:65535))

7.3.9.2 This REQUIRED member attribute uniquely identifies the Printer within the System and is semantically equivalent to the ServiceSummary element ID defined in [PWG5108.06] and semantically analogous to the “job-id” attribute defined in [RFC8011]. See “printer-id” in section 7.5 Printer Status Attributes.printer-info (text(127))

This REQUIRED member attribute contains the description of the Printer and is semantically equivalent to the "printer-info" Printer attribute defined in [RFC8011] but is not included in the ServiceSummary element defined in [PWG5108.06].

Page 124 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

3673683607

360836093610

3611

36123613361436153616361736183619

3620

362136223623

3624

3625

3626

3627362836293630

363136323633

369

Page 125: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

7.3.9.3 printer-is-accepting-jobs (boolean)

This REQUIRED member attribute identifies whether the Printer is currently able to accept incoming Jobs and is semantically equivalent to the "printer-is-accepting-jobs" Printer attribute defined in [RFC8011] and semantically equivalent to the ServiceSummary element IsAcceptingJobs defined in [PWG5108.06].

7.3.9.4 printer-name (name(127))

This REQUIRED member attribute identifies the name of the Printer and is semantically equivalent to the "printer-name" Printer attribute defined in [RFC8011] and semantically equivalent to the ServiceSummary element ServiceName defined in [PWG5108.06].

7.3.9.5 printer-service-type (type2 keyword)

This REQUIRED member attribute identifies the service type of the Printer and is semantically equivalent to the "printer-service-type" Printer attribute defined in section 7.5.2 and semantically equivalent to the ServiceSummary element ServiceType defined in [PWG5108.06].

7.3.9.6 printer-state (type1 enum)

This REQUIRED member attribute contains the current state of the Printer and is semantically equivalent to the "printer-state" Printer attribute defined in [RFC8011] and semantically equivalent to the ServiceSummary element State defined in [PWG5108.06].

7.3.9.7 printer-state-reasons (1setOf type2 keyword)

This REQUIRED member attribute contains additional detail about the current state of the Printer and is semantically equivalent to the "printer-state-reasons" Printer attribute defined in [RFC8011] and semantically equivalent to the ServiceSummary element StateReasons defined in [PWG5108.06].

7.3.9.8 printer-xri-supported (1setOf collection)

This REQUIRED member attribute lists supported XRI (URI, authentication, and security tuples) for the Printer and is semantically equivalent to the "printer-xri-supported" Printer attribute defined in [RFC3380] and semantically equivalent to the ServiceSummary element ServiceXriSupported defined in [PWG5108.06].

7.3.10 system-configured-resources (1setOf collection)

This REQUIRED System attribute contains the summary of all configured Resources for the System and is semantically equivalent to the ConfiguredResources element defined in [PWG5108.06].

Table 11 – Member attributes of system-configured-resources

Page 125 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

3703713634

3635363636373638

3639

364036413642

3643

3644364536463647

3648

364936503651

3652

3653365436553656

3657

3658365936603661

3662

366336643665

3666

372

Page 126: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

Conformance IPP Attribute Name ReferenceREQUIRED 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-state-reasons [PWG5100.SYS]REQUIRED resource-type [PWG5100.SYS]

7.3.10.1 resource-format (mimeMediaType)

This REQUIRED member attribute identifies the format of the Resource and is semantically equivalent to the "resource-format" Resource attribute defined in section 7.7.7 and semantically equivalent to the ResourceSummary element ResourceFormat defined in [PWG5108.06].

7.3.10.2 resource-id (integer (1:MAX))

This REQUIRED member attribute contains the unique identier of the Resource and is semantically equivalent to the "resource-id" Resource attribute defined in section 7.7.8 and semantically equivalent to the ResourceSummary element ResourceId defined in [PWG5108.06].

7.3.10.3 resource-info (text(127))

This REQUIRED member attribute contains the description of the Resource and is semantically equivalent to the "resource-info" Resource attribute defined in section 7.6.1 but is not included in the original ResourceSummary element defined in [PWG5108.06].

7.3.10.4 resource-name (name(127))

This REQUIRED member attribute identifies the name of the Resource and is semantically equivalent to the "resource-name" Resource attribute defined in section 7.6.2 and semantically equivalent to the ResourceSummary element ResourceName defined in [PWG5108.06].

7.3.10.5 resource-state (type1 enum)

This REQUIRED member attribute contains the current state of the Resource and is semantically equivalent to the "resource-state" Resource attribute defined in section 7.7.12 but is not included in the original ResourceSummary element defined in [PWG5108.06].

7.3.10.6 resource-state-reasons (1setOf type2 keyword)

This REQUIRED member attribute contains a list of state reasons for the Resource but is not included in the original Resource object defined in [PWG5108.03] and is semantically

Page 126 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

373374

3667

3668

3669367036713672

3673

3674367536763677

3678

367936803681

3682

3683368436853686

3687

368836893690

3691

36923693

375

Page 127: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

analogous to the “job-state-reasons” attribute defined in [RFC8011]. Any applicable “job-state-reasons” keyword value can be used in “resource-state-reasons”.

7.3.10.7 resource-type (type2 keyword)

This REQUIRED member attribute identifies the type of the Resource and is semantically equivalent to the "resource-type" Resource attribute defined in section 7.7.16 and semantically equivalent to the ResourceSummary element ResourceType defined in [PWG5108.06].

7.3.11 system-serial-number (text(255))

This OPTIONAL System attribute identifies the serial number for the System and is semantically equivalent to the SerialNumber element defined in [PWG5108.06] and semantically analogous to the prtGeneralSerialNumber element defined in [RFC3805].

7.3.12 system-state (type1 enum)

This REQUIRED System attribute contains the current state for the System and is semantically equivalent to the State element defined in [PWG5108.06] and semantically analogous to the “printer-state” attribute defined in [RFC8011].

Standard values for this attribute are:

'3' 'idle': Indicates that all Printers are in the ‘idle’ state.

'4' 'processing': Indicates that one or more Printers are processing Jobs.

'5' 'stopped': Indicates that all Printers are in the ‘stopped’ state.

7.3.13 system-state-change-date-time (dateTime)

This REQUIRED System attribute contains the value of “system-current-time” (date and time) for the most recent System state change and is semantically analogous to the “printer-state-change-date-time” attribute defined in [RFC3995].

7.3.14 system-state-change-time (integer(0:MAX))

This REQUIRED System attribute contains the value of “system-up-time” (seconds since System startup) for the most recent System state change or zero if no System state change has occurred and is semantically analogous to the “printer-state-change-time” attribute defined in [RFC3995].

7.3.15 system-state-message (text(MAX))

This REQUIRED System attribute contains a state message for the System and is semantically analogous to the StateMessages element defined in [PWG5108.06] and semantically analogous to the “printer-state-message” attribute defined in [RFC8011].

Page 127 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

37637736943695

3696

3697369836993700

3701

370237033704

3705

370637073708

3709

3710

3711

3712

3713

371437153716

3717

3718371937203721

3722

372337243725

378

Page 128: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

7.3.16 system-state-reasons (1setOf type2 keyword)

This REQUIRED System attribute contains a list of state reasons for the System and is semantically equivalent to the StateReasons element defined in [PWG5108.06] and semantically analogous to the “printer-state-reasons” attribute defined in [RFC8011]. Any applicable “printer-state-reasons” keyword value can be used in “system-state-reasons”.

7.3.17 system-up-time (integer(1:MAX))

This REQUIRED System attribute contains the time in seconds since last boot for the System and is semantically equivalent to the UpTime element defined in [PWG5108.06].

7.3.18 system-uuid (uri(45))

This REQUIRED System attribute identifies the UUID as a URI [RFC4122] for the System and is semantically equivalent to the ServiceUuid element defined in [PWG5108.01].

7.4 Printer Description Attributes

Printer Description attributes are typically READ-WRITE and can potentially be set by an Operator or Administrator using the Set-Printer-Attributes operation [RFC3380]. Writable Printer Description attributes are listed in the value of “printer-settable-attributes-supported” [RFC3380].

7.4.1 printer-owner-col (collection)

This REQUIRED Printer attribute identifies the Printer Owner.

7.4.1.1 owner-uri (uri)

This REQUIRED member attribute contains a Printer Owner URI, e.g., “mailto:[email protected],” and is semantically analogous to the Service object’s OwnerURI defined in [PWG5108.01]. If specified in a Set-Printer-Attributes operation, then the “owner-vcard” member attribute MUST also be specified (to preserve consistency).

7.4.1.2 owner-vcard (1setOf text(1023))

This REQUIRED member attribute contains a Printer Owner vCard [RFC6350] and is semantically analogous to the Service object’s OwnerVCard defined in [PWG5108.01]. If specified in a Set-Printer-Attributes operation, then the “owner-uri” member attribute MUST also be specified (to preserve consistency).

7.5 Printer Status Attributes

All of the Printer Status attributes are READ-ONLY and cannot be set directly by the Set-Printer-Attributes operation.

Page 128 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

3793803726

3727372837293730

3731

37323733

3734

37353736

3737

3738373937403741

3742

3743

3744

3745374637473748

3749

3750375137523753

3754

37553756

381

Page 129: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

7.5.1 printer-config-changes (integer(0:MAX))

This REQUIRED Printer attribute identifies the number of configuration changes (in Printer Description attributes) for a Printer semantically equivalent to the Monitoring element ConfigChanges defined in [PWG5106.1] and semantically equivalent to “prtGeneralConfigChanges” in IETF Printer MIB v2 [RFC3805]. The value of this attribute MUST be incremented by one for each operation that changes the Printer configuration (rather than incrementing by one for each configuration attribute that was changed by the single operation).

7.5.2 printer-id (integer(1:65535))

This REQUIRED Printer attribute uniquely identifies the Printer within the System and is semantically equivalent to the ServiceSummary element ID defined in [PWG5108.06] and semantically analogous to the “job-id” attribute defined in [RFC8011].

7.5.3 printer-service-type (type2 keyword)

This REQUIRED Printer attribute identifies the service type for a Printer as used in Create-Printer defined in section 6 and is semantically equivalent to the Service Summary element ServiceType defined in [PWG5108.06]. Vendor-specific service types SHOULD be have keywords constructed of the form “smiNNN-name”, where “NNN” is the vendor’s enterprise SMI number assigned by IANA. Vendor-specific service types SHOULD be registered with IANA.

Standard keyword values for this attribute include:

‘copy’: A Copy service defined in [PWG5108.04].

‘faxin’: A FaxIn service defined in [RFC2707] and [PWG5108.01].

‘faxout’: A FaxOut service defined in [PWG5100.15].

‘print’: A Print service defined in [RFC8011].

‘print3d’: A 3D Print service defined in [PWG5100.21P3D]

‘scan’: A Scan service defined in [PWG5100.17].

‘transform’: A Transform service defined in [PWG5108.01].

7.6 Resource Description Attributes

Resource Description attributes are typically READ-WRITE and can potentially be set by an Operator or Administrator using the Set-Resource-Attributes operation (see section 6). Writable Resource Description attributes are listed in the value of “resource-settable-attributes-supported” System Description attribute defined above in section 7.2.

Page 129 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

3823833757

3758375937603761376237633764

3765

376637673768

3769

377037713772377337743775

3776

3777

3778

3779

3780

3781

3782

3783

3784

3785378637873788

384

Page 130: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

7.6.1 resource-info (text(127))

This REQUIRED Resource attribute contains the description of the Resource and is semantically equivalent to the ResourceInfo element defined in [PWG5108.03] and semantically analogous to the "printer-info" Printer attribute defined in [RFC8011].

7.6.2 resource-name (name(127))

This REQUIRED Resource attribute contains the name of the Resource and is semantically equivalent to the ResourceName element defined in [PWG5108.03] and semantically analogous to the "printer-name" Printer attribute defined in [RFC8011].

7.6.3 resource-owner-col (collection)

This REQUIRED Resource attribute identifies the Resource Owner.

7.6.3.1 owner-uri (uri)

This REQUIRED member attribute contains a Resource Owner URI, e.g., “mailto:[email protected],” and is semantically analogous to the Service object’s OwnerURI defined in [PWG5108.01]. If specified in a Set-Resource-Attributes operation, then the “owner-vcard” member attribute MUST also be specified (to preserve consistency).

7.6.3.2 owner-vcard (1setOf text(1023))

This REQUIRED member attribute contains a Resource Owner vCard [RFC6350] and is semantically analogous to the Service object’s OwnerVCard defined in [PWG5108.01]. If specified in a Set-Resource-Attributes operation, then the “owner-uri” member attribute MUST also be specified (to preserve consistency).

7.7 Resource Status Attributes

All of the Resource Status attributes are READ-ONLY and cannot be directly updated by the Set-Resource-Attributes operation.

7.7.1 date-time-at-canceled (dateTime)

This REQUIRED Resource attribute contains the date and time of Resource cancelation request (i.e., when Cancel-Resource operation is accepted) or Resource abortion by the System, which can be before the Resource transitions to the ‘canceled’ or ‘aborted’ state, and is semantically analogous to the DateTimeAtExpiration element defined in [PWG5108.03] and semantically analogous to the Job “date-time-at-completed” attribute defined in [RFC8011].

Page 130 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

3853863789

379037913792

3793

379437953796

3797

3798

3799

38003801380238033804

3805

3806380738083809

3810

38113812

3813

381438153816381738183819

387

Page 131: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

7.7.2 date-time-at-creation (dateTime)

This REQUIRED Resource attribute contains the date and time of Resource creation request (i.e., when Create-Resource operation is accepted) and is semantically equivalent to the DateTimeAtCreation element defined in [PWG5108.03] and semantically analogous to the “date-time-at-creation” Job attribute defined in [RFC8011].

7.7.3 date-time-at-installed (dateTime)

This REQUIRED Resource attribute contains the date and time of Resource installation request (i.e., when Install-Resource operation is accepted), which can be before the Resource transitions to the ‘installed’ state, and is semantically analogous to the “date-time-at-processing” Job attribute defined in [RFC8011].

7.7.4 resource-data-uri (uri | no-value))

This REQUIRED Resource attribute identifies the URI of the Resource data (if any) and is semantically equivalent to the ResourceFormat element defined in [PWG5108.03] and semantically analogous to the “document-format” attribute defined in [RFC8011]. When a Resource has no associated data, the System MUST return the ‘no-value’ out-of-band value defined in [RFC8011] for “resource-data-uri”.

7.7.5 resource-format (mimeMediaType)

This REQUIRED Resource attribute identifies the format of the Resource data and is semantically equivalent to the ResourceFormat element defined in [PWG5108.03] and semantically analogous to the “document-format” attribute defined in [RFC8011].

7.7.6 resource-id (integer(1:MAX))

This REQUIRED Resource attribute uniquely identifies the Resource within the System and is semantically equivalent to the ResourceId element defined in [PWG5108.03] and semantically analogous to the “job-id” attribute defined in [RFC8011].

7.7.7 resource-k-octets (integer(0:MAX))

This REQUIRED Resource attribute contains the size of the data associated with the Resource (if any) but is not included in the original Resource object defined in [PWG5108.03] and semantically analogous to the “job-k-octets” attribute defined in [RFC8011].

7.7.8 resource-state (type1 enum)

This REQUIRED Resource attribute contains the current state of the Resource and is semantically analogous to the DateTimeOfExpiration and ResourceHasExpired elements defined in [PWG5108.03] and semantically analogous to the “job-state” attribute defined in [RFC8011].

Page 131 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

3883893820

3821382238233824

3825

3826382738283829

3830

38313832383338343835

3836

383738383839

3840

384138423843

3844

3845384638473848

3849

3850385138523853

390

Page 132: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

Standard enum values for this attribute are:

‘3’ ‘pending’: The Resource has been created but is not yet available or installed.

‘4’ ‘available’: The Resource data has been uploaded and the Resource is available for installation.

‘5’ ‘installed’: The Resource has been installed and is ready for use.

‘6’ ‘canceled’: The Resource has been canceled and can no longer be used.

‘7’ ‘aborted’: The Resource has been aborted by the System and can no longer be used.

Normal Resource state transitions are shown in Figure 1 below. Resource states normally progress from top to bottom (‘created’ to ‘available’ to ‘installed’) until the Resource finally transitions to a terminal state of ‘canceled’ (by Administrator) or ‘aborted’ (by System). See note 2 below for one of the exceptions to normal Resource state transitions.

Figure 1 – IPP Resource Object Life Cycle

Notes:

Page 132 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

3913923854

38553856

38573858

3859

3860

38613862

3863386438653866

3867

3868

3869

393

Page 133: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

1) A Resource object can transition to the ‘aborted’ state due to an interrupted Send-Resource-Data request, corrupted Resource data, an unsupported Resource data format, inability to store the Resource data, inability to install the Resource data, and/or other System internal fault conditions. The “resource-state-reasons” attribute will contain the reason for the Resource being aborted by the System.

2) When a new Resource version is installed that replaces a previous Resource version (e.g., firmware), the old Resource “resource-state” MUST transition back to ‘available’ and the old Resource “resource-use-count” MUST be set to zero.

7.7.9 resource-state-message (text(MAX))

This REQUIRED Resource attribute contains a state message for the Resource but is not included in the original Resource object defined in [PWG5108.03] and semantically analogous to the “job-state-message” attribute defined in [RFC8011].

7.7.10 resource-state-reasons (1setOf type2 keyword)

This REQUIRED Resource attribute contains a list of state reasons for the Resource but is not included in the original Resource object defined in [PWG5108.03] and is semantically analogous to the “job-state-reasons” attribute defined in [RFC8011]. Any applicable “job-state-reasons” keyword value can be used in “resource-state-reasons”.

Standard values for this attribute are:

‘cancel-requested’: A Cancel-Resource operation has been received and accepted and the Resource will become permanently unavailable when the cancellation is completed (e.g., after the current Job using the Resource is completed).

‘install-requested’: An Install-Resource operation has been received and accepted and the Resource will become available for use when the installation is completed (e.g., potentially after the next System or Subunit reboot in the case of an executable Resource).

‘resource-incoming’: A Send-Resource-Data operation has been received and accepted, Resource data upload is in progress, and “resource-state” will transition to ‘available’ after the upload is completed.

7.7.11 resource-string-version (text(127))

This REQUIRED Resource attribute contains the string version of the Resource, which SHOULD conform to section 4.2.4 “String Version” of IETF PA-TNC [RFC5792] which defines the internal string fields Product Version Number, Internal Build Number, and Configuration Version Number. This attribute is semantically analogous to the FirmwareStringVersion attribute defined in [PWG5110.4].

Page 133 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

39439538703871387238733874

387538763877

3878

387938803881

3882

3883388438853886

3887

388838893890

3891389238933894

389538963897

3898

38993900390139023903

396

Page 134: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

7.7.12 resource-type (type2 keyword)

This REQUIRED Resource attribute identifies the type of the Resource and is semantically equivalent to the ResourceType element defined in [PWG5108.03].

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

Standard values for this attribute (with their resource category prefix) include:

‘executable-firmware’: Executable firmware.

‘executable-software’: Executable software.

‘static-font’: Static font.

‘static-form’: Static form.

‘static-iccprofile’: Static ICC profile.

‘static-image’: Static image.

‘static-logo’: Static logo.

‘template-document’: Template for creating Document object [PWG5100.5].

‘template-job’: Template for creating Job object [PWG5108.07].

‘template-printer’: Template for creating Printer object [RFC8011].

7.7.13 resource-use-count (integer(0:MAX))

This REQUIRED Resource attribute contains the use count (i.e., allocation count) for the Resource but is not included in the original Resource object defined in [PWG5108.03].

Note: If the System internal use count exceeds MAX, then the System MUST return “resource-use-count” with a value of MAX.

7.7.14 resource-uuid (uri(45))

This REQUIRED Resource attribute identifies the UUID as a URI [RFC4122] for the Resource but is not included in the original Resource object defined in [PWG5108.03] and is semantically analogous to the “system-uuid” attribute defined in section 7.3.

Page 134 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

3973983904

39053906

3907390839093910

3911

3912

3913

3914

3915

3916

3917

3918

3919

3920

3921

3922

39233924

39253926

3927

392839293930

399

Page 135: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

7.7.15 resource-version (octetString(16))

This REQUIRED Resource attribute contains the numeric version of the Resource, which SHOULD conform to section 4.2.3 “Numeric Version” of IETF PA-TNC [RFC5792] which defines the internal integer fields Major Version Number, Minor Version Number, Build Number, Service Pack Major, and Service Pack Minor. This attribute is semantically analogous to the FirmwareVersion attribute defined in [PWG5110.4].

7.7.16 time-at-canceled (integer(MIN:MAX))

This REQUIRED Resource attribute contains the time of Resource cancelation request (i.e., when Cancel-Resource operation is accepted) or Resource abortion by the System, which can be before the Resource transitions to the ‘canceled’ or ‘aborted’ state, but is not included in the original Resource object defined in [PWG5108.03] and is semantically analogous to the “time-at-completed” Job attribute defined in [RFC8011].

7.7.17 time-at-creation (integer(MIN:MAX))

This REQUIRED Resource attribute contains the time of Resource creation request (i.e., when Create-Resource operation is accepted) but is not included in the original Resource object defined in [PWG5108.03] and is semantically analogous to the “time-at-creation” Job attribute defined in [RFC8011].

7.7.18 time-at-installed (integer(MIN:MAX))

This REQUIRED Resource attribute contains the time of Resource installation request (i.e., when Install-Resource operation is accepted), which can be before the Resource transitions to the ‘installed’ state, but is not included in the original Resource object defined in [PWG5108.03] and is semantically analogous to the “date-time-at-processing” Job attribute defined in [RFC8011].

7.8 Job Status Attributes

All of the Job Status attributes are READ-ONLY and cannot be directly updated by the Set-Job-Attributes operation.

7.8.1 job-owner-col (collection)

This REQUIRED Job attribute identifies the Job Owner.

7.8.1.1 owner-uri (uri)

This REQUIRED member attribute contains a Job Owner URI, e.g., “mailto:[email protected],” and is semantically analogous to the Service object’s OwnerURI defined in [PWG5108.01].

Page 135 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

4004013931

39323933393439353936

3937

39383939394039413942

3943

3944394539463947

3948

39493950395139523953

3954

39553956

3957

3958

3959

396039613962

402

Page 136: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

7.8.1.2 owner-vcard (1setOf text(1023))

This REQUIRED member attribute contains a Job Owner vCard [RFC6350] and is semantically analogous to the Service object’s OwnerVCard defined in [PWG5108.01].

Page 136 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

4034043963

396439653966

405

Page 137: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

8. Additional Semantics for Existing Operations

8.1 Cancel-Subscription, Get-Notifications, and Renew-Subscription: system-uri (uri) and resource-id (integer(1:MAX))

[8.2] Get-Printer-Attributes: system-uri (uri) or printer-uri (uri)printer-resource-ids (1setOf integer(1:MAX))

This REQUIRED operation allows an authorized User to retrieve a filtered list of the Printer attributes for either the default Printer specified by the “system-default-printer-id” on the target System object or an explicit Printer specified by the “printer-uri” of the target Printer object. This operation supports backward compatibility with previously deployed IPP Clients. If there is no configured default Printer, then the System MUST return a “status-code” of 'successful-ok'.

This operation is semantically equivalent to the Get-Printer-Attributes operation defined in [RFC8011], except that the target MAY be a System object (rather than a Printer object), although previously deployed IPP Clients MAY omit the “system-uri” operation attribute and supply the “printer-uri” operation attribute instead.

If accepted, the System MUST return “printer-id” and “printer-xri-supported” for either the default Printer specified by the “system-default-printer-id” attribute on the target System object or an explicit Printer specified by the “printer-uri” of the target Printer object. The returned Printer attributes from the System MAY also be filtered based on Client access rights (i.e., the value of “requesting-user-name”) or the specified “document-format”. This operation does not change the state of any Printer or the System itself.

8.1.1.1 Get-Printer-Attributes Request

The following groups of attributes are part of a Get-Printer-Attributes request.

Group 1: Operation Attributes

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

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

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

The Client MUST supply either the "system-uri" or "printer-uri" operation attributes and the System MUST support both the "system-uri" and "printer-

Page 137 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

406407

3967

3968

3969

3970

3971

397239733974397539763977

3978397939803981

398239833984398539863987

3988

3989

3990

39913992

39933994

39953996

39973998

408

Page 138: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

uri" operation attributes which specify the target System (and implicit target Printer) or the explicit target Printer for the operation.

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

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

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

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

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

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

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

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

"document-format" (mimeMediaType):

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

8.1.1.2 Get-Printer-Attributes Response

The following groups of attributes are part of a Get-Printer-Attributes response. The System returns a Get-Printer-Attributes operation response to the Client up to the number specified by the “limit” operation attribute that match the filter criteria as specified by the attribute values supplied by the Client in the request.

Group 1: Operation Attributes

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

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

Page 138 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

40941039994000

400140024003

40044005

4006

4007

4008

4009

4010

4011401240134014

4015

401640174018401940204021

4022

4023402440254026

4027

40284029

40304031

411

Page 139: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

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

The System MAY return one or both of these attributes.

Group 2: Unsupported Attributes

See [RFC8011] for details on returning Unsupported Attributes.

Group 3: Printer Attributes

See [RFC8011] for details on returning Printer Attributes.

“printer-id” (integer(1:65535)):

The System MUST return this attribute for the target Printer.

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

The System MUST return this attribute for the target Printer.

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

The System MUST return this attribute for the target Printer.

“printer-state” (type1 enum) and“printer-state-reasons” (1setOf type2 keyword) and“printer-is-accepting-jobs” (boolean):

The System MUST return all three of these attributes for the target Printer.

[for compatibility with legacy IPP Clients – choose implementation-dependent “default” Printer object, “redirect” operation to that Printer object, and relay response to Client]

8.2[8.3] Create-Job, Get-Job-Attributes: job-resource-ids (1setOf integer(1:MAX))

9. Additional Values for Existing Attributes

9.1 notify-events (1setOf type2 keyword)

9.2 printer-state-reasons (1setOf type2 keyword)

[add ‘resuming’ per the description of Resume-All-Printers]

Page 139 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

41241340324033

4034

4035

4036

4037

4038

4039

4040

4041

4042

4043

4044

404540464047

4048

40494050

4051

4052

4053

4054

4055

4056

4057

414

Page 140: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

[probably add TBD other new values for “printer-state-reasons”?]

Page 140 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

4154164058

4059

417

Page 141: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

10. Conformance RequirementsProvide numbered lists of conformance requirements for the document.

10.1 Conformance Requirements for Clients

10.2 Conformance Requirements for Infrastructure Systems

10.3 Conformance Requirements for Systems

11. Internationalization ConsiderationsFor interoperability and basic support for multiple languages, conforming implementations MUST support the Universal Character Set (UCS) Transformation Format -- 8 bit (UTF-8) [RFC3629] encoding of Unicode [UNICODE] [ISO10646] and the Unicode Format for Network Interchange [RFC5198].

Implementations of this specification SHOULD conform to the following standards on processing of human-readable Unicode text strings, see:

Unicode Bidirectional Algorithm [UAX9] – left-to-right, right-to-left, and vertical

Unicode Line Breaking Algorithm [UAX14] – character classes and wrapping

Unicode Normalization Forms [UAX15] – especially NFC for [RFC 5198]

Unicode Text Segmentation [UAX29] – grapheme clusters, words, sentences

Unicode Identifier and Pattern Syntax [UAX31] – identifier use and normalization

Unicode Collation Algorithm [UTS10] – sorting

Unicode Locale Data Markup Language [UTS35] – locale databases

Implementations of this specification are advised to also review the following informational documents on processing of human-readable Unicode text strings:

Unicode Character Encoding Model [UTR17] – multi-layer character model

Unicode in XML and other Markup Languages [UTR20] – XML usage

Unicode Character Property Model [UTR23] – character properties

Page 141 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

418419

4060

4061

4062

4063

4064

4065

4066

4067406840694070

40714072

4073

4074

4075

4076

4077

4078

4079

40804081

4082

4083

4084

420

Page 142: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

Unicode Conformance Model [UTR33] – Unicode conformance basis

12. Security ConsiderationsThe IPP extensions defined in this document require the same security considerations as defined in the IPP/1.1: Model and Semantics [RFC8011] and PWG System Object and System Control Service Semantics [PWG5108.06], plus additional security considerations below

12.1 Human-readable Strings

Implementations of this specification SHOULD conform to the following standard on processing of human-readable Unicode text strings, see:

Unicode Security Mechanisms [UTS39] – detecting and avoiding security attacks

Implementations of this specification are advised to also review the following informational document on processing of human-readable Unicode text strings:

Unicode Security FAQ [UNISECFAQ] – common Unicode security issues

12.2 Confidentiality and Integrity

Clients and Systems MUST provide confidentiality and integrity of data in transit using either an interface providing physical security such as USB or using TLS encryption [RFC5246] over otherwise unsecured local or network connections,

12.3 Access Control

Because of the potential for abuse and misuse, Systems SHOULD provide access control mechanisms including lists of allowed Clients, authentication, and authorization to site defined policies since an IPP System Service consists of administrative operations for authenticated and authorized users (except for Get-Printer-Attributes for legacy Clients).

12.4 Physical Safety

Systems MUST NOT allow Clients to disable physical safety features of the hardware, such as protective gates, covers, or interlocks.

12.5 Digital Signature Validation

- usual references for validation from Send-Resource-Data and Install-Resource- discuss precedence of explicit operation attribute signatures over embedded signatures- discuss *accepting* an expired explicit or embedded signature, if the underlying cert was

Page 142 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

4214224085

4086

4087408840894090

4091

40924093

4094

40954096

4097

4098

409941004101

4102

4103410441054106

4107

41084109

4110

411141124113

423

Page 143: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

valid when the original signature was created (unless compromised keys, algorithms, etc.)- post-Install revalidation of digital signatures might be useful for auditing and malicious software scans, but such activities are outside the scope of this specification

12.6 Encrypted Resources

- discuss Resource data that is encrypted by Client (in addition to TLS data-in-transit), which MAY be supported by an IPP System Service, but is transparent to IPP operations (i.e., just an opaque blob)- stay away from DRM and in-band configurations of crypto infrastructure on System

13. IANA and PWG Considerations

13.1 Object Registrations

The objects defined in this document will be published by IANA according to the procedures in the IPP Model and Semantics [RFC8011] section 7.1 in the following file:

http://www.iana.org/assignments/ipp-registrations

The registry entries will contain the following information:

Object Name Reference----------- ---------Resource [PWG5100.SYS]System [PWG5100.SYS]

13.2 Attribute Registrations

The attributes defined in this document will be published by IANA according to the procedures in IPP Model and Semantics [RFC8011] section 7.2 in the following file:

http://www.iana.org/assignments/ipp-registrations

The registry entries will contain the following information:

Operation attributes: Reference-------------------- ---------printer-id (integer(1:65535)) [PWG5100.SYS]printer-ids (1setOf integer(1:65535)) [PWG5100.SYS]printer-geo-location (uri) [PWG5100.SYS]printer-location (text(127)) [PWG5100.SYS]printer-service-type (1setOf type2 keyword) [PWG5100.SYS]request-user-vcard (1setOf text(MAX)) [PWG5100.SYS]resource-format (mimeMediaType) [PWG5100.SYS]

Page 143 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

424425411441154116

4118

4119412041214122

4123

4124

4125

41264127

4128

4129

4130413141324133

4134

41354136

4137

4138

413941404141414241434144414541464147

426

Page 144: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

resource-format-accepted (1setOf mimeMediaType) [PWG5100.SYS]resource-formats (1setOf mimeMediaType) [PWG5100.SYS]resource-id (integer(1:MAX)) [PWG5100.SYS]resource-ids (1setOf integer(1:MAX)) [PWG5100.SYS]resource-k-octets (integer(0:MAX)) [PWG5100.SYS]resource-signature (1setOf octetString) [PWG5100.SYS]resource-states (1setOf type1 enum) [PWG5100.SYS]resource-type (type2 keyword) [PWG5100.SYS]resource-types (1setOf type2 keyword) [PWG5100.SYS]restart-get-interval (integer(0:MAX)) [PWG5100.SYS]system-uri (uri) [PWG5100.SYS]which-printers (type2 keyword) [PWG5100.SYS]

System Description attributes: Reference----------------------------- ---------charset-configured (charset) [PWG5100.SYS]charset-supported (1setOf charset) [PWG5100.SYS]ipp-features-supported (1setOf type2 keyword) [PWG5100.SYS]ipp-versions-supported (1setOf type2 keyword) [PWG5100.SYS]natural-language-configured (naturalLanguage) [PWG5100.SYS]generated-natural-language-supported (1setOf naturalLanguage) [PWG5100.SYS]operations-supported (1setOf type2 enum) [PWG5100.SYS]power-calendar-policy-col (1setOf collection) [PWG5100.SYS] calendar-id (integer(1:MAX)) [PWG5100.SYS] day-of-month (integer(1:31)) [PWG5100.SYS] day-of-week (integer(1:7)) [PWG5100.SYS] hour (integer(0:23)) [PWG5100.SYS] minute (integer(0:59)) [PWG5100.SYS] month (integer(1:12)) [PWG5100.SYS] request-power-state (type1 keyword) [PWG5100.SYS] run-once (boolean) [PWG5100.SYS]power-event-policy-col (1setOf collection) [PWG5100.SYS] event-id (integer(1:MAX)) [PWG5100.SYS] event-name (name(127)) [PWG5100.SYS] request-power-state (type1 keyword) [PWG5100.SYS]power-timeout-policy-col (1setOf collection) [PWG5100.SYS] start-power-state (type1 keyword) [PWG5100.SYS] timeout-id (integer(1:MAX)) [PWG5100.SYS] timeout-predicate (type1 keyword) [PWG5100.SYS] timeout-seconds (integer(0:MAX)) [PWG5100.SYS]printer-creation-attributes-supported (1setOf keyword) [PWG5100.SYS]resource-format-supported (1setOf mimeMediaType) [PWG5100.SYS]resource-type-supported (1setOf type2 keyword) [PWG5100.SYS]resource-settable-attributes-supported (1setOf keyword) [PWG5100.SYS]system-current-time (dateTime) [PWG5100.SYS]system-default-printer-id (integer(1:65535) | no-value) [PWG5100.SYS]system-device-id (text(MAX)) [PWG5100.SYS]system-geo-location (uri | unknown) [PWG5100.SYS]system-info (text(127)) [PWG5100.SYS]system-location (text(127)) [PWG5100.SYS]system-mandatory-printer-attributes (1setOf keyword) [PWG5100.SYS]system-make-and-model (text(127)) [PWG5100.SYS]system-message-from-operator (text(127)) [PWG5100.SYS]system-name (name(127)) [PWG5100.SYS]system-owner-col (collection) [PWG5100.SYS]system-settable-attributes-supported (1setOf keyword) [PWG5100.SYS]

Page 144 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

42742841484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203

429

Page 145: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

system-strings-languages-supported (1setOf naturalLanguage) [PWG5100.SYS]system-strings-uri (uri | no-value) [PWG5100.SYS]system-xri-supported (1setOf collection) [PWG5100.SYS] < member attributes are the same as "printer-xri-supported" > [PWG5100.SYS]

System Status attributes: Reference------------------------ ---------power-log-col (1setOf collection) [PWG5100.SYS] log-id (integer(1:MAX)) [PWG5100.SYS] power-state (type1 keyword) [PWG5100.SYS] power-state-date-time (dateTime) [PWG5100.SYS] power-state-message (text(255)) [PWG5100.SYS]power-state-capabilities-col (1setOf collection) [PWG5100.SYS] can-accept-jobs (boolean) [PWG5100.SYS] can-process-jobs (boolean) [PWG5100.SYS] power-active-watts (integer(0:MAX)) [PWG5100.SYS] power-inactive-watts (integer(0:MAX)) [PWG5100.SYS] power-state (type1 keyword) [PWG5100.SYS]power-state-counters-col (1setOf collection) [PWG5100.SYS] hibernate-transitions (integer(0:MAX)) [PWG5100.SYS] on-transitions (integer(0:MAX)) [PWG5100.SYS] standby-transitions (integer(0:MAX)) [PWG5100.SYS] suspend-transitions (integer(0:MAX)) [PWG5100.SYS]power-state-monitor-col (collection) [PWG5100.SYS] current-month-kwh (integer(0:MAX)) [PWG5100.SYS] current-watts (integer(0:MAX)) [PWG5100.SYS] lifetime-kwh (integer(0:MAX)) [PWG5100.SYS] meters-are-actual (boolean) [PWG5100.SYS] power-state (type1 keyword) [PWG5100.SYS] power-state-message (text(255)) [PWG5100.SYS] power-usage-is-rms-watts (boolean) [PWG5100.SYS]power-state-transitions-col (1setOf collection) [PWG5100.SYS] end-power-state (type1 keyword) [PWG5100.SYS] start-power-state (type1 keyword) [PWG5100.SYS] state-transition-seconds (integer(0:MAX)) [PWG5100.SYS]system-config-change-date-time (dateTime) [PWG5100.SYS]system-config-change-time (integer(0:MAX)) [PWG5100.SYS]system-config-changes (integer:0:MAX)) [PWG5100.SYS]system-configured-printers (1setOf collection) [PWG5100.SYS] printer-id (integer(0:65535)) [PWG5100.SYS] printer-info (text(127)) [PWG5100.SYS] printer-is-accepting-jobs (boolean) [PWG5100.SYS] printer-name (name(127)) [PWG5100.SYS] printer-service-type (type2 keyword) [PWG5100.SYS] printer-state (type1 enum) [PWG5100.SYS] printer-state-reasons (1setOf type2 keyword) [PWG5100.SYS] printer-xri-supported (collection) [PWG5100.SYS] < member attributes are the same as "printer-xri-supported" > [PWG5100.SYS]system-configured-resources (1setOf collection) [PWG5100.SYS] resource-format (mimeMediaType) [PWG5100.SYS] resource-id (integer(1:MAX)) [PWG5100.SYS] resource-info (text(127)) [PWG5100.SYS] resource-name (name(127)) [PWG5100.SYS] resource-state (type1 enum) [PWG5100.SYS] resource-type (type2 keyword) [PWG5100.SYS]

Page 145 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

43043142044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259

432

Page 146: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

system-serial-number (text(255)) [PWG5100.SYS]system-state (type1 enum) [PWG5100.SYS]system-state-change-date-time (dateTime) [PWG5100.SYS]system-state-change-time (integer(0:MAX)) [PWG5100.SYS]system-state-message (text(MAX) [PWG5100.SYS]system-state-reasons (1setOf type2 keyword) [PWG5100.SYS]system-up-time (integer(1:MAX)) [PWG5100.SYS]system-uuid (uri(45)) [PWG5100.SYS]

Printer Description attributes: Reference------------------------------ ---------printer-owner-col (collection) [PWG5100.SYS]

Printer Status attributes: Reference------------------------- ---------printer-config-changes (integer(0:MAX)) [PWG5100.SYS]printer-id (integer(1:65535)) [PWG5100.SYS]printer-service-type (type2 keyword) [PWG5100.SYS]

Resource Description attributes: Reference------------------------------- ---------resource-info (text(127)) [PWG5100.SYS]resource-name (name(127)) [PWG5100.SYS]resource-owner-col (collection) [PWG5100.SYS]

Resource Status attributes: Reference-------------------------- ---------date-time-at-canceled (dateTime) [PWG5100.SYS]date-time-at-creation (dateTime) [PWG5100.SYS]date-time-at-installed (dateTime) [PWG5100.SYS]resource-data-uri (uri | no-value) [PWG5100.SYS]resource-format (mimeMediaType) [PWG5100.SYS]resource-id (integer(1:MAX)) [PWG5100.SYS]resource-k-octets (integer(0:MAX)) [PWG5100.SYS]resource-state (type1 enum) [PWG5100.SYS]resource-state-message (text(MAX)) [PWG5100.SYS]resource-state-reasons (1setOf type2 keyword) [PWG5100.SYS]resource-string-version (text(127)) [PWG5100.SYS]resource-type (type2 keyword) [PWG5100.SYS]resource-use-count (integer(0:MAX)) [PWG5100.SYS]resource-uuid (uri(45)) [PWG5100.SYS]resource-version (octetString(16)) [PWG5100.SYS]time-at-canceled (integer(0:MAX)) [PWG5100.SYS]time-at-creation (integer(0:MAX)) [PWG5100.SYS]time-at-installed (integer(0:MAX)) [PWG5100.SYS]

Job Status attributes: Reference--------------------- ---------job-owner-col (collection) [PWG5100.SYS]

Page 146 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

4334344260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308

435

Page 147: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

13.3 Type2 keyword Attribute Value Registrations

The keyword attribute values defined in this document will be published by IANA according to the procedures in the IPP Model and Semantics [RFC8011] section 7.3 in the following file:

http://www.iana.org/assignments/ipp-registrations

The registry entries will contain the following information:

Attributes (attribute syntax) Keyword Attribute Value Reference------------------------- ---------end-power-state (type1 keyword) [PWG5100.SYS] < any "power-state" value > [PWG5100.SYS]power-state (type1 keyword) [PWG5100.SYS] hibernate [PWG5100.SYS] hibernate-vendor1 [PWG5100.SYS] hibernate-vendor2 [PWG5100.SYS] hibernate-vendor3 [PWG5100.SYS] hibernate-vendor4 [PWG5100.SYS] hibernate-vendor5 [PWG5100.SYS] off-hard [PWG5100.SYS] off-hard-graceful [PWG5100.SYS] off-soft [PWG5100.SYS] off-soft-graceful [PWG5100.SYS] off-soft-vendor1 [PWG5100.SYS] off-soft-vendor2 [PWG5100.SYS] off-soft-vendor3 [PWG5100.SYS] off-soft-vendor4 [PWG5100.SYS] off-soft-vendor5 [PWG5100.SYS] on [PWG5100.SYS] on-vendor1 [PWG5100.SYS] on-vendor2 [PWG5100.SYS] on-vendor3 [PWG5100.SYS] on-vendor4 [PWG5100.SYS] on-vendor5 [PWG5100.SYS] reset-hard [PWG5100.SYS] reset-hard-graceful [PWG5100.SYS] reset-init [PWG5100.SYS] reset-mbr [PWG5100.SYS] reset-mbr-graceful [PWG5100.SYS] reset-nmi [PWG5100.SYS] reset-soft [PWG5100.SYS] reset-soft-graceful [PWG5100.SYS] standby [PWG5100.SYS] standby-vendor1 [PWG5100.SYS] standby-vendor2 [PWG5100.SYS] standby-vendor3 [PWG5100.SYS] standby-vendor4 [PWG5100.SYS] standby-vendor5 [PWG5100.SYS] suspend [PWG5100.SYS] suspend-vendor1 [PWG5100.SYS] suspend-vendor2 [PWG5100.SYS]

Page 147 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

436437

4309

431043114312

4313

4314

43154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358

438

Page 148: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

suspend-vendor3 [PWG5100.SYS] suspend-vendor4 [PWG5100.SYS] suspend-vendor5 [PWG5100.SYS]printer-service-type (type2 keyword) [PWG5100.SYS] copy [PWG5100.SYS] faxin [PWG5100.SYS] faxout [PWG5100.SYS] print [PWG5100.SYS] print3d [PWG5100.SYS] scan [PWG5100.SYS] transform [PWG5100.SYS]printer-state-reasons (1setOf type2 keyword) [RFC8011] resuming [PWG5100.SYS]request-power-state (type1 keyword) [PWG5100.SYS] < any "power-state" value > [PWG5100.SYS]resource-state-reasons (1setOf type2 keyword) [PWG5100.SYS] < any "job-state-reasons" value > [PWG5100.SYS] cancel-requested [PWG5100.SYS] install-requested [PWG5100.SYS] resource-incoming [PWG5100.SYS]resource-type (type2 keyword) [PWG5100.SYS] executable-firmware [PWG5100.SYS] executable-software [PWG5100.SYS] static-font [PWG5100.SYS] static-form [PWG5100.SYS] static-iccprofile [PWG5100.SYS] static-image [PWG5100.SYS] static-logo [PWG5100.SYS] template-document [PWG5100.SYS] template-job [PWG5100.SYS] template-printer [PWG5100.SYS]start-power-state (type1 keyword) [PWG5100.SYS] < any "power-state" value > [PWG5100.SYS]system-state-reasons (1setOf type2 keyword) [PWG5100.SYS] < any "printer-state-reasons" value > [PWG5100.SYS]timeout-predicate (type1 keyword) [PWG5100.SYS] activity [PWG5100.SYS] inactivity [PWG5100.SYS] none [PWG5100.SYS]which-printers (type2 keyword) [PWG5100.SYS] all [PWG5100.SYS] idle [PWG5100.SYS] not-accepting [PWG5100.SYS] processing [PWG5100.SYS] shutdown [PWG5100.SYS] stopped [PWG5100.SYS] testing [PWG5100.SYS]

13.4 Type2 enum Attribute Value Registrations

The enumerations defined in this document will be published by IANA according to the procedures in the IPP Model and Semantics [RFC8011] section 7.4 in the following file:

http://www.iana.org/assignments/ipp-registrations

Page 148 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

43944043594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405

4406

44074408

4409

441

Page 149: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

The registry entries will contain the following information:

Attributes (attribute syntax) Enum Value Enum Symbolic Name Reference------------ ------------------ ---------operations-supported (1setOf type2 enum) [RFC8011] 0x001E Get-Resource-Attributes [PWG5100.SYS] 0x0020 Get-Resources [PWG5100.SYS] 0x004B Allocate-Printer-Resources [PWG5100.SYS] 0x004C Create-Printer [PWG5100.SYS] 0x004D Deallocate-Printer-Resources [PWG5100.SYS] 0x004E Delete-Printer [PWG5100.SYS] 0x004F Get-Printers [PWG5100.SYS] 0x0050 Shutdown-One-Printer [PWG5100.SYS] 0x0051 Startup-One-Printer [PWG5100.SYS] 0x0052 Cancel-Resource [PWG5100.SYS] 0x0053 Create-Resource [PWG5100.SYS] 0x0054 Install-Resource [PWG5100.SYS] 0x0055 Send-Resource-Data [PWG5100.SYS] 0x0056 Set-Resource-Attributes [PWG5100.SYS] 0x0057 Create-Resource-Subscriptions [PWG5100.SYS] 0x0058 Create-System-Subscriptions [PWG5100.SYS] 0x0059 Disable-All-Printers [PWG5100.SYS] 0x005A Enable-All-Printers [PWG5100.SYS] 0x005B Get-System-Attributes [PWG5100.SYS] 0x005C Get-System-Supported-Values [PWG5100.SYS] 0x005D Pause-All-Printers [PWG5100.SYS] 0x005E Pause-All-Printers-After-Current-Job [PWG5100.SYS] 0x005F Register-Output-Device [PWG5100.SYS] 0x0060 Restart-System [PWG5100.SYS] 0x0061 Resume-All-Printers [PWG5100.SYS] 0x0062 Set-System-Attributes [PWG5100.SYS] 0x0063 Shutdown-All-Printers [PWG5100.SYS] 0x0064 Startup-All-Printers [PWG5100.SYS] 0x0065 Get-Printer-Resources [PWG5100.SYS]resource-state (type1 enum) [PWG5100.SYS] 3 pending [PWG5100.SYS] 4 available [PWG5100.SYS] 5 installed [PWG5100.SYS] 6 canceled [PWG5100.SYS] 7 aborted [PWG5100.SYS]system-state (type1 enum) [PWG5100.SYS] 3 idle [PWG5100.SYS] 4 processing [PWG5100.SYS] 5 stopped [PWG5100.SYS]

13.5 Attribute Group Registrations

The attribute groups defined in this document will be published by IANA according to the procedures in the IPP Model and Semantics [RFC8011] section 7.5 in the following file:

http://www.iana.org/assignments/ipp-registrations

The registry entries will contain the following information:

Page 149 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

4424434410

4411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453

4454

44554456

4457

4458

444

Page 150: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

Attribute Group Value Symbolic Name Reference--------------------- ------------- ---------0x08 resource-attributes-tag [PWG5100.SYS]0x0A system-attributes-tag [PWG5100.SYS]

13.6 Operation Registrations

The operations defined in this document will be published by IANA according to the procedures in the IPP Model and Semantics [RFC8011] section 7.8 in the following file:

http://www.iana.org/assignments/ipp-registrations

The registry entries will contain the following information:

Operation Name Reference-------------- ---------Allocate-Printer-Resources [PWG5100.SYS]Cancel-Resource [PWG5100.SYS]Create-Printer [PWG5100.SYS]Create-Resource [PWG5100.SYS]Create-Resource-Subscriptions [PWG5100.SYS]Create-System-Subscriptions [PWG5100.SYS]Deallocate-Printer-Resources [PWG5100.SYS]Delete-Printer [PWG5100.SYS]Disable-All-Printers [PWG5100.SYS]Enable-All-Printers [PWG5100.SYS]Get-Printer-Attributes(extension) [PWG5100.SYS]Get-Printers [PWG5100.SYS]Get-Resource-Attributes [PWG5100.SYS]Get-Resources [PWG5100.SYS]Get-System-Attributes [PWG5100.SYS]Get-System-Supported-Values [PWG5100.SYS]Install-Resource [PWG5100.SYS]Pause-All-Printers [PWG5100.SYS]Pause-All-Printers-After-Current-Job [PWG5100.SYS]Register-Output-Device [PWG5100.SYS]Restart-System [PWG5100.SYS]Resume-All-Printers [PWG5100.SYS]Send-Resource-Data [PWG5100.SYS]Set-Resource-Attributes [PWG5100.SYS]Set-System-Attributes [PWG5100.SYS]Shutdown-All-Printers [PWG5100.SYS]Shutdown-One-Printer [PWG5100.SYS]Startup-All-Printers [PWG5100.SYS]Startup-One-Printer [PWG5100.SYS]

Page 150 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

4454464459446044614462

4463

44644465

4466

4467

4468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498

447

Page 151: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

14. References

14.1 Normative References

[ACPI] Advanced Configuration and Power Interface Specification Revision 5.0 Errata A, November 2013.http://www.acpi.info/DOWNLOADS/ACPI_5_Errata%20A.pdf

[DSP1027] DMTF Power State Management Profile, DSP1027, December 2009. http://www.dmtf.org/standards/published_documents/DSP1027_2.0.0.pdf

[IANAIPP] IANA IPP Registry, http://www.iana.org/assignments/ipp-registrations/ipp-registrations.xhtml

[IEEE1284] Standard Signaling Method for a Bi-directional Parallel Peripheral Interface for Personal Computers, IEEE 1284, January 2000.

[IEEE1621] “Standard for User Interface Elements in Power Control of Electronic Devices Employed in Office/Consumer Environments”, IEEE 1621, December 2004.

[ISO10175-1] T. Hastings et al, “ISO Document Printing Application (DPA) Part 1: Abstract Service Definition and Procedures”, ISO 10175-1, 1996

[ISO10175-3] T. Hastings et al, “ISO Document Printing Application (DPA) Part 3: Management Abstract Service Definition and Procedures”, ISO 10175-1, 1996

[PWG5100.1FIN] S. Kennedy, M. Sweet, “IPP Finishings 2.1 (FIN)”, PWG 5100.1-2017work-in-progress, February 2017November 2016,http://ftp.pwg.org/pub/pwg/candidates/cs-ippfinishings21-20170217-5100.1.pdfhttp://ftp.pwg.org/pub/pwg/ipp/wd/wd-ippfinishings21-20161109.pdf

[PWG5100.12] R. Bergman, H. Lewis, I. McDonald, M. Sweet, “IPP Version 2.0, 2.1, and 2.2”, PWG Standard 5100.12-2015, October 2015,http://ftp.pwg.org/pub/pwg/standards/std-ipp20-20151030-5100.12.pdf

[PWG5100.13] M.Sweet, I. McDonald, P. Zehler, “IPP Job and Printer Extensions – Set 3”, PWG 5100.13-2012, July 2012,http://ftp.pwg.org/pub/pwg/candidates/cs-ippjobprinterext3v10-20120727-5100.13.pdf

[PWG5100.14] M. Sweet, I. McDonald, A. Mitchell, J. Hutchings, “IPP Everywhere”, PWG 5100.14-2013, January 2013,

Page 151 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

448449

4499

4500

450145024503

450445054506

450745084509

45104511

451245134514

45154516

451745184519

45204521452245234524

452545264527

4528452945304531

45324533

450

Page 152: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

http://ftp.pwg.org/pub/pwg/candidates/cs-ippeve10-20130128-5100.14.pdf

[PWG5100.15] M. Sweet, “IPP FaxOut Service”, PWG 5100.15-2014, June 2014,http://ftp.pwg.org/pub/pwg/candidates/cs-ippfaxout10-20140618-5100.15.pdf

[PWG5100.17] P. Zehler, M. Sweet, “IPP Scan Service”, PWG 5100.17-2014, October 2014, http://ftp.pwg.org/pub/pwg/candidates/cs-ippscan10-20140918-5100.17.pdf

[PWG5100.18] M. Sweet, I. McDonald, “IPP Shared Infrastructure Extensions (INFRA)”, PWG 5100.18-2015, June 2015,http://ftp.pwg.org/pub/pwg/candidates/cs-ippinfra10-20150619-5100.18.pdf

[PWG5100.21P3D] M. Sweet, “IPP 3D Printing Extensions (3D)”, PWG 5100.21-2017work-in-progress, February 2017November 2016,http://ftp.pwg.org/pub/pwg/candidates/cs-ipp3d10-20170210-5100.21.pdf http://ftp.pwg.org/pub/pwg/ipp/wd/wd-ipp3d10- 20161114.pd f

[PWG5105.1] P. Zehler, T. Hastings, S. Albright, “Semantic Model v1.0”, PWG 5105.1-2004, January 2004,http://ftp.pwg.org/pub/pwg/candidates/cs-sm10-20040120-5105.1.pdf

[PWG5106.1] P. Zehler, H. Lewis, I. McDonald, J. Thrasher, W. Wagner, “Standardized Imaging Counters 1.1”, PWG 5106.1-2007, April 2007,http://ftp.pwg.org/pub/pwg/candidates/cs-wimscount11-20070427-5106.1.pdf

[PWG5106.3] I. McDonald, “Imaging System State and Counter MIB v2”, PWG5106.3-2008, March 2008,ftp://ftp.pwg.org/pub/pwg/candidates/cs-wimscountmib20-20080318-5106.3.pdfftp://ftp.pwg.org/pub/pwg/candidates/cs-wimscountmib20-20080318-5106.3.mib

[PWG5106.4] I. McDonald, “Power Management Model for Imaging Systems 1.0”, PWG 5106.4-2011, February 2011,http://ftp.pwg.org/pub/pwg/general/pwg-process-30.pdf

[PWG5107.2] I. McDonald, “PWG Command Set Format for IEEE 1284 Device ID v1.0”, PWG 5107.2-2010, May 2010,http://ftp.pwg.org/pub/pwg/candidates/cs-pmp1284cmdset10-20100531-5107.2.pdf

Page 152 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

45145245344535

453645374538

4539454045414542

4543454445454546

45474548454945504551

455245534554

4555455645574558

455945604561456245634564

456545664567

4568456945704571

453

Page 153: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

[PWG5108.01] W. Wagner, P. Zehler, “MFD Model and Common Semantics”, PWG 5801.01-2011, April 2011,http://ftp.pwg.org/pub/pwg/candidates/cs-sm20-mfdmodel10-20110415-5801.1.pdf

[PWG5108.02] N. Chen, P. Zehler, “Network Scan Service Semantic Model and Service Interface”, PWG 5108.02, April 2009,http://ftp.pwg.org/pub/pwg/candidates/cs-sm20-scan10-20090410-5108.02.pdf

[PWG5108.03] N. Chen, I. McDonald, P. Zehler, “Network Resource Service Semantic Model and Service Interface”, PWG 5108.03, July 2009,http://ftp.pwg.org/pub/pwg/candidates/cs-sm20-resource10-20090703-5108.03.pdf

[PWG5108.05] P. Zehler, “FaxOut Service Semantic Model and Service Interface”, PWG 5108.05-2011, August 2011,http://ftp.pwg.org/pub/pwg/candidates/cs-sm20-faxout10-20110809-5108.05.pdf

[PWG5108.06] P. Zehler, "System Object and System Control Service Semantics", PWG 5108.06-2012, February 2012, http://ftp.pwg.org/pub/pwg/candidates/cs-sm20-system10-20120217-5108.06.pdf

[PWG5109.1] R. Nevo, W. Wagner, “Cloud Imaging Requirements and Model (IMAGINGMODEL)”, PWG 5109.1-2015, June 2015,http://ftp.pwg.org/pub/pwg/candidates/cs-cloudimagingmodel10-20150619-5109.1.pdf

[RFC2119] S. Bradner, "Key words for use in RFCs to Indicate Requirement Levels", RFC 2119/BCP 14, March 1997, https://tools.ietf.org/html/rfc2119

[RFC2707] R. Bergman, T. Hastings, S. Isaacson, H. Lewis, “Job Monitoring MIB - V1.0, RFC 2707, November 1999, https://tools.ietf.org/html/rfc2707

[RFC3275] D. Eastlake 3rd, J. Reagle, D. Solo, “(Extensible Markup Language) XML-Signature Syntax and Processing”, RFC 3275, March 2002, https://tools.ietf.org/html/rfc3275

[RFC3380] T. Hastings, R. Herriot, C. Kugler, H. Lewis, “Internet Printing Protocol (IPP): Job and Printer Set Operations”, RFC 3380, September 2002, https://tools.ietf.org/html/rfc3380

Page 153 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

4544554572457345744575

4576457745784579

4580458145824583

4584458545864587

4588458945904591

4592459345944595

459645974598

459946004601

460246034604

460546064607

456

Page 154: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

[RFC3510] R. Herriot, I. McDonald, “Internet Printing Protocol/1.1: IPP URL Scheme”, RFC 3510, April 2003, https://tools.ietf.org/html/rfc3510

[RFC3805] R. Bergman, H. Lewis, I. McDonald, "Printer MIB v2", RFC 3805, June 2004, https://tools.ietf.org/html/rfc3805

[RFC3806] R. Bergman, H. Lewis, I. McDonald, "Printer Finishing MIB", RFC 3806, June 2004, https://tools.ietf.org/html/rfc3806

[RFC3995] R. Herriot, T. Hastings, “Internet Printing Protocol (IPP): Event Notifications and Subscriptions”, RFC 3995, March 2005, https://tools.ietf.org/html/rfc3995

[RFC3996] R. Herriot, T. Hastings, H. Lewis, “Internet Printing Protocol (IPP): The 'ippget' Delivery Method for Event Notifications”, RFC 3996, March 2005, https://tools.ietf.org/html/rfc3996

[RFC6350] S. Perreault, “vCard Format Specification”, RFC 6350, August 2011, https://tools.ietf.org/html/rfc6350

[RFC7472] I. McDonald, M. Sweet, “Internet Printing Protocol (IPP) over HTTPS Transport Binding and the 'ipps' URI Scheme”, RFC 7472, March 2015, https://tools.ietf.org/html/rfc7472

[RFC8010] M. Sweet, I. McDonald, “Internet Printing Protocol/1.1: Encoding and Transport”, RFC 8010, January 2017, https://tools.ietf.org/html/rfc8010

[RFC8011] M. Sweet, I. McDonald, “Internet Printing Protocol/1.1: Model and Semantics”, RFC 8011, January 2017, https://tools.ietf.org/html/rfc8011

[UAX9] Unicode Consortium, “Unicode Bidirectional Algorithm”, UAX#9, May 2016,http://www.unicode.org/reports/tr9

[UAX14] Unicode Consortium, “Unicode Line Breaking Algorithm”, UAX#14, June 2016,http://www.unicode.org/reports/tr14

[UAX15] Unicode Consortium, “Normalization Forms”, UAX#15, February 2016,

http://www.unicode.org/reports/tr15

Page 154 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

457458460846094610

46114612

461346144615

461646174618

4619462046214622

46234624

4625462646274628

462946304631

463246334634

463546364637

463846394640

464146424643

459

Page 155: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

[UAX29] Unicode Consortium, “Unicode Text Segmentation”, UAX#29, June 2016, http://www.unicode.org/reports/tr29

[UAX31] Unicode Consortium, “Unicode Identifier and Pattern Syntax”, UAX#31, May 2016,http://www.unicode.org/reports/tr31

[UNICODE] Unicode Consortium, "Unicode Standard", Version 10.0.0, June 2017, http://unicode.org/versions/Unicode9.0.0/

[UTS10] Unicode Consortium, “Unicode Collation Algorithm”, UTS#10, May 2016,http://www.unicode.org/reports/tr10

[UTS35] Unicode Consortium, “Unicode Locale Data Markup Language”, UTS#35, October 2016,http://www.unicode.org/reports/tr35

[UTS39] Unicode Consortium, “Unicode Security Mechanisms”, UTS#39, June 2016,http://www.unicode.org/reports/tr39

14.2 Informative References

[ENISAALG] ENISA Algorithms, Key Size and Parameters Report, November 2014.https://www.enisa.europa.eu/publications/algorithms-key-size-and-parameters-report-2014/at_download/fullReport

[FIPS186-4] US NIST Digital Signature Standard, FIPS186-4, July 2013.http://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.186-4.pdf

[RFC2567] F.D. Wright, “Design Goals for an Internet Printing Protocol”, RFC 2567, April 1999, https://tools.ietf.org/html/rfc2567

[RFC5209] P. Sangster, H. Khosravi, M. Mani, K. Narayan, J. Tardo, “Network Endpoint Assessment (NEA): Overview and Requirements”, RFC 5209, June 2008, https://tools.ietf.org/html/rfc2119

[TS102853] ETSI Electronic Signatures and Infrastructures (ESI); Signature validation procedures and policies, ETSI TS 102 853 v1.1.2, October 2012,

Page 155 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

460461464446454646

464746484649

46504651

465246534654

465546564657

465846594660

4661

4662

466346644665

46664667

466846694670

4671467246734674

467546764677

462

Page 156: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

http://www.etsi.org/deliver/etsi_ts/102800_102899/102853/01.01.02_60/ts_102853v010102p.pdf

[UTR17] Unicode Consortium “Unicode Character Encoding Model”, UTR#17, November 2008,http://www.unicode.org/reports/tr17

[UTR20] Unicode Consortium “Unicode in XML and other Markup Languages”, UTR#20, January 2013,http://www.unicode.org/reports/tr20

[UTR23] Unicode Consortium “Unicode Character Property Model”, UTR#23, May 2015,http://www.unicode.org/reports/tr23

[UTR33] Unicode Consortium “Unicode Conformance Model”, UTR#33, November 2008,http://www.unicode.org/reports/tr33

[UNISECFAQ] Unicode Consortium “Unicode Security FAQ”, November2016,http://www.unicode.org/faq/security.html

15. Authors' AddressesPrimary authors:

Ira McDonaldHigh NorthPO Box 221Grand Marais, MI [email protected]

Michael SweetApple Inc.1 Infinite LoopCupertino, CA [email protected]

The authors would also like to thank the following individuals for their contributions to this standards-track document:

Smith Kennedy (HP Inc)William Wagner (TIC)Peter Zehler (Xerox)

Page 156 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

46346446784679

468046814682

468346844685

468646874688

468946904691

46924693

4694

4695

46964697469846994700470147024703470447054706

47074708

470947104711

465

Page 157: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

16. Appendix A – Rationale for Design ChoicesThis section describes the rationale for important design choices made in the development of this IPP System Service specification.

16.1 Resource Object

16.1.1 Move Resource Service operations into System Service

The PWG Network Resource Service [PWG5108.03] was unique because it wasn’t a Job service and was implicitly a capability of the overall System. Therefore, selected Resource operations have been incorporated into the System Service.

16.1.2 Remove some Resource operations

The PWG Network Resource Service [PWG5108.03] defined a DeleteResource operation that was incompatible with System log files and audit trail mechanisms. Instead a new Cancel-Resource operation has been added to the System Service that permanently removes the Resource from further use but preserves the Resource metadata in a Resource History phase for correlation with System log files.

The PWG Network Resource Service [PWG5108.03] defined a RetrieveResource operation for reading the contents of the Resource data that was inherently insecure. This operation has been removed from the System Service.

The PWG Network Resource Service [PWG5108.03] defined a ReplaceResource operation for replacing the contents of the Resource data that was inherently insecure. This operation has been removed from the System Service.

The PWG Network Resource Service [PWG5108.03] defined a RenewResource operation for renewing the lease on a Resource. This operation has been removed from the System Service.

The PWG Network Resource Service [PWG5108.03] defined a set of Administrative service-level operations (DisableResourceService, EnableResourceService, RestartResourceService, ShutdownResourceService, and StartupResourceService). These operations have been removed from the System Service.

16.1.3 Decompose some Resource operations

The PWG Network Resource Service [PWG5108.03] defined a single operation StoreResource that both created the Resource metadata object and uploaded the Resource data, by analogy to the Print-Job operation defined in [RFC8011]. Consistent with current PWG design philosophy, this StoreResource operation has been decomposed into Create-Resource (create Resource object), Send-Resource-Data (upload Resource

Page 157 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

466467

4712

47134714

4715

4716

471747184719

4720

47214722472347244725

472647274728

472947304731

473247334734

4735473647374738

4739

47404741474247434744

468

Page 158: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

data), and Install-Resource (install executable, static, or template Resource for use). Installation of an executable Resource (e.g., firmware) can involve a System or Subunit reboot to complete.

16.1.4 Replace Resource lease with Resource state

The PWG Network Resource Service [PWG5108.03] used the lease concept from the Subscription object defined in [RFC3995]. There was a strong consensus to move away from leases and instead add a new “resource-state” Resource Status attribute for clarity and flexibility.

16.2 Printer Object

[16.2.1] Restrict “printer-id” range to 65535 (16-bit)

For compatibility with IETF Printer MIB v2 [RFC3805] and existing discovery protocols the maximum value of “printer-id” and members of “printer-ids” is restricted to 65535 (16-bit unsigned maximum value). Although some IPP implementations might support more than 65535 print queues, this 16-bit restriction was deemed important for best compatibility with SNMP, Bluetooth, and other interfaces. Implementations needing more than 65535 print queues can use “printer-uuid” and/or partitioning of “printer-id” number spaces.

Page 158 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

469470474547464747

4748

4749475047514752

4753

4754

475547564757475847594760

471

Page 159: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

17. Change History

17.1 1 0 September 2017

- Prototype draft – changes per PWG F2F review on 9 August 2017- global – accepted all changes from previous draft- global – replaced all [PWG.SYS] entries with “<none>” in section section 5 IPP Objects and Operations Summary- global – changed “Set- Resource-Attributes” to “Set-Resource-Attributes (removed space)- revised section 5.2 System Description Attributes to add “Note: An SM/IPP Equivalent entry of “<none>” indicates that there is no previously defined equivalent attribute and the attribute is defined for the first time in this specification.”- revised section 5.2 System Description Attributes Table 1 to change “SM Element Name” to “SM/IPP Equivalent”, change “resource-settable-attributes-supported” mapping to “job-settable-attributes-supported”, change “system-default-printer-id” mapping to <none>, and correct note 7- revised section 5.3 System Status Attributes Table 2 to change “SM Element Name” to “SM/IPP Equivalent” and change “system-strings-uri” mapping to “printer-strings-uri”- revised section 5.4 System Operations Table 3 to change “SM Operation Name” to “SM/IPP Equivalent”, add operation IDs from IANA section and other specs, add Get-Printer-Resources (analogous to Get-Resources), change note 6 to state that Register-Output-Device is CONDITIONALLY REQUIRED for systems that implement IPP Shared Infrastructure Extensions [PWG5100.18], change note 8 to reference the IPP Event Notifications and Subscriptions [RFC3995] operation extensions for the System Service, and add note 10 for Get-Printer-Resources- revised section 5.6 Resource Description Attributes Table 4 to change “SM Element Name” to “SM/IPP Equivalent” (for consistency)- revised section 5.7 Resource Status Attributes Table 5 to change “SM Element Name” to “SM/IPP Equivalent”, correct “date-time-at-xxx” and “time-at-xxx” attributes to Job in [RFC8011], and add more details to most notes- revised section 5.8 Printer Description Attributes Table 6, section 5.9 Printer Status Attributes Table 7, and section 5.10 Job Status Attributes to change “SM Element Name” to “SM/IPP Equivalent” and add appropriate <none> entries- revised section 6 IPP Operations to rewrite summary of Client authentication and authorization requirements and explain exception for Get-Printer-Attributes (for legacy compatibility)- revised section 6.1 Printer Operations, section 6.2 Resource Operations, section 6.3 Subscription Operations, and section 6.4 System Operations to add summary of scope of operations and note about propagation of “printer-message-from-operator” operation attributes to target Printers in section 6.1 and “system-message-from-operator” operation attributes to “printer-message-from-operator” on affected Printers and in section 6.4- added section 6.1.7 Get-Printer-Resources for an authorized End User (analogous to Get-Resources for an authorized Operator or Administrator)

Page 159 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

472473

4761

4762

4763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802

474

Page 160: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

- revised all tables in section 13. IANA and PWG Considerations to use Example style for single-spaced alignment- moved former section 6.1.6 Get-Printer-Attributes (misplaced) to section 8.2 Get-Printer-Attributes and explained choice of “system-uri” (implicit default Printer) or “printer-uri” (explicit target Printer)- revised section 6.3.1 Create-Resource-Subscriptions to create “one or more System Subcription objects on Resources”- revised section 6.3.2 Create-System-Subscriptions to create “one or more System Subcription objects”- revised section 6.4 System Operations to change “printer-message-from-operator” to “system-message-from-operator” throughout for consistency- revised section 6.4.3.1 Get-System-Attributes Request to change “System MUST all” to “System MUST return all”- revised section 6.4.4.1 Get-System-Supported-Values to change “System MUST all” to “System MUST return all” and change “xxx-supported-attributes” to “xxx-supported” attributes (no trailing quote mark)- revised section 6.4.5 Pause-All-Printers and section 6.4.6 Pause-All-Printers-After-Current-Job to change “removed from “printer-state-reasons”” to “removed from their “printer-state-reasons” (change to Printer objects rather than System object- revised section 6.4.7 Register-Output-Device paragraph on “Access Rights” to change “Proxy of the Printer” to “Proxy of the System” and change “Infrastructure Printer” to “System” and correct operation attribute to “output-device-id” (uri(45))- revised section 6.4.8 Restart-System to add comment about possible addition of a state change diagram (System and Printers)- revised section 6.4.8 Restart-System to note potential use for cleanup of non-responsive or corrupt Printers and also for “software rejuvenation” (proactive restart to mitigate performance degradation and other associated failures related to “software aging”) based on AT&T research in the 1990s- revised section 6.4.8.2 Restart-System Response for “restart-get-interval” to change “should” to “SHOULD” (conformance recommendation)- revised section 7.1.15 resource-type to change “Create-Resources” to “Create-Resource”- revised section 7.1.17 restart-get-interval to change “specifies and interval” to “specifies an interval”- revised section 7.2.4 ipp-features-supported to add “semantically analogous” clause- revised section 7.2.5 ipp-versions-supported to change “REQUIRED attribute” to “REQUIRED System attribute”- revised section 7.7.8 resource-state to change “transitions are show” to “transitions are shown”- revised sections 13 IANA and PWG Considerations to use Example style for registration templates (single-spaced)- revised section 13.4 Type2 enum Attribute Value Registrations to add new Get-Printer-Resources and assign new operation ID of “0x0065”- revised section 14.1 Normative References to update for FIN and IPP 3D final versions- revised section 16.2.1 Restrict “printer-id” to simplify title

Page 160 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

47547648034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846

477

Page 161: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

17.2 19 July 2017

- Prototype draft – changes per IPP WG review on 29 June 2017- global – accepted changes before section 6.2.7 from previous draft- global – accepted all “xxx-attributes-supported” removals of infix of “type2”- global – accepted all “printer-id” and “printer-ids” range changes from ‘1:MAX’ to ‘1:65535’for compatibility with Printer MIB and discovery protocols- global – accepted all “requesting-user-vcard” and “system-device-id” range changes from ‘1023’ to ‘MAX’ to retain explicit range for clarity- global – added final System Attributes group to responses of all operations that can change the state of the System as a side-effect (e.g., Create-Printer, Pause-All-Printers)- global – replaced “<none>” in SM object references in tables in section 5 with IPP spec reference (for identical or analogous attribute)- global – changed “Attrbutes” to “Attributes” in numerous operations- revised section 5.7 Resource Status Attributes to fix Figure 1 section reference for “resource-state”- revised section 6 IPP Operations to add paragraph about authorized Operator or Administrator for all operations except Get-Printers and Get-Printer-Attributes- revised section 6.1.5 Get-Printers and section 6.1.6 Get-Printer-Attributes to change “authorized Client” to “authorized User”- revised section 6.2.3 Get-Resources and section 6.2.4 Get-Resource-Attributes to remove note about Client authentication from all individual operation definitions- revised section 6.2.7 Set-Resource-Attributes to define the operation- revised section 6.3.1 Create-Resource-Subscriptions and section 6.3.2 Create-System-Subscriptions to change “authorized Client” to “authorized Operator or Administrator- revised section 6.4.4 Get-System-Supported-Values to define the operation- revised section 6.4.8 Restart-System to define the operation, including the “restart-get-interval” response attribute analogous to “notify-get-interval” in [RFC3996].- revised section 7.1 IPP Operation Attributes and section 13.2 Attribute Registrations to add “restart-get-interval” for use in Restart-System response- revised section 14.1 Normative References to update for Unicode 10- revised section 16.2.1 Restrict “printer-id” range to 65535 (16-bit) to include recommendation that implementations that support more than 65535 print queues can use “printer-uuid” and/or partitioning of “printer-id” number spaces- TODO – complete section 8 Additional Semantics for Existing Operations and section 9 Additional Values for Existing Attributes

17.3[17.2] 24 June 2017

- Interim draft – changes per comments and new text from Mike Sweet- global – kept all changes from previous draft (not yet reviewed)- global – revised all “xxx-attributes-supported” to remove infix of “type2” because these attributes do not have a registered set of values (and support vendor extensions as well)- global – changed the range of all “printer-id” and “printer-ids” from ‘1:MAX’ to ‘1:65535’for compatibility with Printer MIB and discovery protocols

Page 161 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

478479

4847

48484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882

4883

488448854886488748884889

480

Page 162: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

- global – changed the range of all “requesting-user-vcard” and “system-device-id” from ‘1023’ to ‘MAX’ to retain explicit range for clarity- revised section 5.2 System Description Attributes in Table 1 and added section 7.2.4 ipp-features-supported for consistency- revised section 6.4.7 Register-Output-Device to define the operation from Mike Sweet – thanks!- revised section 6.4.10 Set-System-Attributes to define the operation- revised section 7.3.10 system-configured-resources in Table 11 and added section 7.3.10.7 resource-state-reasons for consistency- revised section 7.3.15 system-state-message to change syntax from ‘1setOf’ (like PWG System Service) to single-valued for consistency with existing Printer object- added complete section 13 IANA Considerations (412 lines!) from Mike Sweet – thanks!- added section 16.2.1 Restrict “printer-id” range to 65535 (16-bit) to document design choice for compatibility- TODO – define remaining operations Set-Resource-Attributes, Get-System-Supported-Values, and Restart-System- TODO – add final response group of System attributes for all operations that can change System state (as a side-effect)

17.4[17.3] 9 May 2017

- Interim draft – changes per PWG F2F review on 3 May 2017- global – accepted all changes per complete review at PWG F2F- revised section 6.1.1.2 Allocate-Printer-Resources Response to change “Groups” to “Group”- revised section 6.1.1.2 Allocate-Printer-Resources Response to clarify that “printer-resource-ids” returns the complete list of Resources currently allocated to the Printer (not just ones added by “resource-ids”)- revised section 6.1.3.2 Deallocate-Printer-Resources Response to clarify that “printer-resource-ids” returns the complete list of Resources currently allocated to the Printer (not just ones removed by “resource-ids”)- revised section 6.2.3 Get-Resources to define the operation- revised section 6.2.4 Get-Resource-Attributes to define the operation- revised section 6.4.3 Get-System-Attributes to define the operation- revised section 6.4.5 Pause-All-Printers and section 6.4.9 Resume-All-Printers to clarify “printer-state”, “printer-state-reasonse”, and “system-state” transitions- revised section 6.4.6 Pause-All-Printers-After-Current-Job to define the operation- added section 7.1.9 resource-formats for Get-Resources operation filters.- added section 7.1.14 resource-states for Get-Resources operation filters.- added section 7.1.17 resource-typess for Get-Resources operation filters.- TODO – define remaining operations Set-Resource-Attributes, Get-System-Supported-Values, Register-Output-Device (with Mike’s help), Restart-System, and Set-System-Attributes- TODO – add final response group of System attributes for all operations that can change System state (as a side-effect)

Page 162 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

481482489048914892489348944895489648974898489949004901490249034904490549064907

4908

490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932

483

Page 163: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

17.5[17.4] 14 March 2017

- Interim draft – changes per PWG F2F review on 14 February 2017- global – accepted all changes per complete review at PWG F2F- global – deleted the redundant and confusing phrase “optional to supply” (with a lowercase conformance keyword) in numerous places- global – revised all Printer operations to return at least “printer-id”, “printer-uuid”, “printer-xri-supported”, “printer-state”, “printer-state-reasons”, and “printer-is-accepting-jobs”- global – revised section 14 References to use https://tools.ietf.org/ for all RFCs and revise all Unicode references to latest versions- revised section 5.2 System Description Attributes Table 1 to add note 11 for “resource-type-supported” for Create-Resource operation (previously note 10 was overloaded)- revised section 6.1.1 Allocate-Printer-Resources to add all request and response attributes- revised section 6.1.3 Deallocate-Printer-Resources to add all request and response attributes- revised section 6.1.4 Delete-Printer to add all request and response attributes- revised section 6.1.7 Shutdown-One-Printer to add all request and response attributes- revised section 6.1.8.2 Startup-One-Printer Response to add all response attributes- revised section 6.4 System Operations to add all request and response attributes- revised section 6.4.5 Pause-All-Printers, section 6.4.9 Resume-All-Printers, section 6.4.11 Shutdown-All-Printers, and section 6.4.12 Startup-All-Printers to add appropriate parenthetical clauses for transitional value of “printer-state-reasons”

17.6[17.5] 12 February 2017

- Interim draft – changes per IPP WG reviews on 11 and 25 January 2017- global – accepted all changes per complete review at last two IPP WG calls- global – verified that the “If accepted, the System MUST…” conditional was present in all operation definitions (it was)- global – revised Printer and Job object attribute notes and several operation descriptions to clarify that the Client *optionally* supplies “resource-ids” for Create-Printer or Job Creation operations for assignment of necessary resources in “printer-resource-ids” or “job-resource-ids” status attributes- revised section 5.2 System Description Attributes Table 1 note 10 about “resource-format-supported” to change reference to Create-Resource (no longer used) to Send-Resource-Data- revised section 6.2.2.2 Create-Resource Response to change “resource-format” to “resource-format-accepted” (for subsequent Send-Resource-Data)- revised section 6.2.6 Send-Resource-Data to remove stray “0” from “REQUIRED” in first sentence and add missing single quotes around ‘pending’ in third paragraph- revised section 6.3.1 Create-Resource-Subscriptions to change “Systems” to “System”- revised section 6.3.2.1 Create-System-Subscriptions Request and section 6.3.2.2 Create-System-Subscriptions Response to change “Create-Resource-Subscriptions” to “Create-System-Subscriptions”- revised section 6.4.1 Disable-All-Printers and section 6.4.2 Enable-All-Printers to replace

Page 163 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

484485

4933

493449354936493749384939494049414942494349444945494649474948494949504951495249534954

4955

49564957495849594960496149624963496449654966496749684969497049714972497349744975

486

Page 164: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

sentence about changing System state with “does not change the System state”- revised section 6.4.2.1 Enable-All-Printers Request to move “successful-ok” sentence up to first paragraph of section 6.4.2 Enable-All-Printers- revised section 6.4.5 Pause-All-Printers to change to say the System becomes ‘stopped’ only “if all configured Printers have moved to the 'stopped' state”- revised section 6.4.9 Resume-All-Printers to add qualification about adding the (new) ‘resuming’ value to “printer-state-reasons” (if there was another reason for the Printer to remain in the ‘stopped’ state)- revised section 6.4.11 Shutdown-All-Printers to say that the System MAY change to the ‘stopped’ state if all configured Printers have completed shutdown and moved to the ‘stopped’ state and that only Printers not *already* shutdown will be affected (i.e., redundant shutdown will be ignored)- revised section 6.4.12 Startup-All-Printers to clarify that it will startup *or restart* (for started Printers) all configured Printers- revised section 6.4.12.2 Startup-All-Printers Response (prototype for future attributes cut-and-paste to many other operations) to add Groups 2-N: Printer Attributes returning “printer-id”, “printer-uuid”, “printer-xri-supported”, “printer-state”, and “printer-state-reasons” (same as Create-Printer response)- revised section 7.1.7 resource-format to change to single valued (for Send-Resource-Data and filter in Get-Resources)- added section 7.1.8 resource-format-accepted for multi-valued response to Create-Resource- revised section 7.1.12 resource-signature to change “request override an” to “request override of an” and “Secuity” to “Security” (typos)- revised section 7.2.12 resource-format-supported to delete reference to Create-Resource request (now only specified in Send-Resource-Data request)- added section 9.2 printer-state-reasons (1setOf type2 keyword) for new ‘resuming’ value (and probably others?)- revised section 12.5 Digital Signature Validation to clarify that (notes) that post-Install revalidation of digital signatures might be useful for auditing and malicious software scans, but such activities are outside the scope of this specification- revised section 14.1 Normative References and section 14.2 Informative References to move digital signature validation references to informative status- TODO - expand all request/response sections in section 6 to list all attributes (and not just a reference to Startup-All-Printers)- TODO – add status-code text to section 6 preamble and to all operations in sections 6.x- TODO – fix all the broken section 6.x references from the reorganization of section 6

17.7[17.6] 8 January 2017

- Interim draft – changes per IPP WG review on 14 December 2016- global – accepted all changes per complete review at last IPP WG call- global – revised copyright year in headers, footers, and preface- global – simplified text at start of all Request and Response operation sections and

Page 164 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

4874884976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012

5013

5014

5015501650175018

489

Page 165: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

moved all conformance requirements from Response section header to first paragraphs in operation definitions- global – changed typo “Subcription” to “Subscription”- global – changed “[PWG5106.06]” reference to “[PWG5108.03]” in Resource operations- global – deleted references in response attributes in section 6- global – revised section 6 IPP Operations to reorder clauses of all operation definitions for consistency and to localize state changes to a single paragraph beginning “If accepted, the System MUST…”- global – checked for remaining references to obsolete RFC 3381 and RFC 3382 – none- revised section 4.6 Resource Object to change “scope of allocation” to “allocation scope”- revised section 5.10 Job Status Attributes to change “support the the” to “support the”- revised section 6.2.2.1 Create-Resource Request to delete “resource-format” request attribute- revised section 6.2.2.2 Create-Resource Response to add multi-valued “resource-format” response attribute based on specified “resource-type” in request- revised section 6.2.6.1 Send-Resource-Data Request to add “resource-format”- revised section 6.2.5 Install-Resource to change to ““resource state” is not 'available’ or the "resource-state-reasons" includes 'install-requested'…” and “System MUST validate any Resource signature supplied…”- revised section 6.2.5 Install-Resource and section 6.2.6 Send-Resource-Data to also refer to US NIST [FIPS186-4] and ENISA Algorithms [ENISAALG] for signature validation- revised section 6.2.5.1 Install-Resource Request to add missing period- revised section 6.2.6 Send-Resource-Data to change to ““resource-state” is not ‘pending’…” and “System SHOULD validate any Resource signature supplied…”- revised section 7.1.11 resource-signature, to describe recommended support for signature override and forward reference section 12 Security Considerations for details of digital signature handling issues- revised section 12 Security Considerations with text imported from IPP 3D (and expanded) and new sections for Digital Signature Validation and Encrypted Resources (not just TLS data-in-transit)- revised section 14.1 Normative References to add references to US NIST [FIPS186-4] and ENISA Algorithms [ENISAALG]

17.8[17.7] 11 December 2016

- Interim draft – changes per IPP WG review on 30 November 2016- global – accepted all changes per complete review at last IPP WG call- global – changed “one or more requested per-Xxx“ to “one or more per-Xxx“- global – replaced [RFC2910] and [RFC2911] w/ [RFC8010] and [RFC2911]- revised section 4.6 Resource Object, to add a paragraph about Resource scope, replace left paren w/ comma, and fix broken section reference for Figure 1- revised section 4.6 Resource Object, section 5.10 Job Status Attributes, and section 7.1.6 requesting-user-vcard, to change “Create-Job operation” to “Job Creation operation”- revised section 5.2 System Description Attributes and Table 1 to add “system-mandatory-printer-attributes” and new note 9 and add “resource-format-supported” and “resource-

Page 165 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

49049150195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050

5052

5053505450555056505750585059506050615062

492

Page 166: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

type-supported” and new note 10- revised section 6.1.5.1 Get-Printers Request text on “requested-attributes” to change “Client SHOULD only supply” to “Client SHOULD supply only” and “System MUST only support” to “System MUST support”- revised section 6.2.5 Install-Resource to add detailed definition including signature, format, and type mandatory validation and data recommended validation- revised section 6.2.6 Send-Resource-Data to add detailed definition including new “resource-signature” operation attribute- revised section Get-Printer-Attributes Request to delete extra “system-uri” and change “System both” to “System MUST support both”- revised section 7.1.9 resource-ids to insert hyphen in “Allocate-Printer-Resources”- added section 7.1.11 resource-signature for out-of-band digital signatures in Send-Resource-Data operations- added section 7.2.12 resource-format-supported and section 7.2.13 resource-type-supported for Create-Resource and Send-Resource-Data operations- revised section 7.2.21 system-mandatory-printer-attributes to change “This attribute MUST include” to “The System MUST include in this attribute” and change “SHOULD include the recommended attributes” to “SHOULD include the values”- revised section 7.7.8 resource-state to replace Figure 1 with higher-fidelity cropped figure taken from Mike’s PDF source image (without the extraneous imbedded Note 1)- revised section 7.7.13 resource-use-count to add “Note: If the System internal use count exceeds MAX, then the System MUST return “resource-use-count” with a value of MAX.”

- revised section 14.1 Normative References to add ETSI TS 102-853 (signature validation) [TS102853], add Smith Kennedy as co-editor to [PWG5100.FIN], add [RFC3275] (digital signatures), delete [RFC3382] (collection syntax), and replace [RFC2910] and [RFC2911] w/ [RFC8010] and [RFC8011]

17.9[17.8] 29 November 2016

- Interim draft – changes per IPP WG at Virtual F2F on 15 November 2016- global – accepted all changes per complete review at Virtual F2F- global – changed “but not included in the Resource object” to “but not included in the original Resource object” for clarity- global – searched for all instances of "specifies a/the list of" and made sure the list is the correct items- global – searched for all instances of “type 2” and changed to “type2” (without space)- revised section 4.2 Subunit Object to clarify that System Service spec does NOT define any explicit System object attributes for access to Subunit objects and instead existing Printer object attributes (e.g., “printer-input-tray” from PWG 5100.13) can be used.- revised section 4.6 Resource Object to state that Resources are persistent until they are explicitly canceled by an Administrator or aborted by the System, discuss “resource-use-count”, and discuss deferred cancelation of busy resources with ‘cancel-requested’ added to “resource-state-reasons”

Page 166 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

4934945063506450655066506750685069507050715072507350745075507650775078507950805081508250835084

50855086508750885089

5091

50925093509450955096509750985099510051015102510351045105

495

Page 167: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

- revised section 4.6 Resource Object to add section 4.6.1 Resource History- revised section 4.6 Resource Object and section 7.7.12 resource-type to state that IPP System Service implementations SHOULD support System-scope executable resources (e.g., for firmware update) and MAY support Printer-scope and/or Job-scope executable resources in an implementation-defined manner- revised section 5.2 System Description Attributes and Table 1 to add “printer-creation-attributes-supported”- revised section 5.6 Resource Description Attributes and section 6.2.2 Create-Resource to add notes about Job-scope Resources (allocated via “resource-ids” operation attribute)- revised section 5.7 Resource Status Attributes and Table 5 to add “resource-use-count”- revised section 6.1.5.1 Get-Printers Request text on “requested-attributes” to say that Clients SHOULD only supply and Systems MUST only support Printer attributes listed as Printer source attributes in the table in section 4 of IETF LDAP Schema for Printer Services [RFC7612]- revised section 6.1.6.1 Get-Printer-Attributes Request to say Clients MUST supply “system-uri” or “printer-uri” and Systems MUST support both “system-uri” and “printer-uri” operation attributes- revised section 6.2.1 Cancel-Resource to move Resource History paragraph up to section 4.6 Resource Object and add backward reference to section 4.6- revised section 6.2.2 Create-Resource to support optional creation of one or more per-Resource Subscription objects with request and response Subscription Attributes groups- revised section 6.2.2 Create-Resource to change “Resource for use” to just “Resource”, change “will change” to “will either change”, delete redundant “keep “resource” state of ‘available’ clause, and Job-scope Resource note- revised section 6.2.5 Install-Resource and section 6.2.6 Send-Resource-Data to add notes about need for validation of Resource metadata- revised section 6.2.7 Set-Resource-Attributes to remove discussion of aborting Resources due to bad Set-Resource-Attributes request- revised section 7.1.2 printer-ids to drop references to Create-Resource and add “list of “printer-id” values for target…”- revised section 7.1.9 resource-ids to add reference to Allocate-Printer-Resources and add “list of “resource-id” values for associated…”- added section 7.2.11 printer-creation-attributes-supported for capabilities in Create-Printer operation- revised section 7.2.12 resource-settable-attributes-supported to change “type 2” to “type2”- revised section 7.2.19 system-mandatory-printer-attributes to add analogy to “printer-mandatory-job-attributes”, reword conformance for ‘printer-name’ and ‘printer-xri-supported’ values, rename Table 9 to Recommended-to-Supply Printer Creation Attributes, and delete redundant Conformance column and Notes below- revised section 7.5.3 printer-service-type to change “SMI number registered by IANA” to “SMI number assigned by IANA”- revised section 7.7.1 date-time-at-canceled and section 7.7.16 time-at-canceled to change “before “resource-state” actually transitions to ‘canceled’” to “the Resource transitions to the ‘canceled’ or ‘aborted’ state”- revised section 7.7.3 date-time-at-installed and section 7.7.18 time-at-installed to change

Page 167 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

4964975106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151

498

Page 168: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

“before “resource-state” actually transitions to ‘installed’” to “before the Resource transitions to the ‘installed’ state”- revised section 7.7.8 resource-state to crop Note 1 from figure and add Note 1 and new Note 2 about special state transitions when a new executable Resource is installed and *replaces* a previous executable Resource (which transitions backwards to ‘available’)- revised section 7.7.8 resource-state, section 7.7.9 resource-state-message, and section 7.7.10 resource-state-reasons to correct the analogy to Job state/message/reasons (from previous Printer analogy)- added section 7.7.13 resource-use-count for Resource allocation count- revised section 14.1 Normative References to update references to [PWG5100.FIN] and [PWG5100.P3D]- TODO – add status-code text to section 6 preamble and to all operations in sections 6.x- TODO – add back explicit full parms for every operation in section 6 per PWG F2F review- TODO – fix all the broken section 6.x references from the reorganization of section 6

17.10[17.9] 1 November 2016

- Interim draft – changes per IPP WG discussion on 19 October 2016- revised prologue to add List of Figures- revised section 4.6 Resource Object and section 5.7 Resource Status Attributes to add forward references to Figure 1 in section 7.7.8 resource-state for Resource life cycle- revised section 7.1 IPP Operation Attributes, section 7.3 System Status Attributes, and section 7.7 Resource Status Attributes to accept previously deleted sections for readability- revised section 7.7.8 resource-state to add Figure 1 IPP Resource Object Life Cycle

17.11[17.10] 18 October 2016

- Interim draft – changes per IPP WG review on 5 October 2016- global – accepted all changes before section 6.1.6 Get-Printer-Attributes (all reviewed by IPP WG)- revised section 5.6 Resource Description Attributes to replicate note taken from Create-Printer operation about how Printer-scope Resources are associated with Printers - revised section 6.1.5.1 Get-Printers Request to remove “printer-uri” (redundant with class Get-Printer-Attributes) since this is a new request- revised section 6.1.5.1 Get-Printers Request to explicitly limit the values of “requested-attributes” to those IPP Printer source attributes listed in the table in section 4 Definition of Attribute Types in the IETF LDAP Schema for Printer Services [RFC7612] (to limit new Get-Printers operation to first-order discovery of appropriate Printers)- revised section 16. Appendix A – Rationale for Design Choices to accept all changes (to reduce editor’s annoyance)

17.12[17.11] 4 October 2016

- Interim draft – changes per IPP WG review on 19 September 2016- global – accepted all changes before section 6 (all reviewed by IPP WG)

Page 168 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

49950051525153515451555156515751585159516051615162516351645165

5166

5167516851695170517151725173

5174

5175517651775178517951805181518251835184518551865187

5188

51895190

501

Page 169: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

- global – removed “resource-printer-id” and “resource-printer-ids” from sections 5, 6, and 7, thus removing interaction with “printer-resource-ids” and rewrote Create-Printer and Create-Resource accordingly- revised sections 4.x to change “are [long|short]-lived objects” to “are typically [long|short]-lived objects”- revised section 5.4 System Operations and Table 3 to add Allocate-Printer-Resources and Deallocate-Printer-Resources- revised section 5.7 Resource Status Attributes and Table 5 to delete “resource-printer-ids” and note 5- added section 6.1.1 Allocate-Printer-Resources and section 6.1.3 Deallocate-Printer-Resources to update Resources associated with a given Printer after Create-Printer- revised section 6.1.2 Create-Printer to clarify choices for associating Resources with a given Printer and refer to Resource upload defined in [PWG5100.18].- revised section 6.2.2 Create-Resource to clarify choices for associating Resources with a given Printer and refer to Create-Resource-Subscription operation.- TODO – add status-code text to section 6 preamble and to all operations in sections 6.x- TODO – add back explicit full parms for every operation in section 6 per PWG F2F review- TODO – fix all the broken section 6.x references from the reorganization of section 6

17.13[17.12] 15 September 2016

- Interim draft – changes per PWG F2F review on 23 August 2016- global – accepted all changes before section 8 (all reviewed at PWG F2F)- global – renamed section 5 to IPP Objects and Operations Summary and revised to delete reference to “system-configured-subunits” and change Description attributes sections from “READ-WRITE” to “potentially READ-WRITE” (consistent with section 7)- global – revised section 6 IPP Operations to replace “allows allows” with “allows”- global – changed “resource-state” keywords of ‘pending’ to ‘created’ and ‘active’ to ‘available,’ added “resource-state” keyword of ‘aborted’, and added “resource-state-reasons” keywords of ‘cancel-requested’, ‘install-requested’, and ‘resource-incoming’ for operations with delayed state transitions- revised section 4 IPP Object Model to add notes that System, Printer, and Resource Owners are mutable (long-lived objects) while Job and Subscription Owners are immutable (short-lived objects)- revised section 4.6 Resource Object to correctly explicitly refer to Send-Resource-Data and Install-Resource operations- revised section 5.3 System Status Attributes and Table 2 to delete reference to “system-configured-subunits”- revised section 5.4 System Operations to include Install-Resource in note 3 and state that the original StoreResource operation has been decomposed into the sequence of Create-Resource, Send-Resource-Data, and Install-Resource and to revise and reference note 4 about Install-Resource- revised section 5.7 Resource Status Attributes and Table 5 to delete “resource-authenticator” and “resource-category” and note 7 about “resource-authenticator”, delete “resource-job-id” and note 5 about “resource-job-id”, and change “resource-printer-id” (singular) to “resource-printer-ids” (a list of explicitly associated Printers)

Page 169 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

502503519151925193519451955196519751985199520052015202520352045205520652075208

5209

5210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234

504

Page 170: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

- revised section 5.9 Printer Status Attributes to delete double period on second list item- revised section 5.9 Printer Status Attributes and Table 7 to add “printer-resource-ids” with note about “resource-ids” operation attribute in Create-Printer- revised section 5.10 Job Status Attributes and Table 8 to add “job-resource-ids” with note about “resource-ids” operation attribute in Job Creation operations- revised section 6 IPP Operations to regroup all operations under Printer, Resource, Subscription, and System Operation subsections (this breaks DOZENS of cross-references throughout the document)- revised note in section 6.1.1 Create-Printer and section 6.2.2 Create-Resource to explain two alternatives for correctly populating “printer-resource-ids” and “resource-printer-ids” status attributes- revised section 6.1.1 Create-Printer to add <all mandatory Printer Description attributes> with reference to “system-mandatory-printer-attributes”- revised section 6.1.1.1 Create-Printer Request to add “resource-ids” operation attribute that requests Resources and is copied (if valid) to the “printer-resource-ids” Printer Status attribute – note that this is intentionally NOT a Printer Description attribute for security- revised section 6.1.3 Get-Printers and section 6.1.4 Get-Printer-attributes to state that the returned Printers and Printer attributes MAY be filtered based on Client access rights (i.e., the value of “requesting-user-name”) or the specified “document-format”- revised section 6.1.3 Get-Printers and section 6.1.4 Get-Printer-attributes to list all operation and response attributes explicitly, add optional “printer-uri” alternative to “printer-ids” or “printer-id” for target Printer, optional “document-format” (for filtering returned attributes), and required “printer-xri-supported” in response- revised section 6.1.4 Get-Printer-attributes to discuss backwards compatibility, change “system-uri” target to “Client SHOULD supply” (for legacy IPP Clients), add back optional “printer-uri” (for legacy IPP Clients), add “first-index” and “element, and change “Groups 3 to N” to “Group 3”- revised section 6.2.1 Cancel-Resource, section 6.2.5 Install-Resource, section 6.2.6 Send-Resource-Data, and section 6.2.7 Set-Resource-Attributes to add that if “resource-state” is ‘canceled’ or ‘aborted’ or “resource-state-reasons” includes ‘cancel-requested’ then System MUST return ‘client-error-not-possible’- revised section 6.2.1 Cancel-Resource to correct typos from “Create-Resource” to “Cancel-Resource”, clarify transition of “resource-state” to ‘canceled’ (could be delayed if Resource is in use in a Job) and “resource-state-reasons” to ‘cancel-requested’, change “MAY” to “SHOULD” for the System delete of Resource data, add a definition of the Resource History lifecycle phase, and state that the System MUST support Resource History period of at least 300 seconds for reliable system log files- revised section 6.2.2 Create-Resource to delete “resource-category” (redundant with resource-type), delete “resource-job-id”, and clarify transitions (and keyword names) of “resource-state” and “resource-state-reasons”- revised section 6.4.3 Get-System-Attributes to add note that we will require explicit request for “system-configured-resources” or “system-configured-printers” (by analogy to “media-col-database” for Get-Printer-Attributes)- renamed section 7.1 System, Printer, Resource, and Job Operation Attributes to simply “Operation Attributes” and added note about their applicability- revised section 7.1 Operation Attributes to add “resource-ids” for Create-Printer and Job

Page 170 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

5055065235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280

507

Page 171: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

Creation operations to list requested Resources- deleted section 7.1.7 resource-category operation attribute- deleted section 7.1.10 resource-job-id operation attribute- revised section 7.2.11 resource-settable-attributes-supported to add missing type- revised section 7.2.13 system-default-printer-id to keep “MAX” and delete “max” in type- added section 7.2.18 system-mandatory-printer-attributes and Table 9 – Mandatory-to-Supply Printer Creation Attributes for use in Create-Printer operation- revised section 7.3.11 system-configured-resources and Table 10 to delete “resource-category”- deleted section 7.3.11.1 resource-category (redundant with resource-type)- revised section 7.3.17 system-state-reasons to state that any applicable “printer-state-reasons” keyword value can be used (to avoid enumerating the existing keywords here)- revised section 7.5.3 printer-service-type to add ‘print3d’, delete ‘emailin’ and ‘emailout’ (security nightmares), delete ‘vendor’ (not interoperable), and add ‘smiNNN-name’ pattern and explanation for vendor service types- revised section 7.7.x “[date-time|time]-at-[cancelation|creation|installation]” to state the timestamps MUST be set at the time the System accepts a Cancel-Resource, Create-Resource, or Install-Resource operation (instead of when the process completes and the appropriate “resource-state-reasons” pending value is removed)- deleted section 7.7.4 resource-authenticator (access info must be included in resource data manifest file)- deleted section 7.7.5 resource-category (redundant with resource-type)- deleted section 7.7.9 resource-job-id (use “job-resource-ids” in Job for association)- revised section 7.7.10 resource-state to define ‘pending’ (after creation), ‘available’ (after upload of data), ‘installed’ (after installation), ‘canceled’ (by Client, not by System), and ‘aborted’ (by System) so that ‘canceled’ and ‘aborted’ are the two alternative terminal states- revised section 7.7.12 resource-state-reasons to define ‘cancel-requested’, ‘install-requested’, and ‘upload-requested’ for delayed completion of the respective operations processing- revised section 7.7.16 resource-type to change reference to “resource-category” reference (an attribute) to simply “resource category” (a prefix for a resource-type) and insert explicit resource category prefix into all “resource-type” keyword values and add ‘template-printer’ for potential Create-Printer extension- revised section 14.1 Normative References to add “PWG5100.P3D” for ‘print3d’ service type- added Appendix A – Rationale for Design Choices – added first Resource topics- TODO – add status-code text to section 6 preamble and to all operations in sections 6.x- TODO – add back explicit full parms for every operation in section 6 per PWG F2F review- TODO – fix all the broken section 6.x references from the reorganization of section 6

17.14[17.13] 18 August 2016

- Interim draft – changes per IPP WG review on 15 August 2016- global – accepted all changes before section 7- global – changed “system-default-printer-uri” (ambiguous, N per Printer) to “system-

Page 171 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

5085095281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320

5321

532253235324

510

Page 172: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

default-printer-id” (explicit, 1 per Printer)- global – changed “resource-printer-uri” (ambiguous, N per Printer) to “resource-printer-id” (explicit, 1 per Printer)- global – changed all Printer operations to replace “printer-uri” (ambiguous, N per Printer) with “printer-id” (explicit, 1 per Printer)- added section 1.2 Get-Printer-Attributes extension (about “default” Printer)- added section 1.3 Printer Identity Extension (about “printer-id”)- revised section 5.9 Printer Status Attributes and Table 7 to add “printer-id” and correct SM references for all three attributes- revised sections 6.x to explicit state requirement for “authorized Operator or Administrator” (most operations), “authorized Client” (few operations), or “unauthenticated Client” (ONLY for Get-Printer-Attributes extended legacy operation)- revised section 6.1 Cancel-Resource to discuss “age” out (delete) of Resource objects in the Resource History (after cancellation) – need some more text here- revised section 6.1.1 Cancel-Resource Request and section 6.4.1 Create-Resource-Subscriptions Request to move up the “resource-id” target operation attribute- revised section 6.2.2 Create-Printer Response to delete “printer-uri” and “printer-uri-supported”, etc and add “printer-id” and “printer-xri-supported”- revised section 6.3 Create-Resource to fix spelling of Install-Resource and “notify-printer-id”- revised section 6.4 Create-Resource-Subscriptions to return “status-code” of ‘client-error-not-possible’ for “resource-state” or ‘canceled’- revised section 6.4 Create-Resource-Subscriptions to change analogy from Create-Printer-Subscriptions to Create-Job-Subscriptions- revised section 6.6.1 Delete-Printer Request to explicitly add the (mandatory to supply) “printer-id” operation attribute- revised section 6.9.1 Get-Printers Request to explicitly add the (optional for Client to supply) “printer-ids” operation attribute- revised section 6.9.2 Get-Printers Response to explicitly add the (mandatory for System to return) “printer-id” Printer response attribute for each Printer object returned- revised section 6.10 Get-Printer-Attributes to change “system-default-printer-uri” to “system-default-printer-id” and add (Client optionally supplies) explicit “printer-id” - revised section 7.1 System, Printer, Resource, and Job Operation Attributes to add “printer-id”- revised section 7.3.9 system-configured-printers and Table 9 to add “printer-id”- revised section 7.5 Printer Status Attributes to define “printer-id” for resource-constrained Clients- TODO – add status-code text to section 6 preamble and to all operations in sections 6.x- TODO – add resource-state discussion and clarify Install-Resource (i.e., could it be immediate without a reboot?)

17.15[17.14] 10 August 2016

- Interim draft – changes per IPP WG review on 25 July 2016- global – accepted all changes before section 7.3.11 system-configured-subunits- renamed section 5.10 from Job Description Attributes to Job Status Attributes for new

Page 172 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

5115125325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364

5365

536653675368

513

Page 173: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

“job-owner-col”- revised sections 6.x to add requesting-user-vcard to all operations (as Client SHOULD supply and System MUST support)- revised section 6.1 Cancel-Resource to define the operation- revised section 6.2 Create-Printer to remove erroneous “printer-uri” as input attribute- revised section 6.3 Create-Resource to refer to new Install-Resource and ‘installed’ value of “resource-state”- revised section 6.4 Create-Resource-Subscriptions to define the operation- revised section 6.5 Create-System-Subscriptions to define the operation- revised section 7.1.4 requesting-user-vcard to clarify usage and that it goes to a Job Status attribute (rather than Description attribute), different from System, Printer, and Resource long-lived objects- revised section 7.3.1 power-log-col to change “transition” to “transitions” (plural) and correct spelling of ‘reset-nmi’ in example- revised sections 7.3.10.x to correct forward references to sections 7.x- revised section 7.3.10.3 resource-id to change “(1:max)” to “(1:MAX)”- deleted former section 7.3.11 system-configured-subunits per consensus- deleted former section 7.3.18 system-totals per consensus (redundant with counters in Printer service objects)- revised section 7.7.12 resource-state to add ‘installed’ as a first class state for executable Resource objects (which shows in system-configured-resources summary)- renamed section 7.8 from Job Description Attributes to Job Status Attributes for new “job-owner-col”

17.16[17.15] 20 July 2016

- Interim draft – changes per IPP WG review on 11 July 2016- global – accepted all changes before section 7.3.10 system-configured-resources- revised Abstract and Introduction to tighten up wording- revised section 5.6 Resource Description Attributes and Table 4 to add note for REQUIRED “resource-owner-col”- revised section 5.7 Resource Status Attributes and Table 5 to delete “resource-owner-col” (belongs in settable description attributes for change of owner) and associated note- revised section 5.7 Resource Status Attributes and Table 5 to add note for “date-time-at-installed” and “time-at-installed” including analogy to “date-time-at-processing” and “time-at- processing” Job attributes- added section 5.10 Job Description Attributes and Table 8 for “job-owner-col” extension- revised section 7.1.4 “requesting-user-vcard” to extend to System, Printer, Resource, and Job objects and discuss “most authenticated” user identity with pointer to “job-originating-user-name” in [RFC8011].- revised section 7.3.1 “power-log-col” to discuss minimizing log entries, MUST log final states, and MAY omit intermediate states (e.g., from ‘resetNMI’)- revised section 7.3.9 “system-configured-printers” to add Table 9 of member attributes- revised section 7.3.10 “system-configured-resources” to add Table 10 of member attributes

Page 173 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

51451553695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391

5393

5394539553965397539853995400540154025403540454055406540754085409541054115412

516

Page 174: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

- revised section 7.3.11 “system-configured-subunits” to add Table 11 of member attributes- deleted section 7.3.9.8 “queued-job-count” from “system-configured-printers” (too much detail without much utility)- revised section 7.7.3 “date-time-at-installation” and section 7.7.21 “time-at-installation” to note analogy to analogy to “date-time-at-processing” and “time-at- processing” Job attributes- revised section 7.7.11 “resource-state” to add comment suggesting new first class state of ‘installed’ (follows ‘active’) to show up in “system-configured-resources” summary

17.17[17.16] 6 July 2016

- Interim draft – changes per IPP WG review on 27 June 2016- global – accepted all changes before section 7.3.4 power-state-capabilities-col- global – added many comments with design choice notes- global – replaced “*word*” with “word” in BOLD for consistency- global – revised all System, Printer, and Resource status attribute definitions to use “identifies” or “contains” instead of “specifies” (since status attributes always report values rather than allowing them to be set)- global – changes all power state attributes to be (type1 keyword) in order to disallow any vendor unique extension keywords- global – corrected references to former section 7.2.7.7 power state definitions to section 7.2.1 Power States and Policies- revised section 5.3 System State Attributes and Table 2 to rename “power-monitor-col” to “power-state-monitor-col” and combine with former “power-general-col” and “power-meters-col”- revised section 5.4 System Operations and Table 3 to remove document references on “<none>” operation columns and add appropriate footnotes- revised section 5.6 Resource Description Attributes and Table 4 to delete “resource-string-version” and “resource-version”- revised section 5.7 Resource Status Attributes and Table 5 to add “date-time-at-installed” “time-at-installed”, “resource-string-version”, and “resource-version”- revised section 5.7 Resource Status Attributes and Table 5 to add “resource-owner-col”, “resource-string-version”, and “resource-version” and appropriate footnotes- revised section 5.7 Resource Status Attributes and Table 5 to remove document references on “<none>” operation columns and add appropriate footnotes- added section 5.9 Printer Status Attributes and Table 7 for “printer-config-changes” and “printer-service-type”- revised section 6.2 Create-Printer, section 6.3 Create-Resource, and section 7.1 System, Printer, and Resource Operation Attributes to add “requesting-user-vcard” attribute for use in setting “printer-owner-col” and “resource-owner-col” description attributes- added section 7.2.1 Power States and Policies to define all power states (including examples of their typical effect on System activities), their relationships to DMTF CIM and ACPI, their order of power consumption based on DMTF CIM, and examples of their usage (in power policies and in operations such as Restart-System)- revised section 7.2.8.2 event-name to replace vendor name ‘AcmeCrackedCrock’ with

Page 174 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

51751854135414541554165417541854195420

5422

5423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456

519

Page 175: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

‘ExampleEventName’- revised section 7.2.24 xri-supported member attributes to reference [RFC3380] and use corresponding member attribute names- revised sections 7.2.x power-calendar-policy-col, power-event-policy-col, and power-timeout-policy-col to add commented examples- revised section 7.3.2.4 power-state-message to remove ‘959’, ‘960’, etc. from cut-and-paste from PDF source and add complete example for system shutdown- revised section 7.3.5 power-state-monitor-col to include all attributes from former “power-general-col” and “power-meters-col” collections except for “power-peak-watts” and “previous-month-kwh” and to rename “can-request-power-states” to “valid-request-power-states” (for clarity)- revised section 7.3.5.6 power-state-message to add complete example for system shutdown- revised section 7.3.11 system-configured-subunits to add all member attributes per PWG MFD Model and PWG Imaging System State and Counter MIB v2- revised section 7.6 Resource Description Attributes to add “resource-owner-col” and delete “resource-string-version” and “resource-version”- revised section 7.7 Resource Status Attributes to add “date-time-at-installed”, “time-at-installed”, “resource-string-version”, and “resource-version”- revised section 7.7.14 resource-state-reasons to add ‘installed’ (others are still TBD)- revised section 14.1 Normative References to add [ACPI], DMTF [DSP1027], and [IEEE1621] for power state definitions and semantics and various RFCs and PWG specs for other references- TODO: Design and define “system-totals” as a subset of [PWG5108.06] - TODO: Design and define “resource-authenticator”- ISSUE: Indices for "system-configured-subunits" for multiple output devices?

17.18[17.17] 23 June 2016

- Interim draft – further updates for collection attributes- completed all System, Printer, and Resource attribute definitions, except for “resource-authenticator” and “system-totals” (both need design work)- kept all redlines from 12 June 2016 version (not yet reviewed)- revised section 5.3 System Status Attributes and Table 2 to to rename “power-counters-col” (obscure) to “power-state-counters-col” (counts of state transitions), rename “power-monitor-col” (obscure) to “power-state-monitor-col” (current System power state), rename “power-state-capability-col” (obscure) to “power-state-capabilities-col” (set of booleans and gauges), and rename “power-state-transition-col” (obscure) to “power-state-transitions-col” (set of valid stable/ephemeral state transitions) - revised section 5.6 Resource Description Attributes and Table 4 to add “resource-owner-col” (for consistency w/ System and Printer objects)- revised section 5.7 Resource Status Attributes and Table 5 to delete “resource-originating-user-name” and “resource-originating-user-uri” (redundant with “resource-owner-col”)- revised section 7.3 System Status Attributes to add “-col” suffix to all power collection attributes and add all member attributes

Page 175 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

52052154575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482

5483

54845485548654875488548954905491549254935494549554965497549854995500

522

Page 176: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

- revised section 7.3 System Status Attributes to rename “power-counters-col” (obscure) to “power-state-counters-col” (counts of state transitions), rename “power-monitor-col” (obscure) to “power-state-monitor-col” (current System power state), and rename “power-state-capability-col” (obscure) to “power-state-capabilities-col” (set of booleans and gauges)- revised section 7.3.1 power-general-col to add all member attributes- revised section 7.3.2 power-log-col to add all member attributes, except for PowerComponentType and PowerComponentReferenceId (used for Subunits in power model)- revised section 7.3.3 power-meters-col to add all member attributes- revised section 7.3.4 power-state-capabilities-col to add all member attributes, except for CanUseInterfaces (used for Interface subunits in power model)- revised section 7.3.5 power-state-counters-col to add all member attributes- revised section 7.3.6 power-state-monitor-col to add all member attributes- revised section 7.3.7 power-state-transitions-col to add all member attributes- revised section 7.3.11 system-configured-printers to add all member attributes- revised section 7.3.12 system-configured-resources to add all member attributes- revised section 7.6 Resource Description Attributes to define all group attributes- revised section 7.6 Resource Description Attributes to add “resource-owner-col” (for consistency w/ System and Printer objects- revised section 7.7 Resource Status Attributes to define all group attributes, except for “resource-authenticator” (hash/signature for verification of Resource data) as this needs some design discussion- revised section 7.7 Resource Status Attributes to delete “resource-originating-user-name” and “resource-originating-user-uri” (redundant with “resource-owner-col”)- TODO: Design and define “system-totals” as a subset of [PWG5108.06] - TODO: Design and define “resource-authenticator”

17.19[17.18] 12 June 2016

- Interim draft – changes per IPP WG review on 9 May 2016- accepted all previous changes through end of section 7.3 System Status Attributes- revised section 5.2 System Description Attributes and Table 1 to clarify note 4 about Set-System-Attributes- revised section 5.2 System Description Attributes and Table 1 to clarify note 6 about Set-System-Attributes and change “equivalent” to “analogous” and add full title of [RFC3380].- revised section 5.2 System Description Attributes and Table 1 to add “resource-settable-attributes-supported” and corresponding new note 7 (for consistency w/ System and Printer objects)- revised section 5.3 System Status Attributes and Table 2 to change to “<none>[8]” for system-state-change-[date-time|time]- revised section 5.3 System Status Attributes and Table 2 to clarify note 8 about configuration and state changes- revised section 5.3 System Status Attributes and Table 2 to clarify notes 7 and 9 and add full title of [PWG5100.13]- revised section 5.4 System Operations and Table 3 to move note [7] reference to correct

Page 176 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

523524550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527

5528

5529553055315532553355345535553655375538553955405541554255435544

525

Page 177: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

column- revised section 5.8 Printer Description Attributes and Table 6 to change “printer-owner” to “printer-owner-col” and add note 1 about Set-Printer-Attributes coherence of “owner-uri” and “owner-vcard” member attributes.- revised section 6.2 Create-Printer to delete redundant “and”, missing hyphen in “print-color-mode-supported”, and add quotes around attribute names in final note- revised section 6.14 Get-System-Supported-Values to correct name from “Settable” to “Supported” and to correct reference to Get-Printer-Supported-Values in [RFC3380].- revised section 7.2 System Description Attributes first paragraph to remove redundancy- revised section 7.2 System Description Attributes to add “resource-settable-attributes-supported” (for consistency w/ System and Printer objects)- accepted all changes in section 7.2.7 power-calendar-policy-col and put all member attributes in alphabetical order, clarified first values (zero or one), and removed redundancy in descriptions- renamed section 7.2.7.1 policy-id to calendar-id for consistency with [PWG5106.4]- revised section 7.2.7.3 day-of-week (now integer) to delete previous keyword values- revised section 7.2.7.7 request-power-state to separate stable states and ephemeral (transitional) states into two lists of standard keywords for clarity- revised section 7.2.8 power-event-policy-col to add all member attributes- revised section 7.2.9 power-event-policy-col to add all member attributes- revised section 7.2.24 system-xri-supported to add all member attributes- revised section 7.4 Printer Description Attributes first paragraph to remove redundancy- revised section 7.4 Printer Description Attributes to add “printer-owner-col”, “owner-uri”, and “owner-vcard” attributes- revised section 7.5 Printer Status Attributes to add “printer-config-changes” attribute per PWG F2F review on 26 April 2016- revised section 7.6 Resource Description Attributes first paragraph to remove redundancy- revised section 14.1 Normative References to correct reference to PWG 5100.12 per PWG F2F review on 26 April 2016

17.20[17.19] 9 May 2016

- Interim draft – changes per PWG F2F review on 26 April 2016- revised section 7.2.7.1 to rename “power-calendar-policy-id” to “policy-id”- revised section 7.2.7.2 request-power-state to delete ‘other’ (invalid) and ‘unknown’ (out-of-band value)- revised section 7.2.7.4 day-of-week to change syntax to “integer(1:7)”- revised section 7.2.7.5 month to change syntax to “integer(1:12)”- revised section 7.2.7.6 to rename “day” to “day-of-month” and correct integer syntax- revised section 7.2.7.7 hour and section 7.2.6.8 minute to correct integer syntax- revised section 7.2.7.7 hour to add note about local time zone changes (summer time to standard time or vice versa) and the possibility that a given hour will not occur.

Page 177 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

526527554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574

5575

5576557755785579558055815582558355845585

528

Page 178: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

17.21[17.20] 8 May 2016

- Interim draft – changes per PWG F2F review on 26 April 2016- revised section 3.2.5 Bootstrap Client Access to Default Print Service to use “ipp://printer12.example.com/ipp/print” for discovered default Print Service- revised section 5 IPP System and Resource Objects and Operations to add note about tables listing only top-level attributes and forward reference collection member attributes in section 7- revised section 5.2 System Description Attibutes Table 1 to add “system-settable-attributes-supported”, “system-strings-languages-supported”, and “system-strings-uri” and delete “system-health”- revised section 5.2 System Description Attibutes Table 1 to rename “system-owner-uri” to “system-owner-col” (collection) and make it REQUIRED and delete “system-owner-vcard” - revised section 5.2 System Description Attibutes Table 1 to add “-col” suffix to all power model collection attributes for consistency- revised section 5.3 System Status Attributes Table 2 to also add “-col” suffix to all power model collection attributes for consistency- revised section 5.4 System Operations Table 3 to add Get-System-Supported-Values- revised section 6.2 Create-Printer to note that Subunits are also associated by configured service capabilities – intent and not explicit listing- revised section 6 IPP Operations to add REQUIRED Get-System-Supported-Values for newly REQUIRED Set-System-Attributes operation- revised section 6 IPP Operations definition of Set-System-Attributes to include forward reference to “system-strings-languages-supported” and “system-strings-uri” for Client localization.- revised section 7.2 System Description Attributes to add “system-settable-attributes-supported”, “system-strings-languages-supported”, and “system-strings-uri”and add “-col” suffix to all power model collection attributes for consistency and delete “system-health”- revised section 7.2.7 power-calendar-policy-col to change all enums to keywords- revised section 7.2.19 system-owner-col to changed to REQUIRED- revised section 7.3.10 system-config-changes to clarify semantics and state a System MUST reset to zero when a power cycle occurs (from ‘off’ to ‘on’).

17.22[17.21] 25 April 2016

- Interim draft – changes per IPP WG review on 29 February 2016- global – accepted all redlines from previous versions up to end of section 7.3- global – changed “out-of-band value defined in [RFC8010]” to “out-of-band value defined in [RFC8011]”- revised section 2.3 Printing Terminology to add references for every definition- revised section 3.2.5 Bootstrap Client Access to Default Print Service to use explicit IPv4 address to query the System Service listening to port 631 for the default print service URI- revised section 5.2 System Description Attibutes Table 1 to rename “natural-language-supported” to “generated-natural-language-supported” for consistency with RFC 2911- revised section 5.2 System Description Attibutes Table 1 to add “system-current-time”- revised section 5.3 System Status Attributes Table 2 to add system-config-change-date-

Page 178 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

529530

5586

558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616

5617

56185619562056215622562356245625562656275628

531

Page 179: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

time, system-config-change-time, system-state-change-date-time, and system-state-change-time- revised section 5.3 System Status Attributes Table 2 to delete “system-current-time”- revised section 5.3 System Status Attributes Table 2 to to rename “power-support” to “power-state-capability” and “power-transition” to “power-state-transition” for clarity- revised section 7.2 System Description Attribues to explicitly mention Set-System-Attributes operation and “system-settable-attributes-supported”- revised section 7.2.4 natural-language-configured to restrict scope to only System-generated attribute values.- revised section 7.2.5 to rename “natural-language-supported” to “generated-natural-language-supported” for consistency with RFC 2911 and restored text about a System accepting any natural language value.- revised section 7.2.7 power-calendar-policy to define power-calendar-policy-col and all member attributes- revised section 7.2.10 system-default-printer-uri and section 6.2 Create-Printer to clarify that when the first Print Service is created on a System, the System MUST set the value of “system-default-printer-uri”- revised section 7.2.12 system-geo-location to delete trailing fragment- revised section- added section 7.2.18 system-owner (collection) to include “system-owner-uri” and “system-owner-vcard” and provide extensibility for additional System Owner metadata- revised section 7.3 System Status Attributes to add “system-config-change-date-time”, “system-config-change-time”, “system-state-change-date-time”, and “system-state-change-time”- revised section 7.3.6 to rename “power-support” to “power-state-capability” for clarity- revised section 7.3.7 to rename “power-transition” to “power-state-transition” for clarity- revised section 7.3.8 system-config-changes to clarify that the System MUST increment the value each time an attribute value is changed with a Set-System-Attributes operation.- moved section 7.3.12 system-current-time to section 7.2 System Description Attributes

17.23[17.22] 28 February 2016

- Interim draft – changes per PWG F2F review on 10 February 2016- global – kept some redlines from previous versions for review by IPP WG- global – changed “as described in [xxx]” to “defined in [xxx]” for clarity- global – manually changed lowercase “ system Administrator” to titlecase “ Administrator”, lowercase “ operator” to titlecase “ Operator”, and standalone “ user” or “ User” to titlecase “ End User” - global – changed “specifies [a/the] list of” to simply “lists”- global – accepted all redlines in section 7.1 System, Printer, and Resource Operation Attributes, section 7.2 System Description Attributes, and section 7.3 System Status Attributes up through section 7.3.13 system-health before making current changes for readability- revised section 2.3 Printing Terminology to add definitions of Administrator, End User, and Operator from RFC 2911bis (taken from RFC 2567) and Delivery Method, Event

Page 179 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

53253356295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657

5659

5660566156625663566456655666566756685669567056715672

534

Page 180: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

Notification, Notification, Owner, Resource, and Subscription (taken from PWG 5108.01, PWG 5108.03, or RFC 3995)- added section 3.2.5 Bootstrapping Client Access to Default Print Service and added cross-reference to section 7.2.10 system-default-printer-uri- revised section 7.1 System, Printer, and Resource Operation Attributes, section 7.2 System Description Attributes, and section 7.3 System Status Attributes to attach second sentence (semantic equivalence or analogy) to first sentence for clarity- revised sections 7.2.7, 7.2.8, and 7.2.9 to add “-policy” suffix to “power-calendar”, “power-event”, and “power-timeout” collection System Description attributes - revised section 7.2.10 system-default-printer-uri to change syntax to “(uri | no-value”)- revised section 7.2.11 system-geo-location to change syntax to “(uri | unknown)”- revised section 14.2 Informative References to add RFC 2567

17.24[17.23] 17 January 2016

- Interim draft – changes per IPP WG reviews on 7 December 2015 and 4 January 2016- global – kept most redlines from previous versions for review by IPP WG- global – revised section 6 IPP Operations to delete trailing document references after every operation request and operation response attribute for clarity- global – revised section 7.1 System, Printer, and Resource Operation Attributes to further simplify and clarify filter text- revised section 5.4 System Operations and section 6 IPP Operations to delete redundant and ambiguous Restart-All-Printers and Restart-One-Printer operations (use Shutdown and Startup instead)- revised section 6 IPP Operations to add note that all operation requests and responses use standard operation parameters defined in [RFC8011] and encoded in [RFC8010]- revised section 6 IPP Operations definition of Get-Printers to add note that it is an End User operation and does NOT require Client authentication, but MAY be encrypted and another note that requested-attributes is limited to the LDAP Printer Schema [RFC7612] and if request-attributes is missing, then the System MUST only return printer-uri-supported, uri-authentication-supported, and uri-security-supported.- revised section 6 IPP Operations definition of Get-Resources to add note that it is an Administrator operation and requires Client authentication.- revised section 6 IPP Operations definition of Get-Printers to change operation attribute printer-service-type to ‘1setOf’ (for Get-Printers)- revised section 6 IPP Operations definition of Startup-All-Printers and Startup-One-Printer to remove reference to RFC 3998 Startup-Printer- revised section 6 IPP Operations definition of Create-Printer, Create-Resources, Get-Printers, Startup-All-Printers responses to delete status-code (parameter, not an attribute) and move attributes-charset/attributes-natural-language before status-message- revised section 7.1 System, Printer, and Resource Operation Attributes to delete redundant printer-service-types, to change operation attribute printer-service-type to ‘1setOf’ (for Get-Printers), and to move values to section 7.7 System Status Attributes printer-service-type- revised section 7.1 System, Printer, and Resource Operation Attributes to references to Create-Resource/Send-Resource-Data when appropriate

Page 180 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

535536567356745675567656775678567956805681568256835684

5685

5686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716

537

Page 181: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

- revised section 7.1 System, Printer, and Resource Operation Attributes resource-k-octets to correct forward reference to section 7.7- - revised section 7.1 System, Printer, and Resource Operation Attributes which-printers to clarify ‘all’ and ‘stopped’ and add ‘shutdown’ and ‘testing’ to harmonize with MFD Model and IETF Host Resources MIB [RFC2790]

17.25[17.24] 6 December 2015

- Interim draft – new content after IPP WG review on 5 October 2015- global – kept all redlines from previous versions for review by IPP WG - revised section 6 IPP Operations to define Startup-All-Printers (prototype for all other Xxx-All-Printers operation attributes), Startup-One-Printer (prototype for all other Xxx-One-Printer operation attributes), Create-Printer, Create-Resource, Delete-Printer, Disable-All-Printers, Enable-All-Printers, Get-Printer-Attributes, Pause-All-Printers, Restart-All-Printers, Restart-One-Printer, Resume-All-Printers, Shutdown-All-Printers, Shutdown-One-Printer- revised section 7.7 Resource Status Attributes to define resource-state (to be reviewed by IPP WG since the Resource object has unique states)

17.26[17.25] 2 November 2015

- Interim draft – new content after IPP WG review on 5 October 2015- global – kept all redlines from previous version for review at PWG November F2F- revised section 7.1 System, Printer, and Resource Operation Attributes to add Resource operation attributes resource-category, resource-format, resource-id, resource-job-id, resource-k-octets, resource-printer-uri, resource-state, and resource-type- revised section 7.3 System Status Attributes to add power-counters, power-general, power-log, power-meters, power-monitor, power-support, power-transition, system-config-changes, system-configured-printers, system-configured-resources, system-configured-subunits, system-current-time, system-health, system-serial-number, system-state, system-state-messages, system-state-reasons, system-totals, system-up-time, and system-uuid

17.27[17.26] 18 October 2015

- Interim draft – changes per IPP WG review on 5 October 2015- global - accepted all changes up to and through section 6.9 (from previous review)- revised section 7.1 title to “System, Printer, and Resource Operation Attributes” to allow for Printer operation attributes in future such as “printer-service-type” for Create-Printer- revised sections 7.1.x to change “filters the set of Printers” to “specifies a filter for the applicable Printers”- added section 7.1.3 printer-service-type for Create-Printer operation- revised section 7.1.4 printer-service-types to change “Service Type attribute” to “Service Type element”, add forward reference to “printer-service-type” in section 7.5 Printer Status Attributes, and add emailin, emailout, and faxin (references to PWG 5108.01 and RFC

Page 181 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

53853957175718571957205721

5722

5723572457255726572757285729573057315732

5733

57345735573657375738573957405741574257435744

5745

5746574757485749575057515752575357545755

540

Page 182: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

2707)- revised section 7.1.5 resource-id to add forward reference to “resource-id” in section 7.7 Resource Status Attributes- revised section 7.1.11 system-uri to change “attribute the target” to “attribute specifies the target”- revised section 7.1.12 which-printers to change "This attribute and is" to “This attribute is” (drop “and”)- revised section 14 References to accept all changes and add PWG Job Monitoring MIB (RFC 2707)

17.28[17.27] 20 September 2015

- Interim draft - changes per PWG F2F review on 31 August 2015- global - accepted all changes up to and through section 6.9 (from previous review)- revised Abstract and section 1 Introduction to add explicit references to Cloud & Infra- deleted section 5.2 System Operation Attributes and section 5.7 Resource Operation Attributes- added section 5.8 Printer Description Attributes and table for “printer-owner-[uri|vcard]”- revised section 6.9.1 Get-Printers Request to make “attributes-charset” and “attributes-natural-language” REQUIRED for Client (per RFC 2911)- revised section 6.9.1 Get-Printers Request to add note to “requested-attributes” about the primary Printer attributes in the IETF LDAP Printer Schema (RFC 7612)- revised section 7,2 System Description Attributes to add new attribute definitions- revised section 14.1 Normative References to add references for new attribute definitions

17.29[17.28] 31 August 2015

- Interim draft – changes per PWG F2F review on 10 August 2015- global – deleted redundant “new” and “now” and “below” in several dozen places- revised Table of Contents to delete List of Figures (all now deleted in this version)- revised section 2.2 Protocol Role Terminology to correct “Infrastructure System” from “PWG5109.CLOUD” to “PWG5109.1”, add “Printer”, and correct typos in “Protocol Endpoint”- revised section 2.2 Protocol Role Terminology to add references to IPP INFRA (PWG 5100.18) to “Infrastructure Printer”, “Infrastructure System”, and “Proxy”- revised section 2.3 Printing Terminology to add “Printer” (synonym for “Imaging Service”) with RFC 2911 reference- revised section 3.1 Rationale for the IPP System Service to correct title of IPP/2.0- revised section 3.1 Rationale for the IPP System Service to add paragraphs for IPP INFRA [PWG5100.18] and Cloud Imaging Model [PWG5109.1]- revised section 5 IPP System and Resource Objects and Operations for clarity and deleted redundant Figure 1 through Figure 4 (PWG SM abstract objects) and text- revised section 5.1 System Attribute Groups and section 5.6 Resource Attribute Groups titles to be singular (only one of each)- revised section 5.2 System Operation Attributes and section 5.7 Resource Operation

Page 182 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

541542575657575758575957605761576257635764

5765

576657675768576957705771577257735774577557765777

5778

577957805781578257835784578557865787578857895790579157925793579457955796

543

Page 183: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

Attributes to be just forward references to section 7.1 System and Resource Operation Attributes- revised section 5.3 System Description Attributes Table 1 and section 7.2 System Description Attributes to add “system-default-printer-uri” to support the enhanced “Get-Printer-Attributes” operation- revised and reordered (alphabetized) section 5.3 System Description Attributes Table 1 and section 7.2 System Description Attributes to insert “system” prefix on several attributes for consistency with Printer object in RFC 2911- revised and reordered (alphabetized) section 5.4 System Status Attributes Table 2 and section 7.3 System Status Attributes to insert “system” prefix on several attributes and add “system-up-time”for consistency with Printer object in RFC 2911- revised section 5.5 System Operations Table 3 to add missing references and change “Cancel-Subscriptions” and “Renew-Subscriptions” to singular per RFC 3995- revised section 5.5 System Operations Table 3 to update note for Create-Resource and add note for Create-Printer referring to the semantically equivalent Create operation in ISO 10175-3- revised section 5.5 System Operations Table 3 to add note that Register-Output-Device is semantically equivalent to Register-System in PWG 5109.1 (with differences explained)- revised section 5.9 Resource Status Attributes Table 5 to add note for “resource-id” analogous to “job-id” in RFC 2911.- revised section 5.9 Resource Status Attributes Table 5 to add note for “resource-k-octets” analogous to “job-k-octets” in RFC 2911.- revised section 5.9 Resource Status Attributes Table 5 to add notes for “resource-job-id” and “resource-printer-uri” which are requried for Job and Printer scoped Resource objects, respectively- revised section 5.9 Resource Status Attributes Table 5 to add “resource-authenticator” for verification of Resource data after a Send-Resource-Data operation- deleted redundant sections 6.x Cancel-Subscription, Get-Notifications, Get-Printer-Attributes, and Renew-Subscription and moved to sections 8.x for existing operations with new semantics- revised section 6.x Get-Printers to change “selected” to “matching” and make sure that each attribute has a colon (:) at the end and put the reference(s) at the end of each attribute name - revised section 6.x Get-Printers to use “the Client [MUST|SHOULD|MAY] supply and the System MUST support” for clarity – “OPTIONALLY” is NOT a defined conformance keyword- revised section 6.x Get-Printers and section 7.1.x “printer-geo-location” to remove ‘unknown’ value (never appropriate in this specification)- revised section 6.x Get-Printers and section 7.1.x “printer-service-types” to change singular to plural (i.e., multiple printers can be chosen by the filter)- revised sections 6.x Get-Resources and Get-Resource-Attributes to note that they are modeled on Get-Jobs and Get-Job-Attributes with default returns of “resource-id” and “resource-state”- revised section 6.x Get-System-Attributes to note that it is modeled on Get-Printer-Attributes with default return of all System attributes- revised section 7.1 title to be “System and Resource Operation Attributes” (since some

Page 183 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

5445455797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842

546

Page 184: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

apply to operations on both objects)- revised section 7.1.x to change “selects” to “filters” and “selected” to “matching” for clarity- added sections 7.1.x for “resource-category”, “resource-id”, “resource-job-id”, “resource-printer-uri”, “resource-state”, and “resource-type” operation attributes- revised section 14.1 Normative References to update IPP/2.0 title and reference (work-in-progress) and add IPP INFRA (PWG 5100.18-2015) and Cloud Imaging Model (PWG 5109.1-2015)

17.30[17.29] 10 August 2015

- Interim draft – changes per PWG F2F review on 29 April 2015- global – added working notes from PWG F2F at appropriate operations and attributes to capture discussion and agreements- revised Abstract and section 1 Introduction to say “support registration of an IPP System, through its IPP Proxy, with one or more Cloud Imaging Systems”- revised section 1.1 Rationale for two IPP Protocol Endpoints to titlecase “Protocol Endpoint” in first paragraph- revised section 2.2 Protocol Role Terminology, to add “Endpoint” (whole computing device) from IETF NEA Overview [RFC5209], clarify “Infrastructure System”, and rewrite “Protocol Endpoint” (an application interface) based on standard IETF usage.- revised section 3.4 Out-of-Scope to add support for any non-IPP Cloud Imaging System.- revised section 5.3 System Description Attributes to delete issue about cardinality of “owner-uri” and “owner-vcard” (they are single-valued) and to remove Register-System operation from Table 1 Note 4- revised section 5.5 System Operations Table 3 to replace “Cancel-Xxx-Subscriptions” with “Cancel-Subscriptions” and “Renew-Xxx-Subscriptions” with “Renew-Subscriptions” and reference RFC 3995- revised section 5.5 System Operations Table 3 to delete “Renew-Resource”, add “Get-Subscriptions” and “Get-Subscription-Attributes, and replace “Get-Xxx-Notifications” with “Get-Notifications” and reference RFC 3996- revised section 5.5 System Operations Table 3 to add new “Install-Resource” operation to activate (for use) firmware, software, fonts, etc. after Create-Resource and Send-Resource-Data have completed- added section 5.6 Resource Attribute Groups- added section 5.7 Resource Operation Attributes- added section 5.8 Resource Description Attributes and Table 4- added section 5.9 Resource Status Attributes and Table 5- revised sections 6.x to align with current set of operations- added section 6.x Get-Printers in complete detail for review- added section 7 New IPP Attributes and sections 7.x for all System and Resource operation, description, and status attributes- revised sections 14.x to add or update several references

Page 184 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

5475485843584458455846584758485849

5851

58525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883

549

Page 185: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

17.31[17.30] 28 April 2015

- Interim draft – changes per IPP WG review on 30 March 2015- global – replaced “IPP System Control Service” with “IPP System Service” (but NOT in the abstract PWG equivalent), per IPP WG review- global – replaced titlecase “Object” with lowercase “object” (except in section title or PWG SM spec titles), per IPP WG review- revised Abstract to change “[PWG510x.y]” document references to “(PWG 510x.y)”, consistent with IETF RFC styles and change “Cloud Imaging services” to “Cloud Imaging Systems”, per IPP WG review- revised section 1 Introduction to replace with expanded scope text from Abstract, per IPP WG review- revised section 1.1 Rationale for two IPP Protocol Endpoints to clarify that a conforming IPP System Service supports both a URI for an IPP System object and a separate URI for the implementation defined “default” IPP Printer returned from Get-Printer-Attributes, per IPP WG review- revised section 2.2 Protocol Role Terminology to add definitions of Infrastructure System and Protocol Endpoint, remove the “IPP” prefix from the definitions of Client, Infrastructure Printer, Proxy, and System terms, and enhance the definition of Proxy, per IPP WG review- revised section 3.1 Rationale for the IPP System Service, to replace period “.” with semi-colon “;” in non-terminal members of both numbered lists, per IPP WG review- revised section 5.3 System Description Attributes in Table 1 to change owner-uri from RECOMMENDED to CONDITIONALLY REQUIRED and owner-vcard from OPTIONAL to CONDITIONALLY REQUIRED for systems that support the Set-System-Attributes and Register-System operations and added issue about possible multi-valued ordered sets for multiple owners (whose semantics are presently undefined in any PWG spec), per IPP WG review- revised section 5.4 System Status Attributes in Table 2, note (7) to delete sentence about already removed device-uuid attribute, per IPP WG review- revised section 5.5 System Operations to add Create/Cancel/Renew-Resource-Subscriptions, Create/Cancel/Renew-System-Subscriptions, Get-Notifications, Get-Printer-Attributes (for implementation-defined “default” Printer), RestartSystem (for restart with existing or new firmware Resource for remediation based on health monitoring), and to divide original StoreResource into Create-Resource and Send-Resource-Data (to correct scope ambiguity of original PWG Resource Service operation), per IPP WG review- added (blank placeholder) section 10.2 Conformance Requirements for Infrastructure Systems, per IPP WG review- revised section 11 Internationalization Considerations to add new Unicode boilerplate from JDFMAP, per IPP WG review- revised section 12 Security Considerations to add new Unicode boilerplate from JDFMAP, per IPP WG review- revised section 14.1 Normative References and section 14.2 Informative References to add new Unicode boilerplate specs from JDFMAP, per IPP WG review- TODO – add various spec references, per IPP WG review

Page 185 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

550551

5884

588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926

552

Page 186: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

17.32[17.31] 15 March 2015

- Interim draft – changes per PWG F2F and IPP WG reviews on 4 November 2014, 17 November 2014, 19 January 2015, and 3 February 2015- revised title to “IPP System Service”, per IPP WG review on 4 November 2014- revised Abstract to include management and status of Services, Subunits, and Resources and Cloud registration extensions, per IPP WG review on 4 November 2014- revised section 1.1 Rationale for two IPP Protocol Endpoint to mention of inclusion of original Get-Printer-Attributes that automatically selects the implementation-defined or site-defined “default” IPP Printer object for the convenience of existing IPP Clients, per IPP WG review on 4 November 2014- revised section 2.2 Protocol Role Terminology to add definitions of Infrastructure Printer and IPP Proxy from IPP Shared Infrastructure Extensions, per IPP WG review on 3 February 2015- revised section 2.3 Printing Terminology to delete Resource Service and revise the definitions of Spooling Service and Streaming Service, per IPP WG review on 4 November 2014- revised section 2.3 Printing Terminology to add definitions of Logical Device, Output Device, and Physical Device from IPP Shared Infrastructure Extensions, per IPP WG review on 3 February 2015 - renamed section 2.4 from “Acronyms and Organizations” to simply “Abbreviations”, for consistency with RFC 7472, per RFC Editor on 5 March 2015- revised section 3.1 Rationale for the IPP System Service to add the Resource Service functionality (objects, operations, and attributes), per IPP WG review on 4 November 2014- added new use case in section 3.2.4 Resource Management, per IPP WG review on 4 November 2014- revised section 3.4 Out-of-Scope, to delete creation/deletion of Imaging Services, per IPP WG review on 3 February 2015- revised section 3.5 Design Requirements, to add Resource object, per IPP WG review on 4 November 2014- added section 4.6 Resource Service, to add Resource object, per IPP WG review on 4 November 2014- revised section 5.1 Attribute Groups to define the system-attributes-tag and resource-attributes-tag, per IPP WG review on 19 January 2015- revised section 5.2 Operation Attributes to define system-uri and resource-uri, per IPP WG review on 19 January 2015- revised title of section 5.3 to System Description Attributes, per IPP WG review on 19 January 2015- revised section 5.3 System Description Attributes in Table 1 to raise owner-uri from OPTIONAL to RECOMMENDED, per IPP WG review on 19 January 2015- revised section 5.3 System Description Attributes to delete redundant original Figure 3 and Figure 4, per IPP WG review on 19 January 2015- revised title of section 5.4 to System Status Attributes, per IPP WG review on 19 January 2015- revised section 5.4 to System Status Attributes in Table 2 to delete redundant device-uuid, per IPP WG review on 19 January 2015

Page 186 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

553554

5927

59285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971

555

Page 187: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

- revised section 5.4 to System Status Attributes to delete redundant original Figure 4, Figure 5, Figure 6, and Figure 7, per IPP WG review on 19 January 2015- revised section 5.5 System Operations to delete issue about Subscription operations, per IPP WG review on 3 February 2015- revised section 5.5 System Operations in Table 3 to add Create/Delete-Printer and Resource operations, per IPP WG review on 3 February 2015

17.33[17.32] 2 November 2014

- Interim draft – changes per IPP WG review on 29 September 2014- corrected typos and wording- revised cover page and headers to change “IPPSYSTEM” to “SYSTEM”, per IPP WG review- globally changed “Imaging Device” to “Imaging System” where appropriate (most instances), per IPP WG review- globally changed “[RFC2616]” to “[RFC7230]”, per IPP WG review- globally changed “[PWG5100.SCAN]” to “PWG5100.17]” and corrected reference in section 10.1, per PWG approval of IPP Scan Service- added section 1.1 Rationale for two IPP Protocol Endpoints to explain the reason for separate URI for System and Printer objects, per IPP WG review- revised section 2.2 to change title from “Printing Terminology” to “Protocol Roles”, per IPP WG review- revised section 2.2 to delete “IPP Printer” (and thus Logical Device and Physical Device definitions and details) as not applicable to System Control Service and to add “IPP System”, per IPP WG review- revised section 2.3 to change title from “Other Terminology” to “Printing Terminology”, per IPP WG review- moved first sentence of section 2.2 (sources of terms) to section 2.3, per IPP WG review- revised section 2.3 to add new terms, including “Document”, “FaxOut Job/Service”, “ith”, “Job”, “Print Job/Service”, “Scan Job/Service”, “Spooling Service”, “Streaming Service”, “Subunit”, “Transform Job/Service”, per IPP WG review- revised section 2.3 to improve “Imaging System” definition, per IPP WG review- revised section 3.1 Rationale to clarify various paragraphs and add numbered lists, per IPP WG review- revised section 3.2 Use Cases to clarify various paragraphs, per IPP WG review- revised section 3.3 to change “TBD” to “There are no exceptions to the use cases defined in section 3.2”, per IPP WG review- revised section 3.4 Out of Scope to clarify first sentence, per IPP WG review- revised section 3.4 Out of Scope to clarify several statements, per IPP WG review- revised section 3.4 Design Requirements to clarify first sentence, per IPP WG review- added section 4.5 Document Object, per IPP WG review- revised section 5.3 System Description to change “READ-ONLY” to “READ-WRITE” (because Set-System-Attributes was restored in this draft), per IPP WG review and Cloud Imaging WG recommendations- revised section 5.4 System Status to clarify the “READ-ONLY” cannot be modified by a Set-System-Attributes operation, per IPP WG review and Cloud Imaging WG

Page 187 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

556557597259735974597559765977

5978

5979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015

558

Page 188: ftp.pwg.orgftp.pwg.org/pub/pwg/ipp/wd/wd-ippsystem10-20170910-r…  · Web view2017-09-10 · Abstract: This document defines an IPP System Service binding of the PWG Semantic Model

Working Draft – IPP System Service v1.0 (SYSTEM) 10 September 2017

recommendations- revised section 5.4 System Status to clarify the meaning of “system-uuid” (SCS), “printer-uuid” (Imaging Service), and “device-uuid” (physical hardware, i.e., network device), per IPP WG review- revised section 5.4 System Status Table 2 to change “configured-services” to “configured-printers”, per IPP WG review- revised section 5.5 System Operations Table 3 to add back Restart-One-Printer, Startup-One-Printer, Shutdown-One-Printer, and Set-System-Elements, per IPP WG review and Cloud Imaging WG recommendations- revised section 6 New IPP Operations to add back Restart-One-Printer, Startup-One-Printer, Shutdown-One-Printer, and Set-System-Elements, per IPP WG review and Cloud Imaging WG recommendations- revised section 8.1 title to add “Create-Subscription” operation, per IPP WG review- revised section 13 to change title from “IANA Considerations” to “IANA and PWG Considerations”, per IPP WG review

17.34[17.33] 24 August 2014

- Interim draft- corrected typos and wording- revised section 5.3 and added Table 1 – Attributes in IPP System Description group with notes for rationale of all conformance requirements- revised section 5.4 and added Table 2 – Attributes in IPP System Status group with notes for rationale of all conformance requirements- added section 6 New IPP Operations (empty)- added section 7 New IPP Attributes (empty)

17.35[17.34] 11 August 2014

- Initial draft- based on Mike Sweet’s presentation at PWG F2F meeting in October 2013- added Abstract and Introduction- added Terminology, including new and refined terms for clarity- added Requirements (rationale, use cases, out-of-scope, design requirements)- added IPP Object Model (extensions to RFC 2911)- added IPP System Object (still a sketch)- combined System object and System Control Service object (separation was artificial)- added References (normative and informative)

Page 188 of 188 Copyright © 2014-2017 The Printer Working Group. All rights reserved.

559560601660176018601960206021602260236024602560266027602860296030

6032

60336034603560366037603860396040

6041

604260436044604560466047604860496050

561