]> git.ipfire.org Git - thirdparty/cups.git/blob - doc/help/spec-ipp.html
Merge pull request #1316 from weblate/weblate-cups-cups
[thirdparty/cups.git] / doc / help / spec-ipp.html
1 <!DOCTYPE html>
2 <html>
3 <!-- SECTION: Specifications -->
4
5 IPP specification/reference for CUPS.
6
7 Copyright © 2023-2025 by OpenPrinting.
8
9 Licensed under Apache License v2.0. See the file "LICENSE" for more
10 information.
11 -->
12 <head>
13 <link rel="stylesheet" type="text/css" href="../cups-printable.css">
14 <title>CUPS Implementation of IPP</title>
15 <meta name='keywords' content='Programming, Internet Printing Protocol'>
16 </head>
17 <body>
18 <h1 class="center"><img src="cups.svg" width="64" height="64" alt="CUPS"><br>
19 CUPS Implementation of IPP</h1>
20 <p class="center">Last Updated May 20, 2025</p>
21
22
23 <h2 id='INTRODUCTION'>Introduction</h2>
24 <p>CUPS implements the following Internet Printing Protocol standards:</p>
25 <ul>
26 <li><a href="https://ftp.pwg.org/pub/pwg/candidates/cs-ippfinishings30-20220527-5100.1.pdf">PWG 5100.1-2022: IPP Finishings v3.0 (FIN)</a></li>
27 <li><a href="https://ftp.pwg.org/pub/pwg/candidates/cs-ippoutputbin10-20010207-5100.2.pdf">PWG 5100.2-2001: "output-bin" Attribute Extension</a></li>
28 <li><a href="https://ftp.pwg.org/pub/pwg/candidates/cs-ippppx20-20230131-5100.3.pdf">PWG 5100.3-2023: IPP Production Printing Extensions v2.0 (PPX)</a></li>
29 <li><a href="https://ftp.pwg.org/pub/pwg/candidates/cs-ippdocobject11-20190521-5100.5.pdf">PWG 5100.5-2019: IPP Document Object v1.1</a></li>
30 <li><a href="https://ftp.pwg.org/pub/pwg/candidates/cs-ipppageoverride10-20031031-5100.6.pdf">PWG 5100.6-2003: IPP Page Overrides</a></li>
31 <li><a href="https://ftp.pwg.org/pub/pwg/candidates/cs-ippjobext21-20230210-5100.7.pdf">PWG 5100.7: IPP Job Extensions v2.1 (JOBEXT)</a></li>
32 <li><a href="https://ftp.pwg.org/pub/pwg/candidates/cs-ippactuals10-20030313-5100.8.pdf">PWG 5100.8-2003: IPP "-actual" Attributes</a></li>
33 <li><a href="https://ftp.pwg.org/pub/pwg/candidates/cs-ippstate10-20090731-5100.9.pdf">PWG 5100.9-2009: IPP Printer State Extensions</a></li>
34 <li><a href="https://ftp.pwg.org/pub/pwg/ipp/wd/wd-ippepx20-20231017.pdf">PWG 5100.11-YYYY: IPP Enterprise Printing Extensions v2.0 (EPX)</a></li>
35 <li><a href="https://ftp.pwg.org/pub/pwg/standards/std-ipp20-20151030-5100.12.pdf">PWG 5100.12-2015: IPP 2.0, 2.1, and 2.2</a></li>
36 <li><a href="https://ftp.pwg.org/pub/pwg/candidates/cs-ippnodriver20-20230301-5100.13.pdf">PWG 5100.13-2023: IPP Driver Replacement Extensions v2.0 (NODRIVER)</a></li>
37 <li><a href="https://ftp.pwg.org/pub/pwg/candidates/cs-ippeve11-20200515-5100.14.pdf">PWG 5100.14-2020: IPP Everywhere™ v1.1</a></li>
38 <li><a href="https://ftp.pwg.org/pub/pwg/candidates/cs-ipptrans11-20200327-5100.16.pdf">PWG 5100.16-2020: IPP Transaction-Based Printing Extensions v1.1</a></li>
39 <li><a href="https://ftp.pwg.org/pub/pwg/candidates/cs-ippinfra10-20150619-5100.18.pdf">PWG 5100.18-2015: IPP Shared Infrastructure Extensions (INFRA)</a></li>
40 <li><a href="https://ftp.pwg.org/pub/pwg/candidates/cs-ippsystem10-20191122-5100.22.pdf">PWG 5100.22-2019: IPP System Service v1.0 (SYSTEM)</a></li>
41 <li><a href="https://ftp.pwg.org/pub/pwg/candidates/cs-pwgmsn21-20230915-5101.1.pdf">PWG 5101.1-2023: PWG Media Standardized Names v2.1 (MSN)</a></li>
42 <li><a href="https://ftp.pwg.org/pub/pwg/candidates/cs-ippraster10-20120420-5102.4.pdf">PWG 5102.4-2012: PWG Raster Format</a></li>
43 <li><a href="https://ftp.pwg.org/pub/pwg/candidates/cs-pwgmfdalerts11-20190412-5107.3.pdf">PWG 5107.3-2019: PWG MFD Alerts v1.1 (MFD Alerts)</a></li>
44 <li><a href="https://ftp.pwg.org/pub/pwg/ipp/registrations/reg-ippprivacy10-20180412.pdf">Registration: IPP Privacy Attributes v1.0 (PRIVACY)</a></li>
45 <li><a href="https://ftp.pwg.org/pub/pwg/ipp/registrations/reg-ippsysdisc10-20200604.pdf">Registration: IPP System Service Discovery v1.0</a></li>
46 <li><a href="https://www.rfc-editor.org/rfc/rfc3380.html">RFC 3380: IPP: Job and Printer Set Operations</a></li>
47 <li><a href="https://www.rfc-editor.org/rfc/rfc3510.html">RFC 3510: IPP: IPP URL Scheme</a></li>
48 <li><a href="https://www.rfc-editor.org/rfc/rfc3995.html">RFC 3995: IPP Event Notifications and Subscriptions</a></li>
49 <li><a href="https://www.rfc-editor.org/rfc/rfc3996.html">RFC 3996: The 'ippget' Delivery Method for Event Notifications</a></li>
50 <li><a href="https://www.rfc-editor.org/rfc/rfc3998.html">RFC 3998: IPP Job and Printer Administrative Operations</a></li>
51 <li><a href="https://www.rfc-editor.org/rfc/rfc7472.html">RFC 7472: IPP over HTTPS Transport Binding and 'ipps' URI Scheme</a></li>
52 <li><a href="https://www.rfc-editor.org/rfc/rfc8010.html">RFC 8010: IPP/1.1 Encoding and Transport</a></li>
53 <li><a href="https://www.rfc-editor.org/rfc/rfc8011.html">RFC 8011: IPP/1.1 Model and Semantics</a></li>
54 </ul>
55 <p>CUPS also defines 17 new operations and many new attributes to support multiple IPP printers and printer classes on a single host.</p>
56
57 <h3 id='IPP_URIS'>IPP URIs</h3>
58 <p>CUPS supports the "ipp" and "ipps" schemes. The following resource names are used:</p>
59 <dl>
60 <dt><tt>SCHEME://HOSTNAME:PORT/</tt></dt>
61 <dd>Can be used for all "get" operations and for server subscriptions (deprecated).</dd>
62
63 <dt><tt>SCHEME://HOSTNAME:PORT/admin</tt></dt>
64 <dd>Used for all administrative operations (deprecated).</dd>
65
66 <dt><tt>SCHEME://HOSTNAME:PORT/classes/PRINTER-NAME</tt></dt>
67 <dd>Specifies a printer class (deprecated).</dd>
68
69 <dt><tt>SCHEME://HOSTNAME:PORT/ipp/print/PRINTER-NAME</tt></dt>
70 <dd>Specifies a printer.</dd>
71
72 <dt><tt>SCHEME://HOSTNAME:PORT/ipp/print/PRINTER-NAME/JOB-ID</tt></dt>
73 <dd>Specifies a job.</dd>
74
75 <dt><tt>SCHEME://HOSTNAME:PORT/ipp/system</tt></dt>
76 <dd>Used for all system-wide operations.</dd>
77
78 <dt><tt>SCHEME://HOSTNAME:PORT/jobs/JOB-ID</tt></dt>
79 <dd>Specifies a job (deprecated).</dd>
80
81 <dt><tt>SCHEME://HOSTNAME:PORT/printers/PRINTER-NAME</tt></dt>
82 <dd>Specifies a printer (deprecated).</dd>
83 </dl>
84 <p>So a typical printer URI would be "ipp://foo.example.com/ipp/print/LaserJet".</p>
85
86
87 <h3 id='IPP_OPERATIONS'>CUPS IPP Operations</h3>
88 <p>CUPS defines 17 vendor operations in addition to extending some of the standard IPP and registered extension operations:</p>
89 <table summary='Supported IPP Operations'>
90 <thead>
91 <tr>
92 <th>Operation Name</th>
93 <th>CUPS Version</th>
94 <th>Code</th>
95 <th>Brief Description</th>
96 </tr>
97 </thead>
98 <tbody>
99 <tr>
100 <td><a href='#CANCEL_JOB'>Cancel-Job</a> (Deprecated Extension)</td>
101 <td>1.0</td>
102 <td>0x0008</td>
103 <td>Cancel a print job.</td>
104 </tr>
105 <tr>
106 <td><a href='#CREATE_PRINTER_SUBSCRIPTION'>Create-Printer-Subscription</a> (Deprecated Extension)</td>
107 <td>1.2</td>
108 <td>0x0016</td>
109 <td>Creates a subscription associated with a printer or the server.</td>
110 </tr>
111 <tr>
112 <td><a href='#CUPS_GET_DEFAULT'>CUPS-Get-Default</a> (Deprecated)</td>
113 <td>1.0</td>
114 <td>0x4001</td>
115 <td>Get the default destination.</td>
116 </tr>
117 <tr>
118 <td><a href='#CUPS_GET_PRINTERS'>CUPS-Get-Printers</a></td>
119 <td>1.0</td>
120 <td>0x4002</td>
121 <td>Get all of the available printers.</td>
122 </tr>
123 <tr>
124 <td><a href='#CUPS_ADD_MODIFY_PRINTER'>CUPS-Add-Modify-Printer</a> (Deprecated)</td>
125 <td>1.0</td>
126 <td>0x4003</td>
127 <td>Add or modify a printer.</td>
128 </tr>
129 <tr>
130 <td><a href='#CUPS_DELETE_PRINTER'>CUPS-Delete-Printer</a> (Deprecated)</td>
131 <td>1.0</td>
132 <td>0x4004</td>
133 <td>Delete a printer.</td>
134 </tr>
135 <tr>
136 <td><a href='#CUPS_GET_CLASSES'>CUPS-Get-Classes</a> (Deprecated)</td>
137 <td>1.0</td>
138 <td>0x4005</td>
139 <td>Get all of the available printer classes.</td>
140 </tr>
141 <tr>
142 <td><a href='#CUPS_ADD_MODIFY_CLASS'>CUPS-Add-Modify-Class</a> (Deprecated)</td>
143 <td>1.0</td>
144 <td>0x4006</td>
145 <td>Add or modify a printer class.</td>
146 </tr>
147 <tr>
148 <td><a href='#CUPS_DELETE_CLASS'>CUPS-Delete-Class</a> (Deprecated)</td>
149 <td>1.0</td>
150 <td>0x4007</td>
151 <td>Delete a printer class.</td>
152 </tr>
153 <tr>
154 <td>CUPS-Accept-Jobs (Deprecated)</td>
155 <td>1.0</td>
156 <td>0x4008</td>
157 <td>Accept jobs on a printer or printer class. This operation is deprecated - use the Enable-Printer operation instead.</td>
158 </tr>
159 <tr>
160 <td>CUPS-Reject-Jobs (Deprecated)</td>
161 <td>1.0</td>
162 <td>0x4009</td>
163 <td>Reject jobs on a printer or printer class. This operation is deprecated - use the Disable-Printer operation instead.</td>
164 </tr>
165 <tr>
166 <td><a href='#CUPS_SET_DEFAULT'>CUPS-Set-Default</a> (Deprecated)</td>
167 <td>1.0</td>
168 <td>0x400A</td>
169 <td>Set the default destination.</td>
170 </tr>
171 <tr>
172 <td><a href='#CUPS_GET_DEVICES'>CUPS-Get-Devices</a> (Deprecated)</td>
173 <td>1.1</td>
174 <td>0x400B</td>
175 <td>Get all of the available devices.</td>
176 </tr>
177 <tr>
178 <td><a href='#CUPS_GET_PPDS'>CUPS-Get-PPDs</a> (Deprecated)</td>
179 <td>1.1</td>
180 <td>0x400C</td>
181 <td>Get all of the available PPDs.</td>
182 </tr>
183 <tr>
184 <td><a href='#CUPS_MOVE_JOB'>CUPS-Move-Job</a> (Deprecated)</td>
185 <td>1.1</td>
186 <td>0x400D</td>
187 <td>Move a job to a different printer.</td>
188 </tr>
189 <tr>
190 <td><a href='#CUPS_AUTHENTICATE_JOB'>CUPS-Authenticate-Job</a> (Deprecated)</td>
191 <td>1.2</td>
192 <td>0x400E</td>
193 <td>Authenticate a job for printing.</td>
194 </tr>
195 <tr>
196 <td><a href='#CUPS_GET_PPD'>CUPS-Get-PPD</a> (Deprecated)</td>
197 <td>1.3</td>
198 <td>0x400F</td>
199 <td>Get a PPD file.</td>
200 </tr>
201 <tr>
202 <td><a href='#CUPS_GET_DOCUMENT'>CUPS-Get-Document</a> (Deprecated)</td>
203 <td>1.4</td>
204 <td>0x4027</td>
205 <td>Get a document file from a job.</td>
206 </tr>
207 <tr>
208 <td><a href='#CUPS_CREATE_LOCAL_PRINTER'>CUPS-Create-Local-Printer</a></td>
209 <td>2.2</td>
210 <td>0x4028</td>
211 <td>Creates a local (temporary) print queue pointing to a remote IPP Everywhere printer.</td>
212 </tr>
213 </tbody>
214 </table>
215
216
217 <h2 id='OPERATIONS'>Operations</h2>
218 <p>The following sections describe the operations supported by CUPS. In the interest of brevity, operations which use only the standard IPP attributes are not described.
219
220
221 <h3 id='CANCEL_JOB'><span class='info'>Deprecated Extension</span>Cancel-Job Operation</h3>
222 <p>The Cancel-Job operation (0x0008) cancels the specified job. CUPS 1.4 added support for the <tt>purge-job (boolean)</tt> operation attribute that (if 'true') removes all history and document files for the job as well. This attribute is no longer supported since CUPS 3.0.</p>
223
224
225 <h3 id='CREATE_PRINTER_SUBSCRIPTION'><span class='info'>Deprecated Extension</span>Create-Printer-Subscription</h3>
226 <p>The Create-Printer-Subscription operation (0x0016) creates a subscription for printer event notifications. CUPS 1.2 through 2.5 provide several additional extension events:<p>
227 <ul>
228 <li><tt>printer-added</tt> - Get notified whenever a printer or class is added</li>
229 <li><tt>printer-deleted</tt> - Get notified whenever a printer or class is deleted</li>
230 <li><tt>printer-modified</tt> - Get notified whenever a printer or class is modified</li>
231 <li><tt>server-audit</tt> - Get notified when a security condition occurs</li>
232 <li><tt>server-restarted</tt> - Get notified when the server is restarted</li>
233 <li><tt>server-started</tt> - Get notified when the server is started</li>
234 <li><tt>server-stopped</tt> - Get notified when the server is stopped</li>
235 </ul>
236
237
238 <h3 id='CUPS_GET_DEFAULT'><span class='info'>Deprecated</span>CUPS-Get-Default Operation</h3>
239 <p>The CUPS-Get-Default operation (0x4001) returns the default printer URI and attributes.
240
241 <h4>CUPS-Get-Default Request</h4>
242 <p>The following groups of attributes are supplied as part of the CUPS-Get-Default request:
243 <p>Group 1: Operation Attributes
244 <dl>
245 <dt>Natural Language and Character Set:
246 <dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.1 of the IPP Model and Semantics document.
247
248 <dt>"requested-attributes" (1setOf keyword):
249 <dd>The client OPTIONALLY supplies a set of attribute names and/or attribute group names in whose values the requester is interested. If the client omits this attribute, the server responds as if this attribute had been supplied with a value of 'all'.
250 </dl>
251
252 <h4>CUPS-Get-Default Response</h4>
253 <p>The following groups of attributes are send as part of the CUPS-Get-Default Response:
254 <p>Group 1: Operation Attributes
255 <dl>
256 <dt>Natural Language and Character Set:
257 <dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.2 of the IPP Model and Semantics document.
258
259 <dt>Status Message:
260 <dd>The standard response status message.
261 </dl>
262 <p>Group 2: Printer Object Attributes
263 <dl>
264 <dt>The set of requested attributes and their current values.
265 </dl>
266
267
268 <h3 id='CUPS_GET_PRINTERS'>CUPS-Get-Printers Operation</h3>
269 <p>The CUPS-Get-Printers operation (0x4002) returns the printer attributes for every printer known to the system. This may include printers that are not served directly by the server.
270
271 <h4>CUPS-Get-Printers Request</h4>
272 <p>The following groups of attributes are supplied as part of the CUPS-Get-Printers request:
273 <p>Group 1: Operation Attributes
274 <dl>
275 <dt>Natural Language and Character Set:
276 <dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.1 of the IPP Model and Semantics document.
277
278 <dt><span class='info'>Deprecated</span>"first-printer-name" (name(127)):
279 <dd>The client OPTIONALLY supplies this attribute to select the first printer that is returned.
280
281 <dt>"limit" (integer (1:MAX)):
282 <dd>The client OPTIONALLY supplies this attribute limiting the number of printers that are returned.
283
284 <dt>"printer-id" (integer(0:65535)):
285 <dd>The client OPTIONALLY supplies this attribute to select which printer is returned.
286
287 <dt>"printer-location" (text(127)):
288 <dd>The client OPTIONALLY supplies this attribute to select which printers are returned.
289
290 <dt>"printer-type" (type2 enum):
291 <dd>The client OPTIONALLY supplies a printer type enumeration to select which printers are returned.
292
293 <dt>"printer-type-mask" (type2 enum):
294 <dd>The client OPTIONALLY supplies a printer type mask enumeration to select which bits are used in the "printer-type" attribute.
295
296 <dt>"requested-attributes" (1setOf keyword):
297 <dd>The client OPTIONALLY supplies a set of attribute names and/or attribute group names in whose values the requester is interested. If the client omits this attribute, the server responds as if this attribute had been supplied with a value of 'all'.
298
299 <dt>"requested-user-name" (name(127)):
300 <dd>The client OPTIONALLY supplies a user name that is used to filter the returned printers.
301 </dl>
302
303 <h4>CUPS-Get-Printers Response</h4>
304 <p>The following groups of attributes are send as part of the CUPS-Get-Printers Response:
305 <p>Group 1: Operation Attributes
306 <dl>
307 <dt>Natural Language and Character Set:
308 <dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.2 of the IPP Model and Semantics document.
309
310 <dt>Status Message:
311 <dd>The standard response status message.
312 </dl>
313 <p>Group 2: Printer Object Attributes
314 <dl>
315 <dt>The set of requested attributes and their current values for each printer.
316 </dl>
317
318
319 <h3 id='CUPS_ADD_MODIFY_PRINTER'><span class='info'>Deprecated</span>CUPS-Add-Modify-Printer Operation</h3>
320 <p>The CUPS-Add-Modify-Printer operation (0x4003) adds a new printer or modifies an existing printer on the system.
321
322 <h4>CUPS-Add-Modify-Printer Request</h4>
323 <p>The following groups of attributes are supplied as part of the CUPS-Add-Modify-Printer request:
324 <p>Group 1: Operation Attributes
325 <dl>
326 <dt>Natural Language and Character Set:
327 <dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.1 of the IPP Model and Semantics document.
328
329 <dt>"printer-uri" (uri):
330 <dd>The client MUST supply a URI for the specified printer.
331 </dl>
332 <p>Group 2: Printer Object Attributes
333 <dl>
334 <dt>"auth-info-required" (1setOf type2 keyword):
335 <dd>The client OPTIONALLY supplies one or more authentication keywords that are required to communicate with the printer/remote queue.
336
337 <dt>"job-sheets-default" (1setOf name(127)):
338 <dd>The client OPTIONALLY supplies one or two banner page names that are printed before and after files in a job. The reserved name "none" is used to specify that no banner page should be printed.
339
340 <dt>"device-uri" (uri):
341 <dd>The client OPTIONALLY supplies a device URI for the specified printer.
342
343 <dt>"port-monitor" (name(127)):
344 <dd>The client OPTIONALLY supplies a port monitor name for the specified printer.
345
346 <dt>"ppd-name" (name(255)):
347 <dd>The client OPTIONALLY supplies a PPD name for the specified printer.
348
349 <dt>"printer-is-accepting-jobs" (boolean):
350 <dd>The client OPTIONALLY supplies this boolean attribute indicating whether the printer object should accept new jobs.
351
352 <dt>"printer-info" (text(127)):
353 <dd>The client OPTIONALLY supplies this attribute indicating the printer information string.
354
355 <dt>"printer-location" (text(127)):
356 <dd>The client OPTIONALLY supplies this attribute indicating a textual location of the printer.
357
358 <dt>"printer-more-info" (uri):
359 <dd>The client OPTIONALLY supplies this attribute indicating a URI for additional printer information.
360
361 <dt>"printer-state" (type2 enum):
362 <dd>The client OPTIONALLY supplies this attribute indicating the initial/current state of the printer. Only the 'idle(3)' and 'stopped(5)' enumerations are recognized.
363
364 <dt>"printer-state-message" (text(MAX)):
365 <dd>The client OPTIONALLY supplies this attribute indicating a textual reason for the current printer state.
366
367 <dt>"requesting-user-name-allowed" (1setof name(127) | delete)
368 <br><i>OR</i>
369 <br>"requesting-user-name-denied" (1setof name(127) | delete):
370 <dd>The client OPTIONALLY supplies one of these attributes to specify an access control list for incoming print jobs. To allow all users access to a printer, use the delete tag for the attribute value.
371 </dl>
372 <p>The CUPS-Add-Modify-Printer request can optionally be followed by a PPD file to be used for the printer. The "ppd-name" attribute overrides any file that is attached to the end of the request with a local CUPS PPD file.
373
374 <h4>CUPS-Add-Modify-Printer Response</h4>
375 <p>The following groups of attributes are send as part of the CUPS-Add-Modify-Printer Response:
376 <p>Group 1: Operation Attributes
377 <dl>
378 <dt>Natural Language and Character Set:
379 <dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.2 of the IPP Model and Semantics document.
380
381 <dt>Status Message:
382 <dd>The standard response status message.
383 </dl>
384
385
386 <h3 id='CUPS_DELETE_PRINTER'><span class='info'>Deprecated</span>CUPS-Delete-Printer Operation</h3>
387 <p>The CUPS-Delete-Printer operation (0x4004) removes an existing printer from the system.
388
389 <h4>CUPS-Delete-Printer Request</h4>
390 <p>The following groups of attributes are supplied as part of the CUPS-Delete-Printer request:
391 <p>Group 1: Operation Attributes
392 <dl>
393 <dt>Natural Language and Character Set:
394 <dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.1 of the IPP Model and Semantics document.
395
396 <dt>"printer-uri" (uri):
397 <dd>The client MUST supply a URI for the specified printer.
398 </dl>
399
400 <h4>CUPS-Delete-Printer Response</h4>
401 <p>The following groups of attributes are send as part of the CUPS-Delete-Printer Response:
402 <p>Group 1: Operation Attributes
403 <dl>
404 <dt>Natural Language and Character Set:
405 <dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.2 of the IPP Model and Semantics document.
406
407 <dt>Status Message:
408 <dd>The standard response status message.
409 </dl>
410
411
412 <h3 id='CUPS_GET_CLASSES'><span class='info'>Deprecated</span>CUPS-Get-Classes Operation</h3>
413 <p>The CUPS-Get-Classes operation (0x4005) returns the printer attributes for every printer class known to the system. This may include printer classes that are not served directly by the server.
414
415 <h4>CUPS-Get-Classes Request</h4>
416 <p>The following groups of attributes are supplied as part of the CUPS-Get-Classes request:
417 <p>Group 1: Operation Attributes
418 <dl>
419 <dt>Natural Language and Character Set:
420 <dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.1 of the IPP Model and Semantics document.
421
422 <dt>"first-printer-name" (name(127)):
423 <dd>The client OPTIONALLY supplies this attribute to select the first printer that is returned.
424
425 <dt>"limit" (integer (1:MAX)):
426 <dd>The client OPTIONALLY supplies this attribute limiting the number of printer classes that are returned.
427
428 <dt>"printer-location" (text(127)):
429 <dd>The client OPTIONALLY supplies this attribute to select which printer classes are returned.
430
431 <dt>"printer-type" (type2 enum):
432 <dd>The client OPTIONALLY supplies a printer type enumeration to select which printer classes are returned.
433
434 <dt>"printer-type-mask" (type2 enum):
435 <dd>The client OPTIONALLY supplies a printer type mask enumeration to select which bits are used in the "printer-type" attribute.
436
437 <dt>"requested-attributes" (1setOf keyword):
438 <dd>The client OPTIONALLY supplies a set of attribute names and/or attribute group names in whose values the requester is interested. If the client omits this attribute, the server responds as if this attribute had been supplied with a value of 'all'.
439
440 <dt>"requested-user-name" (name(127)):
441 <dd>The client OPTIONALLY supplies a user name that is used to filter the returned printers.
442 </dl>
443
444 <h4>CUPS-Get-Classes Response</h4>
445 <p>The following groups of attributes are send as part of the CUPS-Get-Classes Response:
446 <p>Group 1: Operation Attributes
447 <dl>
448 <dt>Natural Language and Character Set:
449 <dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.2 of the IPP Model and Semantics document.
450
451 <dt>Status Message:
452 <dd>The standard response status message.
453 </dl>
454 <p>Group 2: Printer Class Object Attributes
455 <dl>
456 <dt>The set of requested attributes and their current values for each printer class.
457 </dl>
458
459
460 <h3 id='CUPS_ADD_MODIFY_CLASS'><span class='info'>Deprecated</span>CUPS-Add-Modify-Class Operation</h3>
461 <p>The CUPS-Add-Modify-Class operation (0x4006) adds a new printer class or modifies and existing printer class on the system.
462
463 <h4>CUPS-Add-Modify-Class Request</h4>
464 <p>The following groups of attributes are supplied as part of the CUPS-Add-Modify-Class request:
465 <p>Group 1: Operation Attributes
466 <dl>
467 <dt>Natural Language and Character Set:
468 <dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.1 of the IPP Model and Semantics document.
469
470 <dt>"printer-uri" (uri):
471 <dd>The client MUST supply a URI for the specified printer class.
472 </dl>
473 <p>Group 2: Printer Object Attributes
474 <dl>
475 <dt>"auth-info-required" (1setOf type2 keyword):
476 <dd>The client OPTIONALLY supplies one or more authentication keywords that are required to communicate with the printer/remote queue.
477
478 <dt>"member-uris" (1setof uri):
479 <dd>The client OPTIONALLY supplies the "member-uris" set specifying the printers and printer classes that are part of the class.
480
481 <dt>"printer-is-accepting-jobs" (boolean):
482 <dd>The client OPTIONALLY supplies this boolean attribute indicating whether the class object should accept new jobs.
483
484 <dt>"printer-info" (text(127)):
485 <dd>The client OPTIONALLY supplies this attribute indicating the printer information string.
486
487 <dt>"printer-location" (text(127)):
488 <dd>The client OPTIONALLY supplies this attribute indicating a textual location of the class.
489
490 <dt>"printer-more-info" (uri):
491 <dd>The client OPTIONALLY supplies this attribute indicating a URI for additional class information.
492
493 <dt>"printer-state" (type2 enum):
494 <dd>The client OPTIONALLY supplies this attribute indicating the initial/current state of the class. Only the 'idle(3)' and 'stopped(5)' enumerations are recognized.
495
496 <dt>"printer-state-message" (text(MAX)):
497 <dd>The client OPTIONALLY supplies this attribute indicating a textual reason for the current class state.
498
499 <dt>"requesting-user-name-allowed" (1setof name(127))
500 <br><i>OR</i>
501 <br>"requesting-user-name-denied" (1setof name(127)):
502 <dd>The client OPTIONALLY supplies one of these attributes to specify an access control list for incoming print jobs. To allow all users access to a class, use the delete tag for the attribute value.
503 </dl>
504
505 <h4>CUPS-Add-Modify-Class Response</h4>
506 <p>The following groups of attributes are send as part of the CUPS-Add-Modify-Class Response:
507 <p>Group 1: Operation Attributes
508 <dl>
509 <dt>Natural Language and Character Set:
510 <dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.2 of the IPP Model and Semantics document.
511
512 <dt>Status Message:
513 <dd>The standard response status message.
514 </dl>
515
516
517 <h3 id='CUPS_DELETE_CLASS'><span class='info'>Deprecated</span>CUPS-Delete-Class Operation</h3>
518 <p>The CUPS-Delete-Class operation (0x4007) removes an existing printer class from the system.
519
520 <h4>CUPS-Delete-Class Request</h4>
521 <p>The following groups of attributes are supplied as part of the CUPS-Delete-Class request:
522 <p>Group 1: Operation Attributes
523 <dl>
524 <dt>Natural Language and Character Set:
525 <dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.1 of the IPP Model and Semantics document.
526
527 <dt>"printer-uri" (uri):
528 <dd>The client MUST supply a URI for the specified printer class.
529 </dl>
530
531 <h4>CUPS-Delete-Class Response</h4>
532 <p>The following groups of attributes are send as part of the CUPS-Delete-Class Response:
533 <p>Group 1: Operation Attributes
534 <dl>
535 <dt>Natural Language and Character Set:
536 <dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.2 of the IPP Model and Semantics document.
537
538 <dt>Status Message:
539 <dd>The standard response status message.
540 </dl>
541
542
543 <h3 id='CUPS_SET_DEFAULT'><span class='info'>Deprecated</span>CUPS-Set-Default Operation</h3>
544 <p>The CUPS-Set-Default operation (0x400A) sets the default printer destination for all clients when a resource name of "/printers" is specified.
545
546 <h4>CUPS-Set-Default Request</h4>
547 <p>The following groups of attributes are supplied as part of the CUPS-Set-Default request:
548 <p>Group 1: Operation Attributes
549 <dl>
550 <dt>Natural Language and Character Set:
551 <dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.1 of the IPP Model and Semantics document.
552
553 <dt>"printer-uri" (uri):
554 <dd>The client MUST supply a URI for the specified printer or printer class.
555 </dl>
556
557 <h4>CUPS-Set-Default Response</h4>
558 <p>The following groups of attributes are send as part of the CUPS-Set-Default Response:
559 <p>Group 1: Operation Attributes
560 <dl>
561 <dt>Natural Language and Character Set:
562 <dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.2 of the IPP Model and Semantics document.
563
564 <dt>Status Message:
565 <dd>The standard response status message.
566 </dl>
567
568
569 <h3 id='CUPS_GET_DEVICES'><span class='info'>Deprecated</span>CUPS-Get-Devices Operation</h3>
570 <p>The CUPS-Get-Devices operation (0x400B) returns all of the supported device-uri's for the server.</p>
571
572 <h4>CUPS-Get-Devices Request</h4>
573 <p>The following groups of attributes are supplied as part of the CUPS-Get-Devices request:
574 <p>Group 1: Operation Attributes
575 <dl>
576 <dt>Natural Language and Character Set:
577 <dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.1 of the IPP Model and Semantics document.
578
579 <dt>"device-class" (type1 keyword):
580 <dd>The client OPTIONALLY supplies a device class keyword to select which devices are returned.
581
582 <dt>"exclude-schemes" (1setOf name):
583 <dd>The client OPTIONALLY supplies a set of scheme names that the requestor does not want to discover. If the client omits this attribute, the server responds with devices of all schemes specified by the "include-schemes" attribute.
584
585 <dt>"include-schemes" (1setOf name):
586 <dd>The client OPTIONALLY supplies a set of scheme names that the requestor wants to discover. If the client omits this attribute, the server responds with devices of all schemes except those specified by the "exclude-schemes" attribute.
587
588 <dt>"limit" (integer (1:MAX)):
589 <dd>The client OPTIONALLY supplies this attribute limiting the number of devices that are returned.
590
591 <dt>"requested-attributes" (1setOf keyword):
592 <dd>The client OPTIONALLY supplies a set of attribute names and/or attribute group names in whose values the requester is interested. If the client omits this attribute, the server responds as if this attribute had been supplied with a value of 'all'.
593
594 <dt>"timeout" (integer (1:MAX)):
595 <dd>The client OPTIONALLY supplies this attribute to limit the duration of the lookup. The default timeout is 15 seconds.
596 </dl>
597
598 <h4>CUPS-Get-Devices Response</h4>
599 <p>The following groups of attributes are send as part of the CUPS-Get-Devices Response:
600 <p>Group 1: Operation Attributes
601 <dl>
602 <dt>Natural Language and Character Set:
603 <dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.2 of the IPP Model and Semantics document.
604
605 <dt>Status Message:
606 <dd>The standard response status message.
607 </dl>
608 <p>Groups 2-N: Device Object Attributes (using printer-attributes-tag group)
609 <dl>
610 <dt>The set of requested attributes and their current values for
611 each device.
612 </dl>
613
614
615 <h3><span class='info'>Deprecated</span><a name='CUPS_GET_PPDS'>CUPS-Get-PPDs Operation</a></h3>
616 <p>The CUPS-Get-PPDs operation (0x400C) returns all of the locally available PPD files on the system.</p>
617
618 <h4>CUPS-Get-PPDs Request</h4>
619 <p>The following groups of attributes are supplied as part of the CUPS-Get-PPDs request:
620 <p>Group 1: Operation Attributes
621 <dl>
622 <dt>Natural Language and Character Set:
623 <dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.1 of the IPP Model and Semantics document.
624
625 <dt>"exclude-schemes" (1setOf name):
626 <dd>The client OPTIONALLY supplies a set of scheme names that the requestor does not want to list. If the client omits this attribute, the server responds with PPDs of all schemes specified by the "include-schemes" attribute.
627
628 <dt>"include-schemes" (1setOf name):
629 <dd>The client OPTIONALLY supplies a set of scheme names that the requestor wants to list. If the client omits this attribute, the server responds with PPDs of all schemes except those specified by the "exclude-schemes" attribute.
630
631 <dt>"limit" (integer (1:MAX)):
632 <dd>The client OPTIONALLY supplies this attribute limiting the number of PPDs that are returned.
633
634 <dt>"ppd-make" (text(127)):
635 <dd>The client OPTIONALLY supplies a printer manufacturer to select which PPDs are returned.
636
637 <dt>"ppd-make-and-model" (text(127)):
638 <dd>The client OPTIONALLY supplies a make and model to select which PPDs are returned.
639
640 <dt>"ppd-model-number" (integer):
641 <dd>The client OPTIONALLY supplies a model number to select which PPDs are returned.
642
643 <dt>"ppd-natural-language" (naturalLanguage):
644 <dd>The client OPTIONALLY supplies a language to select which PPDs are returned.
645
646 <dt>"ppd-product" (text(127)):
647 <dd>The client OPTIONALLY supplies a PostScript product string to select which PPDs are returned.
648
649 <dt>"ppd-psversion" (text(127)):
650 <dd>The client OPTIONALLY supplies a PostScript version string to select which PPDs are returned.
651
652 <dt>"ppd-type" (type1 keyword):
653 <dd>The client OPTIONALLY supplies a driver type to select which PPDs are returned.
654
655 <dt>"requested-attributes" (1setOf keyword):
656 <dd>The client OPTIONALLY supplies a set of attribute names and/or attribute group names in whose values the requester is interested. If the client omits this attribute, the server responds as if this attribute had been supplied with a value of 'all'. Specify "ppd-make" to get a list of manufacturers.
657 </dl>
658
659 <h4>CUPS-Get-PPDs Response</h4>
660 <p>The following groups of attributes are send as part of the
661 CUPS-Get-PPDs Response:
662 <p>Group 1: Operation Attributes
663 <dl>
664 <dt>Natural Language and Character Set:
665 <dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.2 of the IPP Model and Semantics document.
666
667 <dt>Status Message:
668 <dd>The standard response status message.
669 </dl>
670 <p>Groups 2-N: PPD Attributes (using printer-attributes-tag group)
671 <dl>
672 <dt>The set of requested attributes and their current values for each PPD file.
673 </dl>
674
675
676 <h3><span class='info'>Deprecated</span><a name='CUPS_MOVE_JOB'>CUPS-Move-Job Operation</a></h3>
677 <p>The CUPS-Move-Job operation (0x400D) moves an active print job or all print jobs for a printer to a different printer.</p>
678
679 <h4>CUPS-Move-Job Request</h4>
680 <p>The following groups of attributes are supplied as part of the CUPS-Move-Job request:
681 <p>Group 1: Operation Attributes
682 <dl>
683
684 <dt>Natural Language and Character Set:
685 <dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.1 of the IPP Model and Semantics document.
686
687 <dt>"printer-uri" (uri)
688 <br><i>OR</i>
689 <dt>"printer-uri" (uri) and "job-id" (integer)
690 <br><i>OR</i>
691 <br>"job-uri" (uri):
692 <dd>The client MUST supply a URI for the specified printer, the URI for the specified printer and a job ID number, or the job URI.
693 </dl>
694 <p>Group 2: Job Template Attributes
695 <dl>
696 <dt>"job-printer-uri" (uri):
697 <dd>The client MUST supply a URI for a printer on the same server.
698 </dl>
699
700 <h4>CUPS-Move-Job Response</h4>
701 <p>The following groups of attributes are send as part of the CUPS-Move-Job Response:
702 <p>Group 1: Operation Attributes
703 <dl>
704 <dt>Status Message:
705 <dd>The standard response status message.
706
707 <dt>Natural Language and Character Set:
708 <dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.2 of the IPP Model and Semantics document.
709 </dl>
710
711
712 <h3><span class='info'>Deprecated</span><a name='CUPS_AUTHENTICATE_JOB'>CUPS-Authenticate-Job Operation</a></h3>
713 <p>The CUPS-Authenticate-Job operation (0x400E) authenticates a print job for printing, releasing the job if it is held. Typically this is used when printing to a remote server. The authentication information is passed in the HTTP request; the HTTP connection is normally encrypted for this type of request.</p>
714
715 <h4>CUPS-Authenticate-Job Request</h4>
716 <p>The following groups of attributes are supplied as part of the CUPS-Authenticate-Job request:
717 <p>Group 1: Operation Attributes
718 <dl>
719 <dt>Natural Language and Character Set:
720 <dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.1 of the IPP Model and Semantics document.
721
722 <dt>"printer-uri" (uri) and "job-id" (integer)
723 <br><i>OR</i>
724 <br>"job-uri" (uri):
725 <dd>The client MUST supply a URI for the specified printer and a job ID number, or the job URI.
726 </dl>
727 <p>Group 2: Job Attributes
728 <dl>
729 <dt>"auth-info" (1setOf text(MAX)):
730 <dd>The client OPTIONALLY supplies one or more authentication values as specified by the "auth-info-required" attribute.
731
732 <dt>"job-hold-until" (keyword | name(MAX)):
733 <dd>The client OPTIONALLY supplies a new job-hold-until value for the job. If specified and not the "no-hold" value, the job is held instead of released for printing.
734 </dl>
735
736 <h4>CUPS-Authenticate-Job Response</h4>
737 <p>The following groups of attributes are send as part of the CUPS-Authenticate-Job Response:
738 <p>Group 1: Operation Attributes
739 <dl>
740 <dt>Natural Language and Character Set:
741 <dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.2 of the IPP Model and Semantics document.
742
743 <dt>Status Message:
744 <dd>The standard response status message.
745 </dl>
746 <p>Group 2: Unsupported Attributes (status=client-eror-attributes-or-values-not-supported)
747 <dl>
748 <dt>auth-info-required (1setOf Type2 keyword)
749 <dd>The required authentication information.
750 </dl>
751
752
753 <h3><span class='info'>Deprecated</span><a name='CUPS_GET_PPD'>CUPS-Get-PPD Operation</a></h3>
754 <p>The CUPS-Get-PPD operation (0x400F) gets a PPD file from the server. The PPD file can be specified using a <tt>ppd-name</tt> returned by <a href='#CUPS_GET_PPDS'><tt>CUPS-Get-PPDs</tt></a> or using the <tt>printer-uri</tt> for a queue.</p>
755 <p>If the PPD file is found, <tt>successful-ok</tt> is returned with the PPD file following the response data.</p>
756 <p>If the PPD file cannot be served by the local server because the <tt>printer-uri</tt> attribute points to an external printer, a <tt>cups-see-other</tt> status is returned with the correct URI to use.</p>
757 <p>If the PPD file does not exist, <tt>client-error-not-found</tt> is returned.</p>
758
759 <h4>CUPS-Get-PPD Request</h4>
760 <p>The following group of attributes is supplied as part of the CUPS-Get-PPD request:
761 <p>Group 1: Operation Attributes
762 <dl>
763 <dt>Natural Language and Character Set:
764 <dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.1 of the IPP Model and Semantics document.
765
766 <dt>"printer-uri" (uri)
767 <br><i>OR</i>
768 <br>"ppd-name" (name(255)):
769 <dd>The client MUST supply a printer URI or PPD name.
770 </dl>
771
772 <h4>CUPS-Get-PPD Response</h4>
773 <p>The following group of attributes is sent as part of the CUPS-Get-PPD Response:
774 <p>Group 1: Operation Attributes
775 <dl>
776 <dt>Natural Language and Character Set:
777 <dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.2 of the IPP Model and Semantics document.
778
779 <dt>Status Message:
780 <dd>The standard response status message.
781
782 <dt>"printer-uri" (uri):
783 <dd>The printer that provides the actual PPD file when the status code is cups-see-other (0x280).
784 </dl>
785 <p>If the status code is <tt>successful-ok</tt>, the PPD file follows the end of the IPP response.</p>
786
787
788 <h3><span class='info'>Deprecated</span><a name='CUPS_GET_DOCUMENT'>CUPS-Get-Document Operation</a></h3>
789 <p>The CUPS-Get-Document operation (0x4027) gets a document file from a job on the server. The document file is specified using the <tt>document-number</tt> and either the <tt>job-uri</tt> or <tt>printer-uri</tt> and <tt>job-id</tt> identifying the job.</p>
790 <p>If the document file is found, <tt>successful-ok</tt> is returned with the document file following the response data.</p>
791 <p>If the document file does not exist, <tt>client-error-not-found</tt> is returned.</p>
792 <p>If the requesting user does not have access to the document file, <tt>client-error-not-authorized</tt> is returned.
793
794 <h4>CUPS-Get-Document Request</h4>
795 <p>The following group of attributes is supplied as part of the CUPS-Get-Document request:
796 <p>Group 1: Operation Attributes
797 <dl>
798 <dt>Natural Language and Character Set:
799 <dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.1 of the IPP Model and Semantics document.
800
801 <dt>"printer-uri" (uri) and "job-id" (integer)
802 <br><i>OR</i>
803 <br>"job-uri" (uri):
804 <dd>The client MUST supply a printer URI and job ID or job URI.
805
806 <dt>"document-number" (integer(1:MAX)):
807 <dd>The client MUST supply a document number to retrieve. The <tt>number-of-documents</tt> attribute for the job defines the maximum document number that can be specified. In the case of jobs with banners (<tt>job-sheets</tt> is not "none"), document number 1 will typically contain the start banner and document number N will typically contain the end banner.
808 </dl>
809
810 <h4>CUPS-Get-Document Response</h4>
811 <p>The following group of attributes is sent as part of the CUPS-Get-Document Response:
812 <p>Group 1: Operation Attributes
813 <dl>
814 <dt>Natural Language and Character Set:
815 <dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.2 of the IPP Model and Semantics document.
816
817 <dt>Status Message:
818 <dd>The standard response status message.
819
820 <dt>"document-format" (mimeType):
821 <dd>The format of the document file.
822
823 <dt>"document-number" (integer(1:MAX)):
824 <dd>The requested document number.
825
826 <dt>"document-name" (name(MAX)):
827 <dd>The name that was supplied with the document, if any.
828 </dl>
829 <p>If the status code is <tt>successful-ok</tt>, the document file follows the end of the IPP response.</p>
830
831
832 <h3 id='CUPS_CREATE_LOCAL_PRINTER'>CUPS-Create-Local-Printer</h3>
833 <p>The CUPS-Create-Local-Printer operation (0x4028) creates a local (temporary) print queue pointing to a remote IPP Everywhere Printer. The queue will remain until the scheduler idle exits, is restarted, or the system is restarted or shutdown. Temporary print queues can be made permanent by an administrator by setting the "printer-is-shared" attribute to 'true'.</p>
834 <p>At a minimum, the scheduler requires a name and URI for the Printer to add. When successful, the local "printer-uri" values are returned and may be used by the Client to submit Job Creation Requests, monitor for state changes, and so forth.</p>
835 <p>If the named printer already exists, the scheduler will reject the request with the 'client-error-not-possible' status code.</p>
836 <p>Access Rights: The authenticated user performing this operation MUST be a Local User of the system, and the request MUST be made over a local (domain socket or loopback interface) address. Otherwise, the request will be rejected with the 'client-error-forbidden' status code.</p>
837
838 <h4>CUPS-Create-Local-Printer Request</h4>
839 <p>The following group of attributes is supplied as part of the CUPS-Create-Local-Printer request:
840 <p>Group 1: Operation Attributes
841 <dl>
842 <dt>Natural Language and Character Set:
843 <dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.1 of the IPP Model and Semantics document.
844 </dl>
845 <p>Group 2: Printer Attributes
846 <dl>
847 <dt>"printer-name" (name(127)):
848 <dd>The Client MUST supply this attribute which provides the name for the new Printer.
849
850 <dt>"device-uri" (uri):
851 <dd>The Client MUST supply this attribute which provides an "ipp" or "ipps" URI pointing to an IPP Everywhere Printer.
852
853 <dt>"printer-device-id" (text(1023)):
854 <dd>The Client OPTIONALLY supplies this attribute which provides the IEEE 1284 device ID for the new Printer.
855
856 <dt>"printer-geo-location" (uri):
857 <dd>The Client OPTIONALLY supplies this attribute which provides the geo-location of the new Printer as a "geo" URI.
858
859 <dt>"printer-info" (text(127)):
860 <dd>The Client OPTIONALLY supplies this attribute which provides the description for the new Printer.
861
862 <dt>"printer-location" (text(127)):
863 <dd>The Client OPTIONALLY supplies this attribute which provides the location of the new Printer.
864 </dl>
865
866 <h4>CUPS-Create-Local-Printer Response</h4>
867 <p>The following group of attributes is sent as part of the CUPS-Create-Local-Printer Response:
868 <p>Group 1: Operation Attributes
869 <dl>
870 <dt>Natural Language and Character Set:
871 <dd>The "attributes-charset" and "attributes-natural-language" attributes as described in section 3.1.4.2 of the IPP Model and Semantics document.
872
873 <dt>Status Message:
874 <dd>The standard response status message.
875 </dl>
876 <p>Group 2: Printer Attributes
877 <dl>
878 <dt>"printer-id" (integer(0:65535)):
879 <dd>The numeric identifier for the created Printer.
880
881 <dt>"printer-is-accepting-jobs" (boolean):
882 <dd>Whether the created Printer is accepting jobs at the time of the response.
883
884 <dt>"printer-state" (type1 enum):
885 <dd>The state of the created Printer at the time of the response.
886
887 <dt>"printer-state-reasons" (1setOf type2 keyword):
888 <dd>The state keywords for the created Printer at the time of the response.
889
890 <dt>"printer-uri-supported" (1setOf uri):
891 <dd>The URIs for the created Printer.
892 </dl>
893
894
895 <h2 id='ATTRIBUTES'>Attributes</h2>
896 <p>CUPS provides many extension attributes to support multiple devices, PPD files, standard job filters, printers, and printer classes.</p>
897
898
899 <h3 id='DEVICE_ATTRIBUTES'><span class="info">Deprecated</span>Device Attributes</h3>
900 <p>Device attributes are returned by the CUPS-Get-Devices operation and enumerate all of the available hardware devices and network protocols that are supported by the server. Device attributes are reported in the printer-attributes-tag group.</p>
901
902 <h4 id='device-class'><span class="info">Deprecated</span>device-class (type2 keyword)</h4>
903 <p>The "device-class" attribute provides the class of device and can be one of the following:
904 <ul>
905 <li>'file': A disk file.
906 <li>'direct': A parallel or fixed-rate serial data port, currently used for Centronics, IEEE-1284, and USB printer ports.
907 <li>'serial': A variable-rate serial port.
908 <li>'network': A network connection, typically via AppSocket, HTTP, IPP, LPD, or SMB/CIFS protocols.
909 </ul>
910
911 <h4 id='device-id'><span class="info">Deprecated</span>device-id (text(1023))</h4>
912 <p>The "device-id" attribute provides the IEEE-1284 device ID string for the device.</p>
913
914 <h4 id='device-info'><span class="info">Deprecated</span>device-info (text(127))</h4>
915 <p>The "device-info" attribute specifies a human-readable string describing the device, e.g., 'Parallel Port #1'.
916
917 <h4 id='device-location'><span class="info">Deprecated</span>device-location (text(127))</h4>
918 <p>The "device-location" attribute specifies the physical location of the printer, e.g., '2nd Floor Computer Lab'.
919
920 <h4 id='device-make-and-model'><span class="info">Deprecated</span>device-make-and-model (text(127))</h4>
921 <p>The "device-make-and-model" attribute specifies a device identification string provided by the printer connected to the device. If the device or printer does not support identification then this attribute contains the string 'unknown'.
922
923 <h4 id='device-uri'><span class="info">Deprecated</span>device-uri (uri)</h4>
924 <p>The "device-uri" attribute specifies a unique identifier for the device. The actual format of the "device-uri" string depends on the value of the "device-class" attribute:
925 <ul>
926 <li>'file': The "device-uri" will be of the form 'file:///path/to/filename'.
927 <li>'direct': The "device-uri" will be of the form 'scheme:/dev/filename' or 'scheme://vendor/identifier', where scheme may be 'parallel' or 'usb' in the current implementation.
928 <li>'serial': The "device-uri" will be of the form 'serial:/dev/filename?baud=value+parity=value+flow=value'. The baud value is the data rate in bits per second; the supported values depend on the underlying hardware. The parity value can be one of "none", "even", or "odd". The flow value can be one of "none", "soft" (XON/XOFF handshaking), "hard" or "rts/cts" (RTS/CTS handshaking), or "dtrdsr" (DTR/DSR handshaking).
929 <p>The URI returned by CUPS-Get-Devices will contain the maximum baud rate supported by the device and the best type of flow control available ("soft" or "hard").
930 <li>'network': The "device-uri" will be of the form 'scheme://[username:password@]hostname[:port]/[resource]', where scheme may be "http", "https", "ipp", "lpd", "smb", or "socket" in the current implementation.
931 <p>The URI returned by CUPS-Get-Devices MAY only contain the scheme name ('scheme'). It is up to the client application to add the appropriate host and other information when adding a new printer.
932 <p>The URI returned by Get-Printer-Attributes and CUPS-Get-Printers has any username and password information stripped; the information is still stored and used by the server internally to perform any needed authentication.
933 </ul>
934 <blockquote><b>Note:</b> This attribute has been replaced by the ["smi55357-device-uri (uri)"](https://github.com/michaelrsweet/pappl/blob/master/doc/IPP-EXTENSIONS.md#513-smi55357-device-uri-uri) attribute.</blockquote>
935
936
937 <h3 id='JOB_ATTRIBUTES'>Job Attributes</h3>
938
939 <h4 id='auth-info'><span class="info">Deprecated</span>auth-info (1setOf text(MAX))</h4>
940 <p>The "auth-info" attribute specifies the authentication information to use when printing to a remote device. The order and content of each text value is specifed by the <a href="#auth-info-required">auth-info-required</a> printer attribute.
941
942 <h4 id='job-cancel-after'>job-cancel-after (integer(1:MAX))</h4>
943 <p>The "job-cancel-after" attribute provides the maximum number of seconds that are allowed for processing a job.</p>
944
945 <h4 id='job-hold-until'><span class='info'>Extension</span>job-hold-until (keyword | name(MAX))</h4>
946 <p>The "job-hold-until" attribute specifies a hold time. In addition to the standard IPP/1.1 keyword names, CUPS supports name values of the form "HH:MM" and "HH:MM:SS" that specify a hold time. The hold time is in Universal Coordinated Time (UTC) and <i>not</i> in the local time zone. If the specified time is less than the current time, the job is held until the next day.
947
948 <h4 id='job-media-progress'>job-media-progress (integer(0:100))</h4>
949 <p>The "job-media-progress" status attribute specifies the percentage of completion of the current page. It is only valid when the "job-state" attribute has the 'processing(5)' value.</p>
950
951 <h4 id='job-printer-state-message'>job-printer-state-message (text(MAX))</h4>
952 <p>The "job-printer-state-message" status attribute provides the last known value of the "printer-state-message" attribute for the printer that processed (or is processing) the job.</p>
953
954 <h4 id='job-printer-state-reasons'>job-printer-state-reasons (1setOf type2 keyword)</h4>
955 <p>The "job-printer-state-reasons" status attribute provides the last known value of the "printer-state-reasons" attribute for the printer that processed (or is processing) the job.</p>
956
957 <h4 id='job-sheets'><span class='info'>Extension</span>job-sheets (1setof type2 keyword | name(MAX))</h4>
958 <p>The "job-sheets" attribute specifies one or two banner files that are printed before and after a job. The reserved value of "none" disables banner printing. The default value is stored in the "job-sheets-default" attribute.
959 <p>If only one value is supplied, the banner file is printed before the job. If two values are supplied, the first value is used as the starting banner file and the second as the ending banner file.
960
961 <h4 id='job-originating-host-name'>job-originating-host-name (name(MAX))</h4>
962 <p>The "job-originating-host-name" status attribute specifies the host from which the job was queued. The value will be the hostname or IP address of the client depending on whether hostname resolution is enabled. The localhost address (127.0.0.1) is <b>always</b> resolved to the name "localhost".
963 <p>This attribute is read-only.
964
965 <h4 id='page-border'>page-border (type2 keyword)</h4>
966 <p>The "page-border" attribute specifies whether a border is draw around each page. The following keywords are presently defined:
967 <ul>
968 <li>'double': Two hairline borders are drawn</li>
969 <li>'double-thick': Two 1pt borders are drawn</li>
970 <li>'none': No border is drawn (default)</li>
971 <li>'single': A single hairline border is drawn</li>
972 <li>'single-thick': A single 1pt border is drawn</li>
973 </ul>
974
975 <h4 id='page-set'><span class="info">Deprecated</span>page-set (type2 keyword)</h4>
976 <p>The "page-set" attribute specifies which pages to print in a file. The supported keywords are 'all', 'even', and 'odd'. The default value is 'all'.
977
978
979 <h3 id='PPD_ATTRIBUTES'><span class="info">Deprecated</span>PPD Attributes</h3>
980 <p>PPD attributes are returned in the printer-attributes-tag group.
981
982 <h4 id='ppd-device-id'><span class="info">Deprecated</span>ppd-device-id (text(127))</h4>
983 <p>The "ppd-device-id" attribute specifies the IEEE-1284 device ID string for the device described by the PPD file.</p>
984
985 <h4 id='ppd-make'><span class="info">Deprecated</span>ppd-make (text(127))</h4>
986 <p>The "ppd-make" attribute specifies the manufacturer of the printer (the Manufacturer attribute in the PPD file). If the manufacturer is not specified in the PPD file then an educated guess is made using the NickName attribute in the PPD file.
987
988 <h4 id='ppd-make-and-model'><span class="info">Deprecated</span>ppd-make-and-model (text(127))</h4>
989 <p>The "ppd-make-and-model" attribute specifies the manufacturer and model name of the PPD file (the NickName attribute in the PPD file). If the make and model is not specified in the PPD file then the ModelName or ShortNickName attributes are used instead.
990
991 <h4 id='ppd-model-number'><span class="info">Deprecated</span>ppd-model-number (integer)</h4>
992 <p>The "ppd-model-number" attribute provides the <tt>cupsModelNumber</tt> value from the PPD file.
993
994 <h4 id='ppd-name'><span class="info">Deprecated</span>ppd-name (name(255))</h4>
995 <p>The "ppd-name" attribute specifies either the PPD filename on the server relative to the model directory or a URI that maps to a specific driver interface in the driver directory. The forward slash (/) is used to delineate directories.
996
997 <h4 id='ppd-natural-language'><span class="info">Deprecated</span>ppd-natural-language (1setOf naturalLanguage)</h4>
998 <p>The "ppd-natural-language" attribute specifies the language encoding of the PPD file (the LanguageVersion attribute in the PPD file). If the language is unknown or undefined then "en" (English) is assumed.
999
1000 <h4 id='ppd-product'><span class="info">Deprecated</span>ppd-product (1setOf text(127))</h4>
1001 <p>The "ppd-product" attribute specifies the Product attribute values in the PPD file.
1002
1003 <h4 id='ppd-psversion'><span class="info">Deprecated</span>ppd-psversion (1setOf text(127))</h4>
1004 <p>The "ppd-product" attribute specifies the PSVersion attribute values in the PPD file.
1005
1006 <h4 id='ppd-type'><span class="info">Deprecated</span>ppd-type (keyword)</h4>
1007 <p>The "ppd-type" attribute specifies the type of driver described by the PPD file:</p>
1008 <ul>
1009 <li>'fax': A facsimile or multi-function device</li>
1010 <li>'pdf': A PDF printer</li>
1011 <li>'postscript': A PostScript printer (no filters)</li>
1012 <li>'raster': A CUPS raster driver</li>
1013 <li>'unknown': An unknown or hybrid driver</li>
1014 </ul>
1015
1016
1017 <h3 id='PRINTER_ATTRIBUTES'>Printer Attributes</h3>
1018
1019 <h4 id='auth-info-required'><span class="info">Deprecated</span>auth-info-required (1setOf keyword)</h4>
1020 <p>The "auth-info-required" attribute specifies the authentication information that is required for printing a job. The following keywords are recognized:</p>
1021 <ul>
1022 <li>'domain': A domain name is required.</li>
1023 <li>'negotiate': Kerberos is required - this keyword can only appear by itself and causes cupsd to collect the UID of the printing user.</li>
1024 <li>'none': No authentication is required - this keyword can only appear by itself.</li>
1025 <li>'oauth': An OAuth/OpenID access token is required - this keyword can only appear by itself.</li>
1026 <li>'password': A password is required.</li>
1027 <li>'username': A username is required. Some protocols (like SMB) prefix the username with the domain, for example "DOMAIN\user".</li>
1028 </ul>
1029
1030 <h4 id='job-k-limit'><span class="info">Deprecated</span>job-k-limit (integer)</h4>
1031 <p>The "job-k-limit" attribute specifies the maximum number of kilobytes that may be printed by a user, including banner files. The default value of 0 specifies that there is no limit.
1032
1033 <h4 id='job-page-limit'><span class="info">Deprecated</span>job-page-limit (integer)</h4>
1034 <p>The "job-page-limit" attribute specifies the maximum number of pages that may be printed by a user, including banner files. The default value of 0 specifies that there is no limit.
1035
1036 <h4 id='job-quota-period'><span class="info">Deprecated</span>job-quota-period (integer)</h4>
1037 <p>The "job-quota-period" attribute specifies the time period used for quota calculations, in seconds. The default value of 0 specifies that the limits apply to all jobs that have been printed by a user that are still known to the system.
1038
1039 <h4 id='port-monitor'><span class="info">Deprecated</span>port-monitor (name(127))</h4>
1040 <p>The "port-monitor" attribute specifies the port monitor to use when printing to this printer. The default port monitor is 'none'.
1041
1042 <h4 id='port-monitor-supported'><span class="info">Deprecated</span>port-monitor-supported (1setOf name(127))</h4>
1043 <p>The "port-monitor-supported" attribute specifies the available port monitors.
1044
1045 <h4 id='printer-commands'><span class="info">Deprecated</span>printer-commands (1setOf Type3 keyword)</h4>
1046 <p>The "printer-commands" attribute specifies the commands that are supported by the CUPS command file filter. The keyword 'none' indicates that no commands are supported.</p>
1047
1048 <h4 id='printer-type'>printer-type (enum)</h4>
1049 <p>The "printer-type" status attribute specifies printer type and capability bits for the printer or class. The default value is computed from internal state information and the PPD file for the printer. The following bits are defined:</p>
1050 <table summary='Printer Type Bits'>
1051 <thead>
1052 <tr>
1053 <th>Bit</th>
1054 <th>Description</th>
1055 </tr>
1056 </thead>
1057 <tbody>
1058 <tr>
1059 <td>0x00000001</td>
1060 <td>Is a printer class.</td>
1061 </tr>
1062 <tr>
1063 <td>0x00000002</td>
1064 <td>Is a remote destination.</td>
1065 </tr>
1066 <tr>
1067 <td>0x00000004</td>
1068 <td>Can print in black.</td>
1069 </tr>
1070 <tr>
1071 <td>0x00000008</td>
1072 <td>Can print in color.</td>
1073 </tr>
1074 <tr>
1075 <td>0x00000010</td>
1076 <td>Can print on both sides of the page in hardware.</td>
1077 </tr>
1078 <tr>
1079 <td>0x00000020</td>
1080 <td>Can staple output.</td>
1081 </tr>
1082 <tr>
1083 <td>0x00000040</td>
1084 <td>Can do fast copies in hardware.</td>
1085 </tr>
1086 <tr>
1087 <td>0x00000080</td>
1088 <td>Can do fast copy collation in hardware.</td>
1089 </tr>
1090 <tr>
1091 <td>0x00000100</td>
1092 <td>Can punch output.</td>
1093 </tr>
1094 <tr>
1095 <td>0x00000200</td>
1096 <td>Can cover output.</td>
1097 </tr>
1098 <tr>
1099 <td>0x00000400</td>
1100 <td>Can bind output.</td>
1101 </tr>
1102 <tr>
1103 <td>0x00000800</td>
1104 <td>Can sort output.</td>
1105 </tr>
1106 <tr>
1107 <td>0x00001000</td>
1108 <td>Can handle media up to US-Legal/A4.</td>
1109 </tr>
1110 <tr>
1111 <td>0x00002000</td>
1112 <td>Can handle media from US-Legal/A4 to ISO-C/A2.</td>
1113 </tr>
1114 <tr>
1115 <td>0x00004000</td>
1116 <td>Can handle media larger than ISO-C/A2.</td>
1117 </tr>
1118 <tr>
1119 <td>0x00008000</td>
1120 <td>Can handle user-defined media sizes.</td>
1121 </tr>
1122 <tr>
1123 <td>0x00010000</td>
1124 <td>Is an implicit (server-generated) class.</td>
1125 </tr>
1126 <tr>
1127 <td>0x00020000</td>
1128 <td>Is the a default printer on the network.</td>
1129 </tr>
1130 <tr>
1131 <td>0x00040000</td>
1132 <td>Is a facsimile device.</td>
1133 </tr>
1134 <tr>
1135 <td>0x00080000</td>
1136 <td>Is rejecting jobs.</td>
1137 </tr>
1138 <tr>
1139 <td>0x00100000</td>
1140 <td>Delete this queue.</td>
1141 </tr>
1142 <tr>
1143 <td>0x00200000</td>
1144 <td>Queue is not shared.</td>
1145 </tr>
1146 <tr>
1147 <td>0x00400000</td>
1148 <td>Queue requires authentication.</td>
1149 </tr>
1150 <tr>
1151 <td>0x00800000</td>
1152 <td>Queue supports CUPS command files.</td>
1153 </tr>
1154 <tr>
1155 <td>0x01000000</td>
1156 <td>Queue was automatically discovered and added.</td>
1157 </tr>
1158 <tr>
1159 <td>0x02000000</td>
1160 <td>Queue is a scanner with no printing capabilities.</td>
1161 </tr>
1162 <tr>
1163 <td>0x04000000</td>
1164 <td>Queue is a printer with scanning capabilities.</td>
1165 </tr>
1166 </tbody>
1167 </table>
1168
1169 <h4 id='printer-type-mask'>printer-type-mask (enum)</h4>
1170 <p>The "printer-type-mask" attribute is used to choose printers or classes with the CUPS-Get-Printers and CUPS-Get-Classes operations. The bits are defined identically to the printer-type attribute and default to all 1's.
1171
1172 <h4 id='requesting-user-name-allowed'><span class="info">Deprecated</span>requesting-user-name-allowed (1setof name(127))</h4>
1173 <p>The "requesting-user-name-allowed" attribute lists all of the users that are allowed to access a printer or class. Either this attribute or the "requesting-user-name-denied" attribute will be defined, but not both.
1174
1175 <h4 id='requesting-user-name-denied'><span class="info">Deprecated</span>requesting-user-name-denied (1setof name(127))</h4>
1176 <p>The "requesting-user-name-denied" attribute lists all of the users that are not allowed to access a printer or class. Either this attribute or the "requesting-user-name-allowed" attribute will be defined, but not both.
1177
1178
1179 <h3 id='CLASS_ATTRIBUTES'><span class='info'>Deprecated</span>Printer Class Attributes</h3>
1180 <p>Printer class attributes are placed in the printer-attributes-tag group.</p>
1181
1182 <h4><span class='info'>Deprecated</span>member-names (1setof name(127))</h4>
1183 <p>The "member-names" attribute specifies the "printer-name" attributes for each the member printer and class. Each name corresponds to the same element of the "member-uris" attribute.
1184
1185 <h4><span class='info'>Deprecated</span>member-uris (1setof uri)</h4>
1186 <p>The "member-uris" attribute specifies the "printer-uri-supported" values for each member printer and class. Each URI corresponds to the same element of the "member-names" attribute.
1187
1188
1189 <h3 id='SUPPLY_ATTRIBUTES'>Printer Supply Level Attributes</h3>
1190 <p>Printer supply attributes are placed in the printer-attributes-tag group. These attributes are used by AirPrint to provide supply level information similar to the "printer-supply", "printer-supply-description", and "printer-supply-info-uri" attributes defined in the <a href="https://ftp.pwg.org/pub/pwg/candidates/cs-ippnodriver20-20230301-5100.13.pdf">IPP Driver Replacement Extensions v2.0 (NODRIVER)</a>. The supply level attributes are only available when the corresponding CUPS printer driver or IPP Printer report them.</p>
1191
1192 <h4 id='marker-change-time'>marker-change-time (integer)</h4>
1193 <p>The "marker-change-time" status attribute specifies the "printer-up-time" value when the last change to the marker-colors, marker-levels, marker-message, marker-names, or marker-types attributes was made.</p>
1194
1195 <h4 id='marker-colors'>marker-colors (1setof name(MAX))</h4>
1196 <p>The "marker-colors" status attribute specifies the color(s) for each supply in the printer. It is only available when the driver provides supply levels. The color is either 'none' or one or more hex-encoded sRGB colors of the form '#RRGGBB', for example '#000000' and '#00FFFF#FF00FF#FFFF00' for a printer with a black and CMY ink cartridge.</p>
1197
1198 <h4 id='marker-high-levels'>marker-high-levels (1setof integer(0:100))</h4>
1199 <p>The "marker-high-levels" status attribute specifies the supply levels that indicate a near-full condition. A value of 100 is used for supplies that are consumed/emptied such as ink and toner cartridges, and a value of 0 is used for supplies that are filled such as waste containers/recptacles.</p>
1200
1201 <h4 id='marker-levels'>marker-levels (1setof integer(-3:100))</h4>
1202 <p>The "marker-levels" status attribute specifies the current supply levels for the printer. A value of -1 indicates the level is unavailable, -2 indicates unknown, and -3 indicates the level is unknown but has not yet reached capacity. Values from 0 to 100 indicate the corresponding percentage.</p>
1203
1204 <h4 id='marker-low-levels'>marker-low-levels (1setof integer(0:100))</h4>
1205 <p>The "marker-low-levels" status attribute specifies the supply levels that indicate a near-empty (for supplies that are consumed) or near-full (for supplies that are filled) condition. The low values for supplies like ink and toner are often in the range of 5 to 15 percent while waste containers/receptacles typically are in the range of 85 to 95.</p>
1206
1207 <h4 id='marker-message'>marker-message (text(MAX))</h4>
1208 <p>The "marker-message" status attribute provides a human-readable status message for the current supply levels such as '12 pages of ink remaining.' or 'Replace cyan toner soon.'</p>
1209
1210 <h4 id='marker-names'>marker-names (1setof name(MAX))</h4>
1211 <p>The "marker-names" status attribute specifies the name(s) for each supply in the printer, for example 'Black Toner (TK10)' for a B&amp;W laser printer.</p>
1212
1213 <h4 id='marker-types'>marker-types (1setof keyword)</h4>
1214 <p>The "marker-types" status attribute specifies the type(s) of each supply in the printer. The following (RFC 3805) types are currently supported:</p>
1215 <ul>
1216 <li>'banding-supply'</li>
1217 <li>'binding-supply'</li>
1218 <li>'cleaner-unit'</li>
1219 <li>'corona-wire'</li>
1220 <li>'covers'</li>
1221 <li>'developer'</li>
1222 <li>'fuser-cleaning-pad'</li>
1223 <li>'fuser-oil-wick'</li>
1224 <li>'fuser-oil'</li>
1225 <li>'fuser-oiler'</li>
1226 <li>'fuser'</li>
1227 <li>'ink-cartridge'</li>
1228 <li>'ink-ribbon'</li>
1229 <li>'ink'</li>
1230 <li>'inserts'</li>
1231 <li>'opc'</li>
1232 <li>'paper-wrap'</li>
1233 <li>'ribbon-wax'</li>
1234 <li>'shrink-wrap'</li>
1235 <li>'solid-wax'</li>
1236 <li>'staples'</li>
1237 <li>'stiching-wire'</li>
1238 <li>'toner-cartridge'</li>
1239 <li>'toner'</li>
1240 <li>'transfer-unit'</li>
1241 <li>'waste-ink'</li>
1242 <li>'waste-toner'</li>
1243 <li>'waste-water'</li>
1244 <li>'waste-wax'</li>
1245 <li>'water'</li>
1246 </ul>
1247 </body>
1248 </html>