1mod_ipp(4) File Formats mod_ipp(4)
2
6 mod_ipp - Embedded Internet Print Protocol (IPP) listener for the
7 Apache HTTP server
8
10 /usr/apache/libexec/mod_ipp.so
11
14 The mod_ipp module implements RFCs 2910 and 2911 to provide an IPP han‐
15 dling service for the Apache HTTP server. When loaded on the Apache
16 server, mod_ipp processes all HTTP requests with MIME types of applica‐
17 tion/ipp. The mod_ipp module also processes additional configuration
18 directives to enable or disable portions of the protocol support.
19 Using Configuration Directives
21 The following is a list of configuration directives that apply to the
22 Apache IPP Listening service:
23 o ipp-conformance (automatic|1.0|1.1)
25 o ipp-operation (operation) (enable|disable)
27 o enable|disable
29 The values true, yes, on, enable are considered to be
31 synonymous and will enable support for the named opera‐
32 tion. All other values will disable support for the
33 named operation.
34 Operations
36 The following is a list of IPP handling service operations:
37 print-job This operation is a required IPP operation
39 that allows client systems to submit a print
40 job with a single document embedded in the
41 data stream. This operation is primarily used
42 from the IPP support Microsoft has provided
43 for its Windows (9X/ME/NT/2K/XP).
44 print-uri This is an optional IPP operation that allows
47 client systems to submit a print job with a
48 reference (URL) for a single document. This
49 operation is currently not supported by the
50 mod_ipp Apache Module.
51 validate-job This is a required IPP operation that allows
54 client systems to simulate the submission of
55 a print job to verify that the server is
56 capable of handling the job. This operation
57 is supported by mod_ipp.
58 create-job This is an optional IPP operation that allows
61 client systems to submit a print job. The
62 operation is used with the send-document and
63 send-uri operations.
64 get-jobs This is a required IPP operation that allows
67 client systems to retrieve a list of print
68 jobs from the print service.
69 get-printer-attributes This is a required IPP operation that allows
72 client systems to retrieve attributes from
73 the print service that describes the named
74 printer object.
75 pause-printer This an optional IPP operation that allows
78 client systems to stop job processing on the
79 named print queue.
80 resume-printer This is an optional IPP operation that allows
83 client systems to resume job processing on
84 the named print queue.
85 purge-jobs This is an optional IPP operation that allows
88 client systems to cancel all print jobs on
89 the named print queue.
90 send-document This is a required IPP operation that allows
93 client systems to add documents to print jobs
94 created with the create-job operation, but
95 not yet submitted.
96 send-uri This is an optional IPP operation that allows
99 a client system to add a document reference
100 (URI) to a print job created with the create-
101 job operation, but not yet submitted. This
102 operation is currently not supported by the
103 mod_ipp Apache Module.
104 cancel-job This is a required IPP operation that allows
107 client systems to cancel print jobs.
108 get-job-attributes This is a required IPP operation that allows
111 client systems to retrieve attributes that
112 describe a print job from the print service.
113 hold-job This is an optional IPP operation that allows
116 client systems to hold print jobs.
117 release-job This is an optional IPP operation that allows
120 client systems to release print jobs.
121 restart-job This is an optional IPP operation that allows
124 client systems to restart print jobs.
125 all This is a place holder for enabling or dis‐
128 abling support for all IPP operations imple‐
129 mented by the mod_ipp Apache module.
130 required This is a place holder for enabling or dis‐
133 abling support for the required IPP opera‐
134 tions implemented by the mod_ipp Apache mod‐
135 ule.
136
139 Example 1 Using a Configuration File to Start a Standalone Apache
140 Server
141 The following configuration file can be used to start a standalone
144 Apache server to respond to IPP request sent to port 631.
145 ServerType standalone
148 ServerRoot "/usr/apache"
149 PidFile /var/run/httpd-standalone-ipp.pid
150 ErrorLog /var/lp/logs/ipp-errors
151 Timeout 300
153 KeepAlive On
154 MaxKeepAliveRequests 100
155 KeepAliveTimeout 15
156 MinSpareServers 1
158 MaxSpareServers 3
159 StartServers 1
160 MaxClients 150
161 MaxRequestsPerChild 0
162 LoadModule ipp_module libexec/mod_ipp.so
164 ClearModuleList
166 AddModule mod_ipp.c
167 AddModule mod_so.c
168 Port 631
170 User lp
172 Group lp
173 ServerAdmin lp@localhost
175 DefaultType application/ipp
176 <IFModule mod_app>
178 <Location />
179 ipp-operation all on
180 </Location>
181 </IFModule mod_app>
182 A more restrictive configuration might include the following parame‐
186 ters:
187 <IFModule mod_app>
190 <Location />
191 ipp-operation all offn
192 ipp-operation required on
193 </Location>
194 </IFModule mod_app>
195
198 See attributes(5) or descriptions of the following attributes:
199 ┌─────────────────────────────┬─────────────────────────────┐
204 │ ATTRIBUTE TYPE │ ATTRIBUTE VALUE │
205 ├─────────────────────────────┼─────────────────────────────┤
206 │Availability │SUNWipplu │
207 ├─────────────────────────────┼─────────────────────────────┤
208 │Interface Stability │External │
209 └─────────────────────────────┴─────────────────────────────┘
210
212 man(1), catman(1M), attributes(5)
213 Herriot, R., Ed., Butler, S., Moore, P., Turner, R., Wenn, J. RFC 2910,
216 Internet Printing Protocol/1.1: Encoding and Transport. Network Working
217 Group. September 2000.
218 Hastings, T., Ed., Herriot, R., deBry, R., Isaacson, S., Powell, P. RFC
221 2911, Internet Printing Protocol/1.1: Model and Semantics. Network
222 Working Group. September 2000.
223 http://www.apache.org
226
228 Configuration file directives are processed in the order listed in the
229 config file. The default behavior is to enable support for all opera‐
230 tions implemented in the mod_ipp Apache module.
231 Since the Apache IPP listening service implements some capabilities
234 that are more of operator features, it may not be desirable to enable
235 all IPP operations without requiring user authentication on the Apache
236 listening service.
237 The following is an example of a more reasonable configuration for
240 Apache IPP servers without user authentication enabled:
241 ipp-operations all disabled
243 ipp-operations required enabled
244 The printers and jobs available under this service can be accessed
248 using URIs of the following form:
249 printer:
251 http://server[:port]/printers/{queue}
252 ipp://server[:port]/printers/{queue}
253 job:
254 http://server[:port]/printers/{queue}/{job-id}
255 ipp://server[:port]/printers/{queue}/{job-id}
256 631 is the default IPP port and implied when the URI scheme is ipp.
260 However, some client implementations do not recognize the ipp URI
261 scheme and require http://server:631/... instead. For example, Micro‐
262 soft's IPP client implementation does not recognize the ipp scheme.
263 In addition to the documentation and man pages included with Solaris,
266 more information is available at http://www.apache.org
267 The httpd(8) man page and other Apache man pages are provided with the
270 programming modules. To view the Apache manual pages with the man com‐
271 mand, add /usr/apache/man to the MANPATH environment variable. See
272 man(1) for more information. Running catman(1M) on the Apache manual
273 pages is not supported.
274SunOS 5.11 26 Nov 2003 mod_ipp(4)