1ipptool(1) OpenPrinting ipptool(1)
2
6 ipptool - perform internet printing protocol requests
7
9 ipptool [ --help ] [ --ippserver filename ] [ --stop-after-include-er‐
10 ror ] [ --version ] [ -4 ] [ -6 ] [ -C ] [ -E ] [ -I ] [ -L ] [ -P
11 filename.plist ] [ -S ] [ -T seconds ] [ -V version ] [ -X ] [ -c ] [
12 -d name=value ] [ -f filename ] [ -h ] [ -i seconds ] [ -j ] [ -n re‐
13 peat-count ] [ -q ] [ -t ] [ -v ] printer-uri testfile [ ... testfile
14 ]
15
17 ipptool sends IPP requests to the specified printer-uri and tests
18 and/or displays the results. Each named testfile defines one or more
19 requests, including the expected response status, attributes, and val‐
20 ues. Output is either a plain text, formatted text, CSV, or XML report
21 on the standard output, with a non-zero exit status indicating that one
22 or more tests have failed. The testfile format is described in ipp‐
23 toolfile(5).
24
26 The following options are recognized by ipptool:
27 --help
29 Shows program help.
30 --ippserver filename
32 Specifies that the test results should be written to the named
33 ippserver attributes file.
34 --stop-after-include-error
36 Tells ipptool to stop if an error occurs in an included file. Nor‐
37 mally ipptool will continue with subsequent tests after the IN‐
38 CLUDE directive.
39 --version
41 Shows the version of ipptool being used.
42 -4 Specifies that ipptool must connect to the printer or server using
44 IPv4.
45 -6 Specifies that ipptool must connect to the printer or server using
47 IPv6.
48 -C Specifies that requests should be sent using the HTTP/1.1 "Trans‐
50 fer-Encoding: chunked" header, which is required for conformance
51 by all versions of IPP. The default is to use "Transfer-Encoding:
52 chunked" for requests with attached files and "Content-Length:"
53 for requests without attached files.
54 -E Forces TLS encryption when connecting to the server using the HTTP
56 "Upgrade" header.
57 -I Specifies that ipptool will continue past errors.
59 -L Specifies that requests should be sent using the HTTP/1.0 "Con‐
61 tent-Length:" header, which is required for conformance by all
62 versions of IPP. The default is to use "Transfer-Encoding: chun‐
63 ked" for requests with attached files and "Content-Length:" for
64 requests without attached files.
65 -P filename.plist
67 Specifies that the test results should be written to the named XML
68 (Apple plist) file in addition to the regular test report (-t).
69 This option is incompatible with the -i (interval) and -n (re‐
70 peat-count) options.
71 -S Forces (dedicated) TLS encryption when connecting to the server.
73 -T seconds
75 Specifies a timeout for IPP requests in seconds.
76 -V version
78 Specifies the default IPP version to use: 1.0, 1.1, 2.0, 2.1, or
79 2.2. If not specified, version 1.1 is used.
80 -X Specifies that XML (Apple plist) output is desired instead of the
82 plain text report. This option is incompatible with the -i (in‐
83 terval) and -n (repeat-count) options.
84 -c Specifies that CSV (comma-separated values) output is desired in‐
86 stead of the plain text output.
87 -d name=value
89 Defines the named variable.
90 -f filename
92 Defines the default request filename for tests.
93 -h Validate HTTP response headers.
95 -i seconds
97 Specifies that the (last) testfile should be repeated at the spec‐
98 ified interval. This option is incompatible with the -X (XML
99 plist output) option.
100 -j Specifies that ipptool will produce JSON output.
102 -l Specifies that plain text output is desired.
104 -n repeat-count
106 Specifies that the (last) testfile should be repeated the speci‐
107 fied number of times. This option is incompatible with the -X
108 (XML plist output) option.
109 -q Be quiet and produce no output.
111 -t Specifies that CUPS test report output is desired instead of the
113 plain text output.
114 -v Specifies that all request and response attributes should be out‐
116 put in CUPS test mode (-t). This is the default for XML output.
117
119 The ipptool program returns 0 if all tests were successful and 1 other‐
120 wise.
121
123 The following standard files are available:
124 color.jpg
126 create-printer-subscription.test
127 document-a4.pdf
128 document-a4.ps
129 document-letter.pdf
130 document-letter.ps
131 get-completed-jobs.test
132 get-jobs.test
133 get-notifications.test
134 get-printer-attributes.test
135 get-subscriptions.test
136 gray.jpg
137 ipp-1.1.test
138 ipp-2.0.test
139 ipp-2.1.test
140 ipp-2.2.test
141 ipp-everywhere.test
142 onepage-a4.pdf
143 onepage-a4.ps
144 onepage-letter.pdf
145 onepage-letter.ps
146 print-job.test
147 print-job-deflate.test
148 print-job-gzip.test
149 testfile.jpg
150 testfile.pcl
151 testfile.pdf
152 testfile.ps
153 testfile.txt
154 validate-job.test
155
157 The ipptool program is unique to CUPS and conforms to the Internet
158 Printing Protocol up to version 2.2.
159
161 Get a list of completed jobs for "myprinter":
162 ipptool ipp://localhost/printers/myprinter get-completed-jobs.test
164 Send email notifications to "user@example.com" when "myprinter"
166 changes:
167 ipptool -d recipient=mailto:user@example.com \
169 ipp://localhost/printers/myprinter create-printer-subscription.test
170
172 ipptoolfile(5), IANA IPP Registry (https://www.iana.org/assign‐
173 ments/ipp-registrations), PWG Internet Printing Protocol Workgroup
174 (https://www.pwg.org/ipp) RFC 8011 (https://data‐
175 tracker.ietf.org/doc/html/rfc8011),
176
178 Copyright © 2021-2023 by OpenPrinting.
1792021-10-20 CUPS ipptool(1)