ipptool sends IPP requests to the specified printer-uri and tests
and/or displays the results. Each named testfile defines one or more
requests, including the expected response status, attributes, and
values. Output is either a plain text, formatted text, CSV, or XML
report on the standard output, with a non-zero exit status indicating
that one or more tests have failed. The testfile format is described
The following options are recognized by ipptool:--help
Shows program help.
Tells ipptool to stop if an error occurs in an included file.
Normally ipptool will continue with subsequent tests after the
Shows the version of ipptool being used.
-4 Specifies that ipptool must connect to the printer or server
-6 Specifies that ipptool must connect to the printer or server
-C Specifies that requests should be sent using the HTTP/1.1
"Transfer-Encoding: chunked" header, which is required for
conformance by all versions of IPP. The default is to use
"Transfer-Encoding: chunked" for requests with attached files
and "Content-Length:" for requests without attached files.
-E Forces TLS encryption when connecting to the server using the
HTTP "Upgrade" header.
-I Specifies that ipptool will continue past errors.
-L Specifies that requests should be sent using the HTTP/1.0
"Content-Length:" header, which is required for conformance by
all versions of IPP. The default is to use "Transfer-Encoding:
chunked" for requests with attached files and "Content-Length:"
for requests without attached files.
Specifies that the test results should be written to the named
XML (Apple plist) file in addition to the regular test report
(-t). This option is incompatible with the -i (interval) and -n
-S Forces (dedicated) TLS encryption when connecting to the server.
Specifies a timeout for IPP requests in seconds.
Specifies the default IPP version to use: 1.0, 1.1, 2.0, 2.1, or
2.2. If not specified, version 1.1 is used.
-X Specifies that XML (Apple plist) output is desired instead of
the plain text report. This option is incompatible with the -i
(interval) and -n (repeat-count) options.
-c Specifies that CSV (comma-separated values) output is desired
instead of the plain text output.
Defines the named variable.
Defines the default request filename for tests.
Specifies that the (last) testfile should be repeated at the
specified interval. This option is incompatible with the -X
(XML plist output) option.
-l Specifies that plain text output is desired.
Specifies that the (last) testfile should be repeated the
specified number of times. This option is incompatible with the
-X (XML plist output) option.
-q Be quiet and produce no output.
-t Specifies that CUPS test report output is desired instead of the
plain text output.
-v Specifies that all request and response attributes should be
output in CUPS test mode (-t). This is the default for XML
The following standard files are available:
Get a list of completed jobs for "myprinter":
ipptool ipp://localhost/printers/myprinter get-completed-jobs.test
Send email notifications to "firstname.lastname@example.org" when "myprinter"
ipptool -d recipient=mailto:email@example.com \
This page is part of the CUPS (a standards-based, open source
printing system) project. Information about the project can be found
at ⟨http://www.cups.org/⟩. If you have a bug report for this manual
page, see ⟨http://www.cups.org/⟩. This page was obtained from the
project's upstream Git repository ⟨https://github.com/apple/cups⟩ on
2017-03-13. If you discover any rendering problems in this HTML ver‐
sion of the page, or you believe there is a better or more up-to-date
source for the page, or you have corrections or improvements to the
information in this COLOPHON (which is not part of the original man‐
ual page), send a mail to firstname.lastname@example.org
26 August 2015 CUPS ipptool(1)